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

= 3.2 General MQTT Connection =

66

67

68

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

69

70

Below are the commands.

**AT Commands:**

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

75

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

76

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

77

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

78

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

79

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

80

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

81

82

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

83

84

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

85

86

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

91

92

== 1.1 Get MQTT Credentials ==

93

94

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

95

96

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

97

98

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

99

100

101

== 1.2. Simulate with MQTT.fx ==

102

103

=== 1.2.1 Establish MQTT Connection ===

104

105

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

106

107

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

108

109

* Broker Address: mqtt3.thingspeak.com

110

* Broker Port: 1883

111

* Client ID: <Your ThingSpeak MQTT ClientID>

112

* User Name: <Your ThingSpeak MQTT User Name>

113

* Password: <Your ThingSpeak MQTT Password>

114

115

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

116

117

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

118

119

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

120

121

In MQTT.fx, we can publish below info:

122

123

* Topic: channels/YOUR_CHANNEL_ID/publish

124

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

125

126

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

Result:

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

132

133

134

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

135

136

=== 1.3.1 AT Commands: ===

137

138

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

139

140

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

141

* AT+CLIENT=<Your ThingSpeak MQTT ClientID>

142

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

143

* AT+PWD=<Your ThingSpeak MQTT Password>

144

* AT+PUBTOPIC=<YOUR_CHANNEL_ID>

145

* AT+SUBTOPIC=<YOUR_CHANNEL_ID>

146

147

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

175

176

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.

177

178

179

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

180

181

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

182

183

184

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" %)

263

|(% 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" %)

276

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

Battery

= 4. Datacake =

== 1.1 Define Product ==

285

286

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.

287

288

289

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

290

291

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

292

293

== 1.2 Create Device ==

294

295

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

296

297

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

298

299

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

300

301

302

== 1.3 Create Database Fields ==

303

304

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.

305

306

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

307

308

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

309

310

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

311

312

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

313

314

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

315

316

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

317

318

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

319

320

== 1.4 Set up Broker ==

321

322

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.

323

324

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.

325

326

View your Personal Access Token

327

328

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:

329

330

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

335

336

AT+CLIENT=“Any value”

AT+UNAME=Token

AT+PWD=Token

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

343

344

345

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

354

355

356

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

357

358

359

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

360

361

362

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

example:

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

368

369

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

370

371

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

376

377

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

384

385

== 1.8 upload data ==

386

387

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

388

389

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

390

391

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

= =

= 5. Node-Red (via MQTT) =

396

397

398

== 1.1 Configure Node-Red ==

399

400

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

401

402

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

403

404

== 1.2 Simulate Connection ==

405

406

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

407

408

== 1.3 Configure NB-IoT Sensors ==

409

410

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

411

* AT+CLIENT=any value

412

* AT+UNAME=any value

413

* AT+PWD=any value

414

* AT+PUBTOPIC=any value

415

* AT+SUBTOPIC=any value

416

417

= 6. ThingsBoard.Cloud (via MQTT) =

418

419

== 1.1 Configure ThingsBoard ==

420

421

=== 1.1.1 Create Device ===

422

423

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

424

425

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

426

427

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

432

433

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.

434

435

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

Downlink Converter

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

441

442

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

443

444

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

445

446

=== 1.1.3 MQTT Integration Setup ===

447

448

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

449

450

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

451

452

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

453

454

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

455

456

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

Add a topic filter:

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

462

463

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

464

465

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

466

467

== 1.2 Simulate with MQTT.fx ==

468

469

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

470

471

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

472

473

== 1.3 Configure NB-IoT Sensor ==

AT Commands

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

478

479

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

480

481

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

482

483

484

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”