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)

24

25

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

30

)))

31

32

* LG02_LG08-5.3.1580178039

33

** Initiate version

34

35

= 3. MQTT forward operating principle =

36

37

38

== 3.1 Network Structure ==

39

40

41

Below shows the network structure for MQTT forwarding.

42

43

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

44

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

45

46

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

47

48

General MQTT structure

== 3.2 How sensor data is forwarded ==

53

54

55

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

56

57

58

=== 3.2.1 Upstream ===

59

60

61

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.

62

63

(((

64

The data flow works as below diagram.

)))

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

(((

Upstream path

)))

(((

(% style="color:red" %)**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 ===

86

87

88

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.

89

90

(((

91

Below are the data flow for downstream.

92

)))

93

94

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

Downstream path

== 3.3 Macro Definition ==

101

102

103

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

104

105

(((

106

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

)))

=== 3.3.1 -t topic macro ===

113

114

115

* CHANNEL: Remote Channel ID

116

* CLIENTID: Client ID , Same as -i

117

* WRITE_API: Remote Channel Write API

118

* USERNAME: User ID (-u)

119

* HOSTNAME: Device Hostname

120

121

=== 3.3.2 -m message macro ===

122

123

124

* HOSTNAME: Device Hostname

125

* CHANNEL: Remote Channel ID

126

* DATA: Sensor Data without time stamp and rssi

127

* META: Completely sensor data with time stamp and rssi

128

* JSON: Convert META to json format.

129

130

=== 3.3.3 Example for Macro ===

131

132

133

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

134

135

MQTT Publish configure

136

137

138

**Above screen shots shows below format:**

139

140

* -t: CLIENTID/CHANNEL/data

141

* -m: DATA

142

143

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

144

145

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

157

158

159

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

164

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

165

mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.

166

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

167

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

168

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

169

[-A bind_address]

170

[-i id] [-I id_prefix]

171

[-d] [~-~-quiet]

172

[-M max_inflight]

173

[-u username [-P password]]

174

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

175

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

176

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

177

[~-~-tls-alpn protocol]

178

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

179

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

180

[~-~-proxy socks-url]

181

[~-~-property command identifier value]

182

[-D command identifier value]

183

mosquitto_pub ~-~-help

184

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

185

the client communicates over.

186

-d : enable debug messages.

187

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

188

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

189

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

190

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

191

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

192

broker is using the clientid_prefixes option.

193

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

194

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

195

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

196

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

197

-m : message payload to send.

198

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

199

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

200

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

201

-P : provide a password

202

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

203

-r : message should be retained.

204

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

205

-t : mqtt topic to publish to.

206

-u : provide a username

207

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

208

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

209

~-~-help : display this message.

210

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

211

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

212

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

213

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

214

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

215

length message will be sent.

216

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

217

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

218

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

219

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

220

communication.

221

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

222

communication.

223

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

224

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

225

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

226

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

227

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

228

Defaults to tlsv1.2 if available.

229

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

230

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

231

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

232

Do not use this option in a production environment.

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

251

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

252

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

253

case="1"

254

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"

255

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

256

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

257

case="2"

258

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"

259

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

260

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

261

case="3"

262

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

263

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

264

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

265

case="4"

266

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

267

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

268

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

269

case="5"

270

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

271

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

272

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

273

case="6"

274

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

275

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

276

else

277

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

278

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/]].

291

292

293

== 4.2 Simulate via MQTT.fx utility ==

294

295

296

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.

297

298

(((

299

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.

300

)))

301

302

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

303

304

Connect to MQTT Broker

305

306

307

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

308

309

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

310

311

Upstream: Publish message to MQTT Broker

312

313

314

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

315

316

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

317

318

Downstream: Subscribe a topic to get downstream

== 4.3 Simulate via Dragino Command Line ==

323

324

325

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.

326

327

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

328

329

330

(% style="color:blue" %)**For Upstream**

331

332

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

333

334

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

335

336

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

337

338

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

mosquitto_pub

(% style="color:blue" %)**For Downstream**

345

346

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

347

348

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

mosquitto_sub

== 4.4 Configure Dragino UI for MQTT connection ==

355

356

357

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

358

359

(((

360

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

361

)))

362

363

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

364

365

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.

370

)))

371

372

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

forward to MQTT

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

379

380

381

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

386

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

387

~/~/CLIENTID: dragino-1b7060

388

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

389

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

)))

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

394

395

MQTT Publish configure

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

400

401

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.

420

)))

421

422

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

MQTT Publish

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

429

430

431

Below screen shot equal to this subscribe command:

(% class="box" %)

(((

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

436

)))

437

438

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

445

)))

446

447

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

448

449

LoRa Broadcast parameters.

450

451

452

And below is the subscribe simulation:

453

454

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

455

456

downstream simulation

457

458

459

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

460

461

462

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.

463

464

465

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

(((

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:

484

)))

485

486

* 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).

487

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

488

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

489

490

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

491

492

LoRa Parameter should match

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

497

498

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

(((

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.

519

520

521

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

)))

(((

(% style="color:blue" %)**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:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.

530

)))

531

532

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

533

534

Use Same Frequency Band as End Node

(((

(((

(% style="color:blue" %)**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:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.

548

549

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

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

554

555

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

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

Choose ASCII Format

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

LHT65 Decoder

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

573

574

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

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

579

580

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

=== 4.5.3 MQTT Downstream format ===

585

586

587

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

588

589

(% class="box infomessage" %)

590

(((

591

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

592

)))

593

594

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

595

596

(% class="box infomessage" %)

597

(((

598

**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"**

599

)))

600

601

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

602

603

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

604

605

606

(% 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"]]**

607

608

609

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.

617

618

619

= 6. How to ask for Support =

620

621

622

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

623

624

* Detail of your LoRaWAN end node.

625