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 =

30

31

== 3.1 General UDP Connection ==

32

33

34

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

35

36

37

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

38

39

40

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

41

42

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

43

44

45

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

46

47

==== 3.1.2.1 AT Commands ====

48

49

50

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

51

52

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

53

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

54

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

55

56

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

57

58

59

==== 3.1.2.2 Uplink Example ====

60

61

62

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

63

64

65

= 2. General MQTT Connection =

66

67

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

68

69

Below are the commands

AT Commands:

* AT+PRO=3,0 ~/~/ Set to use MQTT protocol to uplink, Payload Type select Hex payload.

74

* AT+SERVADDR=120.24.4.116,1883 ~/~/ Set MQTT server address and port

75

* AT+CLIENT=CLIENT ~/~/ Set up the CLIENT of MQTT

76

* AT+UNAME=UNAME ~/~/ Set the username of MQTT

77

* AT+PWD=PWD ~/~/ Set the password of MQTT

78

* AT+PUBTOPIC=NSE01_PUB ~/~/ Set the sending topic of MQTT

79

* AT+SUBTOPIC=NSE01_SUB ~/~/ Set the subscription topic of MQTT

80

81

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

82

83

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

84

85

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.

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

90

91

== 1.1 Get MQTT Credentials ==

92

93

[[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.

94

95

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

96

97

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

98

99

100

== 1.2. Simulate with MQTT.fx ==

101

102

=== 1.2.1 Establish MQTT Connection ===

103

104

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

105

106

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

107

108

* Broker Address: mqtt3.thingspeak.com

109

* Broker Port: 1883

110

* Client ID: <Your ThingSpeak MQTT ClientID>

111

* User Name: <Your ThingSpeak MQTT User Name>

112

* Password: <Your ThingSpeak MQTT Password>

113

114

=== 1.2.2 Publish Data to ThingSpeak Channel ===

115

116

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

117

118

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

119

120

In MQTT.fx, we can publish below info:

121

122

* Topic: channels/YOUR_CHANNEL_ID/publish

123

* Payload: field1=63&field2=67&status=MQTTPUBLISH

124

125

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

Result:

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

131

132

133

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

134

135

=== 1.3.1 AT Commands: ===

136

137

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

138

139

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

140

* AT+CLIENT=<Your ThingSpeak MQTT ClientID>

141

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

142

* AT+PWD=<Your ThingSpeak MQTT Password>

143

* AT+PUBTOPIC=<YOUR_CHANNEL_ID>

144

* AT+SUBTOPIC=<YOUR_CHANNEL_ID>

145

146

=== 1.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

=== 1.3.2 Map fields to sensor value ===

174

175

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.

176

177

178

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

179

180

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

181

182

183

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

Field9

)))|(% colspan="1" rowspan="1" %)(((

Field10

)))

