ThingsBoard CircuitPython Client SDK

💡 Make the notion that it is the early alpha of MQTT client MicroPython SDK special for controllers. So we appreciate any help in improving this project and getting it growing.

ThingsBoard is an open-source IoT platform for data collection, processing, visualization, and device management. This project is a CircuitPython library that provides convenient client SDK for Device API.

SDK supports:

• Device MQTT API provided by ThingsBoard
• QoS 0 and 1
• Automatic reconnect
• Device Claiming

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-thingsboard-client-sdk

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-thingsboard-client-sdk

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install thingsboard-circuitpython-client-sdk

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install thingsboard-circuitpython-client-sdk

Or the following command to update an existing version:

circup update

Getting Started

Client initialization and telemetry publishing

from tb_device_mqtt import TBDeviceMqttClient
telemetry = {"temperature": 41.9, "enabled": False, "currentFirmwareVersion": "v1.2.2"}
client = TBDeviceMqttClient(host="127.0.0.1", port=1883, access_token="A1_TEST_TOKEN")
# Connect to ThingsBoard
client.connect()
# Sending telemetry without checking the delivery status
client.send_telemetry(telemetry)
# Disconnect from ThingsBoard
client.disconnect()

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Support

• Join our Discord
• Community chat
• Stackoverflow

Licenses

This project is released under Apache 2.0 License.