MQTT Forward Instruction

* Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]

18

* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>doc:Through MQTT to upload data.WebHome]])

19

* LG02, OLG02

* LG308, DLOS8

* LPS8

* LIG16

* MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)

= 2. Firmware Change Log for MQTT feature =

(((

This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.

33

)))

34

35

* LG02_LG08-5.3.1580178039

** Initiate version

= 3. MQTT forward operating principle =

42

43

44

== 3.1 Network Structure ==

45

46

47

Below shows the network structure for MQTT forwarding.

48

49

* For Uplink: The sensor sends data to LoRa Gateway via LoRa wireless, The gateway will process these data and forward to remote MQTT Broker via Internet.

50

* For Downlink: The gateway subscribe a topic in the MQTT broker, when there is update on the topic, the gateway will know and broadcast the data to Local LoRa network,

51

52

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

53

54

General MQTT structure

55

56

57

== 3.2 How sensor data is forwarded ==

58

59

In this MQTT forward feature, the key point is how the gateway process the sensor data.

60

61

62

=== 3.2.1 Upstream ===

63

64

Assume there are two sensor nodes, their ID are Node1 ID: 6734 , Node2 ID: 7456. In the remote MQTT broker there are two topics: Topic1: /channel/765800, Topic2: /channel/367860. We can set up in the gateway to map Node1 to Topic1 and Node2 to Topic2. So when there is a sensor data from Node1, the gateway will forward the data to Topic1, when there is sensor data from Node2, the gateway will forward to Topic2.

65

66

(((

67

The data flow works as below diagram.

68

)))

69

70

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

(((

Upstream path

)))

(((

Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>

)))

(((

)))

=== 3.2.2 Downstream ===

85

86

The gateway subscribes to a topic of the remote MQTT broker topic. When there is some one publish a value on this topic. The gateway will get it and broadcast to local LoRa Network.

87

88

(((

89

Below are the data flow for downstream.

90

)))

91

92

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

Downstream path

== 3.3 Macro Definition ==

98

99

The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.

100

101

(((

102

Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.

)))

=== 3.3.1 -t topic macro ===

108

109

* CHANNEL: Remote Channel ID

110

* CLIENTID: Client ID , Same as -i

111

* WRITE_API: Remote Channel Write API

112

* USERNAME: User ID (-u)

113

* HOSTNAME: Device Hostname

114

115

=== 3.3.2 -m message macro ===

116

117

* HOSTNAME: Device Hostname

118

* CHANNEL: Remote Channel ID

119

* DATA: Sensor Data without time stamp and rssi

120

* META: Completely sensor data with time stamp and rssi

121

* JSON: Convert META to json format.

122

123

=== 3.3.3 Example for Macro ===

124

125

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

126

127

MQTT Publish configure

128

129

130

Above screen shots shows below format:

131

132

* -t: CLIENTID/CHANNEL/data

133

* -m: DATA

134

135

When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:

136

137

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

Sensor Data

(((

According to above macro. Gateway will publish (% style="color:#4f81bd" %)**field1=22.0&field2=49.0**(%%) to topic: (% style="color:#4f81bd" %)**dragino-1b7060/78901/data**(%%), where 78901 is the remote channel for this node ID.

)))

== 3.4 Modify the MQTT to support more options ==

148

149

The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands. User can check the valid options by command mosquitto_pub ~-~-help. as below:

(% class="box" %)

