Deploy with IoT Gateway

ThingsBoard Edge can run alongside the ThingsBoard IoT Gateway on the same device. The IoT Gateway collects data from local sensors and legacy protocols, translates it into ThingsBoard-compatible format, and sends it to the Edge. The Edge rule engine processes it in real time and synchronizes results with the central server.

• Docker installed on the IoT Gateway device.
• A ThingsBoard server account (Cloud, Professional Edition, or Community Edition).
• A Linux-based IoT Gateway device with SSH access.

Go to Edge management → Instances and click + → Add new edge. Enter a name for the Edge instance and click Add. The new Edge instance appears at the top of the list.

Connect to the device over SSH:

ssh username@ip_address

Replace username and ip_address with your device credentials. If SSH runs on a non-default port, add -p <port> to the command.

1. Create a directory for the Edge service:

   mkdir tb_edge

2. Inside that directory, create a docker-compose.yml file:

   nano docker-compose.yml

3. On the server, go to Edge management → Instances, click the Edge instance, and click Install & Connect Instructions.

4. Select the Docker tab, copy the configuration lines, paste them into docker-compose.yml, and save the file.

   Click Install & Connect Instructions on the Edge details page. Select the Docker tab and copy the configuration lines. Step 4: Paste the configuration into docker-compose.yml and save. Press CTRL+X to close.

5. Start the Edge container:

   docker compose up -d
   docker compose logs -f mytbedge

   Run both commands from the tb_edge directory.

To verify Edge started successfully, log in to the Edge UI and go to Edge → Status. The Status field should show Connected.

To access the Edge UI from your local machine, open another terminal tab and set up SSH port forwarding:

ssh -N -L 8080:127.0.0.1:8080 username@ip_address

• 8080 (first): The port on your local machine.
• 127.0.0.1: The target host accessible from the IoT Gateway device.
• 8080 (second): The port on the IoT Gateway device.
• username: The username with access to the device.
• ip_address: The IP address of the device.

Any connection to localhost:8080 on your local machine is forwarded to 127.0.0.1:8080 on the IoT Gateway device. Open http://127.0.0.1:8080 and log in with your tenant credentials.

1. Log in to your ThingsBoard server, go to Edge management → Instances, and click Manage dashboards next to the Edge instance.

2. Click Add (+), select the ThingsBoard IoT Gateways dashboard from the drop-down menu, and click Assign. The ThingsBoard IoT Gateways dashboard is a built-in dashboard available on every ThingsBoard installation.

3. Open the Edge instance at http://127.0.0.1:8080, log in with your tenant credentials, and go to Dashboards. Open the ThingsBoard IoT Gateways dashboard.

4. Click Add (+), enter the gateway name in the Name field, select the default device profile, and click Create.

5. Download the docker-compose.yml file for the IoT Gateway from the Launch command pop-up window.

Step 1: Go to Edge management → Instances and click Manage dashboards. Step 2: Select the ThingsBoard IoT Gateways dashboard and click Assign. Step 3: Open the ThingsBoard IoT Gateways dashboard on Edge. Step 4: Enter a gateway name, select the default device profile, and click Create. Step 5: Download the docker-compose.yml file from the Launch command dialog.

Connect to the device over SSH:

ssh username@ip_address

1. Create a directory for the IoT Gateway service:

   mkdir iot_gateway

2. Inside that directory, create a docker-compose.yml file:

   nano docker-compose.yml

3. Paste the contents of the downloaded docker-compose.yml into the new file and save it. Press CTRL+X to close.

   

4. Start the IoT Gateway:

   docker compose up -d
   docker compose logs -f

To verify the IoT Gateway connected successfully, open the ThingsBoard IoT Gateways dashboard on the Edge instance. The gateway device should appear in the list with an active status.