Skip to content

Commit e0ec321

Browse files
brocaarbrocaar
committed
Update documentation.
1 parent a524727 commit e0ec321

File tree

6 files changed

+28
-26
lines changed

6 files changed

+28
-26
lines changed

‎README.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,8 @@ packet_forwarder UDP protocol versions:
2222
| LoRa Gateway Bridge | packet_forwarder protocol version | Note |
2323
|---------------------|-----------------------------------|---------------------------------------------------------------------|
2424
| 1.x.x | 1 | |
25-
| 2.x.x | 2 | This protocol is used since version 3.0.0 of the `packet_forwarder` |
26-
27-
28-
LoRa Gateway Bridge v1.x.x will be update with bugfixes for the near future as
29-
not all gateways are using packet_forwarder v3.0.0+ yet.
25+
| 2.0.x | 2 | This protocol is used since version 3.0.0 of the `packet_forwarder` |
26+
| >= 2.1.x | 1 & 2 simultaneously | Both protocol versions are supported and auto-detected |
3027

3128
## Downloads
3229

‎cmd/lora-gateway-bridge/main.go‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ var version string // set by the compiler
1919
func run(c *cli.Context) error {
2020
log.SetLevel(log.Level(uint8(c.Int("log-level"))))
2121

22+
log.WithFields(log.Fields{
23+
"version": version,
24+
"docs": "https://docs.loraserver.io/lora-gateway-bridge/",
25+
}).Info("starting LoRa Gateway Bridge")
26+
2227
pubsub, err := mqttpubsub.NewBackend(c.String("mqtt-server"), c.String("mqtt-username"), c.String("mqtt-password"))
2328
if err != nil {
2429
log.Fatalf("could not setup mqtt backend: %s", err)

‎docs/changelog.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## 2.1.0
4+
5+
* Support protocol v1 & v2 simultaneously.
6+
37
## 2.0.2
48

59
* Rename from `lora-semtech-bridge` to `lora-gateway-bridge`

‎docs/getting-started.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,6 @@ to set your gateway up and create a pull-request!
5151

5252
## Installing the LoRa Gateway Brige
5353

54-
!!! warning "Compatibility"
55-
Please check the [Compatibility](index.md#compatibility) to make sure you
56-
download the correct LoRa Gateway Bridge version.
57-
5854
### Download
5955

6056
Download and unpack a pre-compiled binary from the
@@ -105,18 +101,21 @@ After changing the LoRa gateway configuration (and restarting the
105101
packet_forwarder!), you should see received packets in the logs. Example:
106102

107103
```
108-
INFO[0000] backend/mqttpubsub: connecting to mqtt broker server=tcp://127.0.0.1:1883
104+
INFO[0000] starting LoRa Gateway Bridge docs=https://docs.loraserver.io/lora-gateway-bridge/ version=2.1.0
105+
INFO[0000] backend: connecting to mqtt broker server=tcp://127.0.0.1:1883
109106
INFO[0000] gateway: starting gateway udp listener addr=0.0.0.0:1700
110-
INFO[0000] backend/mqttpubsub: connected to mqtt broker
111-
INFO[0006] gateway: received udp packet from gateway addr=192.168.1.8:45082 type=PullData
112-
INFO[0006] backend/mqttpubsub: subscribing to topic topic=gateway/1dee08d0b691d149/tx
113-
INFO[0006] gateway: sending udp packet to gateway addr=192.168.1.8:45082 type=PullACK
114-
INFO[0016] gateway: received udp packet from gateway addr=192.168.1.8:45082 type=PullData
115-
INFO[0016] gateway: sending udp packet to gateway addr=192.168.1.8:45082 type=PullACK
116-
INFO[0021] gateway: received udp packet from gateway addr=192.168.1.8:45738 type=PushData
117-
INFO[0021] gateway: stat packet received addr=192.168.1.8:45738 mac=1dee08d0b691d149
118-
INFO[0021] gateway: sending udp packet to gateway addr=192.168.1.8:45738 type=PushACK
119-
INFO[0021] backend/mqttpubsub: publishing packet topic=gateway/1dee08d0b691d149/stats
107+
INFO[0000] backend: connected to mqtt broker
108+
INFO[0001] gateway: received udp packet from gateway addr=192.168.1.10:51013 protocol_version=2 type=PullData
109+
INFO[0001] backend: subscribing to topic topic=gateway/1dee08d0b691d149/tx
110+
INFO[0001] gateway: sending udp packet to gateway addr=192.168.1.10:51013 protocol_version=2 type=PullACK
111+
INFO[0007] gateway: received udp packet from gateway addr=192.168.1.10:42125 protocol_version=2 type=PushData
112+
INFO[0007] gateway: stat packet received addr=192.168.1.10:42125 mac=1dee08d0b691d149
113+
INFO[0007] backend: publishing packet topic=gateway/1dee08d0b691d149/stats
114+
INFO[0007] gateway: sending udp packet to gateway addr=192.168.1.10:42125 protocol_version=2 type=PushACK
115+
INFO[0011] gateway: received udp packet from gateway addr=192.168.1.10:51013 protocol_version=2 type=PullData
116+
INFO[0011] gateway: sending udp packet to gateway addr=192.168.1.10:51013 protocol_version=2 type=PullACK
117+
INFO[0021] gateway: received udp packet from gateway addr=192.168.1.10:51013 protocol_version=2 type=PullData
118+
INFO[0021] gateway: sending udp packet to gateway addr=192.168.1.10:51013 protocol_version=2 type=PullACK
120119
```
121120

122121
For an explanation of the different types of data you can receive from and

‎docs/index.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ packet_forwarder UDP protocol versions:
1414
| LoRa Gateway Bridge | packet_forwarder protocol version | Note |
1515
|---------------------|-----------------------------------|---------------------------------------------------------------------|
1616
| 1.x.x | 1 | |
17-
| 2.x.x | 2 | This protocol is used since version 3.0.0 of the `packet_forwarder` |
18-
19-
20-
LoRa Gateway Bridge v1.x.x will be update with bugfixes for the near future as
21-
not all gateways are using packet_forwarder v3.0.0+ yet.
17+
| 2.0.x | 2 | This protocol is used since version 3.0.0 of the `packet_forwarder` |
18+
| >= 2.1.x | 1 & 2 simultaneously | Both protocol versions are supported and auto-detected |
2219

2320
## Downloads
2421

‎mkdocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ pages:
1414
- Kerlink IoT Station: gateways/kerlink-iot-station.md
1515

1616
extra:
17-
version: '2.0.2'
17+
version: '2.1.0'
1818
github:
1919
download_release: true
2020

0 commit comments

Comments
 (0)