qbusmqttapi 0.1.0__py3-none-any.whl

qbusmqttapi/__init__.py

@@ -0,0 +1 @@
+"""QBUS MQTT API."""

qbusmqttapi/discovery.py

@@ -0,0 +1,250 @@
+"""QBUS Discovery."""
+from __future__ import annotations
+
+import json
+import logging
+
+_LOGGER = logging.getLogger(__name__)
+
+KEY_DEVICES = "devices"
+
+KEY_DEVICE_FUNCTIONBLOCKS = "functionBlocks"
+KEY_DEVICE_ID = "id"
+KEY_DEVICE_IP = "ip"
+KEY_DEVICE_MAC = "mac"
+KEY_DEVICE_NAME = "name"
+KEY_DEVICE_SERIAL_NR = "serialNr"
+KEY_DEVICE_TYPE = "type"
+
+KEY_OUTPUT_ID = "id"
+KEY_OUTPUT_TYPE = "type"
+KEY_OUTPUT_NAME = "name"
+KEY_OUTPUT_REF_ID = "ref_id"
+KEY_OUTPUT_PROPERTIES = "properties"
+KEY_OUTPUT_ACTIONS = "actions"
+
+KEY_CONTROLLER_CONNECTABLE = "connectable"
+KEY_CONTROLLER_CONNECTED = "connected"
+KEY_CONTROLLER_ID = "id"
+KEY_CONTROLLER_STATE_PROPERTIES = "properties"
+
+
+class QbusMqttOutput:
+    """Class for parsing MQTT discovered outputs for Qbus Home Automation."""
+    
+    def __init__(self, dict: dict) -> None:
+        """Initialize based on a json loaded dictionary."""
+        self._dict = dict
+
+    @property
+    def id(self) -> str:
+        """Return the id."""
+        return self._dict.get(KEY_OUTPUT_ID) or ""
+
+    @property
+    def type(self) -> str:
+        """Return the type."""
+        return self._dict.get(KEY_OUTPUT_TYPE) or ""
+
+    @property
+    def name(self) -> str:
+        """Return the name."""
+        return self._dict.get(KEY_OUTPUT_NAME) or ""
+
+    @property
+    def ref_id(self) -> str:
+        """Return the ref id."""
+        return self._dict.get(KEY_OUTPUT_REF_ID) or ""
+
+    @property
+    def properties(self) -> dict:
+        """Return the properties."""
+        return self._dict.get(KEY_OUTPUT_PROPERTIES) or {}
+
+    @property
+    def actions(self) -> dict:
+        """Return the actions."""
+        return self._dict.get(KEY_OUTPUT_ACTIONS) or {}
+
+class QbusMqttDevice:
+    """Class for parsing MQTT discovered devices for Qbus Home Automation."""
+    
+    def __init__(self, dict: dict) -> None:
+        self._dict = dict
+        self._outputs: list[QbusMqttOutput] = []
+        self._connection_state: bool
+        
+    @property
+    def id(self) -> str:
+        """Return the id."""
+        return self._dict.get(KEY_DEVICE_ID) or ""
+    
+    @property
+    def ip(self) -> str:
+        """Return the ip address."""
+        return self._dict.get(KEY_DEVICE_IP) or ""
+    
+    @property
+    def mac(self) -> str:
+        """Return the ip address."""
+        return self._dict.get(KEY_DEVICE_MAC) or ""
+    
+    @property
+    def name(self) -> str:
+        """Return the ip address."""
+        return self._dict.get(KEY_DEVICE_NAME) or ""
+
+    @property
+    def serial_number(self) -> str:
+        """Return the serial number."""
+        return self._dict.get(KEY_DEVICE_SERIAL_NR) or ""
+
+    @property
+    def type(self) -> str:
+        """Return the mac address."""
+        return self._dict.get(KEY_DEVICE_TYPE) or ""
+    
+    @property
+    def outputs(self) -> list[QbusMqttOutput]:
+        """Return the outputs."""
+
+        outputs: list[QbusMqttOutput] = []
+
+        if self._dict.get(KEY_DEVICE_FUNCTIONBLOCKS):
+            outputs = [QbusMqttOutput(x) for x in self._dict[KEY_DEVICE_FUNCTIONBLOCKS]]
+
+        self._outputs = outputs
+        return self._outputs
+
+class QbusMqttControllerStateProperties:
+    """MQTT representation a Qbus controller its state properties."""
+
+    def __init__(self, dict: dict) -> None:
+        """Initialize based on a json loaded dictionary."""
+        self._dict = dict
+
+    @property
+    def connectable(self) -> bool | None:
+        """Return True if the controller is connectable."""
+        return self._dict.get(KEY_CONTROLLER_CONNECTABLE, None)
+
+    @property
+    def connected(self) -> bool | None:
+        """Return True if the controller is connected."""
+        return self._dict.get(KEY_CONTROLLER_CONNECTED, None)
+   
+class QbusMqttControllerState:
+    """MQTT representation a Qbus controller state."""
+
+    def __init__(self, dict: dict) -> None:
+        """Initialize based on a json loaded dictionary."""
+        self._dict = dict
+        self._properties: QbusMqttControllerStateProperties | None = None
+
+    @property
+    def id(self) -> str | None:
+        """Return the id."""
+        return self._dict.get(KEY_CONTROLLER_ID)
+
+    @property
+    def properties(self) -> QbusMqttControllerStateProperties | None:
+        """Return the properties."""
+
+        if self._properties is not None:
+            return self._properties
+
+        properties: QbusMqttControllerStateProperties | None = None
+
+        if self._dict.get(KEY_CONTROLLER_STATE_PROPERTIES):
+            properties = QbusMqttControllerStateProperties(self._dict[KEY_CONTROLLER_STATE_PROPERTIES])
+
+        self._properties = properties
+
+        return self._properties   
+    
+class QbusMqttOutputState:
+    """MQTT representation a Qbus output state."""
+
+    def __init__(self, dict: dict) -> None:
+        """Initialize based on a json loaded dictionary."""
+        self._dict = dict
+
+    @property
+    def id(self) -> str:
+        """Return the id."""
+        return self._dict.get(KEY_OUTPUT_ID) or ""
+
+    @property
+    def type(self) -> str:
+        """Return the type."""
+        return self._dict.get(KEY_OUTPUT_TYPE) or ""
+
+    @property
+    def properties(self) -> dict | None:
+        """Return the properties."""
+        return self._dict.get(KEY_OUTPUT_PROPERTIES)
+    
+class QbusDiscovery:
+    """Class for parsing MQTT discovery messages for Qbus Home Automation."""
+
+    def __init__(self, domain: str) -> None:
+        """Initialize."""
+        self._domain = domain
+        self._devices = list[QbusMqttDevice] = []
+        self._hub_id = ""
+        self._device_id = ""
+        self._device_type = ""
+        self._device_desc = ""
+        self._name = ""
+        self._owner_id = ""
+        self._data_topic = ""
+        self._command_topic = ""
+        
+    async def parse_discovery(self, discovery_topic: str, payload: str | bytes) -> bool:
+        """Parse an MQTT discovery message and return True if successful."""
+        try:
+            json_data = json.loads(payload)
+        except ValueError:
+            _LOGGER.error(
+                "Invalid QBUS MQTT discovery payload on %s: %s",
+                discovery_topic,
+                payload,
+            )
+            return False
+        
+        topic_elements = discovery_topic.split("/")
+        if not (
+            topic_elements[2].endswith("config")
+        ):
+            return False
+        
+        
+        
+        # Discovery data must include the Qbus device type and name.
+        if (
+            KEY_DEVICES in json_data
+        ):
+            self._devices = json_data[KEY_DEVICES]
+        else:
+            _LOGGER.error(
+                "Incomplete MQTT discovery payload on %s: %s", discovery_topic, payload
+            )
+            return False
+        
+    @property
+    def devices(self) -> list[QbusMqttDevice]:
+        """Return the devices."""
+
+        devices: list[QbusMqttDevice] = []
+
+        if self._dict.get("devices"):
+            devices = [QbusMqttDevice(x) for x in self._dict["devices"]]
+
+        self._devices = devices
+
+        return self._devices
+
+    def get_device(self, serial: str) -> QbusMqttDevice | None:
+        """Get the device by serial number."""
+        return next((x for x in self.devices if x.serial_number == serial), None)
+

