Wiki source code of ThingsBoard

Version 64.2 by Xiaoling on 2025/03/07 11:46

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
64.2	9	= 1. Introduction =
1.1	10
64.2	11
21.1	12	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	13
21.1	14	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	15
17.1	16
64.2	17	= 2. Add New Device =
11.1	18
64.2	19
59.1	20	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.
	21
11.1	22	In the left navigation, click Entities and then click Devices.
	23
59.1	24	[[image:device-list-empty.png]]
11.1	25
	26
21.1	27	On the Devices page, click on the ‘+’ button, and then click on the Add new device from the dropdown menu.
11.1	28
	29
	30	[[image:ThingsBoard-add-new-device.png\|\|height="279" width="500"]]
	31
	32
59.1	33	The Add new device window appears. Name the device, for example 'Virtual NB/CB device'.
11.1	34
59.1	35	Click on the Next: Credentials button.
	36
	37
	38	[[image:new-device-device-details.png\|\|height="529" width="500"]]
	39
	40
	41	Click the Access token button if it is not selected by default.
	42
	43	Copy the Access token to a text editor, as you will need it in the section 'Sending data from an MQTT client'.
	44
	45	Click on the Add button.
	46
	47	[[image:new-device-access-token.png\|\|height="528" width="500"]]
	48
	49
	50	Click on the MQTT button.
	51
	52	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.
	53
	54	Copy the MQTT pub command in the 'Execute the following command' section.
	55
	56	{{code language="none"}}
	57	mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/me/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:25}"
	58	{{/code}}
	59
	60	Note that the State is still shown as 'Inactive' in the Latest telemetry section.
	61
	62	[[image:new-device-check-connectivity.png\|\|height="522" width="500"]]
	63
	64
61.1	65	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.
59.1	66
	67
	68	[[image:mqtt-command-1.png\|\|height="228" width="700"]]
	69
	70
63.1	71	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.
59.1	72
	73
	74	[[image:new-device-telemetry-test.png\|\|height="520" width="500"]]
	75
	76
61.1	77	Send the same command again, only changing the temperature value, to see how the Latest telemetry section updates its data.
59.1	78
61.1	79	Once you are done experimenting with this, close the window by clicking the Close button.
	80
	81
	82	[[image:mqtt-command-2.png\|\|height="227" width="700"]]
	83
	84
63.1	85
	86	[[image:virtual-device-active.png]]
	87
	88
64.2	89	= 3. Data Converters =
11.1	90
64.2	91
21.1	92	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	93
21.1	94
64.2	95	== 3.1 Uplink ==
11.1	96
64.2	97
21.1	98	In the left navigation, click Integrations center, and then click Data converters.
11.1	99
36.1	100	[[image:data-converter-list-page.png]]
11.1	101
	102
21.1	103	On the Data converters page, click on the ‘+’ button, and then click on the Create new converter from the dropdown menu.
11.1	104
	105	[[image:ThingsBoard-new-data-converter.png\|\|height="282" width="500"]]
	106
	107
