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

07 · Integrações DIY

Como enviar leituras de rbamp para sistemas populares de automação self-hosted a partir de um host Python. Para cada plataforma: um script Python mínimo mais a configuração correspondente do lado da plataforma.

As integrações na nuvem / comerciais (AWS IoT, Azure, GCP, InfluxDB Cloud) estão cobertas em 08 · Integrações na nuvem.

Plataforma Transporte Descoberta automática Cliente MQTT em Python
Home Assistant MQTT sim (HA MQTT Discovery) paho-mqtt (CPython) / umqtt.simple (uPy)
Node-RED MQTT (ou HTTP) fluxo manual igual ao anterior
OpenHAB MQTT (ou REST) .things manual igual ao anterior
Domoticz MQTT (automático) ou HTTP sim (plugin MQTT) paho-mqtt ou requests
InfluxDB OSS + Grafana HTTP line-protocol não requests (CPython) / urequests (uPy)
Nota

Scripts prontos para o Home Assistant estão em examples_cpython/09_ha_autodiscovery.py (CPython, daemon sensível a SIGTERM) e examples_upy/10_ha_autodiscovery.py (MicroPython).


Home Assistant — descoberta automática MQTT

A descoberta MQTT do HA cria automaticamente o dispositivo e os seus sensores assim que o seu script Python publicar os tópicos de configuração. Não são necessárias edições YAML no HA.

Versão CPython (via paho-mqtt)

Instale primeiro o cliente: pip install paho-mqtt.

Python
import time, json
from smbus2 import SMBus
import paho.mqtt.client as mqtt_client
from rbamp import RbAmp, RbAmpSensorClass, RbAmpStaleError

DEVICE_ID   = "rbamp_main"
DEVICE_NAME = "Mains rbAmp"

mqtt = mqtt_client.Client(mqtt_client.CallbackAPIVersion.VERSION2, DEVICE_ID)
mqtt.connect("192.168.1.10", 1883, keepalive=60)
mqtt.loop_start()

def publish_discovery_sensor(key, friendly, unit, device_class, state_class):
    payload = {
        "name":            f"{DEVICE_NAME} {friendly}",
        "unique_id":       f"{DEVICE_ID}_{key}",
        "state_topic":     f"rbamp/{DEVICE_ID}/state",
        "value_template":  f"{{{{ value_json.{key} }}}}",
        "state_class":     state_class,
        "device": {
            "identifiers":   [DEVICE_ID],
            "name":          DEVICE_NAME,
            "manufacturer":  "rbAmp",
            "model":         "UI*",
        },
    }
    if unit:         payload["unit_of_measurement"] = unit
    if device_class: payload["device_class"] = device_class
    topic = f"homeassistant/sensor/{DEVICE_ID}/{key}/config"
    mqtt.publish(topic, json.dumps(payload), qos=1, retain=True)

def 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", None, "power_factor", "measurement")

with SMBus(1) as bus, RbAmp(bus, 0x50) as dev:
    dev.set_sensor_class(RbAmpSensorClass.SCT_013)
    dev.set_ct_model(3)

    publish_discovery_all()

    while True:
        time.sleep(60)
        try:
            snap = dev.read_period_snapshot()
        except RbAmpStaleError:
            continue

        state = {
            "voltage":      round(dev.voltage, 1),
            "current":      round(dev.read_current(0), 3),
            "power":        round(snap.avg_p[0], 1),
            "energy":       round(dev.energy.wh(0), 3),
            "frequency":    round(dev.frequency, 1),
            "power_factor": round(dev.read_power_factor(0), 3),
        }
        mqtt.publish(f"rbamp/{DEVICE_ID}/state", json.dumps(state), qos=0)

Versão MicroPython (via umqtt.simple)

Python
import time, ujson
from machine import I2C, Pin
from umqtt.simple import MQTTClient
from rbamp import RbAmp, RbAmpSensorClass, RbAmpStaleError

DEVICE_ID = b"rbamp_main"

def publish_discovery(mqtt, key, friendly, unit, dc, sc):
    payload = {
        "name":           f"Mains rbAmp {friendly}",
        "unique_id":      f"rbamp_main_{key}",
        "state_topic":    f"rbamp/rbamp_main/state",
        "value_template": "{{ value_json." + key + " }}",
        "state_class":    sc,
        "device": {
            "identifiers":  ["rbamp_main"],
            "name":         "Mains rbAmp",
            "manufacturer": "rbAmp",
            "model":        "UI*",
        },
    }
    if unit: payload["unit_of_measurement"] = unit
    if dc:   payload["device_class"] = dc
    topic = b"homeassistant/sensor/rbamp_main/" + key.encode() + b"/config"
    mqtt.publish(topic, ujson.dumps(payload).encode(),
                 qos=1, retain=True)

