The Energy Detective Binding - RobertGordon/openhab GitHub Wiki

Documentation of The Energy Detective Binding

Binding should be compatible with The Energy Detective 5000 (TED5000) devices. The TED5000 provides an HTTP API to access the energy measurement data. The API documentation can be found on the product website at http://www.theenergydetective.com/developer-api. The API provides access to two types of data, live readings and historical data summarized over hourly, daily and monthly totals.

A TED5000 system consists of a Gateway unit and up to four Measuring Transmitting Units (MTU) with current transformers. The Gateway collects readings from the MTUs and provides a LAN interface to access the data. The binding currently implements live data processing. Historical values are under construction.

For installation of the binding, please see Wiki page Bindings.

First of all you need to introduce your TED5000 in the openhab.cfg file (in the folder '${openhab_home}/configurations').

################################# The Energy Detective  Binding ###########################

# Host of the first TED5000 device to control 
# theenergydetective:<gatewayId1>.host=
# Port of the first TED5000 to control (optional, defaults to 80)
# theenergydetective:<gatewayId1>.port=

# Host of the next TED5000 device to control 
# theenergydetective:<gatewayId2>.host=
# Port of the TED5000 to control (optional, defaults to 80)
# theenergydetective:<gatewayId2>.port=

The theenergydetective:<gatewayId1>.host value is the ip address or hostname of the TED5000 gateway.

The theenergydetective:<gatewayId1>.port value is TCP port address of the TED5000. Port value is optional parameter.

Example, how to configure your TED5000 device:

theenergydetective:gw1.host=192.168.1.100
theenergydetective:gw1.port=80

In order to bind an item to the device, you need to provide configuration settings in your item file (in the folder configurations/items`). The syntax of the binding configuration strings accepted is the following:

theenergydetective="<device-id>:<XML-element-path>"

The device-id corresponds to the device introduced in openhab.cfg.

The XML-element-path corresponds to the list of XML elements in the LiveData.xml file that define the energy value for the item. See the TED5000-API-R330.pdf on the TED developer web page for details of the XML file contents.

Examples, how to configure your items:

Number Power_Now  "Current Power [%.0f Watts]"  <energy> {theenergydetective="gw1:Power.MTU1.PowerNow"}
Number Peak_Power_Today  "Peak Power Today [%.0f Watts]"  <energy>  <theenergydetective="gw1:Power.MTU1.PeakTdy"}