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 07:26:52 +01:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source 
Signed-off-by: tomoaki <tomoaki@tomy-tech.com>
This commit is contained in:
tomoaki
2021-04-30 19:20:39 +09:00
parent e4ccfe9487
commit 5c7cefdf48
3 changed files with 17 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.gitignore vendored
View File

@@ -10,3 +10,8 @@
/Release/ /Release/
/Debug/ /Debug/
/core /core
Build
*.a
CMakeFiles/
*.cmake
CMakeCache.txt

29
MQTTSNGateway/README.md
View File

@@ -5,27 +5,21 @@ This Gateway can run as a transparent or aggregating Gateway by specifying the g
### **step1. Build the gateway** ### **step1. Build the gateway**
```` ````
$ git clone -b develop https://github.com/eclipse/paho.mqtt-sn.embedded-c $ git clone -b develop https://github.com/eclipse/paho.mqtt-sn.embedded-c
$ cd paho.mqtt-sn.embedded-c/MQTTSNGateway $ cmake .. [-DSENSORNET={udp|udp6|xbee|loralink}]
$ make [SENSORNET={udp6|xbee|loralink}] $ make
$ make install
$ make clean
```` ````
By default, a gateway for UDP is built. By default, a gateway for UDP is built.
In order to create a gateway for UDP6, XBee or LoRaLink, SENSORNET argument is required. In order to create a gateway for UDP6, XBee or LoRaLink, -DSENSORNET argument is required.
MQTT-SNGateway, MQTT-SNLogmonitor and *.conf files are copied into ../ directory. MQTT-SNGateway and MQTT-SNLogmonitor (executable programs) are built in the Build directory.
If you want to install the gateway into specific directories, enter a command line as follows:
````
$ make install INSTALL_DIR=/path/to/your_directory CONFIG_DIR=/path/to/your_directory
````
### **step2. Execute the Gateway.** ### **step2. Execute the Gateway.**
```` ````
$ cd ../../
$ ./MQTT-SNGateway [-f Config file name] $ ./Build/MQTT-SNGateway -f ./MQTTSNGateway/gateway.conf
```` ````
If you get the error message as follows: If you get the error message as follows:
```` ````
@@ -34,13 +28,12 @@ Aborted (core dumped)
```` ````
You have to start using sudo command only once for the first time. You have to start using sudo command only once for the first time.
```` ````
$ sudo ./MQTT-SNGateway [-f Config file name] $ sudo ./Build/MQTT-SNGateway -f ./MQTTSNGateway/gateway.conf
```` ````
### **How to Change the configuration of the gateway** ### **How to Change the configuration of the gateway**
**../gateway.conf** Contents are follows: **gateway.conf** Contents are follows:
<pre><dev>
# config file of MQTT-SN Gateway # config file of MQTT-SN Gateway
# #
@@ -102,7 +95,7 @@ DeviceTxLoRaLink=/dev/ttyLoRaLinkTx
# LOG # LOG
ShearedMemory=NO; ShearedMemory=NO;
</dev></pre>
**BrokerName** to specify a domain name of the Broker, and **BrokerPortNo** is a port No of the Broker. **BrokerSecurePortNo** is for TLS connection. **BrokerName** to specify a domain name of the Broker, and **BrokerPortNo** is a port No of the Broker. **BrokerSecurePortNo** is for TLS connection.
**MulticastIP** and **MulticastPortNo** is a multicast address for GWSEARCH messages. Gateway is waiting GWSEARCH and when receiving it send GWINFO message via MulticastIP 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 GWSEARCH messages. Gateway is waiting GWSEARCH and when receiving it send GWINFO message via MulticastIP address. Clients can get the gateway address (Gateway IP address and **GatewayPortNo**) from GWINFO message by means of std::recvfrom().

2
README.md
View File

@@ -22,7 +22,7 @@ MQTT project, but it's not yet complete.
## Build requirements / compilation ## Build requirements / compilation
CMake builds for MQTTSNPacket with a Makefile for MQTTSNGateway have been introduced, along with Travis-CI configuration for automated build & testing. CMake builds have been introduced, along with Travis-CI configuration for automated build & testing.
The travis-build.sh file has the full build and test sequence for Linux. The travis-build.sh file has the full build and test sequence for Linux.