Skip to content

Commit 2f56f86

Browse files
committed
Add README.
1 parent 454a3ce commit 2f56f86

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,45 @@
11
# LoRa Semtech Bridge
22

3+
[![Build Status](https://travis-ci.org/brocaar/lora-semtech-bridge.svg?branch=master)](https://travis-ci.org/brocaar/lora-semtech-bridge)
4+
[![GoDoc](https://godoc.org/github.com/brocaar/lora-semtech-bridge/cmd/semtech-bridge?status.svg)](https://godoc.org/github.com/brocaar/lora-semtech-bridge/cmd/semtech-bridge)
5+
36
*LoRa Semtech Bridge* is a service to handle LoRa gateway (Semtech UDP protocol)
4-
connections and communication with the ``loraserver``.
7+
connections and communication with the ``loraserver`` (https://github.com/brocaar/loraserver).
8+
9+
## Installation
10+
11+
12+
## Getting started
13+
14+
1. First install ``semtech-bridge``:
15+
16+
``` bash
17+
go get github.com/brocaar/lora-semtech-bridge/...
18+
```
19+
20+
2. Make sure you have a MQTT server running. Mosquitto is a good option:
21+
http://mosquitto.org/.
22+
23+
3. Start the ``semtech-bridge`` service. The ``--help`` argument will show
24+
you all the available config options. When everything is setup correctly
25+
(your gateway is configured to send data to ``semtech-bridge``), you
26+
should see ``PullData`` packets coming in. E.g.
27+
28+
``` bash
29+
$ ./bin/semtech-bridge
30+
INFO[0000] backend/mqttpubsub: connecting to mqtt server server=tcp://127.0.0.1:1883
31+
INFO[0000] starting gateway udp listener addr=0.0.0.0:1700
32+
INFO[0006] incoming gateway packet addr=192.168.1.4:54993 type=PullData
33+
INFO[0006] backend/mqttpubsub: subscribing to topic topic=gateway/1dee08d0b691d149/tx
34+
INFO[0006] outgoing gateway packet addr=192.168.1.4:54993 type=PullACK
35+
INFO[0006] incoming gateway packet addr=192.168.1.4:51926 type=PushData
36+
INFO[0006] stat packet received addr=192.168.1.4:51926 mac=1dee08d0b691d149
37+
INFO[0006] outgoing gateway packet addr=192.168.1.4:51926 type=PushACK
38+
INFO[0006] backend/mqttpubsub: publishing message topic=gateway/1dee08d0b691d149/stats
39+
```
40+
41+
4. Now setup the ``loraserver`` service! https://github.com/brocaar/loraserver
42+
43+
## License
44+
45+
This package is licensed under the MIT license which can be found in ``LICENSE``.

0 commit comments

Comments
 (0)