36.1	108	The Add data converter window will appear. Name it ‘MQTT Uplink Converter NB/CB’ and select the Type as Uplink.
11.1	109
23.1	110	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.
11.1	111
	112	{{code language="JavaScript"}}
	113	//Version: 0.1
	114	// decode payload to string
	115	var payloadStr = decodeToString(payload);
	116
	117	// decode payload to JSON
	118	var objdata = {};
	119	var obj1 = {};
	120	var data = decodeToJson(payload);
	121	var deviceName = data.IMEI;
	122	delete data.IMEI;
	123	var modelname = "Dragino " + data.Model;
	124	//var mod = data.mod
	125	delete data.Model;
	126	//delete data.mod
	127	var timestamp = new Date().getTime();
	128
	129	for (var key in data) {
	130
	131	if (Number(key)) {
	132	obj1[key] = data[key];
	133	obj1[key][obj1[key].length - 1] = Number(new Date(
	134	obj1[key][obj1[key].length - 1]));
	135
	136	}
	137	//Alec submitted25/02/25
	138	//turn old key into new
	139	else if (key === "Reading") {
	140	objdata["reading"] = data[key];
	141	} else if (key === "work mode") {
	142	objdata["work_mode"] = data[key];
	143	} else if (key === "hum") {
	144	objdata["humidity"] = data[key];
	145	}else if (key === "hum2") {
	146	objdata["humidity2"] = data[key];
	147	} else if (key === "hum3") {
	148	objdata["humidity3"] = data[key];
	149	} else if (key === "tem") {
	150	objdata["temperature"] = data[key];
	151	} else if (key === "tem2") {
	152	objdata["temperature2"] = data[key];
	153	} else if (key === "tem3") {
	154	objdata["temperature3"] = data[key];
	155	} else if (key === "DS18B20_Temp") {
	156	objdata["temperature_pro"] = data[key];
	157	} else if (key === "ds18b20_temperature") {
	158	objdata["temperature_pro"] = data[key];
	159	} else if (key === "DS18B20_temperature_pro") {
	160	objdata["temperature_pro"] = data[key];
	161	} else if (key === "tdc send flag") {
	162	objdata["tdc_send_flag"] = data[key];
	163	} else if (key === "trigger mode") {
	164	objdata["trigger_mode"] = data[key];
	165	} else if (key === "soil dielectric constant") {
	166	objdata["soil_dielectric_constant"] = data[key];
	167	} else if (key === "door open num") {
	168	objdata["door_open_num"] = data[key];
	169	} else if (key === "door duration") {
	170	objdata["door_duration"] = data[key];
	171	} else if (key === "count time") {
	172	objdata["count_time"] = data[key];
	173	} else if (key === "last open time2") {
	174	objdata["last_open_time2"] = data[key];
	175	} else if (key === "last open time3") {
	176	objdata["last_open_time3"] = data[key];
	177	}
	178	//Alec submitted25/02/25
	179	else {
	180	objdata[key] = data[key]
	181	}
	182	}
	183	var listdata = [{
	184	"ts": timestamp,
	185	"values": objdata
	186	}]
	187	for (var key1 in obj1) {
	188	if (modelname == "Dragino RS485-NB") {
	189	listdata.push({
	190	"ts": obj1[key1][obj1[key1].length - 1],
	191	"values": {
	192	"Payload": obj1[key1][0],
	193	}
	194	})
	195	} else {
	196	listdata.push({
	197	"ts": obj1[key1][obj1[key1].length - 1],
	198	"values": {
	199	"values": obj1[key1]
	200	},
	201	})
	202	}
	203	}
	204	var result = {
	205
	206	deviceName: deviceName,
	207	deviceType: modelname,
	208	attributes: {
	209	model: modelname,
	210	//customerName: "NB-CB",
	211	//groupName: "NB-CB",
	212	//integrationName: metadata['integrationName']
	213
	214	},
	215	telemetry: listdata
	216	}
	217
	218	function decodeToString(payload) {
	219	return String.fromCharCode.apply(String, payload);
	220	}
	221
	222	function decodeToJson(payload) {
	223	// covert payload to string.
	224	var str = decodeToString(payload);
	225
	226	// parse string to JSON
	227	var data = JSON.parse(str);
	228	return data;
	229	}
	230
	231	return result;
	232
	233	{{/code}}
	234
64.2	235
21.1	236	Click on the Add button.
11.1	237
36.1	238	[[image:uplink-data-converter.png\|\|height="529" width="500"]]
11.1	239
	240
23.1	241	You should see that the newly added uplink data converter is listed on the Data Converters page.
11.1	242
36.1	243	[[image:data-converter-list-showing-uplink-dc.png]]
21.1	244
	245
64.2	246	== 3.2 Downlink ==
11.1	247
64.2	248
21.1	249	On the Data converters page, click on the ‘+’ button, and then click on the Create new converter from the dropdown menu.
11.1	250
	251	[[image:ThingsBoard-new-data-converter.png\|\|height="282" width="500"]]
	252
	253
