energenie-ener314rt

A node.js module to control the Energenie line of products via the ENER314-RT add-on board for the Raspberry Pi.

https://energenie4u.co.uk/

Purpose

You can use this node.js module to control and monitor the Energenie MiHome radio based smart devices such as adapters, sockets, lights, thermostats and relays on a Raspberry Pi with an ENER314-RT board installed (see below for full device list). This is instead of operating the devices using a MiHome Gateway, so this module does not require an internet connection.

This node module also has two accompanying implementations by the same author. One that provides 'nodes' within node-red: node-red-contrib-energenie-ener314rt, and another that provides an MQTT interface to control and monitor the devices: mqtt-energenie-ener314rt that was built to support Home Assistant. Both of these implementation are easier to use than this node module directly, but it's up to you!

The number of individual devices this module can control is over 4 million, so it should be suitable for most installations!

NOTE: This module does not currently support the older boards (ENER314/Pi-Mote), the Energenie Wifi sockets or the MiHome Gateway.

IMPORTANT: UPGRADING FROM PREVIOUS RELEASE

v0.7.x requires additional software dependencies that must be manually installed first.

If you are upgrading from version 0.6.x or below, please ensure that you install node.js v18.2+, gpiod and libgpiod first.

Node exposed functions

These functions are exposed by this module:

|node function|description|Input params|Return|N-API 'C' function |---|---|---|---|---| |initEner314rt|Initialise radio adaptor|lock||nf_init_ener314rt| |openThingsSwitch|Switch an FSK device|productId, deviceId, switchState, xmits||nf_openThings_switch| |openThingsDeviceList|List discovered devices|scan|json|nf_openThings_deviceList| |openThingsReceive|Get single message|timeout|json|nf_openThings_receive| |openThingsReceiveThread|Start Receive Thread|timeout, callback|via cb|tf_openThings_receive_thread| |openThingsCmd|Send an OpenThings command immediately|productId, deviceId, command, data, xmits||nf_openThings_cmd| |openThingsCacheCmd*|Cache an eTRV Command|productId, deviceId, command, data, retries||nf_openThings_cache_cmd| |stopMonitoring*|Stop Receive Thread|||nf_stop_openThings_receive_thread| |ookSwitch|Switch an OOK device|zone, switchNum, switchState, xmits||nf_ook_switch| |sendRadioMsg|Send raw payload|modulation, xmits, buffer||nf_send_radio_msg| |closeEner314rt|Stop using radio adaptor|||nf_close_ener314rt|

* requires openThingsReceiveThread function to be active

Getting Started

1. Plug in your ENER314-RT-VER01 board from Energenie onto the 26 pin or 40 pin connector of your Raspberry Pi.

2. Include this module in your node.js code using require('energenie-ener314rt');

3. Install node.js, npm, gpiod and libgpiod code dependencies.

4. Use the code in the 'Examples' folder to build your node.js solution. There are 2 examples:

   • app.js: Basic node.js program that uses a number of core functions, including switching Control only sockets and using the Monitor Thread to output messages from all OpenThings 'Monitor' devices.
   • parent.js: An experimental node that forks a separate node instance to run the child.js code, and uses stdin/stdout messages between the parent and child programs.

Hardware based SPI driver - NEW In Version 0.6

