Guides

Hello world

Learn how to collect IoT device data using MQTT, HTTP or CoAP and visualize it on a simple dashboard. Provides variety of sample scripts that you can run on your PC or laptop to simulate the device.

mqtt http coap visualization helloworld

End user IoT dashboards

Learn how to perform basic operations over Devices, Customers, and Dashboards.

devices customers dashboards

Device data management

Learn how to perform basic operations over device attributes to implement practical device management use cases.

device management attributes

Getting started with Rule Engine

Learn about ThingsBoard rule engine and typical use cases you can implement. Review Hello World example and learn how-to enable filtering of incoming telemetry messages.

device management attributes

ThingsBoard PE Cloud Getting Started

Learn about different ThingsBoard PE features using Demo Smart Metering application.

professional edition

Installing ThingsBoard on Windows

Learn how to install ThingsBoard platform and all third-party on Windows OS.

install windows

Installing ThingsBoard on Linux

Learn how to install ThingsBoard platform and all third-party on Ubuntu or CentOS.

install linux ubuntu centos

Installing ThingsBoard on Raspberry Pi 3

Learn how to install ThingsBoard platform and all third-party on Raspberry Pi 3 Model B.

install linux rpi raspberry pi

Installing ThingsBoard on Kubernetes

Learn how to install ThingsBoard platform on Kubernetes.

install linux kubernetes

Installing ThingsBoard on Docker

Learn how to install ThingsBoard platform on Docker.

install docker

Installing ThingsBoard on Docker (Windows)

Learn how to install ThingsBoard platform on Docker (Windows).

install docker windows

Upgrade your ThingsBoard instance

Learn how to upgrade ThingsBoard platform to a newer version.

install upgrade

Cluster setup

Learn how to setup ThingsBoard cluster.

install cluster

AWS cluster setup

Learn how to setup ThingsBoard cluster on AWS infrastructure.

install cluster aws

Cluster setup with Docker Compose

Learn how to setup ThingsBoard cluster with Docker Compose.

install cluster docker docker-compose

Cluster setup with Kubernetes using Minikube

Learn how to setup ThingsBoard cluster with Kubernetes using Minikube.

install cluster kubernetes k8s minikube

Cluster setup with Kubernetes and KubeOne on AWS cloud infrstructure

Learn how to setup ThingsBoard cluster with Kubernetes on AWS cloud infrstructure.

install cluster kubernetes k8s aws cloud

Self-hosted setup using AWS EC2 instance

Learn how to setup ThingsBoard on AWS EC2 instance.

install ec2 aws cloud self-hosted

Cluster setup with Kubernetes using OpenShift

Learn how to setup ThingsBoard cluster with Kubernetes using OpenShift.

install cluster kubernetes k8s openshift

Connect devices using ThingsBoard HTTP API

Learn how to connect your devices using HTTP protocol and ThingsBoard built-in payload format.

http connect

Connect devices using ThingsBoard MQTT API

Learn how to connect your devices using MQTT protocol and ThingsBoard built-in payload format.

mqtt connect

Connect devices using ThingsBoard CoAP API

Learn how to connect your devices using CoAP protocol and ThingsBoard built-in payload format.

coap connect

Connect devices through ThingsBoard IoT Gateway

Learn how to deploy IoT Gateway in your local network and route messages from your devices to the cloud.

gateway connect

ThingsBoard Integrations basics

Learn about ThingsBoard Integrations feature and how you can use it to connect devices and apps that use custom payload formats.

ThingsBoard Integrations vs IoT Gateway

Learn the differences between the Platform Integrations and IoT Gateway.

Connect devices with custom payload using ThingsBoard HTTP Integration

Convert existing protocols and payload formats to ThingsBoard message format.

http connect

Connect devices with custom payload using ThingsBoard MQTT Integration.

Connect to external brokers and consume MQTT data stream

mqtt connect

Connect SigFox devices using TB PE Integration

Learn how to route messages from Sigfox backend to ThingsBoard and decode binary device payloads.

sigfox connect

Connect LoRaWAN devices using TheThingsNetwork

