API
zigbee2mqtt, rf2mqtt, ir2mqtt, mqtt2mqtt, scenes2mqtt
MQTT und Node-Red bieten die Schnittstelle zur Bridge
Die Bridge benutzt für die Zigbee-Geräte das zigbee2mqtt-Protokoll von Koenkk.
Weitere Infos finden Sie hier: zur zigbee2mqtt Dokumentation
Um eine einheitliche Schnittstelle zur Verfügung zu stellen, wurden die anderen Technologien von uns in dieses Protokoll übertragen.
Sie können sich ganz normal per SSH mit dem Pi verbinden.
URL: vv:22
Username: pi
Password: raspberry
URL: vv:1883
Username: mqtt
Password: mypasswd
Hier wird gezeigt, welche MQTT topics von rf2mqtt benutzt werden. Für ir2mqtt/ mqtt2mqtt/ scenes2mqtt gilt das Gleiche.
Alle messages, die an die jeweiligen topics gesendet werden, sind im JSON-Format.
Liefert eine Liste aller RF-Geräte mit folgendem topic zurück.
[
{
"dateCode": "",
"friendly_name": "MotionSensor1",
"ieeeAddr": "0x0000001619606820",
"lastSeen": 1625603479133,
"networkAddress": "0x4116",
"softwareBuildID": "VirtualVox",
"powerSource": "Mains (single phase)",
"type": "Router"
},
{
"dateCode": "",
"friendly_name": "Plug1",
"ieeeAddr": "0x0000000486737761",
"lastSeen": 1625603479133,
"networkAddress": "0xdef5",
"softwareBuildID": "VirtualVox",
"type": "Router"
},
...
]
FRIENDLY_NAME ist z.B. '0x0000000486737761' oder 'Plug1'.
Indem messages unter diesem topic veröffentlicht werden, kann das Gerät FRIENDLY_NAME gesteuert werden.
{
"state": "ON" // Or "OFF", "TOGGLE"
}
Dies ist das Gegenstück zu set. Um state zu lesen, veröffentlichen Sie folgende Anfrage.
{
"state": ""
}
Die Bridge liefert dann z.B. folgende Antwort zurück.
{
"linkquality": 255,
"update": {
"state": "idle"
},
"update_available": false,
"action": "single",
"state": "OFF",
"transition": 1
}