07 · Integraciones DIY
Cómo enviar las lecturas de rbamp a sistemas de automatización autoalojados populares desde un host Python. Para cada plataforma: un script Python mínimo y la configuración correspondiente en el lado de la plataforma.
Las integraciones en la nube y comerciales (AWS IoT, Azure, GCP, InfluxDB Cloud) se tratan en 08 · Integraciones en la nube.
| Plataforma | Transporte | Autodescubrimiento | Cliente MQTT de Python |
|---|---|---|---|
| Home Assistant | MQTT | sí (HA MQTT Discovery) | paho-mqtt (CPython) / umqtt.simple (uPy) |
| Node-RED | MQTT (o HTTP) | flujo manual | igual que arriba |
| OpenHAB | MQTT (o REST) | .things manual |
igual que arriba |
| Domoticz | MQTT (automático) o HTTP | sí (plugin MQTT) | paho-mqtt o requests |
| InfluxDB OSS + Grafana | Protocolo de línea HTTP | no | requests (CPython) / urequests (uPy) |
Los scripts listos para Home Assistant están en examples_cpython/09_ha_autodiscovery.py (CPython, demonio sensible a SIGTERM) y examples_upy/10_ha_autodiscovery.py (MicroPython).
Home Assistant: descubrimiento automático por MQTT
El descubrimiento MQTT de HA crea automáticamente el dispositivo y sus sensores en cuanto su script Python publica los temas de configuración. No hacen falta cambios en YAML en HA.
Versión de CPython (mediante paho-mqtt)
Instale primero el cliente: pip install paho-mqtt.
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)
Versión de MicroPython (mediante umqtt.simple)
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
dev.energy.wh(0) se mantiene en memoria: se reinicia desde 0 tras reiniciar el script o el dispositivo, y HA lo admite porque el sensor es total_increasing. Para conservar un total absoluto por su cuenta, guarde dev.energy.wh(0) y súmelo al arrancar. En módulos BASIC la exportación no se cuenta. En un módulo STD el valor es energía neta (la exportación resta), así que baja mientras exporta: Home Assistant leería una caída de un sensor total_increasing como reinicio del contador. Con exportación en un módulo STD, publique el valor neto con state_class: total, o publique importación y exportación desde read_std_energy() como dos sensores total_increasing. Los primeros valores aparecen tras el primer periodo de 60 segundos.
Resultado en HA
Unos segundos después de la primera publicación, HA crea automáticamente un dispositivo llamado «Mains rbAmp» con 6 sensores (Tensión, Corriente, Potencia, Energía, Frecuencia, Factor de potencia). El sensor de Energía lleva state_class: total_increasing y el device_class correcto, así que el Panel de energía de HA lo acepta como fuente de consumo.
Para eliminar más adelante el dispositivo de HA, publique una carga vacía en homeassistant/sensor/.../config (la marca retained borra la entrada).
UI3 multicanal
Repita publish_discovery_sensor() con claves con sufijo para los canales 1 y 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
Después, amplíe el JSON de estado con los campos "current_1", "power_1", "energy_1", rellenados desde dev.read_current(1) / snap.avg_p[1] / dev.energy.wh(1) (o desde dev.current[1] / dev.power[1] mediante la propiedad _ChannelProxy, si lo prefiere).
En MicroPython, la variante asíncrona (el paquete mqtt_as en lugar de umqtt.simple) ofrece keepalive y reconexión integrados sin un mqtt.ping() manual. Véase también el Escenario 10 en 06 · Ejemplos (transmisión asíncrona).
Node-RED
Suscríbase al tema MQTT del publicador Python dentro de un flujo:
[
{
"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;"
}
]
Conecte rbamp_in → extract_power → rbamp_chart y obtendrá un gráfico de potencia en tiempo real. Haga lo mismo para energía / tensión / PF.
Si Node-RED se ejecuta en la misma Pi que el broker MQTT, ponga el host en localhost. Para brokers remotos, use 192.168.X.Y:1883 más credenciales si el broker exige autenticación.
El lado Python es el mismo script que en la sección de Home Assistant anterior; la carga JSON es común, solo cambia el 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/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" ]
}
}
# 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" }
El lado Python es el mismo script que en la sección de Home Assistant de arriba. El payload JSON es compartido; solo cambia el consumidor.
Domoticz
El plugin de descubrimiento automático MQTT de Domoticz entiende los mismos temas de descubrimiento homeassistant/.... Active el plugin en la configuración de Domoticz y el script Python de la sección de HA anterior empezará a registrar el dispositivo en Domoticz automáticamente, igual que en HA.
La alternativa es la API HTTP nativa de Domoticz mediante requests:
CPython
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
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)
Cree un dispositivo en la interfaz de Domoticz de tipo General → kWh (contador incremental), anote su idx y escríbalo en el script.
InfluxDB OSS + Grafana
Escriba puntos en formato line-protocol directamente en InfluxDB desde el host Python.
CPython (mediante requests)
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 (mediante urequests)
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)
En Grafana, añada un origen de datos de InfluxDB y después un panel con una 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 un despliegue de larga duración, envíe además los contadores de diagnóstico a una medición separada:
# 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...
(En CPython no hay contadores de reintentos: SMBusBackend no tiene capa de reintentos. Envíe solo sanity_reject_count.)
Esto le ofrece un gráfico de salud del bus junto a los datos de energía.
Multiplataforma — distribución desde un único host Python
Si necesita a la vez autodescubrimiento de HA, InfluxDB y Node-RED, publique el JSON de estado una vez en MQTT y deje que cada consumidor se suscriba a rbamp/+/state. El host Python habla solo con el broker MQTT, y el propio broker reparte a los suscriptores. No envíe directamente desde Python a N endpoints HTTP: eso acopla el host a consumidores concretos.
Para un flujo de muy alta frecuencia (10 Hz en tiempo real mediante dev.power[0]), ejecute un script auxiliar de Python en la Raspberry Pi que aloje el broker: suscríbase al tema rápido, reduzca la frecuencia y vuelva a publicar en los temas lentos. El host Python principal (el que ejecuta rbamp) debe centrarse en las llamadas dev.read_* sin la sobrecarga de HTTP.
Variante asyncio (CPython)
Para CPython con asyncio puede combinar la lectura y la publicación múltiple en un solo task:
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() es el generador asíncrono del paquete; véase 09 · Referencia de la API, sección «Contabilidad por periodo».
Enlaces
-
06 · Ejemplos: los scripts base sobre los que se apoyan estas integraciones (incluido el Escenario 10 «transmisión asíncrona»)
-
08 · Integraciones en la nube: AWS IoT / Azure / GCP / InfluxDB Cloud / webhook genérico
-
10 · Solución de problemas: patrones de desconexión MQTT, gestión de señales, presupuesto de memoria TLS
Fuente y incidencias: rb-amp/rbamp-python · esta página en el repositorio: docs/07_diy_integrations.md (v1.6.1)