1+ ThingsBoard CircuitPython Client SDK
2+ ====================================
13
2- .. image :: https://img.shields.io/badge/Discord-Join%20our%20server-5865F2?style=for-the-badge&logo=discord&logoColor=white
3- :target: https://discord.gg/mJxDjAM3PF
4- :alt: Discord Server
4+ .. image :: ./logo.png
5+ :alt: ThingsBoard Logo
6+ :align: center
7+
8+ .. class :: align-center
9+
10+ ThingsBoard is an open-source IoT platform for data collection, processing, visualization, and device management.
11+ This project is a CircuitPython library that provides convenient client SDK for
12+ `Device MQTT API <https://thingsboard.io/docs/reference/mqtt-api/ >`_.
513
614
715.. image :: https://github.com/thingsboard/CircuitPython_thingsboard-client-sdk/workflows/Build%20CI/badge.svg
1321 :target: https://github.com/astral-sh/ruff
1422 :alt: Code Style: Ruff
1523
16- ThingsBoard CircuitPython Client SDK
17- ====================================
24+
25+ .. image :: https://img.shields.io/badge/license-Apache_2.0-blue
26+ :target: https://github.com/thingsboard/CircuitPython_thingsboard-client-sdk/blob/main/LICENSE
27+ :alt: License: Apache 2.0
28+
29+
30+ .. image :: https://img.shields.io/badge/contributions-welcome-green
31+ :target: https://github.com/thingsboard/CircuitPython_thingsboard-client-sdk/issues
32+ :alt: Contributions Welcome
33+
34+
35+ .. image :: https://img.shields.io/github/v/release/thingsboard/CircuitPython_thingsboard-client-sdk
36+ :target: https://github.com/thingsboard/CircuitPython_thingsboard-client-sdk/releases/latest
37+ :alt: Release Version
38+
39+
40+ .. image :: https://img.shields.io/discord/1458396495610122526?logo=discord
41+ :target: https://discord.gg/mJxDjAM3PF
42+ :alt: Discord Server
43+
44+ ----
1845
1946**💡 Make the notion that it is the early alpha of MQTT client MicroPython SDK special for controllers. So we
2047appreciate any help in improving this project and getting it growing. **
2148
22- ThingsBoard is an open-source IoT platform for data collection, processing, visualization, and device management.
23- This project is a CircuitPython library that provides convenient client SDK for Device API.
2449
25- **SDK supports: **
50+ Table of Contents
51+ =================
52+
53+ - `Features <#-features >`_
54+ - `Dependencies <#-dependencies >`_
55+ - `Installation <#-installation >`_
56+
57+ - `PyPI <#installing-from-pypi >`_
58+ - `Circup <#installing-to-a-connected-circuitpython-device-with-circup >`_
59+
60+ - `Getting Started <#-getting-started >`_
61+ - `Examples <#-examples >`_
62+ - `Contributing <#-contributing >`_
63+ - `Support & Community <#-support--community >`_
64+ - `Licenses <#%EF%B8%8F-licenses >`_
65+
66+
67+ 🧩 Features
68+ ===========
2669
2770- `Device MQTT <https://thingsboard.io/docs/reference/mqtt-api/ >`_ API provided by ThingsBoard
2871- QoS 0 and 1
2972- Automatic reconnect
30- - Device Claiming
73+ - Sending attributes to ThingsBoard.
74+ - Sending telemetry data to ThingsBoard.
75+ - Request client and shared attributes from ThingsBoard.
76+ - Subscribing to attribute updates from ThingsBoard.
77+ - Device claiming
78+
79+
80+ 🔗 Dependencies
81+ ===============
3182
32- Dependencies
33- =============
3483This driver depends on:
3584
3685* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython >`_
@@ -41,8 +90,15 @@ This is easily achieved by downloading
4190or individual libraries can be installed using
4291`circup <https://github.com/adafruit/circup >`_.
4392
93+
94+ 📦 Installation
95+ ===============
96+
97+ You can install the ThingsBoard CircuitPython Client SDK in several ways depending on your setup and preferences.
98+
99+
44100Installing from PyPI
45- =====================
101+ --------------------
46102
47103On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
48104PyPI <https://pypi.org/project/thingsboard-circuitpython-client-sdk/> `_.
@@ -67,8 +123,9 @@ To install in a virtual environment in your current project:
67123 source .env/bin/activate
68124 pip3 install thingsboard-circuitpython-client-sdk
69125
126+
70127 Installing to a Connected CircuitPython Device with Circup
71- ==========================================================
128+ ----------------------------------------------------------
72129
73130Make sure that you have ``circup `` installed in your Python environment.
74131Install it with the following command if necessary:
@@ -90,8 +147,8 @@ Or the following command to update an existing version:
90147
91148 circup update
92149
93- Getting Started
94- ===============
150+ 🟢 Getting Started
151+ ==================
95152
96153Client initialization and telemetry publishing
97154
@@ -135,24 +192,34 @@ Client initialization and telemetry publishing
135192 print (" Disconnect error:" , e)
136193
137194
195+ 🪛 Examples
196+ ===========
138197
198+ You can find more examples `here <./examples >`_. They demonstrate how to use the SDK to connect to ThingsBoard, send
199+ telemetry data, subscribe to attribute changes, handle RPC calls, etc.
139200
140201
141- Contributing
142- ============
202+ ⭐ Contributing
203+ ===============
143204
144- Contributions are welcome! Please read our `Code of Conduct
145- <https://github.com/thingsboard/CircuitPython_thingsboard-client-sdk/blob/HEAD/CODE_OF_CONDUCT.md> `_
205+ We welcome contributions to the ThingsBoard CircuitPython Client SDK! If you have an idea for a new feature,
206+ have found a bug, or want to improve the documentation, please feel free to submit a pull request or open an issue.
207+ Please read our `Code of Conduct <./CODE_OF_CONDUCT.md >`_
146208before contributing to help this project stay welcoming.
147209
148- Support
149- =======
210+
211+ 💬 Support & Community
212+ ======================
213+
214+ Need help or want to share ideas?
150215
151216 - `Join our Discord <https://discord.gg/mJxDjAM3PF >`_
152- - `Community chat <https://gitter.im/thingsboard/chat >`_
153217 - `Stackoverflow <http://stackoverflow.com/questions/tagged/thingsboard >`_
154218
155- Licenses
156- ========
219+ **🐞 Found a bug? ** Please open an issue.
220+
221+
222+ ⚖️ Licenses
223+ ===========
157224
158225This project is released under `Apache 2.0 License <./LICENSE >`_.
0 commit comments