07 · Integrazioni fai-da-te
Come inviare le letture di rbamp a sistemi di automazione self-hosted molto diffusi da un host Python. Per ciascuna piattaforma: uno script Python minimo più la configurazione corrispondente lato piattaforma.
Le integrazioni cloud e commerciali (AWS IoT, Azure, GCP, InfluxDB Cloud) sono trattate in 08 · Integrazioni cloud.
| Piattaforma | Trasporto | Auto-discovery | Client MQTT Python |
|---|---|---|---|
| Home Assistant | MQTT | sì (HA MQTT Discovery) | paho-mqtt (CPython) / umqtt.simple (uPy) |
| Node-RED | MQTT (o HTTP) | flusso manuale | come sopra |
| OpenHAB | MQTT (o REST) | .things manuale |
come sopra |
| Domoticz | MQTT (automatico) o HTTP | sì (plugin MQTT) | paho-mqtt oppure requests |
| InfluxDB OSS + Grafana | Line protocol HTTP | no | requests (CPython) / urequests (uPy) |
Gli script pronti per Home Assistant si trovano in examples_cpython/09_ha_autodiscovery.py (CPython, demone sensibile a SIGTERM) e examples_upy/10_ha_autodiscovery.py (MicroPython).
Home Assistant — MQTT Auto-discovery
HA MQTT Discovery crea automaticamente il dispositivo e i suoi sensori non appena il suo script Python pubblica i topic di configurazione. Non servono modifiche YAML in HA.
Versione CPython (tramite paho-mqtt)
Installi prima il client: 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)
Versione MicroPython (tramite 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) è mantenuto in memoria: riparte da 0 dopo un riavvio dello script o del dispositivo, e HA lo gestisce perché il sensore è total_increasing. Per mantenere un totale assoluto, salvarlo in autonomia dev.energy.wh(0) e sommarlo di nuovo all'avvio. Sui moduli BASIC l'esportazione non viene conteggiata. Su un modulo STD il valore è energia netta (l'esportazione sottrae), quindi scende mentre si esporta: Home Assistant leggerebbe un calo di un sensore total_increasing come azzeramento del contatore. Con esportazione su un modulo STD, pubblicare il valore netto con state_class: total, oppure pubblicare import ed export da read_std_energy() come due sensori total_increasing. I primi valori compaiono dopo il primo periodo di 60 secondi.
Risultato in HA
Pochi secondi dopo la prima pubblicazione, HA crea automaticamente un dispositivo chiamato «Mains rbAmp» con 6 sensori (Tensione, Corrente, Potenza, Energia, Frequenza, Fattore di potenza). Il sensore Energia ha state_class: total_increasing e il device_class corretto, quindi il cruscotto Energia di HA lo accetta come sorgente di consumo.
Per rimuovere in seguito il dispositivo da HA, pubblichi un payload vuoto su homeassistant/sensor/.../config (il flag retained cancella la voce).
UI3 multi-canale
Ripeta publish_discovery_sensor() con chiavi suffissate per i canali 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
Poi estendere il JSON di stato con i campi "current_1", "power_1", "energy_1", popolati da dev.read_current(1) / snap.avg_p[1] / dev.energy.wh(1) (oppure da dev.current[1] / dev.power[1] tramite la proprietà _ChannelProxy, se preferite).
Su MicroPython, la variante asincrona — il pacchetto mqtt_as invece di umqtt.simple — fornisce keepalive e riconnessione integrati senza un mqtt.ping() manuale. Vedi anche lo Scenario 10 in 06 · Esempi (streaming asincrono).
Node-RED
Si iscriva al topic MQTT del publisher Python all'interno di un flusso:
[
{
"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;"
}
]
Collegando rbamp_in → extract_power → rbamp_chart si ottiene un grafico di potenza in tempo reale. Lo stesso per energia / tensione / PF.
Se Node-RED gira sullo stesso Pi del broker MQTT, imposti l'host su localhost. Per broker remoti usi 192.168.X.Y:1883 più le credenziali se il broker richiede l'autenticazione.
La parte Python è lo stesso script della sezione Home Assistant qui sopra; il payload JSON è condiviso, cambia solo il consumatore.
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" }
Lo script Python è lo stesso della sezione Home Assistant qui sopra. Il payload JSON è condiviso, cambia solo il consumatore.
Domoticz
Il plugin di auto-discovery MQTT di Domoticz riconosce gli stessi topic di discovery homeassistant/.... Attivi il plugin nelle impostazioni di Domoticz e lo script Python della sezione HA qui sopra inizierà a registrare il dispositivo in Domoticz automaticamente, come fa con HA.
L'alternativa è l'API HTTP nativa di Domoticz tramite 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)
Crei un dispositivo nell'interfaccia di Domoticz di tipo General → kWh (contatore incrementale), ne copi l'idx e lo inserisca nello script.
InfluxDB OSS + Grafana
Scriva i punti in formato line-protocol su InfluxDB direttamente dall'host Python.
CPython (tramite 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 (tramite 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)
In Grafana, aggiunga una sorgente dati InfluxDB, poi un pannello con una query Flux:
from(bucket: "energy")
|> range(start: -24h)
|> filter(fn: (r) => r._measurement == "rbamp" and r.device == "main")
|> filter(fn: (r) => r._field == "power")
Per un deployment di lunga durata sotto carico, invii in aggiunta i contatori diagnostici a una misura separata:
# 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...
(Su CPython non ci sono contatori di ripetizione — SMBusBackend non ha un livello di ripetizione. Invii solo sanity_reject_count.)
Questo le dà un grafico dello stato del bus accanto ai dati energetici.
Multipiattaforma — distribuzione da un unico host Python
Se servono insieme HA Auto-discovery, InfluxDB e Node-RED, pubblicare una volta il JSON di stato su MQTT e lasciare che ogni consumatore si iscriva a rbamp/+/state. L'host Python parla solo con il broker MQTT — è il broker a distribuire ai sottoscrittori. Non inviare direttamente da Python a N endpoint HTTP: così l'host si accoppia a consumatori specifici.
Per uno stream a frequenza molto alta (RT 10 Hz tramite dev.power[0]), esegua uno script sidecar in Python sul Pi che ospita il broker — si iscriva al topic veloce, riduca la frequenza e ripubblichi sui topic lenti. L'host Python principale (quello che esegue rbamp) deve restare concentrato sulle chiamate dev.read_* senza il sovraccarico HTTP.
Variante asyncio (CPython)
Per CPython con asyncio può combinare la lettura + la pubblicazione multi-destinazione in un unico 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() è il generatore asincrono del pacchetto — vedere 09 · Riferimento API, sezione "Contabilizzazione per periodo".
Collegamenti
-
06 · Esempi — gli script di base su cui si costruiscono queste integrazioni (incluso lo Scenario 10 «streaming asincrono»)
-
08 · Integrazioni cloud — AWS IoT / Azure / GCP / InfluxDB Cloud / webhook generico
-
10 · Risoluzione dei problemi — schemi di disconnessione MQTT, gestione dei segnali, budget heap TLS
Sorgente e segnalazioni: rb-amp/rbamp-python · questa pagina nel repo: docs/07_diy_integrations.md (v1.6.1)