m.giller/mash-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added documentation

Browse source
This commit is contained in:
Maximilian Giller 2024-07-17 21:01:54 +02:00
parent c2aa2f5adc
commit fd414c2cd1
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/mash/bridges/zigbee2mqtt.py
View file

@ -1,3 +1,4 @@
import logging
from typing import Optional from typing import Optional
from mash.bridges.bridge import Bridge from mash.bridges.bridge import Bridge
import paho.mqtt.client as mqtt import paho.mqtt.client as mqtt
@ -15,6 +16,14 @@ class Z2mBridge(Bridge):
keepalive: int = 60, keepalive: int = 60,
topic: str = "zigbee2mqtt", topic: str = "zigbee2mqtt",
) -> None: ) -> None:
"""
Args:
id (str): Unique identifier of this bridge instance.
ip (str): IP-Address of MQTT broker.
port (int, optional): Port of MQTT broker. Defaults to 1883.
keepalive (int, optional): MQTT keepalive delay in seconds. Defaults to 60.
topic (str, optional): Base topic for Zigbee2MQTT interface. Defaults to "zigbee2mqtt".
"""
super().__init__(id=id, type="zigbee2mqtt") super().__init__(id=id, type="zigbee2mqtt")
self._ip = ip self._ip = ip
self._port = port self._port = port
@ -37,10 +46,12 @@ class Z2mBridge(Bridge):
def disconnect(self) -> None: def disconnect(self) -> None:
self._client.loop_stop() self._client.loop_stop()
self._client.disconnect() self._client.disconnect()
logging.info(f"Disconnected from Zigbee2MQTT broker [{self.id}].")
def connect(self) -> None: def connect(self) -> None:
self._client.connect(self._ip, self._port, self._keepalive) self._client.connect(self._ip, self._port, self._keepalive)
self._client.loop_start() self._client.loop_start()
logging.info(f"Connect to Zigbee2MQTT broker [{self.id}].")
def __on_connect__(self, client, userdata, flags, reason_code, properties): def __on_connect__(self, client, userdata, flags, reason_code, properties):
self._client.subscribe(f"{self._topic}/#") self._client.subscribe(f"{self._topic}/#")