Wiki source code of ThingsBoard

Version 64.1 by Dilisi S on 2025/03/07 00:17

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