If you want to add your device to the Device Library, please follow the steps below. We review every submission and work with you to make sure it ships at the same quality bar as the rest of the catalog.
Use the following heading structure so the guide stays consistent with the rest of the Device Library:
## Introduction
### Prerequisites
## Create device on ThingsBoard
## Install required libraries and tools (Optional)
## Connect device to ThingsBoard
## Check data on ThingsBoard
## Synchronize device state using client and shared attribute requests (Optional)
## Control device using shared attributes (Optional)
## Control device using RPC (Optional)
## ConclusionUse docx, plain txt, or Markdown. Markdown is preferred — it lets us drop the guide into the docs site with the least amount of conversion work.
If you write in Markdown or txt, ship the screenshots and diagrams alongside the document — either as an archive (zip / tar.gz) or as a public GitHub repository we can clone.
Email the guide to devices@thingsboard.io. Include a short description of the device and a link to its product page so we can cross-reference your hardware in the catalog.
We may make edits for accuracy, clarity, and consistency with our other guides. We'll loop you in on anything material so the final wording reflects how the device actually behaves.
Once accepted, your guide is added to the catalog and is discoverable to every developer browsing the Device Library.