07 · Intégrations DIY
Comment alimenter les lectures de rbamp dans les systèmes d'automatisation auto-hébergés courants. Pour chaque plateforme, il existe un projet ESP-IDF minimal fonctionnel ainsi que la configuration correspondante côté plateforme.
Intégrations cloud / commerciales (AWS IoT, Azure, GCP, InfluxDB Cloud) — 08 · Intégrations cloud.
| Plateforme | Transport | Découverte automatique | Composants IDF |
|---|---|---|---|
| Home Assistant | MQTT | oui (découverte MQTT HA) | espressif/esp_mqtt_client |
| ESPHome | API native + MQTT | oui (configuration YAML) | (cadre alternatif — voir ci-dessous) |
| Node-RED | MQTT (ou HTTP) | flux manuel | espressif/esp_mqtt_client |
| OpenHAB | MQTT (ou REST) | .things manuel |
espressif/esp_mqtt_client |
| Domoticz | MQTT (auto) ou HTTP | oui (extension MQTT) | esp_mqtt_client ou esp_http_client |
| InfluxDB OSS + Grafana | Protocole de ligne HTTPS | non | esp_http_client |
Des projets prêts à l'emploi pour les deux scénarios principaux se trouvent dans examples/ : examples/mqtt_publisher/ (publieur MQTT par canal) et examples/ha_discovery/ (découverte automatique HA au-dessus de mqtt_publisher).
Home Assistant — découverte automatique MQTT
La découverte MQTT de HA crée automatiquement l'appareil et ses capteurs lorsque l'ESP32 publie les sujets de configuration. Aucune modification YAML dans HA n'est nécessaire.
Projet ESP-IDF (rbamp + WiFi STA + esp_mqtt_client)
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "driver/i2c_master.h"
#include "esp_event.h"
#include "esp_log.h"
#include "esp_wifi.h"
#include "mqtt_client.h"
#include "nvs_flash.h"
#include "rbamp.h"
#define DEVICE_ID "rbamp_main"
#define DEVICE_NAME "Mains rbAmp"
#define MQTT_URI "mqtt://192.168.1.10:1883"
static const char *TAG = "ha_discovery";
static esp_mqtt_client_handle_t mqtt;
static void publish_discovery_sensor(const char *key, const char *friendly,
const char *unit, const char *device_class,
const char *state_class) {
char topic[128], payload[512];
snprintf(topic, sizeof(topic),
"homeassistant/sensor/%s/%s/config", DEVICE_ID, key);
int n = snprintf(payload, sizeof(payload),
"{"
"\"name\":\"%s %s\","
"\"unique_id\":\"%s_%s\","
"\"state_topic\":\"rbamp/%s/state\","
"\"value_template\":\"{{ value_json.%s }}\","
"\"state_class\":\"%s\","
"\"device\":{"
"\"identifiers\":[\"%s\"],"
"\"name\":\"%s\","
"\"manufacturer\":\"rbAmp\","
"\"model\":\"UI*\""
"}",
DEVICE_NAME, friendly,
DEVICE_ID, key,
DEVICE_ID, key, state_class,
DEVICE_ID, DEVICE_NAME);
if (unit) n += snprintf(payload+n, sizeof(payload)-n,
",\"unit_of_measurement\":\"%s\"", unit);
if (device_class) n += snprintf(payload+n, sizeof(payload)-n,
",\"device_class\":\"%s\"", device_class);
snprintf(payload+n, sizeof(payload)-n, "}");
esp_mqtt_client_publish(mqtt, topic, payload, 0, /*qos*/1, /*retain*/1);
}
static void publish_discovery_all(void) {
publish_discovery_sensor("voltage", "Voltage", "V", "voltage", "measurement");
publish_discovery_sensor("current", "Current", "A", "current", "measurement");
publish_discovery_sensor("power", "Power", "W", "power", "measurement");
publish_discovery_sensor("energy", "Energy", "Wh", "energy", "total_increasing");
publish_discovery_sensor("frequency", "Frequency", "Hz", "frequency", "measurement");
publish_discovery_sensor("power_factor", "Power Factor", NULL, "power_factor", "measurement");
}
static void mqtt_event_handler(void *handler_args, esp_event_base_t base,
int32_t event_id, void *event_data) {
if (event_id == MQTT_EVENT_CONNECTED) {
publish_discovery_all(); /* publish discovery on every connect */
}
}
void app_main(void) {
/* ...nvs_flash_init + esp_netif_init + esp_event_loop_create_default +
* esp_wifi_init/start + wait for IP_EVENT_STA_GOT_IP... */
/* (pattern from 10 · Troubleshooting, "Watchdog timeout during WiFi") */
/* I²C bus + rbAmp handle */
i2c_master_bus_handle_t bus = NULL;
/* ...i2c_new_master_bus(...)... */
rbamp_handle_t dev = NULL;
ESP_ERROR_CHECK(rbamp_new(bus, 0x50, &dev)); /* new — never fails
* with valid arguments */
/* rbamp_begin may return NACK / VERSION on bus chatter or a cold
* boot of the module. A soft retry is better than an ESP_ERROR_CHECK
* abort — in production the network stack must survive a temporary
* loss of the slave. */
while (rbamp_begin(dev) != ESP_OK) {
ESP_LOGE(TAG, "rbamp_begin: %s — retry in 1 s",
rbamp_err_to_str(rbamp_last_error(dev)));
vTaskDelay(pdMS_TO_TICKS(1000));
}
/* set_sensor_class + set_ct_model — both block ~700 ms
* (flash write). set_sensor_class is a mandatory prerequisite
* for set_ct_model. Log failures, but do not abort. */
esp_err_t err;
if ((err = rbamp_set_sensor_class(dev, RBAMP_SENSOR_SCT013)) != ESP_OK) {
ESP_LOGE(TAG, "set_sensor_class: %s", rbamp_err_to_str(err));
}
if ((err = rbamp_set_ct_model(dev, 3)) != ESP_OK) {
ESP_LOGE(TAG, "set_ct_model: %s", rbamp_err_to_str(err));
}
/* MQTT client */
const esp_mqtt_client_config_t mqtt_cfg = {
.broker.address.uri = MQTT_URI,
.credentials.client_id = DEVICE_ID,
.session.keepalive = 60,
.buffer.size = 1024, /* room for one discovery payload */
};
mqtt = esp_mqtt_client_init(&mqtt_cfg);
esp_mqtt_client_register_event(mqtt, MQTT_EVENT_CONNECTED,
mqtt_event_handler, NULL);
esp_mqtt_client_start(mqtt);
/* State-publish loop — once a minute */
while (1) {
vTaskDelay(pdMS_TO_TICKS(60000));
rbamp_period_snapshot_t snap;
if (rbamp_read_period_snapshot(dev, &snap, 50, false) != ESP_OK ||
!snap.valid) continue;
float u, i, pf, freq;
rbamp_read_voltage(dev, 0, &u);
rbamp_read_current(dev, 0, &i);
rbamp_read_power_factor(dev, 0, &pf);
rbamp_read_frequency(dev, &freq);
char state[384];
snprintf(state, sizeof(state),
"{\"voltage\":%.1f,\"current\":%.3f,\"power\":%.1f,"
"\"energy\":%.3f,\"frequency\":%.1f,\"power_factor\":%.3f}",
(double)u, (double)i, (double)snap.avg_p[0],
rbamp_energy_wh(dev, 0), (double)freq, (double)pf);
char topic[64];
snprintf(topic, sizeof(topic), "rbamp/%s/state", DEVICE_ID);
esp_mqtt_client_publish(mqtt, topic, state, 0, /*qos*/0, /*retain*/0);
}
}
Projet complet — examples/ha_discovery/.
Résultat dans HA
Quelques secondes après la première publication, HA crée automatiquement l'appareil « Mains rbAmp » avec 6 capteurs (Tension, Courant, Puissance, Énergie, Fréquence, Facteur de puissance). Le capteur Énergie a state_class: total_increasing et le device_class correct — le tableau de bord Énergie de HA l'accepte comme source de consommation.
Pour retirer plus tard l'appareil de HA, publiez une charge utile vide sur homeassistant/sensor/.../config (l'indicateur retained efface l'entrée).
UI3 multi-canaux
Répétez les appels publish_discovery_sensor() avec des clés suffixées pour les canaux 1 et 2 :
publish_discovery_sensor("current_1", "Current 1", "A", "current", "measurement");
publish_discovery_sensor("power_1", "Power 1", "W", "power", "measurement");
publish_discovery_sensor("energy_1", "Energy 1", "Wh", "energy", "total_increasing");
/* ...same for _2 */
Et étendez le JSON d'état avec les champs "current_1", "power_1", "energy_1", renseignés depuis rbamp_read_current(dev, 1, &i) / snap.avg_p[1] / rbamp_energy_wh(dev, 1).
ESPHome — alternative via external_components
Si vous utilisez ESPHome (plutôt qu'ESP-IDF nu), il existe un composant externe rbamp dédié qui remplace entièrement ce composant et gère sa propre intégration HA via l'API native d'ESPHome :
external_components:
- source: github://rb-amp/rbamp-esphome
components: [rbamp]
refresh: 0s
i2c:
sda: 21
scl: 22
frequency: 50kHz # see 10 · Troubleshooting on baseline mitigation
sensor:
- platform: rbamp
address: 0x50
update_interval: 60s
voltage:
name: "rbAmp Voltage"
current:
name: "rbAmp Current"
power:
name: "rbAmp Power"
energy:
name: "rbAmp Energy"
frequency:
name: "rbAmp Frequency"
power_factor:
name: "rbAmp Power Factor"
ESPHome s'intègre nativement à HA via l'API ESPHome (et non MQTT) — l'appareil apparaît automatiquement dans HA une fois flashé.
Le composant rbamp-esphome réside dans un dépôt séparé — voir l'index principal rbAmp pour les liens. Utilisez ESPHome à la place de ce composant ; mélanger ESPHome et ESP-IDF nu dans le même projet n'en vaut généralement pas la peine.
Node-RED
Abonnez-vous au sujet MQTT de l'ESP32 dans un flux :
[
{
"id": "rbamp_in",
"type": "mqtt in",
"topic": "rbamp/main/state",
"qos": "0",
"datatype": "json"
},
{
"id": "rbamp_chart",
"type": "ui_chart",
"label": "Mains Power",
"chartType": "line",
"ymin": "0",
"ymax": "5000"
},
{
"id": "extract_power",
"type": "function",
"func": "msg.payload = msg.payload.power; return msg;"
}
]
Reliez rbamp_in → extract_power → rbamp_chart et vous obtenez un graphique de puissance en temps réel. Faites de même pour l'énergie / la tension / le FP.
Si Node-RED fonctionne sur le même Pi que le broker MQTT, utilisez l'hôte localhost. Pour des brokers distants, utilisez 192.168.X.Y:1883, plus des identifiants si le broker exige une authentification.
Le côté ESP32 est le même croquis que dans la section Home Assistant ci-dessus ; la charge utile JSON est partagée — seul le consommateur diffère.
OpenHAB
OpenHAB 4.x + liaison MQTT :
# things/rbamp.things
Bridge mqtt:broker:local "MQTT Broker" [ host="192.168.1.10", port=1883 ] {
Thing topic rbamp_main "rbAmp Main" {
Channels:
Type number : voltage "Voltage" [ stateTopic="rbamp/main/state", transformationPattern="JSONPATH:$.voltage" ]
Type number : current "Current" [ stateTopic="rbamp/main/state", transformationPattern="JSONPATH:$.current" ]
Type number : power "Power" [ stateTopic="rbamp/main/state", transformationPattern="JSONPATH:$.power" ]
Type number : energy "Energy" [ stateTopic="rbamp/main/state", transformationPattern="JSONPATH:$.energy" ]
}
}
# items/rbamp.items
Number:ElectricPotential rbAmp_Voltage "Voltage [%.1f V]" { channel="mqtt:topic:local:rbamp_main:voltage" }
Number:ElectricCurrent rbAmp_Current "Current [%.3f A]" { channel="mqtt:topic:local:rbamp_main:current" }
Number:Power rbAmp_Power "Power [%.1f W]" { channel="mqtt:topic:local:rbamp_main:power" }
Number:Energy rbAmp_Energy "Energy [%.3f Wh]" { channel="mqtt:topic:local:rbamp_main:energy" }
Le côté ESP32 est le même projet que dans la section Home Assistant ci-dessus. La charge utile JSON est partagée — seul le consommateur diffère.
Domoticz
Le plugin de découverte automatique MQTT de Domoticz comprend les mêmes sujets de découverte homeassistant/.... Activez le plugin dans les paramètres de Domoticz et le projet ESP32 de la section HA ci-dessus enregistrera automatiquement l'appareil dans Domoticz, comme il le fait dans HA.
Une alternative est l'API HTTP native de Domoticz via esp_http_client :
#include "esp_http_client.h"
#include "esp_log.h"
static const char *TAG = "domoticz";
static void publish_to_domoticz(int idx, float power, double e_wh) {
char url[256];
/* Energy in Wh, Power in W — Domoticz format: "POWER;ENERGY_WH" */
snprintf(url, sizeof(url),
"http://192.168.1.20:8080/json.htm?type=command¶m=udevice"
"&idx=%d&svalue=%.1f;%.0f", idx, (double)power, e_wh);
esp_http_client_config_t cfg = {
.url = url,
.method = HTTP_METHOD_GET,
.timeout_ms = 5000,
};
esp_http_client_handle_t client = esp_http_client_init(&cfg);
esp_err_t err = esp_http_client_perform(client);
int status = esp_http_client_get_status_code(client);
esp_http_client_cleanup(client);
if (err != ESP_OK || status != 200) {
ESP_LOGW(TAG, "domoticz HTTP %d (err %s)", status, esp_err_to_name(err));
}
}
/* In the 60-second loop: */
publish_to_domoticz(123 /* your idx */, snap.avg_p[0], rbamp_energy_wh(dev, 0));
Créez un périphérique dans l'interface Domoticz de type General → kWh (compteur incrémental), récupérez son idx et codez-le en dur dans le projet.
InfluxDB OSS + Grafana
Écrivez des points au format line-protocol dans InfluxDB directement depuis l'ESP32 via esp_http_client :
#include "esp_http_client.h"
#include "esp_log.h"
#define INFLUX_HOST "192.168.1.30:8086"
#define INFLUX_ORG "homelab"
#define INFLUX_BKT "energy"
#define INFLUX_TOKEN "your-token-here"
static const char *TAG = "influx";
static void push_influx(float u, float p, double e_wh) {
char url[256], body[256];
snprintf(url, sizeof(url),
"http://" INFLUX_HOST "/api/v2/write?org=%s&bucket=%s&precision=s",
INFLUX_ORG, INFLUX_BKT);
snprintf(body, sizeof(body),
"rbamp,device=main voltage=%.1f,power=%.1f,energy=%.3f",
(double)u, (double)p, e_wh);
esp_http_client_config_t cfg = {
.url = url,
.method = HTTP_METHOD_POST,
.timeout_ms = 5000,
};
esp_http_client_handle_t client = esp_http_client_init(&cfg);
esp_http_client_set_header(client, "Authorization", "Token " INFLUX_TOKEN);
esp_http_client_set_header(client, "Content-Type", "text/plain");
esp_http_client_set_post_field(client, body, strlen(body));
esp_err_t err = esp_http_client_perform(client);
int status = esp_http_client_get_status_code(client);
esp_http_client_cleanup(client);
if (err != ESP_OK || status != 204) {
ESP_LOGW(TAG, "influx HTTP %d (err %s)", status, esp_err_to_name(err));
}
}
/* In the 60-second loop: */
rbamp_period_snapshot_t snap;
if (rbamp_read_period_snapshot(dev, &snap, 50, false) == ESP_OK && snap.valid) {
float u;
rbamp_read_voltage(dev, 0, &u);
push_influx(u, snap.avg_p[0], rbamp_energy_wh(dev, 0));
}
Dans Grafana, ajoutez une source de données InfluxDB, puis un panneau avec une requête Flux :
from(bucket: "energy")
|> range(start: -24h)
|> filter(fn: (r) => r._measurement == "rbamp" and r.device == "main")
|> filter(fn: (r) => r._field == "power")
Pour un déploiement d'endurance de longue durée, poussez en plus une charge utile de diagnostic vers une mesure distincte portant le niveau de tas (via esp_get_free_heap_size()) et les compteurs d'instantanés de période réussis / échoués — cela permet de suivre la santé du bus et du Wi-Fi sur le même graphique que les données d'énergie :
snprintf(body, sizeof(body),
"rbamp_diag,device=main heap_free=%u,snap_ok=%lu,snap_fail=%lu",
(unsigned)esp_get_free_heap_size(),
(unsigned long)snap_ok_count,
(unsigned long)snap_fail_count);
/* ...push to InfluxDB... */
: les compteurs internes de reprise et de cohérence du composant ne sont pas exposés dans l'API publique (voir 10 · Dépannage, « On retry/sanity counters »). Comptez vous-même snap_ok_count / snap_fail_count côté application à partir des valeurs renvoyées par rbamp_read_period_snapshot().
Multi-plateformes — diffusion depuis un seul ESP32
Si vous avez besoin à la fois de la découverte automatique HA, d'InfluxDB et de Node-RED, publiez le JSON d'état une fois sur MQTT et laissez chaque consommateur s'abonner à rbamp/+/state. L'ESP32 ne parle qu'au broker MQTT — c'est le broker qui diffuse aux abonnés. Ne poussez pas depuis l'ESP32 vers N points de terminaison HTTP directement : cela couple l'appareil à des consommateurs précis.
Pour un flux à très haute cadence (10 Hz RT), exécutez un script Python auxiliaire sur le Pi à côté du broker — abonnez-vous au sujet rapide, réduisez la cadence et republiez vers les sujets lents. La boucle I²C de l'ESP32 (une tâche FreeRTOS avec des appels rbamp_read_*()) doit rester ciblée, sans surcharge HTTP.
Liens
-
06 · Exemples — les projets de base sur lesquels reposent ces intégrations (dont
mqtt_publisheretha_discovery) -
08 · Intégrations cloud — AWS IoT / Azure / GCP / InfluxDB Cloud / webhook générique
-
10 · Dépannage — motifs pour la déconnexion MQTT, le gestionnaire d'événements WiFi, le budget de tas TLS
Sources et tickets : rb-amp/rbamp-esp-idf · cette page dans le dépôt : docs/07_diy_integrations.md (v1.7.3)