Wiki source code of ThingsBoard

Version 113.1 by Dilisi S on 2025/03/08 20:00

version	line-number	content
1.1	1	Table of Contents:
	2
	3	{{toc/}}
	4
16.1	5	{{warning}}
	6	Draft Document
	7	{{/warning}}
1.1	8
65.1	9
	10
	11
64.2	12	= 1. Introduction =
1.1	13
64.2	14
21.1	15	This document guides you on integrating Dragino -NB and -CB series devices data with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
2.1	16
21.1	17	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.
11.1	18
17.1	19
11.1	20
64.2	21
59.1	22
93.1	23	= 2. Data Converters =
11.1	24
	25
93.1	26	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.
11.1	27
	28
93.1	29	== 2.1 Uplink ==
11.1	30
	31
93.1	32	In the left navigation, click Integrations center, and then click Data converters.
11.1	33
59.1	34
	35
93.1	36	[[image:data-converters-list-empty.png]]
59.1	37
	38
93.1	39	On the Data converters page, click on the ‘+’ button, and then click on the Create new converter from the dropdown menu.
59.1	40
	41
	42
93.1	43	[[image:create-new-converter-menu.png\|\|height="259" width="500"]]
59.1	44
	45
36.1	46	The Add data converter window will appear. Name it ‘MQTT Uplink Converter NB/CB’ and select the Type as Uplink.
11.1	47
93.1	48	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.
11.1	49
	50	{{code language="JavaScript"}}
93.1	51	/ Decoder /
	52
11.1	53	// decode payload to string
	54	var payloadStr = decodeToString(payload);
93.1	55	var data = JSON.parse(payloadStr);
11.1	56
93.1	57	var deviceName = metadata.topic.split("/")[3];
11.1	58	// decode payload to JSON
93.1	59	var deviceType = 'sensor';
11.1	60
93.1	61	// Result object with device attributes/telemetry data
11.1	62	var result = {
	63	deviceName: deviceName,
93.1	64	deviceType: deviceType,
11.1	65	attributes: {
93.1	66	integrationName: metadata['integrationName'],
11.1	67	},
93.1	68	telemetry: {
	69	temperature: data.temperature,
	70	humidity: data.humidity,
	71	}
	72	};
11.1	73
93.1	74	/ Helper functions 'decodeToString' and 'decodeToJson' are already built-in /
11.1	75
	76	return result;
	77	{{/code}}
	78
64.2	79
21.1	80	Click on the Add button.
11.1	81
	82
	83
93.1	84	[[image:add-uplink-data-converter.png\|\|height="529" width="500"]]
11.1	85
93.1	86
	87	You should see that the newly added MQTT Uplink converter NB/CB is listed on the Data Converters page.
	88
105.1	89	[[image:data-converter-list-showing-uplink-dc.png]]
21.1	90
	91
94.1	92
64.2	93	== 3.2 Downlink ==
11.1	94
64.2	95
21.1	96	On the Data converters page, click on the ‘+’ button, and then click on the Create new converter from the dropdown menu.
11.1	97
	98
105.1	99	[[image:create-new-converter-menu.png\|\|width="500"]]
11.1	100
105.1	101
	102
36.1	103	The Add data converter window will appear. Name it ‘MQTT Downlink Converter NB/CB’ and select the Type as Downlink.
11.1	104
93.1	105	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.
11.1	106
	107
	108	{{code language="JavaScript"}}
93.1	109	// Encode downlink data from incoming Rule Engine message
11.1	110
93.1	111	// msg - JSON message payload downlink message json
	112	// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
	113	// metadata - list of key-value pairs with additional data about the message
	114	// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
	115
	116	/ Encoder /
	117
	118	var data = {};
	119
	120	// Process data from incoming message and metadata
	121
	122	data.tempFreq = msg.temperatureUploadFrequency;
	123	data.humFreq = msg.humidityUploadFrequency;
	124
	125	data.devSerialNumber = metadata['ss_serialNumber'];
	126
