twist-innovation-api 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

twist/TwistAPI.py

@@ -13,18 +13,19 @@
 
 
 import asyncio
-from typing import Callable
-import random
 import json
+import random
+from typing import Callable, Awaitable
+
+from .TwistDevice import TwistDevice, TwistModel
 from .TwistTypes import DeviceVariant
-from .TwistDevice import TwistModel, TwistDevice
 
 
 class TwistAPI:
-    def __init__(self, installation_id: int, model_update: Callable[[TwistModel], None]):
+    def __init__(self, installation_id: int, model_update: Callable[[TwistModel], Awaitable[None]]):
         self._ext_publish = None
         self._subscribe = None
-        self._callback = model_update
+        self._callback: Callable[[TwistModel], Awaitable[None]] = model_update
 
         self.function_map = {
             "context": self._context_msg,
@@ -36,14 +37,14 @@ class TwistAPI:
         # TODO: this should come from the API
         self.installation_id = installation_id
 
-    def add_mqtt(self, publisher, subscriber):
+    async def add_mqtt(self, publisher, subscriber):
         self._ext_publish = publisher
         self._subscribe = subscriber
 
-        self._subscribe(f"v2/{self.installation_id}/rx/#", self._on_message_received)
+        await self._subscribe(f"v2/{self.installation_id}/rx/#", self._on_message_received)
 
     async def search_models(self):
-        self.getboard(0xffffffff)
+        await self.getboard(0xffffffff)
         await asyncio.sleep(3)
 
         model_list: list[TwistModel] = list()
@@ -53,7 +54,7 @@ class TwistAPI:
 
         return model_list
 
-    def _publish(self, twist_id, opcode, payload: dict | None = None, model_id=None):
+    async def _publish(self, twist_id, opcode, payload: dict | None = None, model_id=None):
         if self._ext_publish is not None:
             topic = f"v2/{self.installation_id}/tx/{twist_id}/{opcode}"
             if payload is None:
@@ -62,13 +63,13 @@ class TwistAPI:
             if model_id is not None:
                 topic = f"{topic}/{model_id}"
 
-            self._ext_publish(topic, json.dumps(payload))
+            await self._ext_publish(topic, json.dumps(payload))
 
-    def getboard(self, twist_id):
-          self._publish(twist_id, "getboard")
+    async def getboard(self, twist_id):
+        await self._publish(twist_id, "getboard")
 
-    def activate_event(self, model: TwistModel, data: json):
-        self._publish(model.parent_device.twist_id, "activate_event", data, model.model_id)
+    async def activate_event(self, model: TwistModel, data: json):
+        await self._publish(model.parent_device.twist_id, "activate_event", data, model.model_id)
 
     def _parse_topic(self, topic):
         tpc_delim = topic.split('/')
@@ -83,19 +84,19 @@ class TwistAPI:
             "model_id": model_id
         }
 
-    def _on_message_received(self, topic, payload, qos=None):
+    async def _on_message_received(self, topic, payload, qos=None):
         data = self._parse_topic(topic)
         if any(dev.twist_id == data["twist_id"] for dev in self.device_list) or data["opcode"] == "getboard":
             if data["opcode"] in self.function_map:
-                self.function_map[data["opcode"]](data["twist_id"], payload, data["model_id"])
+                await self.function_map[data["opcode"]](data["twist_id"], payload, data["model_id"])
 
-    def _context_msg(self, twist_id, payload, model_id):
+    async def _context_msg(self, twist_id, payload, model_id):
         device = next((d for d in self.device_list if d.twist_id == twist_id), None)
-        model = device.context_msg(model_id, payload)
+        model = await device.context_msg(model_id, payload)
 
-        self._callback(model)
+        await self._callback(model)
 
-    def _get_board(self, twist_id, payload, model_id=None):
+    async def _get_board(self, twist_id, payload, model_id=None):
         data = json.loads(payload)
         if not any(dev.twist_id == twist_id for dev in self.device_list):
             self.device_list.append(TwistDevice(twist_id, data["h"], DeviceVariant(data["v"]), self))

twist/TwistCbShutter.py