To increase reliability a new hardware SPI driver has been added which utilises spidev (Issue #5). The module tries to use the hardware driver on start-up, if it has not been enabled it falls back to the software driver. The hardware SPI driver version can be enabled using sudo raspi-config choosing Interface Options and SPI to enable the hardware SPI mode, do this whilst this software is not running.

Supported Devices

These nodes are designed for energenie RF radio devices in the OOK & FSK (OpenThings) ranges.

I've tested the nodes with all devices that I currently own. Here is a table showing the function(s) to use with each device:

| Device | Description | Control Function | Monitor Function | Tested | |---|---|:---:|:---:|:---:| |ENER002|Green Button Adapter|ookSwitch||x| |ENER010|MiHome 4 gang Multiplug|ookSwitch||x| |MIHO002|MiHome Smart Plug (Blue)|ookSwitch||x| |MIHO004|MiHome Smart Monitor Plug (Pink)||openThingsReceiveThread|x| |MIHO005|MiHome Smart Plug+ (Purple)|openThingsSwitch|openThingsReceiveThread|x| |MIHO006|MiHome House Monitor||openThingsReceiveThread|x| |MIHO007|MiHome Socket (White)|ookSwitch||x| |MIHO008|MiHome Light Switch (White)|ookSwitch||| |MIHO009|MiHome 2 gang Light Switch (White)|ookSwitch||| |MIHO010|MiHome Dimmer Switch (White)|ookSwitch||| |MIHO013|MiHome Radiator Valve|openThingsCacheCmd|openThingsReceiveThread|x| |MIHO014|Single Pole Relay (inline)|ookSwitch||| |MIHO015|MiHome Relay|ookSwitch||| |MIHO021|MiHome Socket (Nickel)|ookSwitch||x| |MIHO022|MiHome Socket (Chrome)|ookSwitch||x| |MIHO023|MiHome Socket (Steel)|ookSwitch||x| |MIHO024|MiHome Light Switch (Nickel)|ookSwitch||| |MIHO025|MiHome Light Switch (Chrome)|ookSwitch||| |MIHO026|MiHome Light Switch (Steel)|ookSwitch||| |MIHO032|MiHome Motion sensor||openThingsReceiveThread|x| |MIHO033|MiHome Open Sensor||openThingsReceiveThread|x| |MIHO069|MiHome Heating Thermostat|openThingsCacheCmd|openThingsReceiveThread|x| |MIHO089|MiHome Click - Smart Button||openThingsReceiveThread|x|

'Control Only' OOK Zone Rules

• Each Energenie 'Control' or OOK based device can be assigned to a specifc zone (or house code) and a switch number.
• Each zone is encoded as a 20-bit address (1-1048575 decimal).
• Each zone can contain up to 6 switches (1-6) - NOTE: officially energenie state this is only 4 devices (1-4)
• All devices within the same zone can be switched at the same time using a switch number of '0'.
• A default zone '0' can be used to use Energenie's default zone (0x6C6C6).

Processing Monitor Messages

The received messages are passed back to node.js using the callback registered during the openThingsReceiveThread. These messages conform to the OpenThings parameter standard. All OpenThings parameters received from the device are decoded and returned using the callback in a json format.

For example the 'Smart Plug+' returns the following parameters:

{
    "timestamp": <numeric 'epoch based' timestamp, of when message was read>
    "REAL_POWER": <power in Watts being consumed>
    "REACTIVE_POWER": <Power in volt-ampere reactive (VAR)>
    "VOLTAGE": <Power in Volts>            
    "FREQUENCY": <Radio Frequency in Hz>
    "SWITCH_STATE": <Device State, 0 = off, 1 = on
}

Other devices will return other parameters which you can use. I have provided parameter name and type mapping for the known values for received messages.

A full parameter list can be found in C/src/achronite/openThings.c if required.

MiHome Heating Support

The MiHome Heating Thermostatic Radiator valve (eTRV), and Thermostat are supported

WARNING: Due to the way these devices work there may be a delay from when a command is sent to it being processed by the device. See Command Caching below

Command Caching

Battery powered energenie devices, such as the eTRV or Thermostat do not constantly listen for commands. For example, the eTRV reports its temperature at the SET_REPORTING_INTERVAL (default 5 minutes) after which the receiver is then activated to listen for commands. The receiver only remains active for 200ms or until a message is received.

To cater for these hardware limitations the openThingsReceiveThread and openThingsCacheCmd functions should be used. Any command sent using the CacheCmd function will be held until a report is received by the receive thread from the device; at this point the most recent cached message (only 1 is supported) will be sent to the device. Messages will continue to be resent until we know they have been succesfully received or until the number of retries has reached 0.

The reason that a command may be resent multiple times is due to reporting issues. The eTRV devices, unfortunately, do not send acknowledgement for every command type (indicated by a 'No' in the Response column in the above table). This includes the TEMP_SET command! So these commands are always resent for the full number of retries.

NOTE: The performance of node may decrease when a command is cached due to dynamic polling. The frequency that the radio device is polled by the monitor thread automatically increases by a factor of 200 when a command is cached (it goes from checking every 5 seconds to every 25 milliseconds) this dramatically increases the chance of a message being correctly received sooner.

eTRV Commands

The MiHome Thermostatic Radiator valve (eTRV) can accept commands to perform operations, provide diagnostics or perform self tests. The documented commands are provided in the table below.

Single commands should be sent using the openThingsCacheCmd function, using the command as the # numeric values. If there is no .data value, set it to 0.

| Command | # | Description | .data | Response Msg | |---|:---:|---|---|:---:| |CLEAR|0|Cancel current outstanding cached command for the device (set command & retries to 0)||All Msgs| |EXERCISE_VALVE|163|Send exercise valve command, recommended once a week to calibrate eTRV||DIAGNOSTICS| |SET_LOW_POWER_MODE|164|This is used to enhance battery life by limiting the hunting of the actuator, ie it limits small adjustments to degree of opening, when the room temperature is close to the TEMP_SET point. A consequence of the Low Power mode is that it may cause larger errors in controlling room temperature to the set temperature.|0=Off1=On|No*| |SET_VALVE_STATE|165|Set valve state|0=Open1=Closed2=Auto (default)|No| |REQUEST_DIAGNOTICS|166|Request diagnostic data from device, if all is OK it will return 0. Otherwise see additional monitored values for status messages||DIAGNOSTICS| |IDENTIFY|191|Identify the device by making the green light flash on the selected eTRV for 60 seconds||No| |SET_REPORTING_INTERVAL|210|Update reporting interval to requested value|300-3600 seconds|No| |REQUEST_VOLTAGE|226|Report current voltage of the batteries||VOLTAGE| |TARGET_TEMP|244|Send new target temperature for eTRV.NOTE: The VALVE_STATE must be set to 'Auto' for this to work.|float|No|

* Although this will not auto-report, a subsequent call to REQUEST_DIAGNOTICS will confirm the LOW_POWER_MODE setting

eTRV Monitor Messages

To support the MiHome Radiator Valve (MIHO013) aka 'eTRV' in v0.3 and above, additional code has been added to cache the monitor information for these devices. An example of the values is shown below, only 'known' values are returned when the eTRV regularly reports the TEMPERATURE. See table for types and determining when field was last updated:

{
    "deviceId":3989,
    "mfrId":4,
    "productId":3,
    "command":0,
    "retries":0,
    "timestamp":1567932119,
    "TEMPERATURE":19.7,
    "EXERCISE_VALVE":"success",
    "VALVE_TS":1567927343,
    "DIAGNOSTICS":512,
    "DIAGNOSTICS_TS":1567927343,
    "LOW_POWER_MODE":false,
    "TARGET_TEMP": 10,
    "VOLTAGE": 3.19,
    "VOLTAGE_TS": 1568036414,
    "ERRORS": true,
    "ERROR_TEXT": ...
}

|Parameter|Description|Data Type|Update time| |---|---|---|---| |command|Numeric value of current cached command being set to eTRV (0=none)|int|timestamp| |retries|The number of remaining retries for 'command' to be sent to the device|int|timestamp| |DIAGNOSTICS|Numeric diagnostic code, see "ERRORS" for interpretation|int|DIAGNOSTIC_TS| |DIAGNOSTICS_TS|timestamp of when diagnostics were last received|epoch|DIAGNOSTIC_TS| |ERRORS|true if an error condition has been detected|boolean|DIAGNOSTIC_TS| |ERROR_TEXT|error information|string|DIAGNOSTIC_TS| |EXERCISE_VALVE|The result of the EXERCISE_VALVE command| success or fail|DIAGNOSTIC_TS| |LOW_POWER_MODE|eTRV is in low power mode state>|boolean|DIAGNOSTIC_TS| |TARGET_TEMP|Target temperature in celcius|float|| |TEMPERATURE|The current temperature in celcius|float|timestamp| |VALVE_STATE|Current valve mode/state| open, closed, auto, error|VALVE_STATE command or DIAGNOSTIC_TS on error| |VALVE_TS|timestamp of when last EXERCISE_VALVE took place|epoch|DIAGNOSTIC_TS| |VOLTAGE|Current battery voltage|float|VOLTAGE_TS| |VOLTAGE_TS|Tmestamp of when battery voltage was last received|epoch|VOLTAGE_TS|

Thermostat commands (new in v0.7.0)

| Command | # | Description | .data | |---|:---:|---|---| |CLEAR|0|Cancel current outstanding cached command for the device (set command & retries to 0)|| |TARGET_TEMP|244|Set new target temperature for thermostat between 5 and 30 C in 0.5 increments|float| |THERMOSTAT_MODE|170|Set operating mode for thermostat, where0=Off, 1=Auto, 2=On|0,1,2| |HYSTERISIS|254|The difference between the current temperature and target temperature before the thermostat triggers|0.5-10| |RELAY_POLARITY|171|Polarity of the boiler relay|0=Normally Open,1=Normally Closed| |TEMP_OFFSET|189|Temperature Calibration|-20.0 to 20.0| |HUMID_OFFSET|186|Humidity Calibration|-20 to 20|

In order for the Thermostat to provide updates for it's telemetry data without an MiHome gateway, auto messaging has been enabled within this module. To start this auto-messaging you will need to have a monitor thread running and then subsequently send a THERMOSTAT_MODE command to the application. Each result of a THERMOSTAT_MODE value will be stored (until a restart) and will be used to prompt the thermostat into providing it's telemetry data. As the result is used, pressing the buttons on the thermostat should still work and be reflected as the thermostat will ignore the same command values after a button has been pressed.

NOTE: If you are controlling/setting the Thermostat using a MiHome gateway/app you should NOT issue commands via this module as the commands could clash/override each other.

A different mechanism of reporting processed commands has also been implemented for the thermostat in v0.7. When (and only when) the thermostat procesess a command it outputs it's telemetry data. This mechanism has been used to assume that the command just sent to the device (upon WAKEUP) has been processed succesfully so the command and it's data value are added to the resulting telemetry message.

Module Build Instructions

run 'node-gyp rebuild' in this directory to rebuild the node module.

Change History

See CHANGELOG.md

Built With

• NodeJS - JavaScript runtime built on Chrome's V8 JavaScript engine.
• N-API - Used to wrap C code as a native node.js Addon. N-API is maintained as part of Node.js itself, and produces Application Binary Interface (ABI) stable across all versions of Node.js.

Authors

• Achronite - Node wrappers, javascript and additional C code for specific devices, monitoring and locking - Achronite
• David Whale - Radio C library and python implementation - whaleygeek
• Energenie - Original C code base - Energenie

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Bugs and Future Work

Future work is detailed on the github issues page. Please raise any bugs, questions, queries or enhancements you have using this page.

https://github.com/Achronite/energenie-ener314rt/issues

@Achronite - February 2024