MQTT node.js application to control the Energenie line of products via the ENER314-RT add-on board for the Raspberry Pi.
The primary reason this application has been built is to allow integration with Home Assistant etc. via MQTT messaging.
I am still actively developing this node.js application.
There are currently lots of DEBUGs in the code and it has yet to be npm or github packaged for release, but the basic code is working as intended and I welcome any testers. Please provide any feedback in issues
You can use this node.js application to control and monitor the Energenie MiHome radio based smart devices such as adapters, sockets, lights, thermostats and relays using MQTT messages 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.
There is also a node-red implementation by the same author node-red-contrib-energenie-ener314rt, for native integration with node-red.
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.
-
Plug in your ENER314-RT-VER01 board from Energenie onto the 26 pin or 40 pin connector of your Raspberry Pi.
-
Ensure that the Raspberry Pi is up to date, and has node.js v10+ or above installed. For example:
sudo apt update
sudo apt upgrade -y
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - // latest long term supported release
sudo apt install -y nodejs npm
- Install the dependant node modules 'mqtt' and 'energenie-ener314rt'
cd mqtt-energenie-ener314rt
npm install mqtt --save
npm install energenie-ener314rt --save
- Create/edit
config.jsonfile in the same directory as the install. It should contain the following entities:
{
"topic_stub": "energenie/",
"mqtt_broker": "mqtt://pi3.local",
"mqtt_options": {
"clientId": "node-ener314rt",
"username":"node-ener314rt",
"clean": true
},
"monitoring": true
}
topic_stubshould contain the base topic where your energenie messages should reside on mqtt, the default value should suit most installations.mqtt_brokershould contain your MQTT broker address and protocol.- Modify the
mqtt_optionssection with your MQTT client options, such as username, password, certificate etc. - If you have any energenie 'Control & Monitor' or 'Monitor' devices then set
"monitoring": trueotherwise remove or set false.
- Run the application manually using the command:
node app.js
Execute the following commands:
sudo ln -s /home/pi/mqtt-energenie-ener314rt/mqtt-energenie-ener314rt.service /lib/systemd/system/
sudo systemctl daemon-reload
sudo systemctl start mqtt-energenie-ener314rt
sudo systemctl enable mqtt-energenie-ener314rt
To view the logs output from the application, use the following command:
journalctl -u mqtt-energenie-ener314rt.service
These nodes are designed for energenie RF radio devices in the OOK & FSK (OpenThings) ranges.
Here is a table showing the Device Topic and if control and monitoring is supoported for each device:
| Device | Description | Device Topic | Control | Monitoring | Supported |
|---|---|---|---|---|---|
| ENER002 | Green Button Adapter | ook | Yes | No | Yes |
| ENER010 | MiHome 4 gang Multiplug | ook | Yes | No | Yes |
| MIHO002 | MiHome Smart Plug (Blue) | ook | Yes | No | Yes |
| MIHO004 | MiHome Smart Monitor Plug (Pink) | 1 | No | Yes | Yes |
| MIHO005 | MiHome Smart Plug+ (Purple) | 2 | Yes | Yes | Yes |
| MIHO006 | MiHome House Monitor | 5 | No | Yes | Yes |
| MIHO007 | MiHome Socket (White) | ook | Yes | No | Yes |
| MIHO008 | MiHome Light Switch (White) | ook | Yes | No | Yes |
| MIHO009 | MiHome 2 gang Light Switch (White) | ook | Yes | No | Yes |
| MIHO010 | MiHome Dimmer Switch (White) | ook | Yes | No | soon |
| MIHO013 | MiHome Radiator Valve | 3 | Cached | Yes | soon |
| MIHO014 | Single Pole Relay (inline) | ook | Yes | No | Yes |
| MIHO015 | MiHome Relay | ook | Yes | No | Yes |
| MIHO021 | MiHome Socket (Nickel) | ook | Yes | No | Yes |
| MIHO022 | MiHome Socket (Chrome) | ook | Yes | No | Yes |
| MIHO023 | MiHome Socket (Steel) | ook | Yes | No | Yes |
| MIHO024 | MiHome Light Switch (Nickel) | ook | Yes | No | Yes |
| MIHO025 | MiHome Light Switch (Chrome) | ook | Yes | No | Yes |
| MIHO026 | MiHome Light Switch (Steel) | ook | Yes | No | Yes |
| MIHO032 | MiHome Motion sensor | 12 | No | Yes | Yes |
| MIHO033 | MiHome Open Sensor | 13 | No | Yes | Yes |
| MIHO069 | MiHome Heating Thermostat | 18 | Cached | Yes | No |
| MIHO089 | MiHome Click - Smart Button | ? | No | Yes |
The commands and monitor messages are sent/received using MQTT topics. The topic design is loosely based on that used for esphome devices, and parameter names generally align to the OpenThings parameter standard.
The following table shows some examples of the topics used:
| device | example topic stem | command topic | state topic(s) | valid values |
|---|---|---|---|---|
| Control only | energenie/ook/zone/switchNum | stem/command | stem/state | ON,OFF |
| MIHO004 | energenie/1/deviceNum | - | stem/REAL_POWER/state stem/REACTIVE_POWER/state stem/VOLTAGE/state stem/FREQUENCY/state |
Number Number Number Float |
| MIHO005 | energenie/2/deviceNum | stem/switch/command | stem/switch/state stem/REAL_POWER/state stem/REACTIVE_POWER/state stem/VOLTAGE/state stem/FREQUENCY/state |
ON,OFF Number Number Number Float |
| MIHO006 | energenie/5/deviceNum | - | stem/APPARENT_POWER/state stem/VOLTAGE/state stem/CURRENT/state |
Number Float Float |
| MIHO032 | energenie/12/deviceNum | - | stem/motion/state | ON,OFF |
| MIHO033 | energenie/13/deviceNum | - | stem/contact/state | ON,OFF |
For example the 'Smart Plug+' populates the following topics in MQTT:
"switch/state": <ON/OFF value received from plug>
"REAL_POWER/state": <power in Watts being consumed>
"REACTIVE_POWER/state": <Power in volt-ampere reactive (VAR)>
"VOLTAGE/state": <Power in Volts>
"FREQUENCY/state": <Radio Frequency in Hz>
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 to MQTT topics, please use an MQTT explorer to find ones to use.
A full parameter list can be found in C/src/achronite/openThings.c if required.
Enable the MQTT Integration in Home Assistant (if not already enabled).
Edit your Home Assistant configuration.yaml file for the switches and reported values as applicable. For example:
mqtt:
switch:
- unique_id: coffee_machine
name: "Coffee Machine"
command_topic: energenie/2/8294/switch/command
optimistic: false
state_topic: energenie/2/8294/switch/state
light:
- unique_id: test_light
name: "Test MQTT Light"
command_topic: energenie/ook/87/1/command
optimistic: false
state_topic: energenie/ook/87/1/state
- unique_id: tree_lights
name: "Christmas Tree lights"
command_topic: energenie/ook/88/2/command
optimistic: false
state_topic: energenie/ook/88/2/state
binary_sensor:
- unique_id: Hallway_PIR
name: "Hallway PIR"
state_topic: energenie/12/5937/motion/state
device_class: motion
- unique_id: Front_Door
name: "Front Door"
state_topic: energenie/13/8888/contact/state
device_class: door
sensor:
- name: "Coffee Machine Reactive Power"
state_topic: energenie/2/8294/REACTIVE_POWER/state
device_class: reactive_power
unit_of_measurement: "VAR"
- name: "Coffee Machine Radio Frequency"
state_topic: energenie/2/8294/FREQUENCY/state
device_class: frequency
unit_of_measurement: "Hz"
- name: "Coffee Machine Real Power"
state_topic: energenie/2/8294/REAL_POWER/state
device_class: power
unit_of_measurement: "W"
- name: "Coffee Machine Voltage"
state_topic: energenie/2/8294/VOLTAGE/state
device_class: voltage
unit_of_measurement: "V"
NOTE: If you have an 'Control' (Blue) devices these will need to be added manually by teaching the device code (see below)
TIP: You can use an MQTT explorer to show the auto-discovered OpenThings 'Monitor' devices reported values.
The control only devices (any listed in the above table as Device Topic 'ook' or with a Blue icon on the energenie boxes) need to be taught a zone and switch code.
- Add an mqtt entry in
configuration.yamlfor your switch or light. These should uniquely reference your device (following the OOK zone rules below). For example to teach an ENER002 socket to be Zone 567 switch 1 enter the following:
mqtt:
switch:
- name: "My Switch"
command_topic: energenie/ook/567/1/switch/command
optimistic: false
state_topic: energenie/ook/567/1/switch/state
- Refresh the MQTT configuration in Home Assistant
- Hold the button on your device until it starts to flash (holding longer clears the learnt codes).
- Click the power on button on the dashboard for your device. This will send an MQTT message to this application, which will send a power-on request for the zone/switch combination set in the command topic.
- The device should learn the zone code being sent by the power-on request, the light should stop flashing when successful.
- All subsequent calls using the same zone/switch number will cause your device to switch.
- 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 separate 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).
See CHANGELOG.md
- NodeJS - JavaScript runtime built on Chrome's V8 JavaScript engine.
- energenie-ener314rt - Dependant node.js module that performs all energenie functions
- mqtt - javascript implementation of MQTT protocol
- Achronite - MQTT implementation and dependant Node module - Achronite
This project is licensed under the MIT License - see the LICENSE.md file for details
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/mqtt-energenie-ener314rt/issues
@Achronite - January 2023 - v0.1.0 Alpha