mqtt = MQTTClient(DEVICE_ID, b"192.168.1.10", port=1883, keepalive=60)
mqtt.connect()

for key, friendly, unit, dc, sc in [
    ("voltage",      "Voltage",      "V",  "voltage",      "measurement"),
    ("current",      "Current",      "A",  "current",      "measurement"),
    ("power",        "Power",        "W",  "power",        "measurement"),
    ("energy",       "Energy",       "Wh", "energy",       "total_increasing"),
    ("frequency",    "Frequency",    "Hz", "frequency",    "measurement"),
    ("power_factor", "Power Factor", None, "power_factor", "measurement"),
]:
    publish_discovery(mqtt, key, friendly, unit, dc, sc)

i2c = I2C(0, scl=Pin(22), sda=Pin(21), freq=50_000)
with RbAmp(i2c, 0x50) as dev:
    dev.set_sensor_class(RbAmpSensorClass.SCT_013)
    dev.set_ct_model(3)

    while True:
        time.sleep(60)
        try:
            snap = dev.read_period_snapshot()
        except RbAmpStaleError:
            continue

        state = {
            "voltage":      round(dev.voltage, 1),
            "current":      round(dev.read_current(0), 3),
            "power":        round(snap.avg_p[0], 1),
            "energy":       round(dev.energy.wh(0), 3),
            "frequency":    round(dev.frequency, 1),
            "power_factor": round(dev.read_power_factor(0), 3),
        }
        mqtt.publish(b"rbamp/rbamp_main/state",
                     ujson.dumps(state).encode(), qos=0)
        mqtt.ping()   # keepalive, since umqtt.simple is sync with no background task
Sobre o valor de Energia.

dev.energy.wh(0) fica em memória: reinicia em 0 após um reinício do script ou do sistema, e o HA lida com isto porque o sensor é total_increasing. Para manter um total absoluto, guarde dev.energy.wh(0) e some-o de volta no arranque. Nos módulos BASIC a exportação não é contabilizada. Num módulo STD o valor é energia líquida (a exportação subtrai), por isso desce enquanto exporta: o Home Assistant leria uma descida de um sensor total_increasing como reposição do contador. Com exportação num módulo STD, publique o valor líquido com state_class: total, ou publique importação e exportação de read_std_energy() como dois sensores total_increasing. Os primeiros valores aparecem após o primeiro período de 60 segundos.

Resultado no HA

Poucos 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, pelo que o Painel de Energia do HA o aceita 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 publish_discovery_sensor() com chaves sufixadas para os canais 1 e 2:

Python
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.read_current(1) / snap.avg_p[1] / dev.energy.wh(1) (ou a partir de dev.current[1] / dev.power[1] através da propriedade _ChannelProxy, se preferir).

Nota

Em MicroPython, a variante assíncrona — o pacote mqtt_as em vez de umqtt.simple — oferece keepalive e reconexão integrados sem um mqtt.ping() manual. Veja também o Cenário 10 em 06 · Exemplos (streaming assíncrono).


Node-RED

Subscreva o tópico MQTT do publicador Python dentro de um fluxo:

