In this guide you may also mention (refer to) any other public source as an example of setup or configuration. However, all the steps has to fit instructions below.

All the steps should be numerated and provided with a clear flow of realization with examples in screenshots/pictures.

  • Store your integration .md file in a directory: “/docs/user-guide/integrations/”
  • Store all of your images for your guide in a separate directory of your integration: “/images/user-guide/integrations/YOUR_INTEGRATION_NAME/”

Intro/Short summary

This block represents your product and possible integration flow for it, and some additional info that could be useful for customers.


Widget/dashboard example for visualization of the data from your device. You can use already existing widgets with needed changes and modifications, same as created from scratch new one.

Integration flow:

Block 1 Device configuration

Block 2 ThingsBoard configuration (please use PE only recommendations)

Choose one of the suitable methods of integration according to Connectivity diagram below

Integration method

or API methods

or IoT Gateway method

Block 3 Additional information

Feedback & Contact Us for your integration

Here you can put the feedback form or assistance page which may help your users with the integration.