(((

root@dragino-1ec39c:~~# mosquitto_pub ~-~-help

154

mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit.

155

mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.

156

\\Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}

157

{-f file | -l | -n | -m message}

158

[-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time]

159

[-A bind_address]

160

[-i id] [-I id_prefix]

161

[-d] [~-~-quiet]

162

[-M max_inflight]

163

[-u username [-P password]]

164

[~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]

165

[{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]

166

[~-~-ciphers ciphers] [~-~-insecure]

167

[~-~-tls-alpn protocol]

168

[~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]

169

[~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]

170

[~-~-proxy socks-url]

171

[~-~-property command identifier value]

172

[-D command identifier value]

173

mosquitto_pub ~-~-help

174

\\-A : bind the outgoing socket to this host/ip address. Use to control which interface

175

the client communicates over.

176

-d : enable debug messages.

177

-D : Define MQTT v5 properties. See the documentation for more details.

178

-f : send the contents of a file as the message.

179

-h : mqtt host to connect to. Defaults to localhost.

180

-i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id.

181

-I : define the client id as id_prefix appended with the process id. Useful for when the

182

broker is using the clientid_prefixes option.

183

-k : keep alive in seconds for this client. Defaults to 60.

184

-L : specify user, password, hostname, port and topic as a URL in the form:

185

mqtt(s):~/~/[username[:password]@]host[:port]/topic

186

-l : read messages from stdin, sending a separate message for each line.

187

-m : message payload to send.

188

-M : the maximum inflight messages for QoS 1/2..

189

-n : send a null (zero length) message.

190

-p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS.

191

-P : provide a password

192

-q : quality of service level to use for all messages. Defaults to 0.

193

-r : message should be retained.

194

-s : read message from stdin, sending the entire input as a message.

195

-t : mqtt topic to publish to.

196

-u : provide a username

197

-V : specify the version of the MQTT protocol to use when connecting.

198

Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311.

199

~-~-help : display this message.

200

~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.

201

~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0.

202

~-~-quiet : (% style="color:red" %)don't print error messages.

203

~-~-will-payload : payload for the client Will, which is sent by the broker in case of

204

unexpected disconnection. If not given and will-topic is set, a zero

205

length message will be sent.

206

~-~-will-qos : QoS level for the client Will.

207

~-~-will-retain : if given, make the client Will retained.

208

~-~-will-topic : the topic on which to publish the client Will.

209

~-~-cafile : path to a file containing trusted CA certificates to enable encrypted

210

communication.

211

~-~-capath : path to a directory containing trusted CA certificates to enable encrypted

212

communication.

213

~-~-cert : client certificate for authentication, if required by server.

214

~-~-key : client private key for authentication, if required by server.

215

~-~-keyform : keyfile type, can be either "pem" or "engine".

216

~-~-ciphers : openssl compatible list of TLS ciphers to support.

217

~-~-tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.

218

Defaults to tlsv1.2 if available.

219

~-~-insecure : do not check that the server certificate hostname matches the remote

220

hostname. Using this option means that you cannot be sure that the

221

remote host is the server you wish to connect to and so is insecure.

222

Do not use this option in a production environment.

223

~-~-tls-engine : If set, enables the use of a TLS engine device.

224

~-~-tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.

225

~-~-psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.

226

~-~-psk-identity : client identity string for TLS-PSK mode.

227

~-~-proxy : SOCKS5 proxy URL of the form:

228

socks5h:~/~/[username[:password]@]hostname[:port]

229

Only "none" and "username" authentication is supported.

230

\\See https:~/~/mosquitto.org/ for more information.

)))

(((

and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines:

)))

(% class="box" %)

(((

//# Call MQTT Publish command

241

\\# 1. Case with User, Password and Client ID present (e.g. Azure)

242

if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then

243

case="1"

244

mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user -P "$pass" $C $cafile $PUB_FLAG "$mqtt_data"

245

\\# 2. Case with Certificate, Key and ClientID present (e.g. AWS)

246

elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then

247

case="2"

248

mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic ~-~-cert $cert ~-~-key $key $C $cafile $PUB_FLAG "$mqtt_data"

249

\\# 3. Case with no User, Certificate or ClientID present

250

elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then

251

case="3"

252

mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"

253

\\# 4. Case with no User, Certificate, but with ClientID present

254

elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then

255

case="4"

256

mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"

257

\\# 5. Case with User and ClientID present, but no Password and no Certificate present

258

elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then

259

case="5"

260

mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"

261

\\# 6. Case with User and Password present, but no ClientID and no Certificate present

262

elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then

263

case="6"

264

mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"

265

\\# 0. Else - invalid parameters, just log

266

else

267

case="(% style="color:red" %)Invalid parameters" (%%)

268

logger (% style="color:red" %)"[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."(%%)

fi//

)))

= 4. Example to communicate to a simple MQTT server =

== 4.1 Overview ==

