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

twist_innovation_api-0.0.1.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: twist-innovation-api
+Version: 0.0.1
+Summary: Python library to talk to the twist-innovation api
+Home-page: https://github.com/twist-innovation/twist-innovation-api
+Author: Sibrecht Goudsmedt
+Author-email: sibrecht.goudsmedt@twist-innovation.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+# Twist Innovation API
+
+## Overview
+This is the **Twist Innovation API** – a Python library for interacting with Twist Innovation devices via MQTT.
+
+## Installation
+
+You can install this package using pip:
+
+```bash
+pip install twist-innovation-api
+```
+
+Alternatively, if you have cloned the repository, install it locally:
+
+```bash
+pip install .
+```
+
+## Contributing the Project (without installing in pip)
+This repo can be tested with the include main.py. With this main.py, you don't need to install the package. If you just want to install and use, go to Usage
+### Configuration
+Before running the project, you need to create a configuration file named `config.yaml` in the project root directory. This file should contain your MQTT broker details:
+
+```yaml
+mqtt_broker: "your-mqtt-broker.com"
+mqtt_user: "your-username"
+mqtt_pass: "your-password"
+mqtt_port: 1883  # Default MQTT port
+```
+### Testing
+You can test the package using the included `main.py` file. Ensure you have a valid `config.yaml` file set up, then run:
+
+```bash
+python main.py
+```
+
+### Building
+To build the package, run the following command:
+
+```bash
+python -m build
+```
+
+### Pushing to PyPi
+To push the package to PyPi, run the following command:
+
+```bash
+twine upload dist/*
+```
+
+
+
+## Usage
+
+Import the package in your Python scripts:
+
+```python
+from twist import TwistAPI, TwistModel
+
+# Other includes for this example
+import asyncio
+from typing import Callable
+
+# Initialize the mqtt broker here and define the functions needed
+
+# Create a callback function
+callback_f: Callable[[str, str], None] | None = None
+
+# 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())
+
+# Publish message to the broker
+def mqtt_publish(topic, payload):
+    pass
+
+# Subscribe to a topic from the broker
+def mqtt_subscribe(topic, callback):
+    global callback_f
+    callback_f = callback
+
+# Callback function when a model received an update
+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()
+
+    while True:
+        await asyncio.sleep(1)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## License
+This project is licensed under the **GPL-3.0 License**. See the `LICENSE` file for details.
+
+## Contributing
+Contributions are welcome! Feel free to submit a pull request or open an issue.
+
+## Contact
+For any issues or questions, reach out via the [GitHub Issues](https://github.com/twist-innovation/twist-innovation-api/issues).
+

twist_innovation_api-0.0.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+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,,

twist_innovation_api-0.0.1.dist-info/WHEEL

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