README
¶
e3dc-mqtt-go
A Go application that bridges E3DC solar battery storage systems to MQTT, enabling integration with home automation systems.
Features
- Real-time power values (PV, battery, grid, home consumption)
- Battery state of charge and detailed status
- Daily statistics (production, consumption, autarky)
- Unix socket support for MQTT connections
- Aligned polling intervals (ticks at clock boundaries)
- Delta-based publishing (only changed values are sent)
Requirements
- Go 1.24.0
- E3DC system with RSCP interface enabled
- MQTT broker (Mosquitto, etc.)
Installation
go build -o e3dc-mqtt
For optimized production builds:
CGO_ENABLED=0 go build -ldflags="-s -w" -o e3dc-mqtt
Configuration
Create a config.toml file:
log_level = "INFO" # DEBUG, INFO, WARN, ERROR
[e3dc]
host = "192.168.1.100"
port = 5033 # default
username = "your_username"
password = "your_password"
key = "your_rscp_key"
interval = "5s" # polling interval (min 5s)
statistic_update_interval = "5m" # daily statistics update
[mqtt]
url = "tcp://localhost:1883" # or "unix:///var/run/mosquitto.sock"
root = "e3dc" # topic prefix
client_id = "e3dc-mqtt-go" # default
username = "" # optional
password = "" # optional
Unix Socket Support
For local MQTT connections via Unix socket:
[mqtt]
url = "unix:///var/run/mosquitto.sock"
Running
./e3dc-mqtt -config config.toml
The application follows a "let it crash" philosophy - on errors, it exits with a specific code and should be restarted by a supervisor (systemd, runit, Docker, etc.).
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Clean shutdown |
| 1 | Configuration error |
| 4 | E3DC connection error |
| 5 | MQTT connection error |
| 6 | GetSystemInfo error |
| 7 | PublishJSON (info) error |
| 10 | publishStatus error |
| 11 | publishDailyStatistics error |
| 12 | publishBatteryData error |
Systemd Service
[Unit]
Description=E3DC MQTT Bridge
After=network.target
[Service]
Type=simple
ExecStart=/path/to/e3dc-mqtt -config /etc/e3dc-mqtt/config.toml
Restart=always
RestartSec=10
[Install]
WantedBy=multi-user.target
Runit Service
Create /etc/sv/e3dc-mqtt/run:
#!/bin/sh
exec /path/to/e3dc-mqtt -config /etc/e3dc-mqtt/config.toml 2>&1
MQTT Topics
All topics follow the pattern {root}/{model}-{serial}/... (e.g., e3dc/S10E-491929004774/...).
Online Status
online- Connection status (true/false, retained, with LWT)
Status (updated at interval)
status/time- Timestamp (RFC3339)status/solar_production- PV production (W)status/house_consumption- Home consumption (W)status/battery_consumption- Battery power (W, positive=charging)status/battery_charge- Battery charging power (W)status/battery_discharge- Battery discharging power (W)status/grid_production- Grid power (W, positive=export)status/consumption_from_grid- Grid import (W)status/export_to_grid- Grid export (W)status/state_of_charge- Battery SoC (%)status/autarky- Current autarky (%)status/self_consumption- Current self-consumption (%)status/wb_consumption- Wallbox power (W)status/additional- Additional sources (W)status/solar_production_excess- PV excess (W)
Daily Statistics (updated at statistic_update_interval)
status_sums/time- Timestampstatus_sums/start- Day start timestampstatus_sums/timespan- Elapsed time (ISO 8601 duration)status_sums/solar_production_today- Daily PV production (Wh)status_sums/house_consumption_today- Daily consumption (Wh)status_sums/battery_charge_today- Daily battery charge (Wh)status_sums/battery_discharge_today- Daily battery discharge (Wh)status_sums/consumption_from_grid_today- Daily grid import (Wh)status_sums/export_to_grid_today- Daily grid export (Wh)status_sums/autarky_today- Daily autarky (%)status_sums/self_consumption_today- Daily self-consumption (%)status_sums/state_of_charge_today- Current SoC (%)
Battery Details
Per battery: status/battery:{index}/...
time,asoc,charge_cycles,current,dcb_countdesign_capacity,device_name,eod_voltage,error_code,fccindex,max_battery_voltage,max_charge_current,max_discharge_currentmax_dcb_cell_temp,min_dcb_cell_temp,module_voltage,rcready_for_shutdown,rsoc,rsoc_real,status_codeterminal_voltage,total_use_time,total_discharge_timetraining_mode,usable_capacity,usable_remaining_capacity
Per DCB: status/battery:{bat}/dcb:{dcb}/...
current,current_avg_30s,cycle_count,design_capacitydesign_voltage,device_name,end_of_discharge,errorfull_charge_capacity,fw_version,manufacture_date,manufacture_namemax_charge_current,max_charge_temperature,max_charge_voltagemax_discharge_current,min_charge_temperatureparallel_cell_count,sensor_count,series_cell_countpcb_version,protocol_version,remaining_capacityserial_no,serial_code,soc,soh,statustemperatures(JSON array),voltage,voltage_avg_30svoltages(JSON array),warning
License
MIT
Documentation
¶
There is no documentation for this package.
Click to show internal directories.
Click to hide internal directories.