Getting started 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

Working with IoT dashboards

Learn how to perform basic operations over Dashboards.

dashboards

Getting started with Rule Engine

Learn about Klyff 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

Lesson 1. Visualizing assets data using OpenStreet Map and Entities table widgets

Explore this guide to learn how to: create assets and devices and define their relationships; add server attributes; develop a new dashboard; visualize data using the ”Entities table” and ”OpenStreet Map” widgets.

asset device server attribute visualization dashboard Entities table OpenStreet Map widget helloworld

Lesson 2. Dashboard states, widget actions, and Image Map widget

Explore this guide to learn how to: add and configure new dashboard states, create different aliases, visualize devices data on the ”Image Map” widget, and set up actions in various widgets to navigate between states.

Line chart aliases attribute Image Map Auto fill layout height actions telemetry analog gauges digital gauge data helloworld

Lesson 3. Charts and card widgets

Explore this guide to learn how to: add separate states for each device, simulate telemetry data for the devices using the Rule Engine, and display them using card and chart widgets.

Line chart aliases attribute Image Map actions telemetry analog gauges digital gauge data helloworld

Lesson 4. Adding customers & sharing or changing ownership of assets.

Explore this guide to learn how to: grant access to the dashboard by assigning ownership or shared access to specific entities (such as devices, assets, etc.) to different clients; create customer and customer users.

customer user share change owner helloworld

Connect devices using Klyff HTTP API

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

http connect

Connect devices using Klyff MQTT API

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

mqtt connect

Connect devices using Klyff MQTT Sparkplug API

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

sparkplug connect

Connect devices using Klyff LwM2M API

Learn how to connect your devices using LwM2M protocol and Klyff built-in payload format.

lwm2m connect

Connect devices using Klyff CoAP API

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

coap connect

Connect devices through Klyff IoT Gateway

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

gateway connect

Klyff Integrations basics

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

Klyff Integrations vs IoT Gateway

Learn the differences between the Platform Integrations and IoT Gateway.

Connect devices with custom payload using Klyff HTTP Integration

Convert existing protocols and payload formats to Klyff message format.

http connect

Connect devices with custom payload using Klyff MQTT Integration.

Connect to external brokers and consume MQTT data stream

mqtt connect

Connect devices with custom payload using Klyff Kafka Integration.

Connect to external brokers and consume Kafka data stream

kafka connect

Connect SigFox devices using TB PE Integration

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

sigfox connect

Connect LoRaWAN devices using TheThingsStack

Learn how to route messages from TheThingsStack backend to Klyff and vise-versa.

ttn connect

Connect OPC-UA servers to Klyff

Learn how to connect OPC-UA devices to Klyff.

opcua connect

Connect LoRaWAN devices using Actility ThingPark

Learn how to route messages from ThingPark to Klyff 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 Klyff.

Connect devices through AWS Kinesis

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

Connect devices through IBM Watson IoT

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

Connect devices through Azure Event Hub

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

Connect devices through Azure IoT Hub

Learn how to connect to Azure IoT Hub and transform the incoming messages using Klyff.

Devices uses TCP protocol

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

Connect TCP devices

Devices uses UDP protocol

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

Connect UDP devices

Connect Tektelic LoRaWAN sensors using TEKTELIC KONA Core Network Server

Learn how to route messages from TEKTELIC KONA Core Network Server to Klyff.

Tektelic connect

Connect smart devices through Tuya Smart

Learn how to connect smart devices using Tuya Smart to Klyff.

Connect OPC-UA devices through SIA Connect

Learn how to connect OPC-UA devices using the SIA Connect to the Klyff.

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 Klyff

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

ESP32 Pico Kit GPIO control and DHT22 sensor monitor using Klyff 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 Klyff

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 Klyff

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

Raspberry Pi GPIO control using Android Things and Klyff

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 Klyff

Contains wiring diagram, sketch and dashboard setup guide.

Learn how to connect your SODAQ Universal Tracker to Klyff

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

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

Learn how to connect your SODAQ Universal Tracker to Klyff

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

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

Klyff 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

How to contribute your device integration guide

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