qbusmqttapi-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Qbus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qbusmqttapi-0.1.0.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.1
+Name: qbusmqttapi
+Version: 0.1.0
+Summary: MQTT API for Qbus Home Automation
+Author-email: Koen Schockaert <iot@qbus.be>
+License: MIT License
+        
+        Copyright (c) 2024 Qbus
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/Qbus-iot/qbusmqttapi
+Keywords: qbus,mqtt,api
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# qbusmqttapi
+Python MQTT API for Qbus Home Automation

qbusmqttapi-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+qbusmqttapi/__init__.py,sha256=gBSKnV4PNKfff3h3lTNMBJue8hkF-NBkFlJ-5bCMnIU,20
+qbusmqttapi/discovery.py,sha256=mCSaQUbgGsFGXytD7Ix1ffz_Tzwx12Vh0M106gFvDNw,7491
+qbusmqttapi-0.1.0.dist-info/LICENSE,sha256=tA9k_z4nwtQ7BPi69x8HyW8NKs6jgiXjYQKEvRSc34Y,1061
+qbusmqttapi-0.1.0.dist-info/METADATA,sha256=vfMeryr2oGyZ3o6mvn3aMr2cTx0n2j7JUNHC1So-yvw,1790
+qbusmqttapi-0.1.0.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+qbusmqttapi-0.1.0.dist-info/top_level.txt,sha256=4b327nGeDy12dfY_wCWnh-qQrOJVBoQBKAaKGvb52vY,12
+qbusmqttapi-0.1.0.dist-info/RECORD,,

qbusmqttapi-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (73.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

qbusmqttapi-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+qbusmqttapi