General Configure/Commands to Connect to IoT server for -NB & -NS NB-IoT models

1

(% class="wikigeneratedid" %)

2

**Table of Contents:**

= 1. The use of this guideline =

9

10

11

This configure instruction is for Dragino NB-IoT models with -NB or -NS suffix, for example DDS75-NB. These models use the same NB-IoT Module **[[BC660K-GL>>https://www.quectel.com/product/lpwa-bc660k-gl-nb2]]** and has the same software structure. The have the same configure instruction to different IoT servers. Use can follow the instruction here to see how to configure to connect to those servers.

12

13

14

= 2. Network Connection =

15

16

17

The -NB and -NS models support (% style="color:blue" %)**LTE Cat NB2**(%%), with below frequency band: multiple frequency bands of (% style="color:blue" %)**B1/B2/B3/B4/B5/B8/B12/B13/B14/B17/B18/B19/B20/B25/B28/B66/B70/B85**(%%) . Make sure you use a the NB-IoT SIM card.

18

19

(% border="1" cellspacing="4" style="background-color:#f2f2f2; width:510px" %)

20

|(% style="background-color:#4f81bd; color:white" %)**SIM Provider**|(% style="background-color:#4f81bd; color:white" %)**APN**|(% style="background-color:#4f81bd; color:white" %)**NB-IoT Coverage**|(% style="background-color:#4f81bd; color:white" %)**Comments**

|1NCE| | |

|China Mobile| | |

== 2.1 1NCE SIM Card. ==

= 3. Configure to connect to different servers =

29

30

== 3.1 General UDP Connection ==

31

32

33

The NB-IoT Sensor can send packet to server use UDP protocol.

34

35

36

=== 3.1.1 Simulate UDP Connection by PC tool ===

37

38

39

We can use PC tool to simulate UDP connection to make sure server works ok.

40

41

[[image:image-20230802112413-1.png]]

42

43

44

=== 3.1.2 Configure NB-IoT Sensor ===

45

46

==== 3.1.2.1 AT Commands ====

47

48

49

(% style="color:blue" %)**AT Commands:**

50

51

* (% style="color:#037691" %)**AT+PRO=2,0** (%%) ~/~/ Set to use UDP protocol to uplink ,Payload Type select Hex payload

52

53

* (% style="color:#037691" %)**AT+SERVADDR=120.24.4.116,5601** (%%) ~/~/ Set UDP server address and port

54

55

* (% style="color:#037691" %)**AT+CFM=1** (%%) ~/~/ If the server does not respond, this command is unnecessary

56

57

[[image:image-20230802112413-2.png]]

58

59

60

==== 3.1.2.2 Uplink Example ====

61

62

63

[[image:image-20230802112413-3.png]]

64

65

66

== 3.2 General MQTT Connection ==

67

68

69

The NB-IoT Sensor can send packet to server use MQTT protocol.

70

71

Below are the commands.

72

73

(% style="color:blue" %)**AT Commands:**

74

75

* (% style="color:#037691" %)**AT+PRO=3,0** (%%) ~/~/ Set to use MQTT protocol to uplink, Payload Type select Hex payload.

76

77

* (% style="color:#037691" %)**AT+SERVADDR=120.24.4.116,1883** (%%) ~/~/ Set MQTT server address and port

78

79

* (% style="color:#037691" %)**AT+CLIENT=CLIENT** (%%) ~/~/ Set up the CLIENT of MQTT

80

81

* (% style="color:#037691" %)**AT+UNAME=UNAME** (%%) ~/~/ Set the username of MQTT

82

83

* (% style="color:#037691" %)**AT+PWD=PWD** (%%) ~/~/ Set the password of MQTT

84

85

* (% style="color:#037691" %)**AT+PUBTOPIC=NSE01_PUB** (%%) ~/~/ Set the sending topic of MQTT

86

87

* (% style="color:#037691" %)**AT+SUBTOPIC=NSE01_SUB** (%%) ~/~/ Set the subscription topic of MQTT

88

89

[[image:image-20230802112413-4.png]]

90

91

[[image:image-20230802112413-5.png]]

92

93

(% style="color:red" %)**Notice: MQTT protocol has a much higher power consumption compare with UDP/CoAP protocol. Please check the power analyze document and adjust the uplink period to a suitable interval.**

94

95

96

== 3.3 [[ThingSpeak>>url:https://thingspeak.com/]] (via MQTT) ==

97

98

=== 3.3.1 Get MQTT Credentials ===

99

100

101

[[ThingSpeak>>url:https://thingspeak.com/]] connection uses MQTT Connection. So we need to get MQTT Credentials first. You need to point MQTT Devices to ThingSpeak Channel as well.

102

103

[[image:image-20230802112413-6.png]]

104

105

[[image:image-20230802112413-7.png]]

106

107

108

== 3.3.2 Simulate with MQTT.fx ==

109

110

=== 3.3.2.1 Establish MQTT Connection ===

111

112

113

After we got MQTT Credentials, we can first simulate with PC tool MQTT.fx tool to see if the Credentials and settings are fine.

114

115

[[image:image-20230802112413-8.png]]

116

117

* (% style="color:#037691" %)**Broker Address:**(%%) mqtt3.thingspeak.com

118

119

* (% style="color:#037691" %)**Broker Port:**(%%) 1883

120

121

* (% style="color:#037691" %)**Client ID:**(%%) <Your ThingSpeak MQTT ClientID>

122

123

* (% style="color:#037691" %)**User Name:**(%%) <Your ThingSpeak MQTT User Name>

124

125

* (% style="color:#037691" %)**Password:**(%%) <Your ThingSpeak MQTT Password>

126

127

128

=== 3.3.2.2 Publish Data to ThingSpeak Channel ===

129

130

[[image:image-20230802112413-9.png]]

131

132

[[image:image-20230802112413-10.png]]

133

134

(% style="color:blue" %)**In MQTT.fx, we can publish below info:**

135

136

* (% style="color:#037691" %)**Topic:**(%%) channels/YOUR_CHANNEL_ID/publish

137

138

* (% style="color:#037691" %)**Payload:**(%%) field1=63&field2=67&status=MQTTPUBLISH

139

140

Where 63 and 67 are the value to be published to field1 & field2.

141

142

143

(% style="color:blue" %)**Result: **

144

145

[[image:image-20230802112413-11.png]]

146

147

148

== 3.3 Configure NB-IoT Sensor for connection ==

149

150

=== 3.3.1 AT Commands: ===

151

152

153

In the NB-IoT, we can run below commands so to publish the channels like MQTT.fx

154

155

* **AT+PRO=3,1** ~/~/ Set to use ThingSpeak Server and Related Payload

156

157

* **AT+CLIENT=<Your ThingSpeak MQTT ClientID>**

158

159

* **AT+UNAME=<Your ThingSpeak MQTT User Name>**

160

161

* **AT+PWD=<Your ThingSpeak MQTT Password>**

162

163

* **AT+PUBTOPIC=<YOUR_CHANNEL_ID>**

164

165

* **AT+SUBTOPIC=<YOUR_CHANNEL_ID>**

166

167

168

=== 3.3.2 Uplink Examples ===

For S31-NB

For SE01-NB

For DDS20-NB

For DDS45-NB

For DDS75-NB

For NMDS120-NB

For SPH01-NB

For NLM01-NB

For NMDS200-NB

For CPN01-NB

For DS03A-NB

For SN50V3-NB

=== 3.3.3 Map fields to sensor value ===

197

198

199

When NB-IoT sensor upload to ThingSpeak. The payload already specify which fileds related to which sensor value. Use need to create fileds in Channels Settings. with name so to see the value correctly.

200

201

202

[[image:image-20230802112413-12.png]]

203

204

[[image:image-20230802112413-13.png]]

205

206

207

Below is the NB-IoT Product Table show the mapping.

208

209

(% border="1" cellspacing="4" style="width:1386px;background-color:#F2F2F2" %)

210

|(% style="width:124px;background-color:#4F81BD" %) |(% style="width:91px;background-color:#4F81BD;color:white" %)Field1|(% style="width:102px;background-color:#4F81BD;color:white" %)Field2|(% style="width:159px;background-color:#4F81BD;color:white" %)Field3|(% style="width:153px;background-color:#4F81BD;color:white" %)Field4|(% style="width:152px;background-color:#4F81BD;color:white" %)Field5|(% style="width:148px;background-color:#4F81BD;color:white" %)Field6|(% style="width:164px;background-color:#4F81BD;color:white" %)Field7|(% style="width:152px;background-color:#4F81BD;color:white" %)Field8|(% style="width:66px;background-color:#4F81BD;color:white" %)Field9|(% style="width:66px;background-color:#4F81BD;color:white" %)Field10

|(% colspan="1" rowspan="1" style="width:124px;background-color:#4F81BD;color:white" %)DS03A-NB|(% colspan="1" rowspan="1" style="width:91px" %)level|(% colspan="1" rowspan="1" style="width:102px" %)alarm|(% colspan="1" rowspan="1" style="width:159px" %)pb14door open num|(% colspan="1" rowspan="1" style="width:153px" %)pb14 last open time|(% colspan="1" rowspan="1" style="width:152px" %)pb15 level status|(% colspan="1" rowspan="1" style="width:148px" %)pb15 alarm status|(% colspan="1" rowspan="1" style="width:164px" %)pb15 door open num|(% colspan="1" rowspan="1" style="width:152px" %)pb15 last open time|(% colspan="1" rowspan="1" style="width:66px" %)Battery|(% colspan="1" rowspan="1" style="width:66px" %)RSSI

222

|(% colspan="1" rowspan="1" style="width:124px;background-color:#4F81BD;color:white" %)SN50V3-NB|(% colspan="1" rowspan="1" style="width:91px" %) |(% colspan="1" rowspan="1" style="width:102px" %) |(% colspan="1" rowspan="1" style="width:159px" %) |(% colspan="1" rowspan="1" style="width:153px" %) |(% colspan="1" rowspan="1" style="width:152px" %) |(% colspan="1" rowspan="1" style="width:148px" %) |(% colspan="1" rowspan="1" style="width:164px" %) |(% colspan="1" rowspan="1" style="width:152px" %) |(% colspan="1" rowspan="1" style="width:66px" %) |(% colspan="1" rowspan="1" style="width:66px" %)

223

|(% colspan="1" rowspan="1" style="width:124px;background-color:#4F81BD;color:white" %)mod1|(% colspan="1" rowspan="1" style="width:91px" %)mod|(% colspan="1" rowspan="1" style="width:102px" %)Battery|(% colspan="1" rowspan="1" style="width:159px" %)RSSI|(% colspan="1" rowspan="1" style="width:153px" %)DS18B20 Temp|(% colspan="1" rowspan="1" style="width:152px" %)exit_state/input PA4|(% colspan="1" rowspan="1" style="width:148px" %)adc0|(% colspan="1" rowspan="1" style="width:164px" %)Temperature |(% colspan="1" rowspan="1" style="width:152px" %)Humidity|(% colspan="1" rowspan="1" style="width:66px" %) |(% colspan="1" rowspan="1" style="width:66px" %)

224

|(% colspan="1" style="width:124px;background-color:#4F81BD;color:white" %)mod2|(% colspan="1" style="width:91px" %)mod|(% colspan="1" style="width:102px" %)Battery|(% colspan="1" style="width:159px" %)RSSI|(% colspan="1" style="width:153px" %)DS18B20 Temp|(% colspan="1" style="width:152px" %)exit_state/input PA4|(% colspan="1" style="width:148px" %)adc0|(% colspan="1" style="width:164px" %)distance|(% colspan="1" style="width:152px" %) |(% colspan="1" style="width:66px" %) |(% colspan="1" style="width:66px" %)

225

|(% colspan="1" style="width:124px;background-color:#4F81BD;color:white" %)mod3|(% colspan="1" style="width:91px" %)mod|(% colspan="1" style="width:102px" %)Battery|(% colspan="1" style="width:159px" %)RSSI|(% colspan="1" style="width:153px" %)adc0|(% colspan="1" style="width:152px" %)exit_state/input PA4|(% colspan="1" style="width:148px" %)adc1|(% colspan="1" style="width:164px" %)Temperature|(% colspan="1" style="width:152px" %)Humidity|(% colspan="1" style="width:66px" %)adc4|(% colspan="1" style="width:66px" %)

226

|(% colspan="1" style="width:124px;background-color:#4F81BD;color:white" %)mod4|(% colspan="1" style="width:91px" %)mod|(% colspan="1" style="width:102px" %)Battery|(% colspan="1" style="width:159px" %)RSSI|(% colspan="1" style="width:153px" %)DS18B20 Temp|(% colspan="1" style="width:152px" %)adc0|(% colspan="1" style="width:148px" %)exit_state/input PA4|(% colspan="1" style="width:164px" %)DS18B20 Temp2|(% colspan="1" style="width:152px" %)DS18B20 Temp3|(% colspan="1" style="width:66px" %) |(% colspan="1" style="width:66px" %)

227

|(% colspan="1" style="width:124px;background-color:#4F81BD;color:white" %)mod5|(% colspan="1" style="width:91px" %)mod|(% colspan="1" style="width:102px" %)Battery|(% colspan="1" style="width:159px" %)RSSI|(% colspan="1" style="width:153px" %)DS18B20 Temp|(% colspan="1" style="width:152px" %)adc0|(% colspan="1" style="width:148px" %)exit_state/input PA4|(% colspan="1" style="width:164px" %)Weight|(% colspan="1" style="width:152px" %) |(% colspan="1" style="width:66px" %) |(% colspan="1" style="width:66px" %)

228

|(% colspan="1" style="width:124px;background-color:#4F81BD;color:white" %)mod6|(% colspan="1" style="width:91px" %)mod|(% colspan="1" style="width:102px" %)Battery|(% colspan="1" style="width:159px" %)RSSI|(% colspan="1" style="width:153px" %)count|(% colspan="1" style="width:152px" %) |(% colspan="1" style="width:148px" %) |(% colspan="1" style="width:164px" %) |(% colspan="1" style="width:152px" %) |(% colspan="1" style="width:66px" %) |(% colspan="1" style="width:66px" %)

== 3.4 Datacake ==

== 3.4.1 Define Product ==

235

236

237

Firstly, we need to set the MQTT mode to datacake, and we need to run** AT+PRO=3,2**. This command is set to datacake. After running the command, the device automatically sets the server address, port.

238

239

240

By chosing to add the device under a **"New Product"** you are required to give a name for this product. You can name it something like "My First MQTT Product".

241

242

[[image:image-20230802112413-14.png]]

243

244

== 1.2 Create Device ==

245

246

In the second step you have to define the device which should be added to the product.

247

248

[[image:image-20230802112413-15.png]]

249

250

Enter a name here (such as "My First MQTT Device") and complete the creation of the device by clicking on the "Next" button.

251

252

253

== 1.3 Create Database Fields ==

254

255

After creating the device, it is listed in the table of the fleet view. Now open the device by clicking on the entry in the list.

256

257

You will then see a device view with an empty dashboard. Now, the first thing we want to do is navigate to the Device configuration. To do this, use the tab bar and click on "Configuration".

258

259

[[image:image-20230802112413-16.png]]

260

261

[[image:image-20230802112413-17.png]]

262

263

To create a first database field, please click on the "Add Field" button as marked in the screenshot above.

264

265

This will open another modal asking for some required input for your first field.

266

267

[[image:image-20230802112413-18.png]]

268

269

[[image:image-20230802112413-19.png]]

270

271

== 1.4 Set up Broker ==

272

273

The broker is running on mqtt.datacake.co on ports 1883 and 8883. Port 1883 is unsecured and should not be used in production environments. Port 8883 uses a CA signed server certificate.

274

275

You will need an access token to log into the Datacake MQTT Broker. You can use your own personal token or create a token explicitly for individual devices or groups of devices.

276

277

View your Personal Access Token

278

279

You can view your own token via the User-Settings-Menu. You can reach this menu by clicking on "Edit Profile" at the end of the list using the Workspace Selector:

280

281

[[image:image-20230802112413-20.png]]

MQTT Client-ID

The Datacake Broker manages the client IDs internally. You do not need to worry about a client ID. If your client optionally supports the specification of a client ID, please leave this specification blank. Your client then creates a randomly generated ID.

286

287

AT+CLIENT=“Any value”

AT+UNAME=Token

AT+PWD=Token

[[image:image-20230802112413-21.png]]

294

295

296

== 1.6 Create your first Subscription ==

Subscribe

Data is published according to the following structure:

dtck~/~//

Subscribe to topics using this structure to receive messages via MQTT when readings (via API or MQTT) arrive in the Datacake Cloud. Messages are published whenever there is a change to a corresponding database field.

305

306

307

[[image:image-20230802112413-22.png]]

308

309

310

[[image:image-20230802112413-23.png]]

311

312

313

[[image:image-20230802112413-24.png]]

example:

AT+PUBTOPIC=dtck-pub/nbmattest/936c0db6-e9a5-4353-9fdb-3f63c8bfce7e/Temperature

319

320

[[image:image-20230802112413-25.png]]

321

322

== 1.7 Define Publish Topic ==

Publish

To upload data into the Datacake Cloud and into a specific device, you publish the data to the respective topic structure.

327

328

Due to the nature of MQTT, the topic prefix differs as follows:

dtck-pub~/~//

example:

AT+SUBTOPIC=dtck/nbmattest/936c0db6-e9a5-4353-9fdb-3f63c8bfce7e/Temperature

335

336

== 1.8 upload data ==

337

338

[[image:image-20230802112413-26.png]]

339

340

[[image:image-20230802112413-27.png]]

341

342

[[image:image-20230802112413-28.png]]

= =

= 5. Node-Red (via MQTT) =

347

348

349

== 1.1 Configure Node-Red ==

350

351

[[image:image-20230802112413-29.png]]

352

353

[[image:image-20230802112413-30.png]]

354

355

== 1.2 Simulate Connection ==

356

357

[[image:image-20230802112413-31.png]]

358

359

== 1.3 Configure NB-IoT Sensors ==

360

361

* AT+PRO=3,0(hex format) or 3,5(json format) ~/~/Set to mqtt Server and Payload

362

* AT+CLIENT=any value

363

* AT+UNAME=any value

364

* AT+PWD=any value

365

* AT+PUBTOPIC=any value

366

* AT+SUBTOPIC=any value

367

368

= 6. ThingsBoard.Cloud (via MQTT) =

369

370

== 1.1 Configure ThingsBoard ==

371

372

=== 1.1.1 Create Device ===

373

374

Create a New Device in [[ThingsBoard>>url:https://thingsboard.cloud/]].

375

376

[[image:image-20230802112413-32.png]]

377

378

=== 1.1.2 Create Uplink & Downlink Converter ===

Uplink Converter

The purpose of the decoder function is to parse the incoming data and metadata to a format that ThingsBoard can consume. deviceName and deviceType are required, while attributes and telemetry are optional. Attributes and telemetry are flat key-value objects. Nested objects are not supported.

383

384

To create an uplink converter go to the Integrations center -> Data converters page and click “plus” button. Name it “MQTT Uplink Converter” and select type Uplink. Use debug mode for now.

385

386

[[image:image-20230802112413-33.png]]

Downlink Converter

The Downlink converter transforming outgoing RPC message and then the Integration sends it to external MQTT broke

392

393

[[image:image-20230802112413-34.png]]

394

395

Note:Our device payload is already human readable data. Therefore, users do not need to write decoders. Simply create by default.

396

397

=== 1.1.3 MQTT Integration Setup ===

398

399

Go to the Integrations center -> Integrations page and click “plus” icon to add a new integration. Name it “MQTT Integration”, select type MQTT;

400

401

[[image:image-20230802112413-35.png]]

402

403

* The next steps is to add the recently created uplink and downlink converters;

404

405

[[image:image-20230802112413-36.png]]

406

407

[[image:image-20230802112413-37.png]]

Add a topic filter:

tb/mqtt-integration-tutorial/sensors~/~/temperature ~-~-> Temperature 固定的? 对的。

413

414

You can also select an MQTT QoS level. We use MQTT QoS level 0 (At most once) by default;

415

416

[[image:image-20230802112413-38.png]]

417

418

== 1.2 Simulate with MQTT.fx ==

419

420

[[image:image-20230802112413-39.png]]

421

422

[[image:image-20230802112413-40.png]]

423

424

== 1.3 Configure NB-IoT Sensor ==

AT Commands

AT+PRO=3,3 ~/~/ Use MQTT to connect to ThingsBoard.

429

430

AT+SUBTOPIC=device name ~-~-> 只需要 Device Name 吗?对的

431

432

AT+PUBTOPIC=device name ~-~-> 只需要 Device Name 吗?对的

433

434

435

Users do not need to fill in the client, username, and password. But the configuration information of the device requires setting the client, username, and password, which can be entered freely. (软件自动填充为 Device Name 吧).这边不用提示了，客户不需要输入。（大部分客户还是会自己去设置这个的，提高安全性）

CLIENT :“Any value”

User Name:“Any value”

Password:“Any value”