This section is an example to show how to set up LG01-N to communicate with a MQTT server. The MQTT server is a simple utility set up in a local PC. Note: User can set up same server via [[this instruction>>url:http://www.steves-internet-guide.com/install-mosquitto-broker/]].

278

279

280

== 4.2 Simulate via MQTT.fx utility ==

281

282

The [[MQTT.fx>>url:http://mqttfx.jensd.de/index.php/download]] is a MQTT client tool. We can use this to simulate a MQTT connection to our MQTT broker first to make sure the MQTT broker works. This will also help us understand how it works.

283

284

(((

285

In this test, the MQTT broker and MQTT.fx are installed in the same PC, so the MQTT server address in MQTT.fx should be localhost. Below shows how to connect to the server.

286

)))

287

288

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

289

290

Connect to MQTT Broker

291

292

293

After connected, use publish to public some thing to MQTT server. This to simulate upsteam

294

295

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

296

297

Upstream: Publish message to MQTT Broker

298

299

300

To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:

301

302

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

303

304

Downstream: Subscribe a topic to get downstream

305

306

307

== 4.3 Simulate via Dragino Command Line ==

308

309

For first try of MQTT connection, simulate via command line is recommend, there are many servers / connection type for MQTT. They are using different connection parameters. Simulating the connection via command line will help us rapidly connect to server and debug.

310

311

In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.

312

313

314

(% style="color:#4f81bd" %)**For Upstream**

315

316

command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]

317

318

Example: mosquitto_pub -h 192.168.199.148 -p 1883 -t /channel/6543 -m temp=36

319

320

Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network.

321

322

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

mosquitto_pub

(% style="color:#4f81bd" %)**For Downstream**

328

329

Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.

330

331

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

mosquitto_sub

== 4.4 Configure Dragino UI for MQTT connection ==

337

338

This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.

339

340

(((

341

Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**

342

)))

343

344

[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]

345

346

go to mqtt configure menu

(((

Select (% style="color:#4f81bd" %)**Forward to MQTT server**. (% style="color:red" %)**Notice**(%%): This option is removed from the latest firmware, in the latest firmware, if user submit "SAVE & APPLY" in MQTT page, the gateway will use MQTT service.

351

)))

352

353

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

forward to MQTT

=== 4.4.1 Configure the MQTT Client for Upstream ===

359

360

Below screenshot is same as the publish command:

(% class="box" %)

(((

mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA

365

~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for

366

~/~/CLIENTID: dragino-1b7060

367

~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456

368

~/~/DATA: The data stores in /var/iot/channels/

369

)))

370

371

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

372

373

MQTT Publish configure

374

375

376

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

377

378

MQTT Channel settings

(((

For example, if we put a data(temp=46) on the file /var/iot/channels/4567, because 4567 match the remote channel 78901. the gateway will run this command:

)))

(% class="box" %)

(((

mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46

)))

(((

to MQTT broker.

)))

(((

Below is a simulation to put this data to active the MQTT publish.

397

)))

398

399

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

MQTT Publish

=== 4.4.2 Configure the MQTT Client for Downstream ===

405

406

Below screen shot equal to this subscribe command:

(% class="box" %)

(((

mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.

411

)))

412

413

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

MQTT Subscribe

(((

When MQTT broker receive a update on this topic, the gateway will get the update and use LoRa radio to broadcast this message. The LoRa parameters used for update is:

420

)))

421

422

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

423

424

LoRa Broadcast parameters.

425

426

427

And below is the subscribe simulation:

428

429

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

430

431

downstream simulation

432

433

434

== 4.5 Add LoRa support to communicate with remote sensor ==

435

436

In above section, we have configured the UI to support MQTT upstream and downstream. We can simulate via Linux command. In this section, we will guide how to communicate with remote LoRa End Node for upstream and downstream.

437

438

439

=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===

440

441

(((

442

We can use [[LoRa Shield>>url:http://www.dragino.com/products/lora/item/102-lora-shield.html]] to send LoRa Raw data to Gateway and receive data from gateway.

)))

(((

The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]

)))

(((

And this link is the required library: [[arduino-LoRa-master>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]. Unzip this library and put in Arduino library location.

)))

(((

What does the Arduino Sketch do? The Arduino Sketch will:

455

)))

456

457

* Upstream: Keep sending a LoRa Message every minutes with this payload : <4567>tem=xx&hum=yy (Where xx and yy are temperature and humidity value generated randomly).

458

* Downstream: Listening broadcast message from gateway, and print it in console.

459

* The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:

460

461

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

462

463

LoRa Parameter should match

Below is the test result after the Arduino Sketch is running.

468

469

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

Upstream Data Flow

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

Downstream Data Flow

=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===

481

482

(((

483

Since firmware (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% style="color:#4f81bd" %)**ABP end node**(%%) locally without the need of LoRaWAN server. This feature allow us to integrate MQTT in the gateway to support LoRaWAN to MQTT forwarding or visa verse.

)))

(((

When use test this feature, please use the version higher then : (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration.

488

(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]

)))

(((

(% style="color:#4f81bd" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308]] to know how to set up LG308 to work with LoRaWAN End node.

)))

(((

(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.

497

)))

498

499

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

500

501

Use Same Frequency Band as End Node

(((

(((

(% style="color:#4f81bd" %)**Step 3**(%%): Set up publish format and MQTT channel. The LG308 will store the Data from End node in (% style="color:#4f81bd" %)**HEX format**(%%) in the file.

)))

)))

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

(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.

515

516

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

(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server

521

522

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

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

Choose ASCII Format

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

LHT65 Decoder

(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.

540

541

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

(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.

546

547

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

=== MQTT Downstream format ===

552

553

554

mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"

555

556

(% class="box infomessage" %)

557

(((

558

mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"

559

)))

560

561

mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"

562

563

(% class="box infomessage" %)

564

(((

565

mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2 > /var/iot/push/test"

566

)))

567

568

Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]

569

570

[[image:image-20220613192816-6.png||height="440" width="1056"]]

571

572

(% style="color:red" %)**Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308||anchor="H2.2Downstream"]]**

573

574

Check out this link for more mosquito-related directives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]

= 5. How to Debug =

User can login the gateway's console and run (% style="color:#4f81bd" %)**logread -f**(%%). It will shows the output when there is packet arrive.User can see if it is correct.

579

580

581

= 6. How to ask for Support =

582

583

If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:

584

585

* Detail of your LoRaWAN end node.

586

* Gateway Model and firmware version