rbAmp
DE
Shop
Docs
Aktualisiert · Auf GitHub bearbeiten

07 · DIY-Integrationen

Wie sich rbamp-Messwerte in verbreitete selbst gehostete Automatisierungssysteme einspeisen lassen. Für jede Plattform gibt es ein minimal lauffähiges ESP-IDF-Projekt plus die passende Konfiguration auf der Plattformseite.

Cloud- / kommerzielle Integrationen (AWS IoT, Azure, GCP, InfluxDB Cloud) — 08 · Cloud-Integrationen.

Plattform Transport Auto-Discovery IDF-Komponenten
Home Assistant MQTT ja (HA MQTT-Discovery) espressif/esp_mqtt_client
ESPHome Native API + MQTT ja (YAML-Konfiguration) (alternatives Framework — siehe unten)
Node-RED MQTT (oder HTTP) manueller Ablauf espressif/esp_mqtt_client
OpenHAB MQTT (oder REST) manuelle .things espressif/esp_mqtt_client
Domoticz MQTT (automatisch) oder HTTP ja (MQTT-Plugin) esp_mqtt_client oder esp_http_client
InfluxDB OSS + Grafana HTTPS-Line-Protokoll nein esp_http_client
Hinweis

Fertige Projekte für die beiden Hauptszenarien liegen in examples/: examples/mqtt_publisher/ (MQTT-Publisher pro Kanal) und examples/ha_discovery/ (HA-Auto-Discovery auf Basis von mqtt_publisher).


Home Assistant — MQTT-Auto-Discovery

HA MQTT Discovery legt Gerät und Sensoren automatisch an, sobald der ESP32 die Konfigurations-Topics veröffentlicht. In HA sind keine YAML-Änderungen nötig.

ESP-IDF-Projekt (rbamp + WiFi STA + esp_mqtt_client)

C
#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);
    }
}

Vollständiges Projekt — examples/ha_discovery/.

Ergebnis in HA

Einige Sekunden nach der ersten Veröffentlichung legt HA automatisch das Gerät „Mains rbAmp“ mit 6 Sensoren an (Spannung, Strom, Leistung, Energie, Frequenz, Leistungsfaktor). Der Energiesensor hat state_class: total_increasing und die korrekte device_class — das HA-Energie-Dashboard akzeptiert ihn als Verbrauchsquelle.

Um das Gerät später aus HA zu entfernen, veröffentlichen Sie eine leere Nutzlast auf homeassistant/sensor/.../config (das Retained-Flag löscht den Eintrag).

Mehrkanal-UI3

Wiederholen Sie die Aufrufe publish_discovery_sensor() mit nummerierten Schlüsseln für die Kanäle 1 und 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 */

Und erweitern Sie das State-JSON um die Felder "current_1", "power_1", "energy_1", gefüllt aus rbamp_read_current(dev, 1, &i) / snap.avg_p[1] / rbamp_energy_wh(dev, 1).


ESPHome — Alternative über external_components

Wenn Sie ESPHome verwenden (statt reinem ESP-IDF), gibt es eine eigene externe Komponente rbamp, die diese Komponente vollständig ersetzt und ihre eigene HA-Integration über die native ESPHome-API abwickelt:

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"

ESPHome integriert sich nativ über die ESPHome-API (nicht MQTT) in HA — das Gerät erscheint nach dem Flashen automatisch in HA.

Die Komponente rbamp-esphome liegt in einem separaten Repository — Links finden Sie im rbAmp-Hauptindex. Verwenden Sie ESPHome anstelle von dieser Komponente; das Mischen von ESPHome und reinem ESP-IDF im selben Projekt lohnt sich in der Regel nicht.


Node-RED

Abonnieren Sie das MQTT-Topic des ESP32 in einem Flow:

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;"
  }
]

Verbinden Sie rbamp_in → extract_power → rbamp_chart, und Sie erhalten ein Echtzeit-Leistungsdiagramm. Verfahren Sie ebenso für Energie / Spannung / PF.

Läuft Node-RED auf demselben Pi wie der MQTT-Broker, verwenden Sie den Host localhost. Für entfernte Broker verwenden Sie 192.168.X.Y:1883, plus Zugangsdaten, falls der Broker eine Anmeldung verlangt.