Learn how to route messages from TheThingsNetwork backend to ThingsBoard and vise-versa.

ttn connect

Connect OPC-UA servers to ThingsBoard

Learn how to connect OPC-UA devices to ThingsBoard.

opcua connect

Connect LoRaWAN devices using Actility ThingPark

Learn how to route messages from ThingPark to ThingsBoard and vise-versa.

Connect devices through AWS IoT

Learn how to connect to AWS IoT broker, transform the incoming messages and generate the downlinks using ThingsBoard.

Connect devices through AWS Kinesis

Learn how to connect to AWS Kinesis stream, transform the incoming messages and generate the downlinks using ThingsBoard.

Connect devices through IBM Watson IoT

Learn how to connect to IBM Watson IoT broker, transform the incoming messages and generate the downlinks using ThingsBoard.

Connect devices through Azure Event Hub

Learn how to connect to Azure Event Hub, transform the incoming messages and generate the downlinks using ThingsBoard.

Devices uses TCP protocol

How to connect to ThingsBoard TCP-server, transform the incoming messages and generate the downlinks using ThingsBoard.

Connect TCP devices

Devices uses UDP protocol

How to connect to ThingsBoard UDP-server, transform the incoming messages and generate the downlinks using ThingsBoard.

Connect UDP devices

Visualizing assets data using Maps and Tables

Learn how to: create assets and devices and define their relationships; add the server attributes and create a new dashboard; visualize data from the asset attributes using “Entities Table” and “Map” widgets.

Dashboard states, aliases and widget actions

Learn how to: add and configure new dashboard states; create various aliases; visualize the attributes data using the Image Map widget; create actions in different widgets in order to navigate between states; visualize the telemetry data using Analogue and Digital gauges and the Timeseries widget.

Remote device control and alarm management

Learn how to: add and use the Knob Control widget; create alarm rules; handle alarms using the Alarms widget; make a dashboard public.

Basic widget settings

Learn how to: change widget title, background, colors, fonts, shadows, etc.

Latest Values Map widget

Learn how to create Map widget, based on latitude and longitude, and customize the Map widget layout and properties.

Time Series Map widget

Learn how to display your devices with the latest telemetry data on the Time Series Map widget and modify the widget properties.

Trip Animation widget

Learn how to display your devices with the latest telemetry data on the Trip Animation widget and modify the widget properties.

Validate incoming telemetry

Learn how to configure Rule Engine to discard invalid telemetry readings based on JavaScript filter function.

Telemetry delta calculation

Learn how to configure Rule Engine to calculate telemetry delta readings based on Originator telemetry rule node.

Data function based on telemetry from 2 devices

Learn how to configure Rule Engine to create new telemetry based on telemetry readings from multiple devices.

Transform incoming telemetry

Learn how to configure Rule Engine to transform incoming telemetry based on JavaScript function before it is stored to the database.

Transform telemetry using previous record

Learn how to configure Rule Engine to calculate “delta” of the counter readings based on current and previous reading.

Create & clear alarms

Learn how to configure Rule Engine to create and clear alarms based on incoming data from devices.

Working with Alarm details

Learn how to configure Alarm Details function in Alarm nodes and how to add an Alarm widget to the dashboard.

Send email on alarm

Learn how to configure Rule Engine to send email when new alarm is created.

Send email to customer

Learn how to configure Rule Engine to send email to the customer of the assigned device.

Notifications and Alarms on your smartphone using Telegram Bot

Learn how to configure Rule Engine to send notification using Telegram Bot when new alarm is created.

Create alarm when the device is offline

Learn how to create an alarm when the device is offline for a certain period of time using RuleEngine.

Check relation between Entities

Learn how the Check Relation node can be used to check the relation between Entities.

RPC Request to related Device

Learn how to send a remote request call to a Related Device using Rule Engine.

Using REST API to get weather data

Learn how to use REST API to get weather data in a specified location.

Add & remove devices to group dynamically

Learn how to how to dynamically add & remove device from the device group based on incoming data from device.

Send data to external MQTT brokers

Connect to external brokers and send MQTT data stream

Using queues for synchronization

