Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/02 02:09

From version < 92.1 >

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

To version < 93.1 >

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

Change comment: Mar 7 edits -part 1

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -17,230 +17,75 @@
  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. Add New Device =
--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. Data Converters =
--[[image:device-list-empty.png]]
++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.
--On the **Devices **page, click on the ‘**+**’ button, and then click on the **Add new device **from the dropdown menu.
--[[image:ThingsBoard-add-new-device.png||height="279" width="500"]]
++== 2.1 Uplink ==
--The **Add new device** window appears. Name the device, for example '**Virtual NB/CB device**'.
++In the left navigation, click **Integrations center**, and then click **Data converters**.
--Click on the **Next: Credentials** button.
--[[image:new-device-device-details.png||height="529" width="500"]]
++[[image:data-converters-list-empty.png]]
--Click the **Access token** button if it is not selected by default.
--Copy the **Access token** to a text editor, as you will need it in the section **'Sending data from an MQTT client'**.
++On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
--Click on the **Add** button.
--[[image:new-device-access-token.png||height="528" width="500"]]
++[[image:create-new-converter-menu.png||height="259" width="500"]]
--Click on the **MQTT** 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.
--
--{{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.
--
--[[image:new-device-check-connectivity.png||height="522" width="500"]]
--
--
--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.
--
--
--[[image:mqtt-command-1.png||height="228" width="700"]]
--
--
--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.
--
--
--[[image:new-device-telemetry-test.png||height="520" width="500"]]
--
--
--Send the same command again, only changing the **temperature** value, to see how the **Latest telemetry** section updates its data.
--
--Once you are done experimenting with this, close the window by clicking the **Close** button.
--
--
--[[image:mqtt-command-2.png||height="227" width="700"]]
--
--
--
--[[image:virtual-device-active.png]]
--
--
--= 3. 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.
--
--
--== 3.1 Uplink ==
--
--
--In the left navigation, click **Integrations center**, and then click **Data converters**.
--
--[[image:data-converter-list-page.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"]]
--
--
  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
--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.
++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.
  {{code language="JavaScript"}}
--//Version: 0.1
++/** Decoder **/
++
  // decode payload to string
  var payloadStr = decodeToString(payload);
++var data = JSON.parse(payloadStr);
++var deviceName =  metadata.topic.split("/")[3];
  // decode payload to JSON
--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();
++var deviceType = 'sensor';
--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]
--            },
--        })
--    }
--}
++// Result object with device attributes/telemetry data
  var result = {
--
      deviceName: deviceName,
--    deviceType: modelname,
++    deviceType: deviceType,
      attributes: {
--        model: modelname,
--        //customerName: "NB-CB",
--        //groupName: "NB-CB",
--        //integrationName: metadata['integrationName']
--
++        integrationName: metadata['integrationName'],
      },
--    telemetry: listdata
--}
++    telemetry: {
++        temperature: data.temperature,
++        humidity: data.humidity,
++    }
++};
--function decodeToString(payload) {
--    return String.fromCharCode.apply(String, payload);
--}
++/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
--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"]]
--You should see that the newly added **uplink data converter** is listed on the **Data Converters** page.
++[[image:add-uplink-data-converter.png||height="529" width="500"]]
++
++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]]
@@ -254,32 +254,41 @@
  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
--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.
++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.
  {{code language="JavaScript"}}
--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);
--}
++// Encode downlink data from incoming Rule Engine message
++// 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: "BINARY",
++    contentType: "JSON",
      // downlink data
--    data:hexToBase64(metadata.shared_value)
++    data: JSON.stringify(data),
      // Optional metadata object presented in key/value format
--    //metadata: {}
++    metadata: {
++            topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
++    }
  };
@@ -289,17 +289,20 @@
  Click on the **Add** button.
--[[image:downlink-data-converter.png||height="530" width="500"]]
--You should see that the newly added **downlink data converter** is listed on the **Data Converters** page.
++[[image:add-downlink-data-converter.png||height="529" width="500"]]
--[[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**.
  On the **Integrations** page, click on the '**+**' button.
@@ -344,13 +344,16 @@
  **Connection:**
--* **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)
++* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
++* **Port**: 8883
  * **Credentials**: Basic
--* **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
++* **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
++* **Clean session:** NO
++* **Retained**: NO
  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.