07 · DIY-интеграции
Как передавать показания rbamp в популярные системы домашней автоматизации с хоста на Python. Для каждой платформы: минимальный скрипт на Python и соответствующая настройка на стороне платформы.
Облачные и коммерческие интеграции (AWS IoT, Azure, GCP, InfluxDB Cloud) описаны в 08 · Cloud integrations.
| Платформа | Транспорт | Автообнаружение | Python MQTT-клиент |
|---|---|---|---|
| Home Assistant | MQTT | да (HA MQTT Discovery) | paho-mqtt (CPython) / umqtt.simple (uPy) |
| Node-RED | MQTT (или HTTP) | ручной поток | как выше |
| OpenHAB | MQTT (или REST) | ручной .things |
как выше |
| Domoticz | MQTT (авто) или HTTP | Да (плагин MQTT) | paho-mqtt или requests |
| InfluxDB OSS + Grafana | HTTP line-protocol | нет | requests (CPython) / urequests (uPy) |
Готовые скрипты для Home Assistant находятся в examples_cpython/09_ha_autodiscovery.py (CPython, демон с обработкой SIGTERM) и examples_upy/10_ha_autodiscovery.py (MicroPython).
Home Assistant — MQTT Auto-discovery
HA MQTT Discovery автоматически создаёт устройство и его датчики, как только ваш скрипт на Python публикует топики конфигурации. Правок YAML в HA не требуется.
CPython, версия (через paho-mqtt)
Сначала установите клиент: 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)
MicroPython, версия (через 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) хранится в памяти: он начинается с 0 после перезапуска скрипта или перезагрузки, и HA с этим справляется, потому что сенсор total_increasing. Чтобы сохранить абсолютный итог, сохраняйте сами dev.energy.wh(0) и прибавляйте его при старте. На модулях BASIC экспорт не учитывается. На модуле STD значение — чистая энергия (экспорт вычитается), поэтому оно уменьшается при экспорте: Home Assistant воспримет падение сенсора total_increasing как сброс счётчика. При экспорте на модуле STD публикуйте чистое значение с state_class: total или публикуйте импорт и экспорт из read_std_energy() как два сенсора total_increasing. Первые значения появляются после первого 60-секундного периода.
Результат в HA
Через несколько секунд после первой публикации HA автоматически создаёт устройство «Mains rbAmp» с 6 сенсорами (Voltage, Current, Power, Energy, Frequency, Power Factor). Сенсор Energy имеет state_class: total_increasing и правильный device_class, поэтому панель энергии HA принимает его как источник потребления.
Чтобы позже удалить устройство из HA, опубликуйте пустую полезную нагрузку в homeassistant/sensor/.../config (флаг retained очищает запись).
Многоканальный UI3
Повторите publish_discovery_sensor() с суффиксными ключами для каналов 1 и 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
Затем дополните JSON состояния полями "current_1", "power_1", "energy_1", заполненными из dev.read_current(1) / snap.avg_p[1] / dev.energy.wh(1) (или из dev.current[1] / dev.power[1] через свойство _ChannelProxy, если удобнее).
На MicroPython асинхронный вариант — пакет mqtt_as вместо umqtt.simple — даёт встроенный keepalive и переподключение без ручного mqtt.ping(). См. также Сценарий 10 в 06 · Examples (асинхронная потоковая передача).
Node-RED
Подпишитесь на MQTT-топик издателя на Python внутри потока:
[
{
"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;"
}
]
Соедините rbamp_in → extract_power → rbamp_chart — и получите график мощности в реальном времени. То же — для энергии / напряжения / PF.
Если Node-RED работает на том же Pi, что и брокер MQTT, укажите хост localhost. Для удалённых брокеров используйте 192.168.X.Y:1883 и учётные данные, если брокер требует аутентификацию.
Сторона Python — тот же скрипт, что и в разделе Home Assistant выше; JSON-полезная нагрузка общая, отличается только потребитель.
OpenHAB
OpenHAB 4.x + MQTT binding:
# 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" }
Python-часть — тот же скрипт, что в разделе Home Assistant выше. JSON-нагрузка общая, отличается только потребитель.
Domoticz
Плагин MQTT Auto-discovery в Domoticz понимает те же топики обнаружения homeassistant/.... Включите плагин в настройках Domoticz — и Python-скрипт из раздела про HA выше начнёт автоматически регистрировать устройство в Domoticz, как это делает в HA.
Альтернатива — нативный HTTP API Domoticz через 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)
Создайте устройство в интерфейсе Domoticz типа General → kWh (инкрементальный счётчик), возьмите его idx и пропишите в скрипте.
InfluxDB OSS + Grafana
Записывайте точки в протоколе line InfluxDB напрямую с хоста Python.
CPython (через 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 (через 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)
В Grafana добавьте источник данных InfluxDB, затем панель с запросом Flux:
from(bucket: "energy")
|> range(start: -24h)
|> filter(fn: (r) => r._measurement == "rbamp" and r.device == "main")
|> filter(fn: (r) => r._field == "power")
Для длительного испытания на выносливость дополнительно отправляйте диагностические счётчики в отдельное измерение:
# 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...
(На CPython счётчиков повторов нет — SMBusBackend не имеет слоя повторов. Передавайте только sanity_reject_count.)
Это даёт график состояния шины рядом с данными энергии.
Несколько платформ — раздача с одного хоста Python
Если нужны одновременно HA Auto-discovery, InfluxDB и Node-RED, публикуйте JSON состояния один раз в MQTT, а каждый потребитель подписывается на rbamp/+/state. Python-хост общается только с MQTT-брокером, а брокер сам раздаёт подписчикам. Не шлите из Python напрямую на N HTTP-адресов: это привязывает хост к конкретным потребителям.
Для очень высокоскоростного потока (10 Гц RT через dev.power[0]) запустите вспомогательный скрипт Python на Pi, на котором работает брокер: подпишитесь на быстрый топик, прореживайте и переопубликуйте в медленные топики. Основной хост Python (тот, на котором работает rbamp) должен заниматься только вызовами dev.read_* без накладных расходов HTTP.
Вариант asyncio (CPython)
Для CPython с asyncio можно объединить чтение и публикацию в несколько целей в одну задачу:
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() — асинхронный генератор пакета; см. 09 · Справочник API, раздел «Учёт по периодам».
Ссылки
-
06 · Examples — базовые скрипты, на которых построены эти интеграции (включая Сценарий 10 «async-streaming»)
-
08 · Cloud integrations — AWS IoT / Azure / GCP / InfluxDB Cloud / общий webhook
-
10 · Troubleshooting — паттерны обрыва MQTT, обработка сигналов, бюджет кучи TLS
Исходники и вопросы: rb-amp/rbamp-python · эта страница в репозитории: docs/07_diy_integrations.md (v1.6.1)