Skip to content

thingsboard/thingsboard-micropython-client-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ThingsBoard MicroPython Client SDK

ThingsBoard

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

Discord Discord Discord Discord

💡 Make the notion that it is the early beta of MicroPython Client SDK. So we appreciate any help in improving this project and getting it growing.

Table of Contents

🧩 Features

  • Provided all supported feature of umqtt library
  • Unencrypted and encrypted (TLS v1.2) connection
  • QoS 0 and 1 (MQTT only)
  • Automatic reconnect
  • Device MQTT API provided by ThingsBoard
  • Firmware updates
  • Device Claiming
  • Device provisioning

📦 Installation

To install using mip:

import mip

mip.install('github:thingsboard/thingsboard-micropython-client-sdk')

🟢 Getting Started

Client initialization and telemetry publishing

from thingsboard_sdk.tb_device_mqtt import TBDeviceMqttClient

telemetry = {"temperature": 41.9, "enabled": False, "currentFirmwareVersion": "v1.2.2"}
client = TBDeviceMqttClient(host="127.0.0.1", 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()

📚 Documentation

You can find the full official documentation here. It includes detailed information about the SDK's features, API reference, and usage examples.

🪛 Examples

You can find more examples here. They demonstrate how to use the SDK to connect to ThingsBoard, send telemetry data, subscribe to attribute changes, handle RPC calls, etc.

🗺 Guides

⭐ Contributing

We welcome contributions to the ThingsBoard MicroPython Client SDK! If you have an idea for a new feature, have found a bug, or want to improve the documentation, please feel free to submit a pull request or open an issue.

💬 Support & Community

Need help or want to share ideas?

🐞 Found a bug? Please open an issue.

⚖️ Licenses

This project is released under Apache 2.0 License.

About

ThingsBoard MicroPython library that provides convenient client SDK for Device API

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages