Update documentation.

Author: brocaar

README.md

@@ -48,6 +48,28 @@ INFO[0006] backend/mqttpubsub: publishing message        topic=gateway/1dee08d0b
 
 * Now it is time to setup the [LoRa Server](https://github.com/brocaar/loraserver)!
 
+## Debugging
+
+To view all incoming and outgoing MQTT messages, you can use the ``mosquitto_sub``
+tool.
+
+```bash
+$ mosquitto_sub -t "#" -v
+gateway/1dee08d0b691d149/stats {"mac":"1dee08d0b691d149","time":"2016-04-16T10:08:11Z","latitude":0,"longitude":0,"altitude":0,"rxPacketsReceived":0,"rxPacketsReceivedOK":0}
+gateway/1dee08d0b691d149/rx {"rxInfo":{"mac":"1dee08d0b691d149","time":"2016-04-16T10:08:30.005418Z","timestamp":1623489499,"frequency":868300000,"channel":1,"rfChain":1,"crcStatus":1,"codeRate":"4/5","rssi":-48,"loRaSNR":10,"size":23,"dataRate":{"modulation":"LORA","spreadFactor":7,"bandwidth":125}},"phyPayload":"AAEBAQEBAQEBAgICAgICAgJzTIBGXXg="}
+gateway/1dee08d0b691d149/stats {"mac":"1dee08d0b691d149","time":"2016-04-16T10:08:41Z","latitude":0,"longitude":0,"altitude":0,"rxPacketsReceived":1,"rxPacketsReceivedOK":1}
+```
+
+## Data model
+
+The data model is defined in the [LoRa Server](https://github.com/brocaar/loraserver)
+project. JSON is used as marshaling format. See:
+
+* [RXPacket](https://godoc.org/github.com/brocaar/loraserver/models/#RXPacket) (packet received by the gateway)
+* [TXPacket](https://godoc.org/github.com/brocaar/loraserver/models/#TXPacket) (packet to be sent by the gateway)
+* [GatewayStatsPacket](https://godoc.org/github.com/brocaar/loraserver/models/#GatewayStatsPacket) (gateway stats)
+
+
 ## License
 
 This package is licensed under the MIT license. See ``LICENSE``.

cmd/semtech-bridge/doc.go

@@ -1,6 +1,6 @@
 /*
 NAME:
-   semtech-bridge - Semtech UDP protocol speaking gateway <-> MQTT
+   semtech-bridge - communicate with a LoRa gateway (Semtech UDP protocol) over MQTT
 
 USAGE:
    main [global options] command [command options] [arguments...]
@@ -13,9 +13,13 @@ GLOBAL OPTIONS:
    --mqtt-server "tcp://127.0.0.1:1883"	MQTT server [$MQTT_SERVER]
    --mqtt-username 			MQTT username [$MQTT_USERNAME]
    --mqtt-password 			MQTT password [$MQTT_PASSWORD]
+   --log-level "4"			debug=5, info=4, warning=3, error=2, fatal=1, panic=0 [$LOG_LEVEL]
    --help, -h				show help
    --version, -v			print the version
    
+COPYRIGHT:
+   See http://github.com/brocaar/lora-semtech-bridge for copyright information
+   
 
 */
 package main

cmd/semtech-bridge/main.go

@@ -72,7 +72,7 @@ func run(c *cli.Context) {
 func main() {
 	app := cli.NewApp()
 	app.Name = "semtech-bridge"
-	app.Usage = "Semtech UDP protocol speaking gateway <-> MQTT"
+	app.Usage = "communicate with a LoRa gateway (Semtech UDP protocol) over MQTT"
 	app.Copyright = "See http://github.com/brocaar/lora-semtech-bridge for copyright information"
 	app.Version = version
 	app.Action = run