@@ -23,7 +23,7 @@ class TwistCbShutter(TwistModel):
     def __init__(self, model_id: int, parent_device: TwistDevice):
         super().__init__(model_id, parent_device)
 
-    def context_msg(self, payload: str):
+    async def context_msg(self, payload: str):
         self.parse_general_context(payload)
 
     def print_context(self):

twist/TwistDevice.py

@@ -37,6 +37,6 @@ class TwistDevice:
                 self.model_list.append(model(model_id, self))
                 model_id += 1
 
-    def context_msg(self, model_id: int, payload: str):
-        self.model_list[model_id].context_msg(payload)
+    async def context_msg(self, model_id: int, payload: str):
+        await self.model_list[model_id].context_msg(payload)
         return self.model_list[model_id]

twist/TwistLight.py

@@ -34,22 +34,22 @@ class TwistLight(TwistModel):
         self.operating_time = 0
         self.current = 0
 
-    def turn_on(self):
-        self._activate_event(TwistLight.EventIndexes.SET)
+    async def turn_on(self):
+        await self._activate_event(TwistLight.EventIndexes.SET)
 
-    def turn_off(self):
-        self._activate_event(TwistLight.EventIndexes.CLEAR)
+    async def turn_off(self):
+        await self._activate_event(TwistLight.EventIndexes.CLEAR)
 
-    def toggle(self):
-        self._activate_event(TwistLight.EventIndexes.TOGGLE)
+    async def toggle(self):
+        await self._activate_event(TwistLight.EventIndexes.TOGGLE)
 
-    def set_value(self, value: int, fading_time: int | None = None):
+    async def set_value(self, value: int, fading_time: int | None = None):
         if fading_time is None:
-            self._activate_event(TwistLight.EventIndexes.VALUE, value)
+            await self._activate_event(TwistLight.EventIndexes.VALUE, value)
         else:
-            self._activate_event(TwistLight.EventIndexes.VALUE_FADING, value, fading_time)
+            await self._activate_event(TwistLight.EventIndexes.VALUE_FADING, value, fading_time)
 
-    def _activate_event(self, index: TwistLight.EventIndexes, value: int | None = None, fading_time: int | None = None):
+    async def _activate_event(self, index: TwistLight.EventIndexes, value: int | None = None, fading_time: int | None = None):
         data = {
             "i": index.value
         }
@@ -61,9 +61,9 @@ class TwistLight(TwistModel):
         else:
             data["vl"] = [value, fading_time]
 
-        self.parent_device.api.activate_event(self, data)
+        await self.parent_device.api.activate_event(self, data)
 
-    def context_msg(self, payload: str):
+    async def context_msg(self, payload: str):
         data = self.parse_general_context(payload)
 
         for ctx in data["cl"]:

twist/TwistLouvre.py

@@ -34,7 +34,7 @@ class TwistLouvre(TwistModel):
         self.operating_time = 0
         self.current = 0
 
-    def context_msg(self, payload: str):
+    async def context_msg(self, payload: str):
         data = self.parse_general_context(payload)
 
         for ctx in data["cl"]:
@@ -50,25 +50,25 @@ class TwistLouvre(TwistModel):
                 elif index == 7:
                     self.current = value[0]
 
-    def open(self):
-        self._activate_event(TwistLouvre.EventIndexes.OPEN)
+    async def open(self):
+        await self._activate_event(TwistLouvre.EventIndexes.OPEN)
 
-    def stop(self):
-        self._activate_event(TwistLouvre.EventIndexes.STOP)
+    async def stop(self):
+        await self._activate_event(TwistLouvre.EventIndexes.STOP)
 
-    def close(self):
-        self._activate_event(TwistLouvre.EventIndexes.CLOSE)
+    async def close(self):
+        await self._activate_event(TwistLouvre.EventIndexes.CLOSE)
 
-    def toggle(self):
-        self._activate_event(TwistLouvre.EventIndexes.TOGGLE)
+    async def toggle(self):
+        await self._activate_event(TwistLouvre.EventIndexes.TOGGLE)
 
-    def set_value(self, value: int, fading_time: int | None = None):
+    async def set_value(self, value: int, fading_time: int | None = None):
         if fading_time is not None:
             raise NotImplementedError("Fading time can't be used in this model")
         else:
