UltraMon HSPI User`s Guide

UltraECM3 HSPI User’s
Guide
A HomeSeer HS3 plug-in for the
Brultech Energy Consumption Monitors.
Copyright © 2014
[email protected]
Revised 01/12/2014
This document contains proprietary and copyrighted information and may not be copied, reproduced,
translated, or reduced to any electronic medium without prior consent, in writing, from
[email protected].
Table of Contents
Introduction .................................................................................................................................................. 4
Intended Audience .................................................................................................................................... 4
UltraECM3 HSPI Overview ............................................................................................................................ 4
How It Works ............................................................................................................................................ 4
Features .................................................................................................................................................... 4
Requirements............................................................................................................................................ 4
UltraECM3 HSPI Installation.......................................................................................................................... 5
Downloading and Installing the HomeSeer Plug-in .................................................................................. 5
UltraECM3 HSPI Setup .................................................................................................................................. 5
Initial Setup Checklist ................................................................................................................................ 5
UltraECM3 HSPI Configuration ..................................................................................................................... 6
Web Page Layout ...................................................................................................................................... 6
Screenshot ............................................................................................................................................ 7
Options ...................................................................................................................................................... 7
Brultech Devices ....................................................................................................................................... 8
Adding a New Brultech Device .............................................................................................................. 8
Modifying an Existing Brultech Device.................................................................................................. 9
Deleting an Existing Brultech Device .................................................................................................... 9
Brultech Channel Devices ......................................................................................................................... 9
Adding a UltraECM3 Channel Device .................................................................................................... 9
Modifying an Existing UltraECM3 Channel Device.............................................................................. 10
Deleting an Existing UltraECM3 Channel Device ................................................................................ 10
Brultech Pulse Counters .......................................................................................................................... 10
Adding a UltraECM3 Pulse Counter Device......................................................................................... 10
Modifying an Existing UltraECM3 Pulse Counter Device .................................................................... 11
Deleting an Existing UltraECM3 Pulse Counter Device ....................................................................... 11
Brultech 1-Wire Temperature Sensors ................................................................................................... 11
Adding a UltraECM3 Temperature Device .......................................................................................... 11
Modifying an Existing UltraECM3 Temperature Device ..................................................................... 12
2
Deleting an Existing UltraECM3 Temperature Device ........................................................................ 12
UltraECM3 Homeseer Devices ................................................................................................................ 12
Connection Device .............................................................................................................................. 12
Database Device.................................................................................................................................. 12
UltraECM3 Energy Charts........................................................................................................................ 13
Screenshot .......................................................................................................................................... 13
Screenshot .......................................................................................................................................... 13
UltraECM3 HSPI Triggers ............................................................................................................................. 14
UltraECM3 HSPI Trigger Actions ................................................................................................................. 14
UltraECM3 HSPI Trigger Conditions ............................................................................................................ 14
3
Introduction
UltraECM3 is a HomeSeer3 plug-in for the Brultech Energy Consumption Monitors (ECM). The plug-in
connects directly to one or more Brultech ECM devices providing HomeSeer a view into the electrical
power consumption of your home.
Intended Audience
This document is intended for the HomeSeer user that has chosen to install and configure the UltraECM3
HomeSeer Plug-in.
UltraECM3 HSPI Overview
The Brultech ECM-1240 and GreenEye Energy Monitors are multi-channel energy consumption monitors
designed for use with residential electrical systems. The ECM-1240 is used to measure consumption of
up to 7 electrical circuits and provides up to the minute consumption data. The GreenEye Monitor
(GEM) is used to measure consumption of up to 32 electrical circuits and provides up to the minute
consumption data. The GEM also includes 8 temperature sensing and 4 pulse counting inputs.
How It Works
The UltraECM3 HSPI connects directly to the Brultech Energy Consumption Monitors using either a
serial or TCP network connection. The packets received from the Brultech ECM devices can be buffered
and averaged to reduce loads for ECM units configured to send frequent updates. The UltraECM3 plugin provides real-time access to Watts and KWh. The plug-in allows you to create a HomeSeer device for
just the ECM devices you want HomeSeer to display and react to.
Features







Multiple threading allows UltraECM3 HSPI to communicate with the Brultech ECM devices
without disrupting the performance of HomeSeer.
Support for up to 9 Brultech ECM-1240 and GreenEye Monitor devices.
Create only the HomeSeer devices you need to track energy usage in your home.
A Loads web page provides access to the real-time energy usage.
The Dashboard web page provides a cost and usage breakdown of all electrical circuits
connected to the Brultech ECM devices.
The Energy Charts web page displays watts and KWh usage over time.
Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception.
Requirements


Homeseer 3 or greater.
One or more of the Brultech ECM-1240 and/or GreenEye Monitors connect to HomeSeer using
either a serial or network connection.
4
UltraECM3 HSPI Installation
Downloading and Installing the HomeSeer Plug-in
1. From your HomeSeer web page, select PLUG-INS > Manage.
2. Click the + icon next to Additional Interfaces to expand the list of available HomSeer3 plug-ins.
3. Click the + icon next to the “Hardware Interface Plug-Ins” category, then click the checkbox next
to the UltraECM3 plug-in package to mark the plug-in for installation.
4. Under “Pending Updates/Installs”, click the Download and Install button.
5. Once the installer finishes, find the UltraECM3 plug-in under Installed Plug-Ins, then enable it.
UltraECM3 HSPI Setup
Before you begin to configure the UltraECM3 plug-in, you’ll need to make sure you test connectivity to
the Brultech ECM devices. Refer to the Brultech documentation for additional information.
Initial Setup Checklist
1. Brultech ECM-1240 Installation – Refer to the Brultech ECM-1240 Install Guide and User Manual
on how to install and configure the energy consumption monitors.
2. Brultech GreenEye Monitor (GEM) Installation - Refer to the Brultech GEM Install Guide and
User Manual on how to install and configure the energy consumption monitors.
Under Network > Remote Host, enter the IP address of your HomeSeer system and port 8000,
then click Save. This is server mode, so you'll want to use client mode within the UltraECM3
plug-in (e.g. 0.0.0.0:8000). You should also select BIN48-NET (5) for the packet format.
3. Start HomeSeer and ignore any UltraECM3 errors indicating the ECM interface is disabled.
Select UltraECM3 > Devices to add each Brultech device connected to your HomeSeer system.
a. Device Serial: Enter the Brultech serial number (or any unique number of you don’t
know the serial number). The serial number will be populated once the plug-in makes a
connection to the Brultech device.
b. Device Name: Enter the Brultech device alias (e.g. Basement Main Panel).
c. Device Type: Select from one of the supported Brultech device types.
d. Connection Type: Select the type of connection used to connect HomeSeer to the
Brultech ECM device.
e. Connection Address: If you are using a Serial Connection, enter COM:N where N is the
serial port number. If you are using an Ethernet Connection: If the Brultech device is
using server mode, enter 0.0.0.0:8000 where 8000 is the TCP port defined within the
GEM. If the Brultech device is using client mode, then enter n.n.n.n:ppp where n.n.n.n
5
is the IP address of the Brultech device and ppp is the TCP port number.
4. Restart HomeSeer to allow the plug-in to establish the initial connection to the Brultech ECM
devices. The HomeSeer status web page should indicate the UltraECM3 HSPI is successfully
connected to the Brultech Device.
5. Make sure you are seeing successful database inserts from the UltraECM3 > Status web page:
UltraECM3 HSPI Configuration
Web Page Layout
The UltraECM3 plug-in has 10 web pages that provide access to the available features of the plug-in.
6
Screenshot
The available web pages are as follows:
1. Status – Displays the UltraECM3 HSPI plug-in status, Brultech Engine connection status,
database status, and database statistics.
2. Options – Displays and allows you to change the options associated with the plug-in.
3. Devices – Displays and allows you to add, modify and delete Brultech ECM devices.
4. Channels – Displays the options associated with each electrical circuit being monitored by the
Brultech ECM devices. The web page allows you to define a friendly channel name, the graph
line color and provides the ability to automatically create the desired HomeSeer devices.
5. Pulse Counter – Displays the options associated with each pulse counter being monitored by
the Brultech ECM devices. The web page allows you to define a friendly pulse counter name,
the graph line color and provides the ability to automatically create a HomeSeer device.
6. Temperature – Displays the options associated with each temperature sensor being monitored
by the Brultech ECM devices. The web page allows you to define a friendly temperature sensor
name, the graph line color and provides the ability to automatically create a HomeSeer device.
7. Rates – Displays the Energy Rates.
8. Loads – Displays the real-time watt usage for each electrical circuit being monitored by the
Brultech ECM devices. The UltraECM3 HSPI displays real-time data using either gauges or
tables.
9. Dashboard – The dashboard web displays a breakdown of energy usage and cost over time.
10. Energy Charts – A web page that allows you to chart the energy usage (Watts or KWh) of each
ECM device and associated channels.
Options
All options are set from the Options web page. The following options are supported:
1. Data Buffer – Select the number of packets to buffer and average before updating the
underlying HomeSeer devices and database. If the ECM devices are configured to buffer
packets, then select 1 packet. If you need to reduce disk activity, then select a higher packet
buffer value.
Please Note: Selecting a data buffer greater than 1 will use more memory in order to properly
average the values between database writes.
2. Device Value – This option allows you to update the underlying HomeSeer device value
multiplied by either 10, 100 or 1000.
7
3. Default Cost – Enter the default cost per KWh. This value will be used if the electric rate cannot
be determined.
4. Site Type – Select SmartEnergyGroup if you want to post updates to the Smart Energy Groups
web site. You’ll need to complete the setup on http://smartenergygroups.com before enabling
this option.
5. Send Interval – Select how often you want to post data to the SmartEnergyGroup web site.
6. URL Address – Enter the URL for the SmartEnergyGroup web site. The default value is
http://api.smartenergygroups.com/sites/
7. Token – Enter the token you received when you signed up on the SmartEnergyGroup web site.
8. Authorized User Roles – Specify the HomeSeer uses authorized to access the UltraECM3 web
page.
9. Unit Type – The format used to display temperatures from the 1-wire sensors. The default
format is U.S customary units.
10. Display Degree Units – If set to Yes, a degree icon will be displayed on the HomeSeer status web
page.
11. GreenEye Serial Baud Rate – Select the default serial connection baud rate.
12. ECM-1240 Serial Baud Rate – Select the default serial connection baud rate.
13. Register Link – If set to Yes, the UltraECM3 button will be displayed on all web pages.
14. Debug Mode – If set to Yes, the plug-in will write verbose logging to the HomeSeer log file.
Brultech Devices
The Devices web page allows you to add, modify and delete the Brultech Energy Consumption Monitors
you have installed in your home. A Brultech Device entry contains the serial number, name, type,
connection type and connection address.
Adding a New Brultech Device
1. Click on the UltraECM3 > Devices button.
2. Enter the Brultech ECM serial number.
8
3.
4.
5.
6.
Enter a unique device name.
Select the Brultech Device Type from the dropdown list.
Select the Connection Type from the drowndown list.
Enter the Connection Address.
a. For Serial Connections, enter COM:N where N is the serial port number.
b. For Ethernet Connections using server mode, enter 0.0.0.0:8000 where 8000 is the TCP
port defined within the GEM.
c. For Ethernet Connections using client mode, enter n.n.n.n:ppp where n.n.n.n is the IP
address of the Brultech device and ppp is the TCP port number.
7. To add the Brultech Device, simply click on the Add New icon
Modifying an Existing Brultech Device
1. Click on the UltraECM3 > Devices button.
2. Find the Brultech Device you want to edit, and then click the Edit icon
3. Edit the values as needed, then press the Save icon
4. To cancel the changes, simply press the Cancel icon
Deleting an Existing Brultech Device
1. Click on the UltraECM3 > Devices button
2. Find the Brultech Device you want to delete, and then click the Delete icon
3. Confirm you want to delete the Brultech Device by clicking OK.
Brultech Channel Devices
The Channels web page allows you to modify the Brultech channels name, chart color and other
properties. I recommend you rename the channels before adding any UltraECM3 Channel Devices so
the proper channel name is used when the device is created.
Adding a UltraECM3 Channel Device
You can add HomeSeer devices that will display the channel watts and KWh from the UltraECM3 >
Channels web page. Simply select the Brultech Device from the drop down to display the channels
defined to the Brultech Device. Once the desired Brultech Channel devices are displayed, click the Edit
icon
, then simply select the checkbox for each HomeSeer device you want to create, then click the
Save icon
. Repeat these steps until you have created all the HomeSeer devices you want to create.
9
Screenshot
Modifying an Existing UltraECM3 Channel Device
You can modify an UltraECM3 device the same way you modify any other HomeSeer device. Simply click
on the device name from the HomeSeer device page, and then change the device properties as needed.
Note: Once a HomeSeer device is created, the plug-in will not overwrite any of the device properties, so
feel free to modify the name, location and location2 properties as you see fit.
Deleting an Existing UltraECM3 Channel Device
You can delete an UltraECM3 device the same way you delete any other HomeSeer device. From the
HomeSeer device web page, click the device name, then from the HomeSeer modify device web page,
click the Delete button.
Brultech Pulse Counters
The Pulse Counter web page allows you to modify the Brultech pulse counter name, chart color and
other properties. I recommend you rename the pulse counters before adding any UltraECM3 Pulse
Counter Devices so the proper name is used when the device is created.
Adding a UltraECM3 Pulse Counter Device
You can add HomeSeer devices that will display pulse counters from the UltraECM3 > Channels web
page. Simply select the Brultech Device from the drop down to display the pulse counters defined to the
Brultech Device. Once the desired Brultech Pulse Counter devices are displayed, click the Edit icon
,
10
then simply select the enabled checkbox to create a HomeSeer device, then click the Save icon
Repeat these steps until you have created all the HomeSeer devices you want to create.
.
Screenshot
Modifying an Existing UltraECM3 Pulse Counter Device
You can modify an UltraECM3 device the same way you modify any other HomeSeer device. Simply click
on the device name from the HomeSeer device page, and then change the device properties as needed.
Note: Once a HomeSeer device is created, the plug-in will not overwrite any of the device properties, so
feel free to modify the name, location and location2 properties as you see fit.
Deleting an Existing UltraECM3 Pulse Counter Device
You can delete an UltraECM3 device the same way you delete any other HomeSeer device. From the
HomeSeer device web page, click the device name, then from the HomeSeer modify device web page,
click the Delete button.
Brultech 1-Wire Temperature Sensors
The Temperature web page allows you to modify the Brultech Temperature name, chart color and other
properties. I recommend you rename the temperature sensors before adding any UltraECM3
Temperature Devices so the proper name is used when the device is created.
Adding a UltraECM3 Temperature Device
You can add HomeSeer devices that will display the temperature from the UltraECM3 > Channels web
page. Simply select the Brultech Device from the drop down to display the temperature sensors defined
to the Brultech Device. Once the desired Brultech Temperature devices are displayed, click the Edit
icon
, then simply select the enabled checkbox to create a HomeSeer device, then click the Save
icon
. Repeat these steps until you have created all the HomeSeer devices you want to create.
11
Screenshot
Modifying an Existing UltraECM3 Temperature Device
You can modify an UltraECM3 device the same way you modify any other HomeSeer device. Simply click
on the device name from the HomeSeer device page, and then change the device properties as needed.
Note: Once a HomeSeer device is created, the plug-in will not overwrite any of the device properties, so
feel free to modify the name, location and location2 properties as you see fit.
Deleting an Existing UltraECM3 Temperature Device
You can delete an UltraECM3 device the same way you delete any other HomeSeer device. From the
HomeSeer device web page, click the device name, then from the HomeSeer modify device web page,
click the Delete button.
UltraECM3 Homeseer Devices
Connection Device
This HomeSeer device is automatically created and manages the connection to the Brultech Devices. If
the plug-in happens to lose connection for whatever reason, you can force a connection by selecting
reconnect from the Control options. You can also halt the watchdog reconnection functionality by
selecting disconnect from the Control options.
Database Device
This HomeSeer device is automatically created and manages the connection to underlying database.
12
UltraECM3 Energy Charts
You can chart the energy usage over time from the Energy Charts web page. Simply select the Brultech
Device, the chart type, duration, the ending date and time, and then click the Build Chart button.
Screenshot
You can toggled the display of a channel by clicking the icon next to the channel name.
Screenshot
13
UltraECM3 HSPI Triggers
This plug-in does not have any HomeSeer triggers defined.
UltraECM3 HSPI Trigger Actions
This plug-in does not have any HomeSeer trigger actions defined.
UltraECM3 HSPI Trigger Conditions
This plug-in does not have any HomeSeer trigger conditions defined.
14