Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23

From 89.1 to 88.1 From 119.1 to 118.1

From version 118.1

edited by Dilisi S
on 2025/03/08 20:20

Change comment: Uploaded new attachment "hivemq-8.png", version {1}

To version 89.1

edited by Dilisi S
on 2025/03/08 03:43

Change comment: Uploaded new attachment "create-new-converter-menu.png", version {1}

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 21 removed)

Details

Page properties

Content

@@ -17,193 +17,269 @@
  The **NB series** devices end with the suffix **-NB**, and the **CB series** devices end with the suffix **-CB**. For example, **S31B-NB** is an **NB device**, and **S31-CB** is a **CB device**.
--= 2. Prerequisites =
++= 2. Add New Device =
--To complete this tutorial, you need to have the following:
--* ThingsBoard cloud account -
--* HiveMQ Cloud account
++First, we will add a device to simulate data using MQTT. This device does not represent a real physical device but serves as a common virtual device for all Dragino NB/CB devices.
++In the left navigation, click **Entities** and then click **Devices**.
--== 2.1 HiveMQ Cloud ==
++[[image:device-list-empty.png]]
--Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
++On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
--Click on the **Start Free** button.
++[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
--[[image:hivwmq-1.png]]
++The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
--Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
++Click on the **Next: Credentials** button.
--[[image:hivemq-2.png]]
++[[image:new-device-device-details.png||height="529" width="500"]]
--Click on the **Sign Up** button.
++Click the **Access token** button if it is not selected by default.
--You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
++Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
--If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
++Click on the **Add** button.
++[[image:new-device-access-token.png||height="528" width="500"]]
--[[image:hivemq-3.png]]
++Click on the **MQTT** button.
--You will receive an email to verify your email address. Click on the **Confirm my account** button.
++Then, select the operating system you are going to use with the **Mosquitto MQTT Broker**. This example shows sending a command from a computer running **MacOS**. First, install the necessary client tools on your computer.
++Copy the MQTT pub command in the '**Execute the following command**' section.
--[[image:hivemq-4.jpg||height="889" width="400"]]
++{{code language="none"}}
++mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
++{{/code}}
++Note that the **State** is still shown as **'Inactive'** in the **Latest telemetry** section.
--You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
++[[image:new-device-check-connectivity.png||height="522" width="500"]]
--[[image:hivemq-5.png||height="655" width="700"]]
++On the terminal, enter the command you copied. This command sends the MQTT payload **{temperature:25}** as telemetry data from a virtual device named **'me'**. Of course, you can replace **'me'** with a device name or use the wildcard character **'+'** to match any device name.
--Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
++[[image:mqtt-command-1.png||height="228" width="700"]]
--[[image:hivemq-6.png]]
++If the command is successful, you can see the telemetry data you sent under the **Latest telemetry** section. Note that the **State** is now **'Active'** in the **Latest telemetry** section.
--You will be navigated  to the **Your Clusters** page. Click on the **Manage Cluster** button.
++[[image:new-device-telemetry-test.png||height="520" width="500"]]
--[[image:hivemq-7.png]]
++Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
--In your cluster page, you can find some useful parameters you need to create a MQTT connection.
++Once you are done experimenting with this, close the window by clicking the **Close** button.
--**URL**: This is the host name. Click on the copy button to copy it.
--**Port**: 8883
++[[image:mqtt-command-2.png||height="227" width="700"]]
--Click on the **Getting Started** tab to setup the username and the password.
++[[image:virtual-device-active.png]]
--[[image:hivemq-8.png]]
++= 3. Data Converters =
--= 2. Data Converters =
--
--
  In **ThingsBoard**, **Data Converters** are components used to transform incoming or outgoing data between different formats, typically to convert raw telemetry data from devices into a structured format that ThingsBoard can understand, or vice versa.
--== 2.1 Uplink ==
++== 3.1 Uplink ==
  In the left navigation, click **Integrations center**, and then click **Data converters**.
++[[image:data-converter-list-page.png]]
--[[image:data-converters-list-empty.png]]
++On the **Data converters** page, click on the ‘+’ button, and then click on the **Create new converter** from the dropdown menu.
++[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
--On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
--
--
--[[image:create-new-converter-menu.png||height="259" width="500"]]
--
--
  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
--Click on the **TBEL** button if not selected it by default. Delete the existing decoder function in the code editor. Now copy and paste the following decoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
++Click on the **JavaScript** button. Now copy and paste the following JavaScript to the **Decoder function** section. This decoder function is valid for both NB and CB series devices.
  {{code language="JavaScript"}}
--/** Decoder **/
--
++//Version: 0.1
  // decode payload to string
  var payloadStr = decodeToString(payload);
--var data = JSON.parse(payloadStr);
--var deviceName =  metadata.topic.split("/")[3];
  // decode payload to JSON
--var deviceType = 'sensor';
++var objdata = {};
++var obj1 = {};
++var data = decodeToJson(payload);
++var deviceName = data.IMEI;
++delete data.IMEI;
++var modelname = "Dragino " + data.Model;
++//var mod = data.mod
++delete data.Model;
++//delete data.mod
++var timestamp = new Date().getTime();
--// Result object with device attributes/telemetry data
++for (var key in data) {
++
++    if (Number(key)) {
++        obj1[key] = data[key];
++        obj1[key][obj1[key].length - 1] = Number(new Date(
++            obj1[key][obj1[key].length - 1]));
++
++    }
++//Alec submitted25/02/25
++//turn old key into new
++    else if (key === "Reading") {
++        objdata["reading"] = data[key];
++    } else if (key === "work mode") {
++        objdata["work_mode"] = data[key];
++    } else if (key === "hum") {
++        objdata["humidity"] = data[key];
++    }else if (key === "hum2") {
++        objdata["humidity2"] = data[key];
++    } else if (key === "hum3") {
++        objdata["humidity3"] = data[key];
++    } else if (key === "tem") {
++        objdata["temperature"] = data[key];
++    } else if (key === "tem2") {
++        objdata["temperature2"] = data[key];
++    } else if (key === "tem3") {
++        objdata["temperature3"] = data[key];
++    } else if (key === "DS18B20_Temp") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "ds18b20_temperature") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "DS18B20_temperature_pro") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "tdc send flag") {
++        objdata["tdc_send_flag"] = data[key];
++    } else if (key === "trigger mode") {
++        objdata["trigger_mode"] = data[key];
++    } else if (key === "soil dielectric constant") {
++        objdata["soil_dielectric_constant"] = data[key];
++    } else if (key === "door open num") {
++        objdata["door_open_num"] = data[key];
++    } else if (key === "door duration") {
++        objdata["door_duration"] = data[key];
++    } else if (key === "count time") {
++        objdata["count_time"] = data[key];
++    } else if (key === "last open time2") {
++        objdata["last_open_time2"] = data[key];
++    } else if (key === "last open time3") {
++        objdata["last_open_time3"] = data[key];
++    }
++//Alec submitted25/02/25
++    else {
++        objdata[key] = data[key]
++    }
++}
++var listdata = [{
++    "ts": timestamp,
++    "values": objdata
++}]
++for (var key1 in obj1) {
++    if (modelname == "Dragino RS485-NB") {
++        listdata.push({
++            "ts": obj1[key1][obj1[key1].length - 1],
++            "values": {
++                "Payload": obj1[key1][0],
++            }
++        })
++    } else {
++        listdata.push({
++            "ts": obj1[key1][obj1[key1].length - 1],
++            "values": {
++                "values": obj1[key1]
++            },
++        })
++    }
++}
  var result = {
++
      deviceName: deviceName,
--    deviceType: deviceType,
++    deviceType: modelname,
      attributes: {
--        integrationName: metadata['integrationName'],
++        model: modelname,
++        //customerName: "NB-CB",
++        //groupName: "NB-CB",
++        //integrationName: metadata['integrationName']
++
      },
--    telemetry: {
--        temperature: data.temperature,
--        humidity: data.humidity,
--    }
--};
++    telemetry: listdata
++}
--/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++function decodeToString(payload) {
++    return String.fromCharCode.apply(String, payload);
++}
++function decodeToJson(payload) {
++    // covert payload to string.
++    var str = decodeToString(payload);
++
++    // parse string to JSON
++    var data = JSON.parse(str);
++    return data;
++}
++
  return result;
