ThingsBoard

https://thingsboard.io/docs
Admin
ThingsBoard is an open-source IoT platform for collecting, processing, visualizing, and managing IoT...
Tokens:2,227,112
Snippets:26,265
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and start WebReport service

Source: https://thingsboard.io/docs/pe/installation/rpi

Install the .deb package and start the service.

```bash
sudo dpkg -i tb-web-report-4.3.1.4pe.deb
sudo service tb-web-report start
```

--------------------------------

### HTTP Integration Service Setup

Source: https://thingsboard.io/docs/paas/user-guide/integrations/remote

Commands to download, install, configure, and start the HTTP integration service.

```bash
wget https://dist.thingsboard.io/tb-http-integration-4.3.1.4pe.deb
```

```bash
sudo dpkg -i tb-http-integration-4.3.1.4pe.deb
```

```bash
sudo nano /etc/tb-http-integration/conf/tb-http-integration.conf
```

```bash
# UNCOMMENT NEXT LINES AND PUT YOUR CONNECTION PARAMETERS:
export RPC_HOST=thingsboard.cloud
export RPC_PORT=9090
export INTEGRATION_ROUTING_KEY=YOUR_INTEGRATION_KEY
export INTEGRATION_SECRET=YOUR_INTEGRATION_SECRET
```

```bash
sudo service tb-http-integration start
```

--------------------------------

### Install and start Cassandra

Source: https://thingsboard.io/docs/edge/pe/installation/rhel

Updates system packages, installs Cassandra, and starts the service.

```bash
sudo yum update
sudo yum install cassandra
sudo service cassandra start
```

--------------------------------

### Complete Installation and Start Service

Source: https://thingsboard.io/docs/edge/pe/installation/rpi

Executes the installation script and starts the ThingsBoard Edge service.

```bash

sudo /usr/share/tb-edge/bin/install/install.sh
```

```bash

sudo service tb-edge start
```

--------------------------------

### Execute installation and start service

Source: https://thingsboard.io/docs/edge/installation/rpi

Runs the installation script and starts the ThingsBoard Edge service.

```bash
sudo /usr/share/tb-edge/bin/install/install.sh
```

```bash
sudo service tb-edge start
```

--------------------------------

### Install and configure Cassandra

Source: https://thingsboard.io/docs/installation/rhel?database=hybrid

Install the Apache Cassandra repository, install the package, and start the service.

```bash
sudo rpm --import https://downloads.apache.org/cassandra/KEYS
sudo tee /etc/yum.repos.d/cassandra.repo > /dev/null <<'EOF'
[cassandra]
name=Apache Cassandra
baseurl=https://redhat.cassandra.apache.org/50x/
gpgcheck=1
repo_gpgcheck=0
gpgkey=https://downloads.apache.org/cassandra/KEYS
EOF
sudo dnf -y update && sudo dnf -y install cassandra cassandra-tools chkconfig
sudo systemctl daemon-reexec
sudo systemctl start cassandra.service
sudo chkconfig cassandra on
```

--------------------------------

### Quickstart Java client example

Source: https://thingsboard.io/docs/edge/reference/java-client

An end-to-end example demonstrating how to authenticate, create a device, push telemetry, and delete the device using the ThingsboardClient.

```java
import org.thingsboard.client.ApiException;
import org.thingsboard.client.ThingsboardClient;
import org.thingsboard.client.model.Device;


public class Quickstart {
  public static void main(String[] args) throws ApiException {
      ThingsboardClient client = ThingsboardClient.builder()
          .url("http://localhost:8080")
          .apiKey("YOUR_API_KEY_VALUE")
          .build();


      Device newDevice = new Device();
      newDevice.setName("Quickstart Device");
      newDevice.setType("default");
      Device savedDevice = client.saveDevice(newDevice, null, null, null, null);


      String deviceId = savedDevice.getId().getId().toString();
      client.saveEntityTelemetry("DEVICE", deviceId, "ANY", """
          {"temperature": 22.4}
          """);
      System.out.println("Pushed telemetry to " + savedDevice.getName());


      client.deleteDevice(deviceId);
  }
}
```

--------------------------------

### Install and start ThingsBoard

Source: https://thingsboard.io/docs/installation/minikube-cluster-setup

Run the installation script, deploy third-party resources, and deploy ThingsBoard resources.

```bash
./k8s-install-tb.sh --loadDemo
```

```bash
./k8s-deploy-thirdparty.sh
```

```bash
./k8s-deploy-resources.sh
```

--------------------------------

### Install and Start PostgreSQL

Source: https://thingsboard.io/docs/edge/installation/ubuntu

Configures the repository and installs the PostgreSQL 16 service on Ubuntu.

```bash
# Automated repository configuration:
sudo apt install -y postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh


# Install and launch the PostgreSQL service:
sudo apt update
sudo apt -y install postgresql-16
sudo service postgresql start
```

--------------------------------

### Install and Start WebReport Service

Source: https://thingsboard.io/docs/pe/installation/rhel

Install the RPM package and start the WebReport system service.

```bash
sudo rpm -Uvh tb-web-report-4.3.1.4pe.rpm
sudo systemctl start tb-web-report
```

--------------------------------

### Execute installation script

Source: https://thingsboard.io/docs/edge/installation/ubuntu

Run the installation script from the root directory to complete the setup.

```bash
sudo /usr/share/tb-edge/bin/install/install.sh
```

--------------------------------

### Run the site locally

Source: https://thingsboard.io/docs/user-guide/contribution/how-to-contribute-your-device-integration-guide

Commands to install dependencies and start the development server.

```bash
pnpm install
pnpm dev
```

--------------------------------

### Quickstart: Authenticate, create device, and push telemetry

Source: https://thingsboard.io/docs/edge/pe/reference/java-client

A complete example demonstrating how to initialize the client, create a device, send telemetry data, and delete the device.

```java
import org.thingsboard.client.ApiException;
import org.thingsboard.client.ThingsboardClient;
import org.thingsboard.client.model.Device;


public class Quickstart {
  public static void main(String[] args) throws ApiException {
      ThingsboardClient client = ThingsboardClient.builder()
          .url("http://localhost:8080")
          .apiKey("YOUR_API_KEY_VALUE")
          .build();


      Device newDevice = new Device();
      newDevice.setName("Quickstart Device");
      newDevice.setType("default");
      Device savedDevice = client.saveDevice(newDevice, null, null, null, null, null, null);


      String deviceId = savedDevice.getId().getId().toString();
      client.saveEntityTelemetry("DEVICE", deviceId, "ANY", """
          {"temperature": 22.4}
          """);
      System.out.println("Pushed telemetry to " + savedDevice.getName());


      client.deleteDevice(deviceId);
  }
}
```

--------------------------------

### Post-Install Gateway Launch

Source: https://thingsboard.io/docs/iot-hub/contribution-guides/device

Example of how to present the download button and start command in post-install instructions.

```markdown
## Launch Gateway


Download the configuration file and start the gateway:


${gateway.downloadButton}


Then run in the same directory:


```bash
docker compose up -d
```


The gateway will connect to **${mqtt.host}:${mqtt.port}**.
```

--------------------------------

### Quickstart: Authenticate, create device, and push telemetry

Source: https://thingsboard.io/docs/edge/pe/reference/python-client

An end-to-end example demonstrating authentication with an API key, device creation, telemetry submission, and cleanup.

```python
import json
from tb_pe_client import ThingsboardClient
from tb_pe_client.models import Device


with ThingsboardClient("http://localhost:8080", api_key="YOUR_API_KEY_VALUE") as client:
  saved = client.save_device(Device(name="Quickstart Device", type="default"))
  device_id = str(saved.id.id)


  client.save_entity_telemetry(
      entity_type="DEVICE",
      entity_id=device_id,
      scope="ANY",
      body=json.dumps({"temperature": 22.4}),
  )
  print(f"Pushed telemetry to {saved.name}")


  client.delete_device(device_id=device_id)
```

--------------------------------

### Install Steps Configuration Example

Source: https://thingsboard.io/docs/iot-hub/contribution-guides/device

A complete example of an installSteps array demonstrating the sequence of forms, entity creation, and instructions. Note that converter steps must precede the integration step.

```json
"installSteps": {
  "INTEGRATION_TTN": [
    {"type": "SHOW_FORM", "name": "TTN Settings", "file": "ttn/form.json"},
    {"type": "DEVICE_PROFILE", "name": "Acme Sensor", "template": "common/device-profile.json"},
    {"type": "UPLINK_CONVERTER", "name": "Acme Decoder", "template": "ttn/uplink.json"},
    {"type": "DOWNLINK_CONVERTER", "name": "Acme Encoder", "template": "ttn/downlink.json"},
    {"type": "INTEGRATION", "name": "${deviceName} - TTN", "template": "ttn/integration.json"},
    {"type": "DEVICE", "name": "${deviceName}", "template": "common/device.json"},
    {"type": "DASHBOARD", "name": "Monitor", "template": "common/dashboard.json"},
    {"type": "SHOW_INSTRUCTION", "name": "Setup Complete", "file": "ttn/post-install.md"}
  ]
}
```