-            self._activate_event(TwistLouvre.EventIndexes.VALUE, value)
+            await self._activate_event(TwistLouvre.EventIndexes.VALUE, value)
 
-    def _activate_event(self, index: TwistLouvre.EventIndexes, value: int | None = None,
+    async def _activate_event(self, index: TwistLouvre.EventIndexes, value: int | None = None,
                         fading_time: int | None = None):
         data = {
             "i": index.value
@@ -81,7 +81,7 @@ class TwistLouvre(TwistModel):
         else:
             data["vl"] = [value, fading_time]
 
-        self.parent_device.api.activate_event(self, data)
+        await self.parent_device.api.activate_event(self, data)
 
     def print_context(self):
         print(

twist/TwistModel.py

@@ -57,26 +57,26 @@ class TwistModel():
     def _get_value_from_context(self, ctx: dict):
         return ctx["i"], ctx["vl"]
 
-    def context_msg(self, payload):
+    async def context_msg(self, payload):
         raise NotImplementedError("Function not supported for this model")
 
-    def turn_on(self):
+    async def turn_on(self):
         raise NotImplementedError("Function not supported for this model")
 
-    def turn_off(self):
+    async def turn_off(self):
         raise NotImplementedError("Function not supported for this model")
 
-    def open(self):
+    async def open(self):
         raise NotImplementedError("Function not supported for this model")
 
-    def stop(self):
+    async def stop(self):
         raise NotImplementedError("Function not supported for this model")
 
-    def close(self):
+    async def close(self):
         raise NotImplementedError("Function not supported for this model")
 
-    def toggle(self):
+    async def toggle(self):
         raise NotImplementedError("Function not supported for this model")
 
-    def set_value(self, value: int | list[int, int] | list[int, int, int], fading_time: int | None = None):
+    async def set_value(self, value: int | list[int, int] | list[int, int, int], fading_time: int | None = None):
         raise NotImplementedError("Function not supported for this model")

twist/TwistRgb.py

@@ -42,22 +42,22 @@ class TwistRgb(TwistModel):
 
         self.operating_time = 0
 
-    def turn_on(self):
-        self._activate_event(TwistRgb.EventIndexes.SET)
+    async def turn_on(self):
+        await self._activate_event(TwistRgb.EventIndexes.SET)
 
-    def turn_off(self):
-        self._activate_event(TwistRgb.EventIndexes.CLEAR)
+    async def turn_off(self):
+        await self._activate_event(TwistRgb.EventIndexes.CLEAR)
 
-    def toggle(self):
-        self._activate_event(TwistRgb.EventIndexes.TOGGLE)
+    async def toggle(self):
+        await self._activate_event(TwistRgb.EventIndexes.TOGGLE)
 
-    def set_value(self, value: list[int, int, int], fading_time: int | None = None):
+    async def set_value(self, value: list[int, int, int], fading_time: int | None = None):
         if fading_time is None:
-            self._activate_event(TwistRgb.EventIndexes.VALUE, value)
+            await self._activate_event(TwistRgb.EventIndexes.VALUE, value)
         else:
-            self._activate_event(TwistRgb.EventIndexes.VALUE_FADING, value, fading_time)
+            await self._activate_event(TwistRgb.EventIndexes.VALUE_FADING, value, fading_time)
 
-    def _activate_event(self, index: TwistRgb.EventIndexes, value: list[int, int, int] | None = None,
+    async def _activate_event(self, index: TwistRgb.EventIndexes, value: list[int, int, int] | None = None,
                         fading_time: int | None = None):
         data = {
             "i": index.value
@@ -71,9 +71,9 @@ class TwistRgb(TwistModel):
             value.append(fading_time)
             data["vl"] = value
 
-        self.parent_device.api.activate_event(self, data)
+        await self.parent_device.api.activate_event(self, data)
 
-    def context_msg(self, payload: str):
+    async def context_msg(self, payload: str):
         data = self.parse_general_context(payload)
 
         for ctx in data["cl"]:

twist/TwistSensor.py

@@ -24,7 +24,7 @@ class TwistSensor(TwistModel):
     def __init__(self, model_id: int, parent_device: TwistDevice):
         super().__init__(model_id, parent_device)
 
-    def context_msg(self, payload: str):
+    async def context_msg(self, payload: str):
         self.parse_general_context(payload)
 
     def print_context(self):

{twist_innovation_api-0.0.1.dist-info → twist_innovation_api-0.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: twist-innovation-api
-Version: 0.0.1
+Version: 0.0.2
 Summary: Python library to talk to the twist-innovation api
 Home-page: https://github.com/twist-innovation/twist-innovation-api
 Author: Sibrecht Goudsmedt
@@ -79,46 +79,75 @@ twine upload dist/*
 Import the package in your Python scripts:
 
 ```python
-from twist import TwistAPI, TwistModel
-
-# Other includes for this example
 import asyncio
-from typing import Callable
+import yaml
+from typing import Callable, Awaitable
+import aiomqtt
 
-# Initialize the mqtt broker here and define the functions needed
+from twist import TwistAPI, TwistModel
 
-# Create a callback function
-callback_f: Callable[[str, str], None] | None = None
+# Load configuration
+with open("config.yaml", 'r') as file:
+    config = yaml.safe_load(file)
 
-# Callback function when a Mqtt message is received from the broker and forward it to the twist API
-def on_message(client, userdata, msg):
-    if callback_f is not None:
-        callback_f(msg.topic, msg.payload.decode())
+mqtt_broker = config["mqtt_broker"]
+mqtt_user = config["mqtt_user"]
+mqtt_pass = config["mqtt_pass"]
+mqtt_port = config["mqtt_port"]
 
-# Publish message to the broker
-def mqtt_publish(topic, payload):
+async def _noop(topic: str, payload: str):
     pass
 
-# Subscribe to a topic from the broker
-def mqtt_subscribe(topic, callback):
-    global callback_f
-    callback_f = callback
+callback_f :Callable[[str, str], Awaitable[None]]  = _noop
 
-# Callback function when a model received an update
-def on_model_update(model: TwistModel):
+
+async def on_model_update(model: TwistModel):
     model.print_context()
 
+
 async def main():
-    twist_api = TwistAPI(8, on_model_update)
-    twist_api.add_mqtt(mqtt_publish, mqtt_subscribe)
-    twist_model_list: list[TwistModel] = await twist_api.search_models()
+    global callback_f
+
+    async with aiomqtt.Client(
+        hostname=mqtt_broker,
+        port=mqtt_port,
+        username=mqtt_user,
+        password=mqtt_pass
+    ) as mqtt_client:
 
-    while True:
-        await asyncio.sleep(1)
+        # Async publish method
+        async def mqtt_publish(topic: str, payload: str):
+            await mqtt_client.publish(topic, payload)
+
+        # Async subscribe method
+        async def mqtt_subscribe(topic: str, callback: Callable[[str, str], None]):
+            global callback_f
+            callback_f = callback
+
+            async def listen():
+                await mqtt_client.subscribe(topic)
+                async for message in mqtt_client.messages:
+                    assert callback_f is not None
+                    await callback_f(message.topic.value, message.payload.decode())
+
+            asyncio.create_task(listen())
+
+        # Initialize Twist API with async methods
+        twist_api = TwistAPI(8, on_model_update)
+        await twist_api.add_mqtt(mqtt_publish, mqtt_subscribe)
+
+        twist_model_list: list[TwistModel] = await twist_api.search_models()
+
+        for model in twist_model_list:
+            print(f"{type(model)} has Model id: {model.model_id}, Device id: {model.parent_device.twist_id}")
+            
+        while True:
+            await asyncio.sleep(1)
 
 
 if __name__ == "__main__":
     asyncio.run(main())
+
 ```
 
 ## License

twist_innovation_api-0.0.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+twist/TwistAPI.py,sha256=hXkkxkUM9W9oDczRKwioDJ1SZA0s1K8Ed612YkvtUmk,3797
+twist/TwistCbShutter.py,sha256=Ps_Yvr7pl71wvt0h3BU12MyccUitA6qJMyBP-Yq9qks,1106
+twist/TwistDevice.py,sha256=1wfLNB0BgJHDSUrBYD4gv_Txak7SS4mmHrJ0jcMxfI8,1421
+twist/TwistLight.py,sha256=TrlZ03Aztc8-Qvybv96RYA_21zAke6GLBGHFpk-RznU,3106
+twist/TwistLouvre.py,sha256=wFl8MOMMslKDzSr2FkqArXXoJ5CWvBqMde7-UTlEpgU,3206
+twist/TwistModel.py,sha256=pyaGiw2vpaCsZkp0xC6XDB7HABGZM_2X7aZCqAxhmE0,2925
+twist/TwistRgb.py,sha256=MxAshwe4fczGD-pEgMAXG5847kKR0KFm7WemWKeDKHs,3412
+twist/TwistSensor.py,sha256=C1uHxdVvixnJeijeWAhArSAu5e7Dag7yt-dqqt407lg,1099
+twist/TwistTypes.py,sha256=wsp-lnkaU70wNdoKWOWcnsq89vBheBYmM31ZXW3FMRw,2166
+twist/Variants.py,sha256=SFAZ7bSmTRomPspOfU1qNWEW-htRuyhTKuyGKK9Qh54,1369
+twist/__init__.py,sha256=gf8GHc9utiG0vD8GP3IfzLFHAG-ev1TXBIm0XUHxy38,201
+twist_innovation_api-0.0.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+twist_innovation_api-0.0.2.dist-info/METADATA,sha256=g7LK4ufC35S-4xD1w8me6pb95jbmURlhALaRs7p3yp0,4298
+twist_innovation_api-0.0.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+twist_innovation_api-0.0.2.dist-info/top_level.txt,sha256=mkoeBkRPFodjnd-3UDf9YndjTQ6Sriz-EKSI4nQ7brs,6
+twist_innovation_api-0.0.2.dist-info/RECORD,,

twist_innovation_api-0.0.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-twist/TwistAPI.py,sha256=pHUXI-ToF3zda9Q2gQzlHg73G0q7MWwgXGqz23PmRyY,3645
-twist/TwistCbShutter.py,sha256=fOZ2ELxmsuH7seLmxvZmSpuSIzn6D6kKyIxtVYU0ZUI,1100
-twist/TwistDevice.py,sha256=dByOL6v3k36Dz-QMsbgZQCr8JdxxxyOWhfn4G1Xzpaw,1409
-twist/TwistLight.py,sha256=H1guYXWgZYCV5b-pNnQalAp5-_aI6N6db5aEoJhEoEs,3034
-twist/TwistLouvre.py,sha256=ewYLO7nXFSEq7XtitXJW0VlLRv3_-iwsg8BhA5bOUMw,3128
-twist/TwistModel.py,sha256=MFN3Bs0g3k_FKwTL40c3iHsy4mqXpUvLQpSfGybwaGY,2877
-twist/TwistRgb.py,sha256=ui4DiKJ91TRTXQz3s6J_Wl-Ue7tKIGnY1FuMTZP_RFs,3340
-twist/TwistSensor.py,sha256=AvuhlUejthAdQXsNA6MAS6NyKwpvLs4UiEa3P1mwqOE,1093
-twist/TwistTypes.py,sha256=wsp-lnkaU70wNdoKWOWcnsq89vBheBYmM31ZXW3FMRw,2166
-twist/Variants.py,sha256=SFAZ7bSmTRomPspOfU1qNWEW-htRuyhTKuyGKK9Qh54,1369
-twist/__init__.py,sha256=gf8GHc9utiG0vD8GP3IfzLFHAG-ev1TXBIm0XUHxy38,201
-twist_innovation_api-0.0.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-twist_innovation_api-0.0.1.dist-info/METADATA,sha256=2BIzSO_NZ2Dygs_hUdVg5PfeUcX3riO1tr4txoerIxY,3499
-twist_innovation_api-0.0.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-twist_innovation_api-0.0.1.dist-info/top_level.txt,sha256=mkoeBkRPFodjnd-3UDf9YndjTQ6Sriz-EKSI4nQ7brs,6
-twist_innovation_api-0.0.1.dist-info/RECORD,,