++
  {{/code}}
  Click on the **Add** button.
++[[image:uplink-data-converter.png||height="529" width="500"]]
--[[image:add-uplink-data-converter.png||height="529" width="500"]]
++You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
--
--You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
--
  [[image:data-converter-list-showing-uplink-dc.png]]
--
  == 3.2 Downlink ==
  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
++[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
--[[image:create-new-converter-menu.png||width="500"]]
--
--
  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
--Click on the **TBEL** button if not selected it by default. Now copy and paste the following encoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This encoder function is compatible for both NB and CB series devices.
++Click on the **JavaScript** button. Now copy and paste the following JavaScript to the **Encoder function **section. This encoder function is valid for both NB and CB series devices.
  {{code language="JavaScript"}}
--// Encode downlink data from incoming Rule Engine message
++function hexToBase64(hexString) {
++    // 将16进制字符串两个字符转换为一个字节
++    var bytes = hexString.match(/.{2}/g);
++    // 对每个字节进行解析，并转换为对应的字符
++    var binaryString = bytes.map(function(byte) {
++        return String.fromCharCode(parseInt(byte, 16));
++    }).join('');
++
++    // 使用btoa进行base64编码
++    return btoa(binaryString);
++}
--// msg - JSON message payload downlink message json
--// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
--// metadata - list of key-value pairs with additional data about the message
--// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
--
--/** Encoder **/
--
--var data = {};
--
--// Process data from incoming message and metadata
--
--data.tempFreq = msg.temperatureUploadFrequency;
--data.humFreq = msg.humidityUploadFrequency;
--
--data.devSerialNumber = metadata['ss_serialNumber'];
--
  // Result object with encoded downlink payload
  var result = {
--
      // downlink data content type: JSON, TEXT or BINARY (base64 format)
--    contentType: "JSON",
++    contentType: "BINARY",
      // downlink data
--    data: JSON.stringify(data),
++    data:hexToBase64(metadata.shared_value)
      // Optional metadata object presented in key/value format
--    metadata: {
--            topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
--    }
++    //metadata: {}
  };
@@ -213,30 +213,24 @@
  Click on the **Add** button.
++[[image:downlink-data-converter.png||height="530" width="500"]]
--[[image:add-downlink-data-converter.png||height="529" width="500"]]
++You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
++[[image:data-converter-list.png]]
--You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
++= 4. Add Integration =
--[[image:data-converters-list.png]]
--
--
--= 3. Add Integration =
--
--
  In the left navigation, click **Integrations center**, and then click **Integrations**.
--
--[[image:integrations-list-empty.png]]
--
--
  On the **Integrations** page, click on the '**+**' button.
++[[image:data-converter-list-page.png]]
++
  The **Add integration** window appears.
  In the **Add integration** window, configure the following settings:
@@ -246,13 +246,9 @@
  * **Integration type**: MQTT
  * **Name**: MQTT integration NB/CB
--* **Enable integration**: YES
--* **Allows create devices or assets**: YES
  Click **Next** button.
--
--
  [[image:add-integration-basic-settings.png||height="511" width="500"]]
@@ -263,11 +263,9 @@
  Click **Next** button.
++[[image:add-integration-uplink-data-converter.png||width="500"]]
--[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
--
--
  **Downlink data converter:**
  * Click on the **Select existing** button.
@@ -275,56 +275,38 @@
  Click **Next** button.
++[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
--[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
--
--
  **Connection:**
--* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
--* **Port**: 8883
++* **Host**: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
++* **Port**: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
  * **Credentials**: Basic
--* **Enable SSL**: YES
--* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
--* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
--* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
--* **QoS:** 0-At most once
++* **Username**: Access token (This is the access token you copied from the device)
++* **Password** - Leave it as blank
++* **Topic** - v1/devices/+/telemetry (sightly modify the topic 'v1/devices/me/telemetry' you copied from the device to enable receiving data from any 'device name')
++* **QoS** - 0-At most once
--[[image:add-integration-connection.png||height="511" width="500"]]
--
--
--Click on the **Advanced settings** button.
--
--* **Clean session:** NO
--* **Retained**: NO
--
--[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
--
--
  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
++[[image:add-integration-connection.png||width="500"]]
--[[image:check-connection.png||height="83" width="300"]]
++If the connection is successful, you will see the **Connected** message.
--If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
++Click on the **Add** button.
++[[image:add-connection-success.png||height="511" width="500"]]
--[[image:connection-success.png||height="511" width="500"]]
--
--Click on the **Add** button.
--
  You should see that the newly added integration is listed on the **Integrations** page.
  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
++[[image:integrations-list-added-pending.png]]
--[[image:new-integration-pending.png]]
--
--
  = 5. Verifying the receipt of data from the device =
@@ -335,3 +335,5 @@
  {{/code}}
  If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “S31B-NB” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter  NB/CB → Events.
++
++

add-downlink-data-converter.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-175.2 KB

Content

add-integration-basic-settings.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-122.5 KB

Content

add-integration-connection-advanced-settings.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-155.2 KB

Content

add-integration-connection.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-124.4 KB

Content

add-integration-downlink-data-converter.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-123.0 KB

Content

add-integration-uplink-data-converter.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-120.7 KB

Content

add-uplink-data-converter.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-174.1 KB

Content

check-connection.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-14.7 KB

Content

connection-success.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-90.0 KB

Content

data-converter-list-showing-uplink-dc.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-194.9 KB

Content

data-converters-list.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-212.2 KB

Content

hivemq-2.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-300.7 KB

Content

hivemq-3.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-535.2 KB

Content

hivemq-4.jpg

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-309.8 KB

Content

hivemq-5.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-115.0 KB

Content

hivemq-6.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-321.0 KB

Content

hivemq-7.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-203.5 KB

Content

hivemq-8.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-268.7 KB

Content

hivwmq-1.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-380.3 KB

Content

integrations-list-empty.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-264.5 KB

Content

new-integration-pending.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.pradeeka

Size

...	...	@@ -1,1 +1,0 @@
1		-199.7 KB

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation