GitHub/paho.mqtt-sn.embedded-c
1
0
Fork 0
mirror of https://github.com/eclipse/paho.mqtt-sn.embedded-c.git synced 2025-12-13 15:36:51 +01:00
Code Issues Projects Releases Wiki Activity

Update: Create param.conf and key files automatically.

Browse Source 
BugFix: change parameter name BroadcastIp and BroadcastPortNo to
MulticastIP and MulticastPortNo, respectively.
Update: Makefile to copy param.conf and build Log monitor.
Update: README 

Signed-off-by: tomoaki <tomoaki@tomy-tech.com>
This commit is contained in:
tomoaki
2016-07-03 10:00:57 +09:00
parent 691f046078
commit 4bdec4a11f
10 changed files with 110 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
MQTTSNGateway/README.md
View File

@@ -2,53 +2,82 @@
### **step1. Build the gateway**
````
$ git clone -b gateway https://github.com/eclipse/paho.mqtt-sn.embedded-c
$ make
$ git clone -b gateway https://github.com/eclipse/paho.mqtt-sn.embedded-c
$ cd paho.mqtt-sn.embedded-c
$ make
$ make install
$ make clean
```
or compile with Eclipse CDT
MQTT-SNGateway, MQTT-SNLogmonitor and param.conf are copied into ../ directory.
### **step2. Create configuration file of the gateway**
Create **/usr/local/etc/mqttsnGateway/config/param.conf**
Contents are follows:
### **step2. Execute the Gateway.**
````
$ cd ../
$ ./MQTT-SNGateway
````
MQTT-SN clients should run in differnt from a host of the gateway. Other wise the gateway can't receive multicast packets form clients.
### **How to Change the configuration of the gateway**
**../param.conf** Contents are follows:
````
BrokerName=test.mosquitto.org
BrokerPortNo=1883
SecureConnection=NO
#BrokerPortNo=8883
#SecureConnection=YES
ClientAuthorization=NO
GatewayID=1
GatewayName=PahoGateway-01
KeepAlive=900
#LoginID=
#Password=
BroadcastIP=225.1.1.1
GatewayPortNo=2000
BroadcastPortNo=1883
# config file of MQTT-SN Gateway
BrokerName=test.mosquitto.org
BrokerPortNo=1883
SecureConnection=NO
#BrokerPortNo=8883
#SecureConnection=YES
ClientAuthorization=NO
GatewayID=1
GatewayName=PahoGateway-01
KeepAlive=900
#LoginID=
#Password=
# UDP
GatewayPortNo=2000
MulticastIP=225.1.1.1
MulticastPortNo=1883
# XBee
Baudrate=38400
SerialDevice=/dev/ttyUSB0
```
**BrokerName** to specify a domain name of the Broker, and **BrokerPortNo** is a port No of the Broker. If the Broker have to connected via TLS, set BrokerPortNo=8883 and **SecureConnection=YES**.
**BroadcastIP** and **BroadcastPortNo** is a multicast address for ADVERTISE, GWSEARCH and GWINFO messages. Gateway is waiting GWSEARCH multicast message and when receiving it send GWINFO message via Broadcast address. Clients can get the gateway address (Gateway IP address and **GatewayPortNo**) from GWINFO message by means of std::recvfrom(),
**MulticastIP** and **MulticastPortNo** is a multicast address for ADVERTISE, GWSEARCH and GWINFO messages. Gateway is waiting GWSEARCH multicast message and when receiving it send GWINFO message via Broadcast address. Clients can get the gateway address (Gateway IP address and **GatewayPortNo**) from GWINFO message by means of std::recvfrom(),
Client should know the BroadcastIP and PortNo to send a SEARCHGW message.
**GatewayId** is defined by GWSEARCH message.
**KeepAlive** is a duration of ADVERTISE message in seconds.
when **ClientAuthorization** is YES, see MQTTSNGWClient.cpp line53, /usr/local/etc/mqttsnGateway/config/clientList.conf file is required. this file defines connect able clients by IPaddress and PortNo.
when **ClientAuthorization** is YES, see MQTTSNGWClient.cpp line53, /usr/local/etc/mqttsnGateway/config/clientList.conf file is required. this file defines connect able clients by IPaddress and PortNo.
### **step3. Create key files of the ring buffer**
Create the following 3 empty files as key files.
1) /usr/local/etc/mqttsnGateway/config/**rbmutex.key**
2) /usr/local/etc/mqttsnGateway/config/**ringbuffer.key**
3) /usr/local/etc/mqttsnGateway/config/**semaphore.key**
### **step4. Execute the Gateway.**
This must not be the same machine as the Client.
`$ ./MQTT-SNGateway`
### ** How to change the config files directory. **
The directory is defined in MQTTSNGWProcess.h line33.
change this value to new directory you want to use.
`#define MQTTSNGW_CONFIG_DIRECTORY "./"`
### ** How to monitor the gateway from remote. **
Uncomment line32 in MQTTSNGWDefined.h.
`//#define RINGBUFFER // print out Packets log into shared memory./"`
````
$ make
$ make install
$ make clean
````
restart the gateway.
open ssh terminal and execute LogMonitor.
`$ ./MQTT-SNLogmonitor`
Now you can get the Log on your terminal.