Changes for page ThingsBoard

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (1 modified, 10 added, 0 removed)
  • add-integration-connection.png
  • dashboard-2.png
  • dashboard-3.png
  • dashboard-4.png
  • dashboard-5.png
  • emqx.png
  • ins1.png
  • mqtt-uplink.png
  • timeseries-1.png
  • timeseries-3.png
  • timeseries-4.png

Details

Page properties

Content

...	...	@@ -22,7 +22,10 @@
22	22	To complete this tutorial, you need to have the following:
23	23
24	24	* ThingsBoard cloud account
25		-* HiveMQ Cloud account
	25	+* MQTT Broker (public or private) such as,
	26	+** **[[HiveMQ Cloud>>https://www.hivemq.com]] - You can create a free account to try it or subscribe for a paid account. - We use HiveMQ Cloud as the MQTT broker to build example in this tutorial.**
	27	+** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
	28	+** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
26	26
27	27	== 2.1 ThingsBoard Cloud ==
28	28
...	...	@@ -66,7 +66,9 @@
66	66
67	67	== 2.2 HiveMQ Cloud ==
68	68
	72	+=== 2.2.1 HiveMQ Cloud ===
69	69
	74	+
70	70	Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
71	71
72	72	Click on the **Start Free** button.
...	...	@@ -141,6 +141,24 @@
141	141	You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
142	142
143	143
	149	+=== 2.2.2 emqx ===
	150	+
	151	+
	152	+The [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
	153	+
	154	+
	155	+[[image:emqx.png||height="420" width="500"]]
	156	+
	157	+
	158	+=== 2.2.3 Ins1.thingseye.io ===
	159	+
	160	+[[lns1.thingseye.io>>http://lns1.thingseye.io/]] is the Dragino's MQTT broker, which requires a CA certificate file, Certificate file, and the Private key file to use.
	161	+
	162	+If customers need to use this MQTT connection with ThingsBoard, they need to contact the TE team to obtain three license files.
	163	+
	164	+[[image:ins1.png||height="310" width="500"]]
	165	+
	166	+
144	144	= 3. Data Converters =
145	145
146	146
...	...	@@ -153,7 +153,6 @@
153	153	In the left navigation, click **Integrations center**, and then click **Data converters**.
154	154
155	155
156		-
157	157	[[image:data-converters-list-empty.png]]
158	158
159	159
...	...	@@ -166,34 +166,130 @@
166	166
167	167	The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
168	168
169		-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.
	191	+Click on the **JavaScript** button.
170	170
171		-{{code language="JavaScript"}}
172		-/** Decoder **/
	193	+Delete the default decoder function in the code editor. Now copy and paste the following decoder function written in **JavaScript** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
173	173
	195	+
	196	+{{code language="JavaScript"}}
	197	+//Version: 0.1
174	174	// decode payload to string
175	175	var payloadStr = decodeToString(payload);
176		-var data = JSON.parse(payloadStr);
177	177
178		-var deviceName = metadata.topic.split("/")[3];
179	179	// decode payload to JSON
180		-var deviceType = 'sensor';
	202	+var objdata = {};
	203	+var obj1 = {};
	204	+var data = decodeToJson(payload);
	205	+var deviceName = data.IMEI;
	206	+delete data.IMEI;
	207	+var modelname = "Dragino " + data.Model;
	208	+//var mod = data.mod
	209	+delete data.Model;
	210	+//delete data.mod
	211	+var timestamp = new Date().getTime();
181	181
182		-// Result object with device attributes/telemetry data
	213	+for (var key in data) {
	214	+
	215	+ if (Number(key)) {
	216	+ obj1[key] = data[key];
	217	+ obj1[key][obj1[key].length - 1] = Number(new Date(
	218	+ obj1[key][obj1[key].length - 1]));
	219	+
	220	+ }
	221	+//Alec submitted25/02/25
	222	+//turn old key into new
	223	+ else if (key === "Reading") {
	224	+ objdata["reading"] = data[key];
	225	+ } else if (key === "work mode") {
	226	+ objdata["work_mode"] = data[key];
	227	+ } else if (key === "hum") {
	228	+ objdata["humidity"] = data[key];
	229	+ }else if (key === "hum2") {
	230	+ objdata["humidity2"] = data[key];
	231	+ } else if (key === "hum3") {
	232	+ objdata["humidity3"] = data[key];
	233	+ } else if (key === "tem") {
	234	+ objdata["temperature"] = data[key];
	235	+ } else if (key === "tem2") {
	236	+ objdata["temperature2"] = data[key];
	237	+ } else if (key === "tem3") {
	238	+ objdata["temperature3"] = data[key];
	239	+ } else if (key === "DS18B20_Temp") {
	240	+ objdata["temperature_pro"] = data[key];
	241	+ } else if (key === "ds18b20_temperature") {
	242	+ objdata["temperature_pro"] = data[key];
	243	+ } else if (key === "DS18B20_temperature_pro") {
	244	+ objdata["temperature_pro"] = data[key];
	245	+ } else if (key === "tdc send flag") {
	246	+ objdata["tdc_send_flag"] = data[key];
	247	+ } else if (key === "trigger mode") {
	248	+ objdata["trigger_mode"] = data[key];
	249	+ } else if (key === "soil dielectric constant") {
	250	+ objdata["soil_dielectric_constant"] = data[key];
	251	+ } else if (key === "door open num") {
	252	+ objdata["door_open_num"] = data[key];
	253	+ } else if (key === "door duration") {
	254	+ objdata["door_duration"] = data[key];
	255	+ } else if (key === "count time") {
	256	+ objdata["count_time"] = data[key];
	257	+ } else if (key === "last open time2") {
	258	+ objdata["last_open_time2"] = data[key];
	259	+ } else if (key === "last open time3") {
	260	+ objdata["last_open_time3"] = data[key];
	261	+ }
	262	+//Alec submitted25/02/25
	263	+ else {
	264	+ objdata[key] = data[key]
	265	+ }
	266	+}
	267	+var listdata = [{
	268	+ "ts": timestamp,
	269	+ "values": objdata
	270	+}]
	271	+for (var key1 in obj1) {
	272	+ if (modelname == "Dragino RS485-NB") {
	273	+ listdata.push({
	274	+ "ts": obj1[key1][obj1[key1].length - 1],
	275	+ "values": {
	276	+ "Payload": obj1[key1][0],
	277	+ }
	278	+ })
	279	+ } else {
	280	+ listdata.push({
	281	+ "ts": obj1[key1][obj1[key1].length - 1],
	282	+ "values": {
	283	+ "values": obj1[key1]
	284	+ },
	285	+ })
	286	+ }
	287	+}
183	183	var result = {
	289	+
184	184	deviceName: deviceName,
185		- deviceType: deviceType,
	291	+ deviceType: modelname,
186	186	attributes: {
187		- integrationName: metadata['integrationName'],
	293	+ model: modelname,
	294	+ //customerName: "NB-CB",
	295	+ //groupName: "NB-CB",
	296	+ //integrationName: metadata['integrationName']
	297	+
188	188	},
189		- telemetry: {
190		- temperature: data.temperature,
191		- humidity: data.humidity,
192		- }
193		-};
	299	+ telemetry: listdata
	300	+}
194	194
195		-/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
	302	+function decodeToString(payload) {
	303	+ return String.fromCharCode.apply(String, payload);
	304	+}
196	196
	306	+function decodeToJson(payload) {
	307	+ // covert payload to string.
	308	+ var str = decodeToString(payload);
	309	+
	310	+ // parse string to JSON
	311	+ var data = JSON.parse(str);
	312	+ return data;
	313	+}
	314	+
197	197	return result;
198	198	{{/code}}
199	199
...	...	@@ -201,16 +201,16 @@
201	201	Click on the **Add** button.
202	202
203	203
	322	+[[image:mqtt-uplink.png||width="500"]]
204	204
205		-[[image:add-uplink-data-converter.png||height="529" width="500"]]
206	206
207	207
208	208	You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
209	209
	328	+
210	210	[[image:data-converter-list-showing-uplink-dc.png]]
211	211
212	212
213		-
214	214	== 3.2 Downlink ==
215	215
216	216
...	...	@@ -268,7 +268,6 @@
268	268	Click on the **Add** button.
269	269
270	270
271		-
272	272	[[image:add-downlink-data-converter.png||height="529" width="500"]]
273	273
274	274
...	...	@@ -278,7 +278,6 @@
278	278	[[image:data-converters-list.png]]
279	279
280	280
281		-
282	282	= 4. Add Integration =
283	283
284	284
...	...	@@ -306,7 +306,6 @@
306	306	Click **Next** button.
307	307
308	308
309		-
310	310	[[image:add-integration-basic-settings.png||height="511" width="500"]]
311	311
312	312
...	...	@@ -318,7 +318,6 @@
318	318	Click **Next** button.
319	319
320	320
321		-
322	322	[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
323	323
324	324
...	...	@@ -330,19 +330,18 @@
330	330	Click **Next** button.
331	331
332	332
333		-
334	334	[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
335	335
336	336
337	337	**Connection:**
338	338
339		-* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
	452	+* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
340	340	* **Port**: 8883
341	341	* **Credentials**: Basic
342	342	* **Enable SSL**: YES
343	343	* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
344	344	* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
345		-* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
	458	+* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
346	346	* **QoS:** 0-At most once
347	347
348	348	[[image:add-integration-connection.png||height="511" width="500"]]
...	...	@@ -350,8 +350,8 @@
350	350
351	351	Click on the **Advanced settings** button.
352	352
353		-* **Clean session:** NO
354		-* **Retained**: NO
	466	+* **Clean session:** YES
	467	+* **Retained**: YES
355	355
356	356	[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
357	357
...	...	@@ -384,6 +384,7 @@
384	384
385	385	== 5.1 How does it work? ==
386	386
	500	+
387	387	We use the Mosquitto MQTT client to simulate MQTT messages, acting as a virtual device. First, install the Mosquitto client on your computer from [[this link>>url:https://mosquitto.org/download/]]. The Mosquitto client publishes messages to the MQTT broker (HiveMQ) on a specified MQTT topic. ThingsBoard subscribes to these messages using the same topic.
388	388
389	389	The Mosquitto client publishes messages on the topic v1/devices/[device_name]/telemetry. The [device_name]placeholder can be replaced with any device name, for example, 'S31B-NB'. Then, the MQTT topic would be v1/devices/S31B-NB/telemetry.
...	...	@@ -397,12 +397,12 @@
397	397	For example, if you send two MQTT messages with different device names in the topic:
398	398
399	399	1. v1/devices/**S31B-NB**/telemetry
400		-1. v1/devices/**S31B-CB**/telemetry
	514	+1. v1/devices/**LDS25-NB**/telemetry
401	401
402		-ThingsBoard will create two devices named **S31B-NB** and **S31B-CB** in the **//Devices//** section.
	516	+ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
403	403
404	404
405		-The MQTT payload format is as follows, for example:
	519	+The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
406	406
407	407	{{code language="none"}}
408	408	{"temperature":10.4, "humidity":85}
...	...	@@ -415,7 +415,144 @@
415	415	On the terminal, issue the following MQTT command which simulates the device S31B-NB. The message payload contains the fields temperature and humidity, which hold the values 10.4 and 85, respectively. This payload is also (technically) known as telemetry.
416	416
417	417	{{code language="none"}}
418		-mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/SN-001/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":10.4, "humidity":85}'
	532	+mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":10.4, "humidity":85}'
419	419	{{/code}}
420	420
421		-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.
	535	+If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
	536	+
	537	+
	538	+[[image:integration-active.png]]
	539	+
	540	+
	541	+Also, a new device named **S31B-NB** will appear under **//Entities -> Devices -> All//**. This means the first MQTT message triggers ThingsBoard to provision a device named **S31B-NB**.
	542	+
	543	+
	544	+[[image:device-provision-1.png]]
	545	+
	546	+
	547	+Click on the device S31B-NB on the devices list to see its details.
	548	+
	549	+Then go to the **Latest telemetry** tab.
	550	+
	551	+You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
	552	+
	553	+
	554	+[[image:telemetry-1.png]]
	555	+
	556	+
	557	+Now, change the values of the fields and send the MQTT message again. For example, set temperature to 20 and humidity to 70. Observe how the values update in //Latest Telemetry//.
	558	+
	559	+
	560	+[[image:telemetry-2.png]]
	561	+
	562	+
	563	+Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
	564	+
	565	+
	566	+{{code language="none"}}
	567	+mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/LDS25-NB/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":11, "humidity":87}'
	568	+{{/code}}
	569	+
	570	+Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
	571	+
	572	+
	573	+[[image:device-provision-2.png]]
	574	+
	575	+
	576	+= 6. Creating a Dashboard =
	577	+
	578	+ThingsBoard **Dashboards** provide a powerful way to visualize and monitor real-time and historical data from connected devices. They allow users to create interactive, customizable panels displaying telemetry data, device status, and other key metrics. With a variety of widgets, including charts, maps, and tables, dashboards help users gain insights, track trends, and manage IoT deployments efficiently.
	579	+
	580	+
	581	+This section guides you on how to create a dashboard to display temperature and humidity data from the device on a time-series chart. You may also use other widgets in ThingsBoard to display data according to your requirements.
	582	+
	583	+
	584	+In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
	585	+
	586	+
	587	+[[image:dashboard-1.png]]
	588	+
	589	+
	590	+In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.
	591	+
	592	+Click on the **Add** button.
	593	+
	594	+
	595	+[[image:dashboard-2.png||height="526" width="500"]]
	596	+
	597	+
	598	+Click on the **Add widget / Add new widget** button.
	599	+
	600	+
	601	+[[image:dashboard-3.png]]
	602	+
	603	+
	604	+In the **Select widgets bundle** window, click **Charts**.
	605	+
	606	+
	607	+[[image:dashboard-4.png||height="537" width="700"]]
	608	+
	609	+
	610	+
	611	+In the **Charts: select widget** window, click **Time series chart**.
	612	+
	613	+
	614	+[[image:dashboard-5.png||height="525" width="700"]]
	615	+
	616	+
	617	+Configure the **Time series chart** widget as follows:
	618	+
	619	+* **Datasource** - select S31B-NB device you provisioned.
	620	+* **Series**:
	621	+** **temperature** - you can see this key by default.
	622	+** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
	623	+* Click on the **Add** button.
	624	+
	625	+[[image:timeseries-1.png||height="491" width="700"]]
	626	+
	627	+
	628	+The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
	629	+
	630	+Click the **Save** button to add the widget to the dashboard.
	631	+
	632	+
	633	+[[image:timeseries-3.png||height="347" width="700"]]
	634	+
	635	+
	636	+Now send the following MQTT messages from the terminal to simulate the data.
	637	+
	638	+
	639	+{{code language="none"}}
	640	+mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":20, "humidity":70}'
	641	+
	642	+mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":22, "humidity":71}'
	643	+
	644	+mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":18, "humidity":79}'
	645	+
	646	+{{/code}}
	647	+
	648	+The chart will update with the values in realtime, as shown in the below image.
	649	+
	650	+
	651	+[[image:timeseries-4.png||height="316" width="700"]]
	652	+
	653	+
	654	+= 7. Configure NB-IoT Sensor =
	655	+
	656	+
	657	+Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
	658	+
	659	+First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
	660	+
	661	+
	662	+**AT Commands**
	663	+
	664	+* **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
	665	+* **AT+SUBTOPIC=<MQTT topic>**
	666	+* **AT+PUBTOPIC=<MQTT topic>**
	667	+* **AT+CLIENT=null**
	668	+* **AT+UNAME=<MQTT Username>**
	669	+* **AT+PWD=<MQTT Password>**
	670	+* **AT+SERVADDR=<Broker address, Port>**
	671	+
	672	+Test your uplink by pressing the ACT button for 1 second.

add-integration-connection.png

Size

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

Content

dashboard-2.png

Author

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

Size

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

Content

dashboard-3.png

Author

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

Size

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

Content

dashboard-4.png

Author

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

Size

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

Content

dashboard-5.png

Author

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

Size

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

Content

emqx.png

Author

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

Size

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

Content

ins1.png

Author

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

Size

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

Content

mqtt-uplink.png

Author

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

Size

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

Content

timeseries-1.png

Author

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

Size

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

Content

timeseries-3.png

Author

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

Size

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

Content

timeseries-4.png

Author

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

Size

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

Content