everblu-meters - Water usage data for Home Assistant
Fetch water/gas usage data from Cyble EverBlu meters using RADIAN protocol on 433Mhz. Intergrated with Home Assistant via MQTT.
Note: HASS autodiscovery is working.
Meters supported:
- Itron EverBlu Cyble Enhanced
Hardware
The project runs on ESP8266/ESP32 with an RF transreciver (CC1101).
Connections (ESP32/ESP8266 to CC1101):
- See
cc1101.ccpfor SPI pins mapping. - See
everblu_meters.hfor GDOx pins mapping.
Pins wiring for Wemos D1 board :
| CC1101 | Wemos |
|---|---|
| VCC | 3V3 |
| GOD0 (GDO0) | D1 |
| CSN (SPI chip select) | D8 |
| SCK (SPI clock) | D5 |
| MOSI (SPI MOSI) | D7 |
| GOD1 (SPI MISO) | D6 |
| GOD2 (GDO2) | D2 |
| GND (ground) | G |
Configuration
- Install EspMQTTClient through Arduino library manager as it required for MQTT
- Update WiFi and MQTT details in everblu-meters-esp8266.ino, if you do not use username and password for MQTT then comment those out with //
- Set meter serial number (without the leading 0) and production year in
everblu_meters.h(at the end of the file), it can be found on the meter label itself:
- Flash the sketch to your ESP device
- After a few second your meter data should be on the screen (serial console) and data should be pushed to MQTT.
- The device will query the meter once a day, every 24 hours and retry every hour if query failed.
Troubleshooting
Frequency adjustment
Your transreciver module may be not calibrated correctly, please modify frequency a bit lower or higher and try again. You may use RTL-SDR to measure the offset needed.
You can uncomment the part of the code in the everblu-meters-esp8266.ino file that scans all the frequencies around the meter frequency to find the correct one.
Business hours
Your meter may be configured in such a way that is listens for request only during hours when data collectors work - to conserve energy. If you are unable to communicate with the meter, please try again during business hours (8:00-16:00), Monday to Friday. As a rule of thumb, please try to set up your device only during business hours, then you can avoid confusion and asking questions why is it not working!
Serial number starting with 0
Please ignore the leading 0, provide serial in configuration without it.
Origin and license
This code is based on code from http://www.lamaisonsimon.fr/wiki/doku.php?id=maison2:compteur_d_eau:compteur_d_eau
The license is unknown, citing one of the authors (fred):
I didn't put a license on this code maybe I should, I didn't know much about it in terms of licensing. this code was made by "looking" at the radian protocol which is said to be open source earlier in the page, I don't know if that helps?