Die ESP32-Seite ist dieselbe Skizze wie im obigen Abschnitt Home Assistant; die JSON-Nutzlast ist gemeinsam — nur der Verbraucher unterscheidet sich.


OpenHAB

OpenHAB 4.x + MQTT-Binding:

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

Die ESP32-Seite ist dasselbe Projekt wie im Abschnitt Home Assistant oben. Die JSON-Nutzlast ist gemeinsam — nur der Verbraucher unterscheidet sich.


Domoticz

Das MQTT-Auto-Discovery-Plugin in Domoticz versteht dieselben Discovery-Topics homeassistant/.... Aktivieren Sie das Plugin in den Domoticz-Einstellungen, dann registriert das ESP32-Projekt aus dem obigen HA-Abschnitt das Gerät automatisch in Domoticz, genau wie in HA.

Eine Alternative ist die native Domoticz-HTTP-API über esp_http_client:

C
#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));

Legen Sie in der Domoticz-Oberfläche ein Gerät vom Typ General → kWh (inkrementeller Zähler) an, übernehmen Sie dessen idx und tragen Sie ihn fest in das Projekt ein.


InfluxDB OSS + Grafana

Schreiben Sie Line-Protocol-Punkte direkt vom ESP32 über esp_http_client in InfluxDB:

C
#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));
}

Fügen Sie in Grafana eine InfluxDB-Datenquelle hinzu und dann ein Panel mit einer Flux-Abfrage:

Text
from(bucket: "energy")
  |> range(start: -24h)
  |> filter(fn: (r) => r._measurement == "rbamp" and r.device == "main")
  |> filter(fn: (r) => r._field == "power")

Für einen langlaufenden Soak-Betrieb schieben Sie zusätzlich eine Diagnose-Nutzlast in eine eigene Messreihe, die den Heap-Füllstand (über esp_get_free_heap_size()) sowie Zähler erfolgreicher und fehlgeschlagener Periodensnapshots enthält — so sehen Sie die Gesundheit von Bus und WLAN im selben Diagramm wie die Energiedaten:

C
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... */
Hinweis

: Die internen Retry-/Sanity-Zähler der Komponente sind in der öffentlichen API nicht freigegeben (siehe 10 · Fehlerbehebung, „On retry/sanity counters“). Zählen Sie snap_ok_count / snap_fail_count selbst auf der Anwendungsseite aus den Rückgabewerten von rbamp_read_period_snapshot().


Mehrere Plattformen — Verteilung von einem einzigen ESP32

Wenn Sie zugleich HA-Auto-Discovery, InfluxDB und Node-RED brauchen, veröffentlichen Sie den Zustands-JSON einmal über MQTT und lassen jeden Verbraucher rbamp/+/state abonnieren. Der ESP32 spricht nur mit dem MQTT-Broker — der Broker selbst verteilt an die Abonnenten. Senden Sie vom ESP32 nicht direkt an N HTTP-Endpunkte: Das koppelt das Gerät an bestimmte Verbraucher.

Für einen sehr hochfrequenten Datenstrom (10 Hz RT) betreiben Sie ein Sidecar-Python-Skript auf dem Pi neben dem Broker — es abonniert das schnelle Thema, dezimiert und veröffentlicht erneut auf die langsamen Themen. Die I²C-Schleife des ESP32 (eine FreeRTOS-Task mit rbamp_read_*()-Aufrufen) sollte fokussiert bleiben, frei von HTTP-Overhead.


  • 06 · Beispiele — die Basisprojekte, auf denen diese Integrationen aufbauen (einschließlich mqtt_publisher und ha_discovery)

  • 08 · Cloud-Integrationen — AWS IoT / Azure / GCP / InfluxDB Cloud / generischer Webhook

  • 10 · Fehlerbehebung — Muster für MQTT-Trennung, WiFi-Event-Handler, TLS-Heap-Budget


Quelle & Issues: rb-amp/rbamp-esp-idf · diese Seite im Repo: docs/07_diy_integrations.md (v1.7.3)