|(% colspan="1" rowspan="1" %)DDS20-NB|(% colspan="1" rowspan="1" %)distance|(% colspan="1" rowspan="1" %)(((

Battery

|(% colspan="1" rowspan="1" %)DDS45-NB|(% colspan="1" rowspan="1" %)distance|(% colspan="1" rowspan="1" %)(((

Battery

|(% colspan="1" rowspan="1" %)DDS75-NB|(% colspan="1" rowspan="1" %)distance|(% colspan="1" rowspan="1" %)(((

Battery

|(% colspan="1" rowspan="1" %)NMDS120-NB|(% colspan="1" rowspan="1" %)distance|(% colspan="1" rowspan="1" %)(((

Battery

|(% colspan="1" rowspan="1" %)DS03A-NB|(% colspan="1" rowspan="1" %)level|(% colspan="1" rowspan="1" %)alarm|(% colspan="1" rowspan="1" %)pb14door open num|(% colspan="1" rowspan="1" %)pb14 last open time|(% colspan="1" rowspan="1" %)pb15 level status|(% colspan="1" rowspan="1" %)pb15 alarm status|(% colspan="1" rowspan="1" %)pb15 door open num|(% colspan="1" rowspan="1" %)pb15 last open time|(% colspan="1" rowspan="1" %)Battery|(% colspan="1" rowspan="1" %)RSSI

DS18B20 Temp

)))|(% colspan="1" rowspan="1" %)(((

exit_state/input PA4

|(% colspan="1" rowspan="1" %)mod3|(% colspan="1" rowspan="1" %)mod|(% colspan="1" rowspan="1" %)(((

Battery

)))|(% colspan="1" rowspan="1" %)RSSI|(% colspan="1" rowspan="1" %)adc0|(% colspan="1" rowspan="1" %)(((

exit_state/input PA4

|(% colspan="1" rowspan="1" %)mod4|(% colspan="1" rowspan="1" %)mod|(% colspan="1" rowspan="1" %)(((

Battery

)))|(% colspan="1" rowspan="1" %)RSSI|(% colspan="1" rowspan="1" %)(((

DS18B20 Temp

)))|(% colspan="1" rowspan="1" %)adc0|(% colspan="1" rowspan="1" %)(((

exit_state/input PA4

)))|(% colspan="1" rowspan="1" %)(((

DS18B20 Temp2

)))|(% colspan="1" rowspan="1" %)(((

DS18B20 Temp3

)))|(% colspan="1" rowspan="1" %) |(% colspan="1" rowspan="1" %)

262

|(% colspan="1" rowspan="1" %)mod5|(% colspan="1" rowspan="1" %)mod|(% colspan="1" rowspan="1" %)(((

Battery

)))|(% colspan="1" rowspan="1" %)RSSI|(% colspan="1" rowspan="1" %)(((

DS18B20 Temp

)))|(% colspan="1" rowspan="1" %)adc0|(% colspan="1" rowspan="1" %)(((

exit_state/input PA4

)))|(% colspan="1" rowspan="1" %)Weight|(% colspan="1" rowspan="1" %) |(% colspan="1" rowspan="1" %) |(% colspan="1" rowspan="1" %)

275

|(% colspan="1" rowspan="1" %)mod6|(% colspan="1" rowspan="1" %)mod|(% colspan="1" rowspan="1" %)(((

Battery

= 4. Datacake =

== 1.1 Define Product ==

284

285

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.

286

287

288

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".

289

290

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

291

292

== 1.2 Create Device ==

293

294

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

295

296

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

297

298

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

299

300

301

== 1.3 Create Database Fields ==

302

303

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.

304

305

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".

306

307

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

308

309

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

310

311

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

312

313

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

314

315

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

316

317

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

318

319

== 1.4 Set up Broker ==

320

321

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.

322

323

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.

324

325

View your Personal Access Token

326

327

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:

328

329

[[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.

334

335

AT+CLIENT=“Any value”

AT+UNAME=Token

AT+PWD=Token

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

342

343

344

== 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.

353

354

355

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

356

357

358

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

359

360

361

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

example:

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

367

368

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

369

370

== 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.

375

376

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

383

384

== 1.8 upload data ==

385

386

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

387

388

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

389

390

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

= =

= 5. Node-Red (via MQTT) =

395

396

397

== 1.1 Configure Node-Red ==

398

399

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

400

401

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

402

403

== 1.2 Simulate Connection ==

404

405

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

406

407

== 1.3 Configure NB-IoT Sensors ==

408

409

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

410

* AT+CLIENT=any value

411

* AT+UNAME=any value

412

* AT+PWD=any value

413

* AT+PUBTOPIC=any value

414

* AT+SUBTOPIC=any value

415

416

= 6. ThingsBoard.Cloud (via MQTT) =

417

418

== 1.1 Configure ThingsBoard ==

419

420

=== 1.1.1 Create Device ===

421

422

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

423

424

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

425

426

=== 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.

431

432

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.

433

434

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

Downlink Converter

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

440

441

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

442

443

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

444

445

=== 1.1.3 MQTT Integration Setup ===

446

447

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

448

449

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

450

451

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

452

453

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

454

455

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

Add a topic filter:

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

461

462

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

463

464

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

465

466

== 1.2 Simulate with MQTT.fx ==

467

468

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

469

470

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

471

472

== 1.3 Configure NB-IoT Sensor ==

AT Commands

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

477

478

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

479

480

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

481

482

483

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”