07 · Integrações DIY
Como alimentar as leituras do rbamp em sistemas de automação auto-alojados populares. Para cada plataforma há um projeto ESP-IDF mínimo funcional mais a configuração correspondente do lado da plataforma.
Integrações cloud / comerciais (AWS IoT, Azure, GCP, InfluxDB Cloud) — 08 · Integrações na nuvem.
| Plataforma | Transporte | Descoberta automática | Componentes IDF |
|---|---|---|---|
| Home Assistant | MQTT | sim (HA MQTT Discovery) | espressif/esp_mqtt_client |
| ESPHome | API nativa + MQTT | sim (configuração YAML) | (enquadramento alternativo — ver abaixo) |
| Node-RED | MQTT (ou HTTP) | fluxo manual | espressif/esp_mqtt_client |
| OpenHAB | MQTT (ou REST) | .things manual |
espressif/esp_mqtt_client |
| Domoticz | MQTT (automático) ou HTTP | sim (plugin MQTT) | esp_mqtt_client ou esp_http_client |
| InfluxDB OSS + Grafana | HTTPS line-protocol | não | esp_http_client |
Projetos prontos para os dois cenários principais estão em examples/: examples/mqtt_publisher/ (publicador MQTT por canal) e examples/ha_discovery/ (descoberta automática do HA sobre o mqtt_publisher).
Home Assistant — descoberta automática MQTT
O HA MQTT Discovery cria automaticamente o dispositivo e os seus sensores quando o ESP32 publica os tópicos de configuração. Não são precisas edições YAML no HA.
Projeto 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);
}
}
Projeto completo — examples/ha_discovery/.
Resultado no HA
Alguns segundos após a primeira publicação, o HA cria automaticamente o dispositivo "Mains rbAmp" com 6 sensores (Tensão, Corrente, Potência, Energia, Frequência, Fator de potência). O sensor de Energia tem state_class: total_increasing e o device_class correto — o Painel de Energia do HA aceita-o como fonte de consumo.
Para remover o dispositivo do HA mais tarde, publique um payload vazio em homeassistant/sensor/.../config (a flag retained limpa a entrada).
UI3 multicanal
Repita as chamadas publish_discovery_sensor() com chaves com sufixo para os canais 1 e 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 */
E acrescente ao JSON de estado os campos "current_1", "power_1", "energy_1", preenchidos a partir de rbamp_read_current(dev, 1, &i) / snap.avg_p[1] / rbamp_energy_wh(dev, 1).
ESPHome — alternativa através de external_components
Se usar ESPHome (em vez do ESP-IDF puro), existe um componente externo rbamp dedicado que substitui este componente por completo e trata da sua própria integração com o HA através da API nativa do 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"
O ESPHome integra-se nativamente com o HA através da API do ESPHome (não MQTT) — o dispositivo aparece no HA automaticamente após ser gravado.
O componente rbamp-esphome vive num repositório separado — veja o índice rbAmp principal para as ligações. Use o ESPHome em vez de este componente; misturar ESPHome e ESP-IDF puro no mesmo projeto normalmente não compensa.
Node-RED
Subscreva o tópico MQTT do ESP32 num fluxo:
[
{
"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;"
}
]
Ligue rbamp_in → extract_power → rbamp_chart e obtém um gráfico de potência em tempo real. Faça o mesmo para energia / tensão / PF.
Se o Node-RED correr no mesmo Pi que o broker MQTT, use o localhost do anfitrião. Para brokers remotos use 192.168.X.Y:1883 mais credenciais se o broker exigir autenticação.
O lado do ESP32 é o mesmo esboço da secção Home Assistant acima; a carga JSON é partilhada — só muda o consumidor.
OpenHAB
OpenHAB 4.x + binding 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" }
O lado do ESP32 é o mesmo projeto da secção Home Assistant acima. O payload JSON é partilhado — só muda o consumidor.
Domoticz
O plugin de Auto-discovery MQTT do Domoticz entende os mesmos tópicos de descoberta homeassistant/.... Ative o plugin nas definições do Domoticz e o projeto ESP32 da secção HA acima registará automaticamente o dispositivo no Domoticz, tal como faz no HA.
Uma alternativa é a API HTTP nativa do 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));
Crie um dispositivo na interface do Domoticz do tipo General → kWh (contador incremental), obtenha o seu idx e codifique-o no projeto.
InfluxDB OSS + Grafana
Escreva pontos em line-protocol no InfluxDB diretamente a partir do 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));
}
No Grafana, adicione uma fonte de dados InfluxDB e depois um painel com uma consulta Flux:
from(bucket: "energy")
|> range(start: -24h)
|> filter(fn: (r) => r._measurement == "rbamp" and r.device == "main")
|> filter(fn: (r) => r._field == "power")
Para uma implementação prolongada de teste de resistência, envie adicionalmente um payload de diagnóstico para uma medição separada com o nível de heap (através de esp_get_free_heap_size()) e contadores de instantâneos de período bem-sucedidos / falhados — isto permite acompanhar a saúde do barramento e do WiFi no mesmo gráfico dos dados de energia:
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... */
: os contadores internos de retentativa/sanidade do componente não são expostos na API pública (ver 10 · Resolução de problemas "Sobre os contadores de retentativa/sanidade"). Conte snap_ok_count / snap_fail_count do lado da aplicação a partir dos valores devolvidos por rbamp_read_period_snapshot().
Multiplataforma — difusão a partir de um só ESP32
Se precisar de auto-descoberta do HA, InfluxDB e Node-RED ao mesmo tempo, publique o JSON de estado uma vez no MQTT e deixe cada consumidor subscrever rbamp/+/state. O ESP32 fala apenas com o broker MQTT — o próprio broker distribui aos subscritores. Não envie do ESP32 para N endpoints HTTP diretamente: isso acopla o dispositivo a consumidores específicos.
Para um fluxo de taxa muito alta (RT a 10 Hz), execute um script Python auxiliar no Pi junto ao broker — subscreva o tópico rápido, reduza a frequência e volte a publicar nos tópicos lentos. O loop I²C do ESP32 (uma tarefa FreeRTOS com chamadas rbamp_read_*()) deve manter-se focado, sem overhead de HTTP.
Ligações
-
06 · Exemplos — os projetos de base sobre os quais assentam estas integrações (incluindo
mqtt_publishereha_discovery) -
08 · Integrações na nuvem — AWS IoT / Azure / GCP / InfluxDB Cloud / webhook genérico
-
10 · Resolução de problemas — padrões para desconexão MQTT, manipulador de eventos WiFi, orçamento de heap TLS
Código-fonte e problemas: rb-amp/rbamp-esp-idf · esta página no repositório: docs/07_diy_integrations.md (v1.7.3)