--------------------------------

### Run initial database setup

Source: https://thingsboard.io/docs/installation/aws-monolith

Execute the installation script to initialize the database. The --loadDemo argument is optional for loading demo data.

```bash
./k8s-install-tb.sh --loadDemo
```

--------------------------------

### Initialize database with demo data

Source: https://thingsboard.io/docs/installation/docker-windows

Run this command to initialize the database schema and load sample tenant accounts, dashboards, and devices.

```bash
docker compose run --rm -e INSTALL_TB=true -e LOAD_DEMO=true thingsboard-ce
```

--------------------------------

### Install PostgreSQL 16

Source: https://thingsboard.io/docs/installation/rpi

Install and start the PostgreSQL 16 database server.

```bash
sudo apt install -y postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
sudo apt update
sudo apt -y install postgresql-16
sudo service postgresql start
```

--------------------------------

### Handle GET Response

Source: https://thingsboard.io/docs/iot-gateway/config/bacnet

Example JSON response from a GET RPC operation.

```json
{"result": {"value":  "inactive"}}
```

```json
{"result": {"value":  "active"}}
```

--------------------------------

### SHOW_INSTRUCTION Step Configuration

Source: https://thingsboard.io/docs/iot-hub/contribution-guides/device

Displays a markdown file to the user during the installation process.

```json
{"type": "SHOW_INSTRUCTION", "name": "Prerequisites", "file": "prerequisites.md"}
```

--------------------------------

### Run installation script

Source: https://thingsboard.io/docs/installation/gcp-microservices

Execute the installation script with the --loadDemo flag to initialize the environment.

```bash
./k8s-install-tb.sh --loadDemo
```

```text
Installation finished successfully!
```

--------------------------------

### Install Gateway package

Source: https://thingsboard.io/docs/iot-gateway/installation/source-installation

Install the Gateway package using the setup script.

```bash
python setup.py install
```

--------------------------------

### Install PostgreSQL 18

Source: https://thingsboard.io/docs/installation/ubuntu

Commands to install and start the PostgreSQL 18 service on Ubuntu.

```bash
sudo apt install -y postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
sudo apt update && sudo apt -y install postgresql-18
sudo systemctl start postgresql
```

--------------------------------

### FTP GET Example and Response

Source: https://thingsboard.io/docs/iot-gateway/features/reserved-rpc

Example of reading a file named light_level.txt from an FTP server.

```text
get filePath=./light_level.txt;
```

```text
{"result": 30}
```

--------------------------------

### Start ThingsBoard Edge service

Source: https://thingsboard.io/docs/edge/installation/ubuntu

Start the service after installation to access the Edge UI at http://localhost:8080.

```bash
sudo service tb-edge start
```

--------------------------------

### Initialize a new project

Source: https://thingsboard.io/docs/paas/user-guide/cli

Create a new directory and initialize it as a ThingsBoard project.

```bash
mkdir my-iot-project && cd my-iot-project && tb init
```

--------------------------------

### External API GET Example and Response

Source: https://thingsboard.io/docs/iot-gateway/features/reserved-rpc

Example of reading light level from a configured base URL.

```text
get requestUrlExpression=light-level;
```

```text
{"result": "{\"light-level\":30}"}
```

--------------------------------

### REST GET Example and Response

Source: https://thingsboard.io/docs/iot-gateway/features/reserved-rpc

Example of reading a light level from a REST endpoint and the resulting JSON response.

```text
get requestUrlExpression=http://127.0.0.1:8000/light-level;value=${params};
```

```text
{"result": {"light-level": 30}}
```

--------------------------------

### Install and start PostgreSQL 18

Source: https://thingsboard.io/docs/installation/rhel?database=hybrid

Disable the default module, install PostgreSQL 18, initialize the database, and enable the service.

```bash
sudo dnf -qy module disable postgresql
sudo dnf -y install postgresql18 postgresql18-server postgresql18-contrib
sudo /usr/pgsql-18/bin/postgresql-18-setup initdb
sudo systemctl enable --now postgresql-18
```

--------------------------------

### REST SET Example and Verification

Source: https://thingsboard.io/docs/iot-gateway/features/reserved-rpc

Example of setting a light level via POST and verifying the change with a GET request.

```text
set requestUrlExpression=http://127.0.0.1:8000/light-level;value=80;HTTPMethod=POST;
```

```text
{"result": {"status": "ok"}}
```

```text
get requestUrlExpression=http://127.0.0.1:8000/light-level;value=${params};
```

```text
{"result": {"light-level": 80}}
```
Tokens:
Raw