JSON
[
  {
    "id": "rbamp_in",
    "type": "mqtt in",
    "topic": "rbamp/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.

O lado Python é o mesmo script da secção Home Assistant acima; o payload JSON é partilhado, só muda o consumidor.


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/rbamp_main/state", transformationPattern="JSONPATH:$.voltage" ]
            Type number : current "Current" [ stateTopic="rbamp/rbamp_main/state", transformationPattern="JSONPATH:$.current" ]
            Type number : power   "Power"   [ stateTopic="rbamp/rbamp_main/state", transformationPattern="JSONPATH:$.power" ]
            Type number : energy  "Energy"  [ stateTopic="rbamp/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 lado Python é o mesmo script da secção Home Assistant acima. O payload JSON é partilhado, só o consumidor muda.


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 script Python da secção HA acima começará a registar o dispositivo no Domoticz automaticamente, tal como faz no HA.

A alternativa é a API HTTP nativa do Domoticz através de requests:

CPython

Python
import requests
from rbamp import RbAmp, RbAmpStaleError

def publish_to_domoticz(idx, power, e_wh):
    """Domoticz svalue format for a kWh meter: 'POWER;ENERGY_WH'."""
    try:
        r = requests.get(
            "http://192.168.1.20:8080/json.htm",
            params={
                "type": "command",
                "param": "udevice",
                "idx": idx,
                "svalue": f"{power:.1f};{e_wh:.0f}",
            },
            timeout=5,
        )
        if r.status_code != 200:
            print(f"domoticz HTTP {r.status_code}")
    except requests.RequestException as e:
        print("domoticz request failed:", e)

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

MicroPython

Python
import urequests as requests

def publish_to_domoticz(idx, power, e_wh):
    url = ("http://192.168.1.20:8080/json.htm"
           "?type=command¶m=udevice"
           "&idx={}&svalue={:.1f};{:.0f}").format(idx, power, e_wh)
    try:
        r = requests.get(url)
        if r.status_code != 200:
            print("domoticz HTTP", r.status_code)
        r.close()   # MicroPython requires explicit close to free socket
    except OSError as e:
        print("domoticz request failed:", e)

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


InfluxDB OSS + Grafana

Escreva pontos line-protocol no InfluxDB diretamente a partir do host Python.

CPython (via requests)

Python
import time, requests
from smbus2 import SMBus
from rbamp import RbAmp, RbAmpSensorClass, RbAmpStaleError

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

def push_influx(u, p, e_wh):
    url = (f"http://{INFLUX_HOST}/api/v2/write"
           f"?org={INFLUX_ORG}&bucket={INFLUX_BKT}&precision=s")
    body = f"rbamp,device=main voltage={u:.1f},power={p:.1f},energy={e_wh:.3f}"
    try:
        r = requests.post(url, data=body, headers={
            "Authorization": f"Token {INFLUX_TOKEN}",
            "Content-Type":  "text/plain",
        }, timeout=5)
        if r.status_code != 204:
            print(f"influx HTTP {r.status_code}: {r.text}")
    except requests.RequestException as e:
        print("influx request failed:", e)

with SMBus(1) as bus, RbAmp(bus, 0x50) as dev:
    dev.set_sensor_class(RbAmpSensorClass.SCT_013)
    dev.set_ct_model(3)

    while True:
        time.sleep(60)
        try:
            snap = dev.read_period_snapshot()
        except RbAmpStaleError:
            continue
        push_influx(dev.voltage, snap.avg_p[0], dev.energy.wh(0))

MicroPython (através de urequests)

Python
import urequests as requests
import time

INFLUX_URL    = "http://192.168.1.30:8086/api/v2/write?org=homelab&bucket=energy&precision=s"
INFLUX_TOKEN  = "your-token-here"

def push_influx(u, p, e_wh):
    body = "rbamp,device=main voltage={:.1f},power={:.1f},energy={:.3f}".format(u, p, e_wh)
    try:
        r = requests.post(INFLUX_URL, data=body, headers={
            "Authorization": "Token " + INFLUX_TOKEN,
            "Content-Type":  "text/plain",
        })
        if r.status_code != 204:
            print("influx HTTP", r.status_code)
        r.close()
    except OSError as e:
        print("influx request failed:", e)

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 em teste de resistência, envie adicionalmente os contadores de diagnóstico para uma medição separada:

Python
# On MicroPython, build the backend yourself and pass it to RbAmp:
#   backend = MachineI2CBackend(i2c, retry_attempts=5); dev = RbAmp(backend, 0x50)
diag_body = (
    "rbamp_diag,device=main "
    f"sanity_reject={dev.sanity_reject_count},"
    f"retry_exhaust={backend.retry_exhaustion_count},"
    f"retry_total={backend.retry_count_total}"
)
# ...push to InfluxDB...

(No CPython não há contadores de retry — SMBusBackend não tem camada de retry. Envie apenas sanity_reject_count.)

Isto dá-lhe um gráfico de saúde do barramento ao lado dos dados de energia.


Multiplataforma — distribuição a partir de um único host Python

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 anfitrião Python fala apenas com o broker MQTT — o broker distribui aos subscritores. Não envie diretamente de Python para N endpoints HTTP: isso acopla o anfitrião a consumidores específicos.

Para um fluxo de dados de taxa muito alta (10 Hz RT via dev.power[0]), execute um script auxiliar em Python no Pi que aloja o broker — subscreva o tópico rápido, reduza a frequência e republique para os tópicos lentos. O host Python principal (aquele que corre rbamp) deve manter-se focado nas chamadas dev.read_* sem sobrecarga HTTP.

Variante asyncio (CPython)

Para CPython com asyncio, pode combinar a leitura e a publicação multi-destino numa única tarefa:

Python
import asyncio, json
from smbus2 import SMBus
from rbamp import RbAmp, RbAmpSensorClass

async def publish_mqtt(client, snap, dev): ...   # paho-mqtt async wrapper
async def push_influx(snap, dev): ...            # aiohttp instead of requests
async def push_webhook(snap, dev): ...           # aiohttp as well

async def main():
    with SMBus(1) as bus, RbAmp(bus, 0x50) as dev:
        dev.set_sensor_class(RbAmpSensorClass.SCT_013)
        dev.set_ct_model(3)

        async for snap in dev.stream_period(interval_s=60.0):
            await asyncio.gather(
                publish_mqtt(mqtt_client, snap, dev),
                push_influx(snap, dev),
                push_webhook(snap, dev),
            )

asyncio.run(main())

dev.stream_period() é o gerador assíncrono do pacote — ver 09 · Referência da API, secção "Contabilização por período".



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