Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 104.1
edited by Dilisi S
on 2025/03/08 04:35
Change comment: Uploaded new attachment "connection-success.png", version {1}
To version 128.1
edited by Dilisi S
on 2025/03/08 22:01
Change comment: Uploaded new attachment "thingsboard-6.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -17,16 +17,118 @@
17 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**.
18 18  
19 19  
20 += 2. Prerequisites =
20 20  
22 +To complete this tutorial, you need to have the following:
21 21  
24 +* ThingsBoard cloud account
25 +* HiveMQ Cloud account
22 22  
23 -= 2. Data Converters =
27 +== 2.1 ThingsBoard Cloud ==
24 24  
25 25  
30 +Go to [[https:~~/~~/thingsboard.io/>>https://thingsboard.io/]]
31 +
32 +Click on the **Try it now**.
33 +
34 +
35 +[[image:thingsboard-1.png]]
36 +
37 +
38 +Select either the **North America** or **Europe** region. Here, we use the Europe region.
39 +
40 +[[image:thingsboard-2.png]]
41 +
42 +
43 +You can sign up with your Google, GitHub, Facebook, or Apple account. If not you can create an account with providing your name, email address and a password.
44 +
45 +[[image:thingsboard-3.png||height="651" width="500"]]
46 +
47 +
48 +== 2.2 HiveMQ Cloud ==
49 +
50 +
51 +Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
52 +
53 +Click on the **Start Free** button.
54 +
55 +[[image:hivwmq-1.png]]
56 +
57 +
58 +Click on the **Sign Up FREE Now** button in the **HIVEMQ CLOUD** section.
59 +
60 +[[image:hivemq-2.png]]
61 +
62 +
63 +Click on the **Sign Up** button.
64 +
65 +You can sign up with HiveMQ using your **GitHub**, **Google**, or **LinkedIn** account.
66 +
67 +If not, provide your **email address** and a **password** to create an account by clicking on the **Sign Up** button.
68 +
69 +
70 +[[image:hivemq-3.png]]
71 +
72 +
73 +You will receive an email to verify your email address. Click on the **Confirm my account** button.
74 +
75 +
76 +[[image:hivemq-4.jpg||height="889" width="400"]]
77 +
78 +
79 +You will be redirected to a page asking you to complete your profile. Once done, click the **Continue** button.
80 +
81 +
82 +[[image:hivemq-5.png||height="655" width="700"]]
83 +
84 +
85 +Select the CloudMQ Cloud plan you need. For testing purposes, select the **Serverless FREE** plan by clicking on the **Create Serverless Cluster** button.
86 +
87 +
88 +[[image:hivemq-6.png]]
89 +
90 +
91 +You will be navigated to the **Your Clusters** page. Click on the **Manage Cluster** button.
92 +
93 +[[image:hivemq-7.png]]
94 +
95 +
96 +In your cluster page, you can find some useful parameters you need to create a MQTT connection.
97 +
98 +**URL**: This is the host name. Click on the copy button to copy it.
99 +
100 +**Port**: 8883
101 +
102 +
103 +Click on the **Getting Started** tab to setup the username and the password as the connection credentials.
104 +
105 +
106 +[[image:hivemq-8.png]]
107 +
108 +
109 +In the '**Create Connection Credentials**' section, provide a **username** and **password**, then click the **Add** button.
110 +
111 +
112 +[[image:hivemq-9.png]]
113 +
114 +
115 +
116 +If everything is successful, you will see the following message.
117 +
118 +
119 +[[image:hivemq-10.png||height="206" width="500"]]
120 +
121 +
122 +You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
123 +
124 +
125 += 3. Data Converters =
126 +
127 +
26 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.
27 27  
28 28  
29 -== 2.1 Uplink ==
131 +== 3.1 Uplink ==
30 30  
31 31  
32 32  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -86,9 +86,9 @@
86 86  
87 87  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88 88  
191 +[[image:data-converter-list-showing-uplink-dc.png]]
89 89  
90 90  
91 -[[image:create-new-converter-menu.png||width="500"]]
92 92  
93 93  == 3.2 Downlink ==
94 94  
... ... @@ -95,9 +95,11 @@
95 95  
96 96  On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
97 97  
98 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
99 99  
201 +[[image:create-new-converter-menu.png||width="500"]]
100 100  
203 +
204 +
101 101  The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
102 102  
103 103  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.
... ... @@ -152,19 +152,22 @@
152 152  You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
153 153  
154 154  
155 -
156 156  [[image:data-converters-list.png]]
157 157  
158 -= 3. Add Integration =
159 159  
160 160  
263 += 4. Add Integration =
264 +
265 +
161 161  In the left navigation, click **Integrations center**, and then click **Integrations**.
162 162  
163 -On the **Integrations** page, click on the '**+**' button.
164 164  
165 -[[image:data-converter-list-page.png]]
269 +[[image:integrations-list-empty.png]]
166 166  
167 167  
272 +On the **Integrations** page, click on the '**+**' button.
273 +
274 +
168 168  The **Add integration** window appears.
169 169  
170 170  In the **Add integration** window, configure the following settings:
... ... @@ -174,9 +174,13 @@
174 174  
175 175  * **Integration type**: MQTT
176 176  * **Name**: MQTT integration NB/CB
284 +* **Enable integration**: YES
285 +* **Allows create devices or assets**: YES
177 177  
178 178  Click **Next** button.
179 179  
289 +
290 +
180 180  [[image:add-integration-basic-settings.png||height="511" width="500"]]
181 181  
182 182  
... ... @@ -187,9 +187,11 @@
187 187  
188 188  Click **Next** button.
189 189  
190 -[[image:add-integration-uplink-data-converter.png||width="500"]]
191 191  
192 192  
303 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
304 +
305 +
193 193  **Downlink data converter:**
194 194  
195 195  * Click on the **Select existing** button.
... ... @@ -197,9 +197,11 @@
197 197  
198 198  Click **Next** button.
199 199  
200 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
201 201  
202 202  
315 +[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
316 +
317 +
203 203  **Connection:**
204 204  
205 205  * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -210,28 +210,41 @@
210 210  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
211 211  * **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
212 212  * **QoS:** 0-At most once
328 +
329 +[[image:add-integration-connection.png||height="511" width="500"]]
330 +
331 +
332 +Click on the **Advanced settings** button.
333 +
213 213  * **Clean session:** NO
214 214  * **Retained**: NO
215 215  
337 +[[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
338 +
339 +
216 216  Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
217 217  
218 -[[image:add-integration-connection.png||width="500"]]
219 219  
343 +[[image:check-connection.png||height="83" width="300"]]
220 220  
221 -If the connection is successful, you will see the **Connected** message.
222 222  
223 -Click on the **Add** button.
346 +If the connection is successful, you will see the **Connected** message. If not, check your connection parameters again.
224 224  
225 -[[image:add-connection-success.png||height="511" width="500"]]
226 226  
349 +[[image:connection-success.png||height="511" width="500"]]
227 227  
351 +
352 +Click on the **Add** button.
353 +
228 228  You should see that the newly added integration is listed on the **Integrations** page.
229 229  
230 230  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
231 231  
232 -[[image:integrations-list-added-pending.png]]
233 233  
234 234  
360 +[[image:new-integration-pending.png]]
361 +
362 +
235 235  = 5. Verifying the receipt of data from the device =
236 236  
237 237  
... ... @@ -242,4 +242,3 @@
242 242  {{/code}}
243 243  
244 244  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.
245 -
hivemq-10.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +82.7 KB
Content
hivemq-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +300.7 KB
Content
hivemq-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +535.2 KB
Content
hivemq-4.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +309.8 KB
Content
hivemq-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +115.0 KB
Content
hivemq-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +321.0 KB
Content
hivemq-7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +203.5 KB
Content
hivemq-8.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +268.7 KB
Content
hivemq-9.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +303.7 KB
Content
hivwmq-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +380.3 KB
Content
new-integration-pending.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +199.7 KB
Content
thingsboard-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +1.9 MB
Content
thingsboard-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +901.1 KB
Content
thingsboard-3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +146.3 KB
Content
thingsboard-4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +122.1 KB
Content
thingsboard-5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +106.7 KB
Content
thingsboard-6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +119.3 KB
Content