Template:Networking rutos Thingsboard.io: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
(37 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<p style="color:red">The information on this page is updated in accordance with the [https://wiki.teltonika-networks.com/view/FW_%26_SDK_Downloads'''00.07.10'''] firmware version .</p>
__TOC__
 


==Introduction==
==Introduction==


This article contains instructions on how to configure ThingsBoard IoT platform and connect Teltonika-Networks devices. [https://thingsboard.io/ ThingsBoard IoT platform ] is an open-source IoT platform for data collection, processing, visualization, and device management. It enables device connectivity via industry standard IoT protocols - MQTT, CoAP and HTTP and supports both cloud and on-premises deployments. ThingsBoard combines scalability, fault-tolerance and performance so you will never lose your data.
This article contains instructions on how to configure Thingsboard.io platform and connect a Teltonika-Networks devices.


==Configuring ThingsBoard IoT platform==
==Connect device==




The goal of this tutorial is to demonstrate the basic usage of the most popular ThingsBoard features which helps monitor Teltonika-Networks devices.
The goal of this tutorial is to demonstrate the basic usage of the most popular ThingsBoard features which helps monitor Teltonika-Networks devices.First, you need to login into the platform. Next, you will see an overview window, scroll down to <b>Device managment</b> section or simply click on the <b>Device group</b> in the navigation  menu.


First, you need to login into the platform. Next, you will see an overview window, scroll down to <b>Entities</b> section and simply click on the <b>Device</b> in the navigation menu.
[[File:Thingboards_io_Overview_page.png]]


<ol>
<li>1. Click on one of the marked in red buttons in the <b>Device groups</b> overview page.</li>
    <li> Click on one of the marked in red buttons in the overview page <b> Entities → Devices</b>. In this page you can also add additional device in order to distinguish different devices with unique data flows.</li>
<li>2. Click marked "<b>+</b>" buttons to add new device to the group.</li>
    <li> Click marked "<b>+</b>" buttons to add new device to the group.</li>
[[File:Thingboards_io_device_groups.png]]
</ol>
<li>1. In the pop up window set name for your device.</li>
[[File:1111.png]]
<li>2. Configure your device's <b>Access token</b>(Optional)</li>
[[File:Thingboards_io_add_new_device.png]]
<li>1. Enable <b>Add credentials</b> option.</li>
<li>2. Set desirable <b>Access token</b>. </li>
<li>3. Click <b>Add</b> button  to save changes. </li>
[[File:Thingboards_io_configuring_credentials.png]]


==Configuring data source==


<ol>
    <li> In the pop up window set name for your device.</li>
    <li> Configure your device's <b>Label</b> (Optional)</li>
</ol>
[[File:22222222222.png]]


Different data streams can be selected depending on the device's supported functionality's. In this example we will be using <b>Modbus TCP slave</b> with native <b> Modbus TCP master </b> functionality.


<li>1. First, change WEBUI mode from <b>basic</b> to <b>advanced</b>.</li>
[[File:Networking_rutx_manual_webui_basic_advanced_mode.gif|border|class=tlt-border]]
<li>2. Go to <b>Services → Modbus TCP slave</b> page.</li>
<li>3. Enable <b>Modbus TCP slave</b>.</li>
[[File:Thingboards_io_Modbus_TCP_slave.png]]
<li>4. Go to <b>Modbus TCP master</b> page and add new slave device.</li>
[[File:Thingboards_io_Modbus_TCP_master.png]]
<li>5. Configure <b>Modbus TCP master's slave device</b> as shown below to return device's uptime value.</li>
[[File:Thingboards_io_Modbus_TCP_master_device.png]]


==== Credentials type: Access token (HTTP protocol) ====
==Configuring data to server==
----
<ol>
    <li> Enable <b>Add credentials</b> option.</li>
    <li> Set desirable <b>Access token</b>.
    <li> Click <b>Add</b> button  to save changes. </li>
</ol>
[[File:33333333.png |border|class=tlt-border]]
 
=== Credentials type: MQTT Basic ===
----
<ol>
    <li> Enable <b>Add credentials</b> option.</li>
    <li> Choose Credentials type:<b>MQTT  Basic</b>.</li>
    <li> Set username which will be  used in MQTT authorization.</li>
    <li> Set password which will be  used in MQTT authorization.</li>
    <li>  Click <b>Add</b> button  to save changes. </li>
</ol>
[[File:44444444444.png]]
 
==Preparing data source==
 
 
Different data streams can be selected depending on the device's supported functionality's. In this example we will be using <b>Modbus TCP Server</b> with native <b> Modbus TCP Client </b> functionality.
 
1. First, change WEBUI mode from <b>basic</b> to <b>advanced</b>.<br>
[[File:Networking_rutos_manual_webui_basic_advanced_mode_75.gif|border|center|class=tlt-border|1102x93px]]
2. Go to <b>Services → Modbus → Modbus TCP Server</b> page.<br>
3. Enable <b>Modbus TCP Server</b>.<br>
[[File:Networking_RutOS_Thingsboard_config_example_1.png|border|class=tlt-border]]
----
 
4. Go to <b>Services → Modbus → Modbus TCP Client</b> page and add new Server device.<br>
[[File:Networking_RutOS_Thingsboard_config_example_2.png|border|class=tlt-border|1100px]]
 
----
 
5. Configure <b>Modbus TCP master's Server device</b>:<br>
#'''Enable''' the instance;
#Choose your desired '''Name''' for the instance;
#Choose your device's address, in this case, we are using routers address - '''192.168.11.1''';
#Choose the period on how often the data should be sent, in this case we use '''10''';
[[File:Networking_RutOS_Thingsboard_config_example_3.png|border|class=tlt-border]]
 
----
 
6. Add a new instance of request and configure it by your needs. In this example, we will get the devices uptime:
#Click on '''Add''' button;
#Choose the '''Data type''' - 32bit UINT, Byte order 1,2,3,4;
#Choose the '''Function''' - Read holding register (3);
#Write the '''First register number''' - 2;
#Write the '''Register count / Values''' - 2;
#'''Enable''' the request;
#Click on '''Test''' button, to see if the request is configured correctly as shown below;
[[File:Networking_RutOS_Thingsboard_config_example_4.png|border|class=tlt-border|1100px]]
 
==Configuring data to server with HTTP protocol==


After configuring the data source, you can add a data sender configuration. Data sender functionality is located  <b>Services → Data to server</b>. You can add data sender by clicking <b>Add</b> button.
After configuring the data source, you can add a data sender configuration. Data sender functionality is located  <b>Services → Data to server</b>. You can add data sender by clicking <b>Add</b> button.


[[File:Networking_RutOS_Thingsboard_config_example_5.png|border|class=tlt-border|1100px]]
[[File:Thingboards_io_Thingboards_io_Data_to_server_HTTP.png]]
 
<li>1. Set name for the <b>Data sender</b>.</li>
* Configure '''Data''':
<li>2. Set desirable name for your data variable. Make sure that your chosen parameter is shown below JSON format field.</li>
 
<li>3. Paste connection string with your own <b>Access token</b>.</li>
#Choose your desired '''Name''' for the instance;
<pre>https://thingsboard.cloud/api/v1/YOUR_ACCESS_TOKEN/telemetry</pre>
#Choose Type - '''Modbus''';
<li>4. Add value to Custom header. </li>
#Choose Format Type - '''Custom''';
<pre>Content-Type:application/json</pre>
#Choose the '''data''' that you want to send;
[[File:Thingboards_io_data_sender_configuration.png]]
#Once done configuring, click on '''Next: collection edit''' button;
 
[[File:Networking_RutOS_Thingsboard_config_example_6.png|border|class=tlt-border]]
 
* In Collection configuration, we can leave default settings, so we can move onto '''Server configuration''':


[[File:Networking_RutOS_Thingsboard_config_example_7.png|border|class=tlt-border|1100px]]
* Configure '''Server instance''':
#Type - '''HTTP''';
#Server address - '''https://thingsboard.cloud/api/v1/<your_access_token_here>/telemetry''';
#HTTP headers - '''Content-Type:application/json'''
[[File:Networking_RutOS_Thingsboard_config_example_8.png|border|class=tlt-border|1100px]]
==Configuring data to server with MQTT protocol==
After configuring the data source, you can add a data sender configuration. Data sender functionality is located  <b>Services → Data to server</b>. You can add data sender by clicking <b>Add</b> button.
[[File:Networking_RutOS_Thingsboard_config_example_5.png|border|class=tlt-border|1100px]]
* Configure '''Data''':
#Choose your desired '''Name''' for the instance;
#Choose Type - '''Modbus''';
#Choose Format Type - '''Custom''';
#Choose the '''data''' that you want to send;
#Once done configuring, click on '''Next: collection edit''' button;
[[File:Networking_RutOS_Thingsboard_config_example_6.png|border|class=tlt-border]]
* In Collection configuration, we can leave default settings, so we can move onto '''Server configuration''':
[[File:Networking_RutOS_Thingsboard_config_example_7.png|border|class=tlt-border|1100px]]
* Configure '''Server instance''':
#Type - '''MQTT;
#Server address - '''thingsboard.cloud''';
#Topic - '''/v1/devices/me/telemetry''';
#Client ID - '''Generated ID from ThingsBoard''';
#Username - '''Created Username from ThingsBoard''';
#Password - '''Created Password from ThingsBoard''';
[[File:Networking_RutOS_Thingsboard_config_example_9.png|border|class=tlt-border|1100px]]
==Adding widget to the dashboard==
==Adding widget to the dashboard==


The collected data can be displayed using various a widgets. To create one you should be able to see gathered data in the <b>Latest telemetry </b> section. To access it you should follow these steps:
The collected data can be displayed using various a widgets. To create one you should be able to see gathered data in the <b>Latest telemetry </b> section. To access it you should follow these steps:
<ol>
<li>1. Click on the configured device. </li>
    <li> Click on the configured device. </li>
<li>2. From the pop-up menu select <b>Latest telemetry </b> option. There you should see collected data.</li>
    <li> From the pop-up menu select <b>Latest telemetry </b> option. There you should see collected data.</li>
[[File:Thingboards_io_latest_telemetry.png]]
</ol>
[[File:500.png]]
 
 


In order to display data in the widget you should:
In order to display data in the widget you should:
<ol>
<li>1. Click on the gathered data row.</li>
    <li> Click on the gathered data row.</li>
<li>2. Press <b>Show on  widget </b> button.</li>
    <li> Press <b>Show on  widget </b> button.</li>
[[File:Thingboards_io_latest_telemetry_data.png]]
</ol>
<li>1. Choose bundle accordingly to your data.</li>
[[File:600.png]]
<li>2. Choose suitable chart for your data visualization.</li>
<ol>
<li>3. Add widget to dashboard.</li>
    <li> Choose bundle accordingly to your data.</li>
[[File:Thingboards_io_charts.png]]
    <li> Choose suitable chart for your data visualization.</li>
<li>1. Create new dashboard. </li>
    <li> Add widget to dashboard.</li>
<li>2. With this option enabled after addition you will be redirected to newly created dashboard</li>
</ol>
<li>3. Adds widget to dashboard.</li>
[[File:700.png]]
[[File:Thingboards_io_adding_widget.png]]
<ol>
    <li> Create new dashboard. </li>
    <li> With this option enabled after addition you will be redirected to newly created dashboard</li>
    <li> Adds widget to dashboard.</li>
</ol>
[[File:1000000.png]]




[[File:2- Dashbord.png]]
[[File:Thingboards_io_dashboard.png]]


==See also==
==See also==


* https://thingsboard.io/docs/getting-started-guides/helloworld-pe/
*https://thingsboard.io/docs/getting-started-guides/helloworld-pe/
[[Category:{{{name}}} Configuration Examples]]

Revision as of 02:53, 5 January 2021


Introduction

This article contains instructions on how to configure Thingsboard.io platform and connect a Teltonika-Networks devices.

Connect device

The goal of this tutorial is to demonstrate the basic usage of the most popular ThingsBoard features which helps monitor Teltonika-Networks devices.First, you need to login into the platform. Next, you will see an overview window, scroll down to Device managment section or simply click on the Device group in the navigation menu.

  • 1. Click on one of the marked in red buttons in the Device groups overview page.
  • 2. Click marked "+" buttons to add new device to the group.

  • 1. In the pop up window set name for your device.
  • 2. Configure your device's Access token(Optional)

  • 1. Enable Add credentials option.
  • 2. Set desirable Access token.
  • 3. Click Add button to save changes.

    • Configuring data source

    Different data streams can be selected depending on the device's supported functionality's. In this example we will be using Modbus TCP slave with native Modbus TCP master functionality.

  • 1. First, change WEBUI mode from basic to advanced.

  • 2. Go to Services → Modbus TCP slave page.
  • 3. Enable Modbus TCP slave.

  • 4. Go to Modbus TCP master page and add new slave device.

  • 5. Configure Modbus TCP master's slave device as shown below to return device's uptime value.

    • Configuring data to server

    After configuring the data source, you can add a data sender configuration. Data sender functionality is located Services → Data to server. You can add data sender by clicking Add button.

  • 1. Set name for the Data sender.
  • 2. Set desirable name for your data variable. Make sure that your chosen parameter is shown below JSON format field.
  • 3. Paste connection string with your own Access token.
    • https://thingsboard.cloud/api/v1/YOUR_ACCESS_TOKEN/telemetry
  • 4. Add value to Custom header. 
    • Content-Type:application/json

    Adding widget to the dashboard

    The collected data can be displayed using various a widgets. To create one you should be able to see gathered data in the Latest telemetry section. To access it you should follow these steps:

  • 1. Click on the configured device.
  • 2. From the pop-up menu select Latest telemetry option. There you should see collected data.

    • In order to display data in the widget you should:

  • 1. Click on the gathered data row.
  • 2. Press Show on widget button.

  • 1. Choose bundle accordingly to your data.
  • 2. Choose suitable chart for your data visualization.
  • 3. Add widget to dashboard.

  • 1. Create new dashboard.
  • 2. With this option enabled after addition you will be redirected to newly created dashboard
  • 3. Adds widget to dashboard.

    • See also

    [[Category:{{{name}}} Configuration Examples]]

    Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_Thingsboard.io&oldid=76646"