36.1	254	The Add data converter window will appear. Name it ‘MQTT Downlink Converter NB/CB’ and select the Type as Downlink.
11.1	255
23.1	256	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.
11.1	257
	258
	259	{{code language="JavaScript"}}
	260	function hexToBase64(hexString) {
	261	// 将16进制字符串两个字符转换为一个字节
	262	var bytes = hexString.match(/.{2}/g);
	263	// 对每个字节进行解析，并转换为对应的字符
	264	var binaryString = bytes.map(function(byte) {
	265	return String.fromCharCode(parseInt(byte, 16));
	266	}).join('');
1.1	267
11.1	268	// 使用btoa进行base64编码
	269	return btoa(binaryString);
	270	}
	271
	272	// Result object with encoded downlink payload
	273	var result = {
	274	// downlink data content type: JSON, TEXT or BINARY (base64 format)
	275	contentType: "BINARY",
	276
	277	// downlink data
	278	data:hexToBase64(metadata.shared_value)
	279
	280	// Optional metadata object presented in key/value format
	281	//metadata: {}
	282
	283	};
	284
	285	return result;
	286	{{/code}}
	287
	288
	289	Click on the Add button.
	290
36.1	291	[[image:downlink-data-converter.png\|\|height="530" width="500"]]
11.1	292
	293
23.1	294	You should see that the newly added downlink data converter is listed on the Data Converters page.
21.1	295
36.1	296	[[image:data-converter-list.png]]
21.1	297
	298
64.2	299	= 4. Add Integration =
11.1	300
64.2	301
21.1	302	In the left navigation, click Integrations center, and then click Integrations.
11.1	303
21.1	304	On the Integrations page, click on the '+' button.
11.1	305
49.1	306	[[image:data-converter-list-page.png]]
11.1	307
	308
21.1	309	The Add integration window appears.
11.1	310
24.1	311	In the Add integration window, configure the following settings:
11.1	312
21.1	313
11.1	314	Basic settings:
	315
49.1	316	* Integration type: MQTT
	317	* Name: MQTT integration NB/CB
11.1	318
	319	Click Next button.
	320
16.1	321	[[image:add-integration-basic-settings.png\|\|height="511" width="500"]]
11.1	322
	323
16.1	324	Uplink data converter:
11.1	325
21.1	326	* Click on the Select existing button.
49.1	327	* Uplink data converter: Select MQTT Uplink Converter NB/CB from the dropdown list.
16.1	328
	329	Click Next button.
	330
49.1	331	[[image:add-integration-uplink-data-converter.png\|\|width="500"]]
16.1	332
	333
	334	Downlink data converter:
	335
21.1	336	* Click on the Select existing button.
49.1	337	* Downlink data converter: Select MQTT Downlink Converter NB/CB from the dropdown list.
16.1	338
	339	Click Next button.
	340
49.1	341	[[image:add-integration-downlink-data-converter.png\|\|height="510" width="500"]]
16.1	342
	343
	344	Connection:
	345
49.1	346	* Host: mqtt.eu.thingsboard.cloud (This is the host name you copied from the device - See section xxxxx for more information)
	347	* Port: 1883 (This is the port number you copied from the device - See section xxxxx for more information)
	348	* Credentials: Basic
	349	* Username: Access token (This is the access token you copied from the device)
	350	* Password - Leave it as blank
59.1	351	* 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')
49.1	352	* QoS - 0-At most once
16.1	353
49.1	354	Click on the Check connection button to verify the MQTT connection using the provided parameters.
16.1	355
49.1	356	[[image:add-integration-connection.png\|\|width="500"]]
	357
	358
	359	If the connection is successful, you will see the Connected message.
	360
16.1	361	Click on the Add button.
	362
49.1	363	[[image:add-connection-success.png\|\|height="511" width="500"]]
16.1	364
	365
59.1	366	You should see that the newly added integration is listed on the Integrations page.
49.1	367
59.1	368	Since we haven't received data from a device yet, the integration Status is shown as Pending.
49.1	369
64.2	370	[[image:integrations-list-added-pending.png]]
49.1	371
	372
64.2	373	= 5. Verifying the receipt of data from the device =
49.1	374
16.1	375
64.1	376	On the terminal, issue the following MQTT command which simulates the device S31B-NB.
	377
	378	{{code language="none"}}
	379	mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
	380	{{/code}}
	381
	382	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.
64.2	383
	384

Wiki source code of ThingsBoard

Applications

Navigation