rbAmp
PT
Loja
Docs
Atualizado a · Editar no GitHub [Edit on GitHub]

07 · Integrações DIY

Como enviar leituras do RbAmp para sistemas de domótica auto-hospedados populares. Para cada plataforma obtém um esboço ESP32 mínimo a funcionar mais a configuração correspondente do lado da plataforma.

Integrações na cloud / comerciais (AWS IoT, Azure, GCP, InfluxDB Cloud) — 08 · Integrações na cloud.

Plataforma Transporte Descoberta automática Anfitrião
Home Assistant MQTT sim (HA MQTT Discovery) ESP32
ESPHome API nativa + MQTT sim (configuração YAML) Apenas ESP32
Node-RED MQTT (ou HTTP) fluxo manual qualquer anfitrião
OpenHAB MQTT (ou REST) .things manual qualquer anfitrião
Domoticz MQTT (automático) ou HTTP sim (plugin MQTT) qualquer anfitrião
InfluxDB OSS + Grafana HTTP line-protocol não qualquer anfitrião

Home Assistant — descoberta automática MQTT

O HA MQTT Discovery cria automaticamente o dispositivo e os seus sensores assim que o ESP32 publica os tópicos de configuração. Não são necessárias edições YAML no HA.

Esboço ESP32 (RbAmp + WiFi + MQTT Discovery)

C++
#include 
#include 
#include 
#include 

#define RBAMP_ADDR 0x50
static const char* DEVICE_ID   = "rbamp_main";
static const char* DEVICE_NAME = "Mains rbAmp";

static RbAmp dev(Wire, RBAMP_ADDR);
static WiFiClient   espClient;
static PubSubClient mqtt(espClient);

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, "}");
    mqtt.publish(topic, payload, true);
}

void publish_discovery_all() {
    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");
}

void setup() {
    Serial.begin(115200);
    WiFi.begin("ssid", "pass");
    while (WiFi.status() != WL_CONNECTED) delay(500);
    mqtt.setServer("192.168.1.10", 1883);
    mqtt.setKeepAlive(60);
    mqtt.setBufferSize(1024);   // enough for one discovery payload
    mqtt.connect(DEVICE_ID);
    publish_discovery_all();

    Wire.begin();
    Wire.setClock(50000);       // ESP32 baseline mitigation — see 10 · Troubleshooting
    dev.setLogStream(&Serial);
    while (!dev.begin()) { delay(500); }
}

void loop() {
    if (!mqtt.connected()) mqtt.connect(DEVICE_ID);
    mqtt.loop();

    static uint32_t last = 0;
    if (last == 0) last = millis();
    if (millis() - last < 60000) { delay(50); return; }
    last = millis();

    RbAmpPeriodSnapshot snap;
    if (!dev.readPeriodSnapshot(snap)) return;

    char state[384];
    snprintf(state, sizeof(state),
        "{\"voltage\":%.1f,\"current\":%.3f,\"power\":%.1f,"
        "\"energy\":%.3f,\"frequency\":%.1f,\"power_factor\":%.3f}",
        dev.readVoltage(), dev.readCurrent(0), snap.avg_p[0],
        dev.energy().wh(0), dev.readFrequency(), dev.readPowerFactor(0));
    char topic[64];
    snprintf(topic, sizeof(topic), "rbamp/%s/state", DEVICE_ID);
    mqtt.publish(topic, state, false);
}

Resultado no HA

Alguns segundos após a primeira publicação, o HA cria automaticamente um dispositivo chamado «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 mais tarde o dispositivo do HA, publique uma carga vazia em homeassistant/sensor/.../config (a flag retained apaga o registo).

UI3 multicanal

Repita as chamadas publish_discovery_sensor() com chaves com sufixo para os canais 1 e 2:

C++
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

Depois, acrescente ao JSON de estado os campos "current_1", "power_1", "energy_1", preenchidos a partir de dev.readCurrent(1) / snap.avg_p[1] / dev.energy().wh(1).