Learn how to use Rule Engine 2.5 queues for message processing synchronization.

Using queues for message reprocessing

Learn how to use Rule Engine 2.5 queues for message reprocessing in case of failure or timeout.

Aggregate incoming data stream

Calculate total water consumption in the building based on readings from multiple water meters within a building.

aggregation water meter analytics rule engine

Aggregate latest telemetry values periodically

Calculate average temperature in the warehouse based on readings from multiple temperature sensors.

average temperature analytics rule engine

Predict timeseries

Build prediction model based on vibration of water pump

analytics forecast prediction

ESP32 OTA using ThingsBoard

Learn how to make ESP32 OTA update using ThingsBoard custom widget, rule chain and dashboard

ESP32 Pico Kit GPIO control and DHT22 sensor monitor using ThingsBoard Arduino SDK

Contains wiring diagram, sketch and dashboard setup guide.

Temperature upload over MQTT using Arduino UNO, ESP8266 and DHT22 sensor

Contains wiring diagram, sketch and dashboard setup guide.

Humidity and temperature upload over HTTP using Arduino UNO, SIM808 Shield and HTU21D sensor

Contains wiring diagram, sketch and dashboard setup guide.

Temperature upload over MQTT using ESP8266 and DHT22 sensor

Contains wiring diagram, sketch, dashboard setup guide and demonstration video.

ESP8266 GPIO control over MQTT using ThingsBoard

Contains wiring diagram, sketch, dashboard setup guide and demonstration video.

Temperature upload over MQTT using NodeMCU and DHT11 sensor

Contains wiring diagram, sketch and dashboard setup guide.

Raspberry Pi GPIO control over MQTT using ThingsBoard

Contains wiring diagram, source code, dashboard setup guide and demonstration video.

Raspberry Pi GPIO control using Android Things and ThingsBoard

Contains wiring diagram, source code, dashboard setup guide and demonstration video.

Temperature upload over MQTT using Raspberry Pi and DHT22 sensor

Contains wiring diagram, sketch, dashboard setup guide and demonstration video.

GPS data upload and visualization using LinkIt ONE and ThingsBoard

Contains wiring diagram, sketch and dashboard setup guide.

Learn how to connect your SODAQ Universal Tracker to ThingsBoard

Learn how to connect your SODAQ Universal Tracker to ThingsBoard via T-Mobile – IoT CDP Integration.

NB IoT, NB-IoT, T-Mobile, SODAQ, 5G

Learn how to connect your SODAQ Universal Tracker to ThingsBoard

Learn how to connect your SODAQ Universal Tracker to ThingsBoard via UDP Integration.

NB IoT, NB-IoT, T-Mobile, SODAQ, 5G

ThingsBoard BLE Demo with Raspberry PI, ESP32, Xiaomi MI and HTU21D sensors

Contains wiring diagram and dashboard setup guide.

Temperature upload over MQTT using Nettra RTU

Contains wiring diagram and dashboard setup guide.

Connectivity status

Learn how to track connectivity status of the devices: connected, disconnected, active, inactive

Audit log

Learn how to track user actions in order to keep audit log.

API limits

Learn how to control API usage, by limiting number of requests from single host during single time unit (Minutes, Hours, etc.)

White-labeling

Learn how to configure your company or product logo and color scheme in 2 minutes with zero coding efforts.

Device and Asset groups

Learn how to work with entity groups and perform bulk operations

Scheduler

Learn how to schedule various types of events and trigger actions.

Reporting

Learn how to schedule and generate reports based on existing dashboards.

Google OAuth example

Learn how to step-by-step setup OAuth with Google.

OAuth0 OAuth example

Learn how to step-by-step setup OAuth with OAuth0.

OAuth0 Okta example

Learn how to step-by-step setup OAuth with Okta.

OAuth0 Azure Active Directory example

Learn how to step-by-step setup OAuth with Azure Active Directory.

How to Contribute

Learn how to contribute to Thingsboard

Rule Node Development Guide

Learn how to customize and create custom rule nodes

Widgets Development Guide

Learn how to customize and create custom widgets