11.1	127	// Result object with encoded downlink payload
	128	var result = {
93.1	129
11.1	130	// downlink data content type: JSON, TEXT or BINARY (base64 format)
93.1	131	contentType: "JSON",
11.1	132
	133	// downlink data
93.1	134	data: JSON.stringify(data),
11.1	135
	136	// Optional metadata object presented in key/value format
93.1	137	metadata: {
	138	topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
	139	}
11.1	140
	141	};
	142
	143	return result;
	144	{{/code}}
	145
	146
	147	Click on the Add button.
	148
	149
	150
93.1	151	[[image:add-downlink-data-converter.png\|\|height="529" width="500"]]
21.1	152
	153
93.1	154	You should see that the newly added MQTT Downlink Converter NB/CB is listed on the Data Converters page.
21.1	155
11.1	156
93.1	157	[[image:data-converters-list.png]]
	158
105.1	159	(% class="wikigeneratedid" %)
	160
	161
93.1	162	= 3. Add Integration =
	163
	164
21.1	165	In the left navigation, click Integrations center, and then click Integrations.
11.1	166
105.1	167
	168	[[image:integrations-list-empty.png]]
	169
	170
21.1	171	On the Integrations page, click on the '+' button.
11.1	172
	173
21.1	174	The Add integration window appears.
11.1	175
24.1	176	In the Add integration window, configure the following settings:
11.1	177
21.1	178
11.1	179	Basic settings:
	180
49.1	181	* Integration type: MQTT
	182	* Name: MQTT integration NB/CB
105.1	183	* Enable integration: YES
	184	* Allows create devices or assets: YES
11.1	185
	186	Click Next button.
	187
105.1	188
	189
16.1	190	[[image:add-integration-basic-settings.png\|\|height="511" width="500"]]
11.1	191
	192
16.1	193	Uplink data converter:
11.1	194
21.1	195	* Click on the Select existing button.
49.1	196	* Uplink data converter: Select MQTT Uplink Converter NB/CB from the dropdown list.
16.1	197
	198	Click Next button.
	199
	200
	201
105.1	202	[[image:add-integration-uplink-data-converter.png\|\|height="511" width="500"]]
	203
	204
16.1	205	Downlink data converter:
	206
21.1	207	* Click on the Select existing button.
49.1	208	* Downlink data converter: Select MQTT Downlink Converter NB/CB from the dropdown list.
16.1	209
	210	Click Next button.
	211
	212
	213
105.1	214	[[image:add-integration-downlink-data-converter.png\|\|height="511" width="500"]]
	215
	216
16.1	217	Connection:
	218
93.1	219	* Host: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
	220	* Port: 8883
49.1	221	* Credentials: Basic
93.1	222	* Enable SSL: YES
	223	* Username: Username (from your HiveMQ Cloud Cluster with your credentials)
	224	* Password: Password (from your HiveMQ Cloud Cluster with your credentials)
	225	* Topic: tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
	226	* QoS: 0-At most once
105.1	227
	228
	229	[[image:add-integration-connection.png\|\|height="511" width="500"]]
	230
	231
	232	Click on the Advanced settings button.
	233
93.1	234	* Clean session: NO
	235	* Retained: NO
16.1	236
105.1	237	[[image:add-integration-connection-advanced-settings.png\|\|height="510" width="500"]]
	238
	239
49.1	240	Click on the Check connection button to verify the MQTT connection using the provided parameters.
16.1	241
49.1	242
	243
105.1	244	[[image:check-connection.png\|\|height="83" width="300"]]
	245
	246
49.1	247	If the connection is successful, you will see the Connected message.
	248
105.1	249
	250	[[image:connection-success.png\|\|height="511" width="500"]]
	251
	252
16.1	253	Click on the Add button.
	254
	255
	256
59.1	257	You should see that the newly added integration is listed on the Integrations page.
49.1	258
59.1	259	Since we haven't received data from a device yet, the integration Status is shown as Pending.
49.1	260
64.2	261	[[image:integrations-list-added-pending.png]]
49.1	262
	263
64.2	264	= 5. Verifying the receipt of data from the device =
49.1	265
16.1	266
64.1	267	On the terminal, issue the following MQTT command which simulates the device S31B-NB.
	268
	269	{{code language="none"}}
	270	mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
	271	{{/code}}
	272
	273	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.

Wiki source code of ThingsBoard

Applications

Navigation