ESPHome através de um componente externo

Se o seu ESP32 já correr o ESPHome (em vez de ESP-IDF puro / arduino-esp32), existe um componente externo rbamp dedicado:

YAML
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"

Isto substitui por completo o esboço Arduino acima. O ESPHome integra-se nativamente com o HA através da API ESPHome (e não MQTT) — o dispositivo aparece automaticamente no HA após ser gravado.

O componente rbamp-esphome vive num repositório separado — veja o índice principal da rbAmp para as ligações.


Node-RED

Subscreva o tópico MQTT do ESP32 num fluxo:

JSON
[
  {
    "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, defina o anfitrião como localhost. Para brokers remotos use 192.168.X.Y:1883 mais credenciais, se o broker exigir autenticação.


OpenHAB

OpenHAB 4.x + binding MQTT:

Text
# 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" ]
    }
}
Text
# 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 esboço Arduino é o mesmo da secção Home Assistant acima. O payload JSON é partilhado; só muda o consumidor.


Domoticz

O plugin MQTT Auto-discovery no Domoticz entende os mesmos tópicos de descoberta homeassistant/.... Ative o plugin nas definições do Domoticz, e o esboço do ESP32 da secção HA acima registará automaticamente o dispositivo no Domoticz, tal como o faz no HA.

A alternativa é a API HTTP nativa do Domoticz:

C++
#include 

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, power, e_wh);
    HTTPClient http;
    http.begin(url);
    int code = http.GET();
    http.end();
    if (code != 200) Serial.printf("domoticz HTTP %d\n", code);
}

// In your 60-second loop:
publish_to_domoticz(123 /* your idx */, snap.avg_p[0], dev.energy().wh(0));

Crie um dispositivo na interface do Domoticz do tipo General → kWh (contador incremental), obtenha o seu idx e escreva-o diretamente no esboço.


InfluxDB OSS + Grafana

Escreva pontos em line-protocol no InfluxDB diretamente a partir do ESP32:

C++
#include 

#define INFLUX_HOST  "192.168.1.30:8086"
#define INFLUX_ORG   "homelab"
#define INFLUX_BKT   "energy"
#define INFLUX_TOKEN "your-token-here"

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",
        u, p, e_wh);

    HTTPClient http;
    http.begin(url);
    http.addHeader("Authorization", "Token " INFLUX_TOKEN);
    http.addHeader("Content-Type", "text/plain");
    int code = http.POST(body);
    http.end();
    if (code != 204) Serial.printf("influx HTTP %d\n", code);
}

// In your 60-second loop:
RbAmpPeriodSnapshot snap;
if (dev.readPeriodSnapshot(snap)) {
    push_influx(dev.readVoltage(), snap.avg_p[0], dev.energy().wh(0));
}

No Grafana, adicione uma fonte de dados InfluxDB e, depois, um painel com uma consulta Flux:

Text
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 de longa duração, envie também os contadores de diagnóstico:

C++
snprintf(body, sizeof(body),
    "rbamp_diag,device=main retry_exhaust=%lu,sanity_reject=%lu",
    dev.retryExhaustionCount(), dev.sanityRejectCount());
// ...push to InfluxDB...

— e obtém um gráfico de saúde do barramento junto com os dados de energia.


Multiplataforma — difusão a partir de um só ESP32

Se precisar de Auto-discovery 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 comunica apenas com o broker MQTT — o broker trata da difusão para os subscritores. Não envie do ESP32 diretamente para N endpoints HTTP: 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 que aloja o broker — subscreva o tópico rápido, reduza a taxa e republique para os tópicos lentos. O loop I²C do ESP32 deve manter-se focado nas chamadas dev.read*(), sem sobrecarga HTTP.



Fonte e problemas: rb-amp/rbamp-arduino · esta página no repositório: docs/07_diy_integrations.md (v1.6.2)