Skip to content

Commit 923653d

Browse files
brocaarbrocaar
committed
Update gateway documentation.
1 parent f909cf2 commit 923653d

File tree

7 files changed

+182
-84
lines changed

7 files changed

+182
-84
lines changed

‎docs/frequently-asked-questions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ There are many issues that can cause packet-loss (data is not received or
66
transmitted by the gateway). Here are some hints:
77

88
* Compile the packet_forwarder with debugging enabled, it might give you a clue
9-
about what is going wrong. See [packet_forwarder](packet-forwarder.md)
10-
installation instructions.
9+
about what is going wrong. Before compiling the packet_forwarder, you can
10+
set the debug flags in `lora_gateway/libloragw/library.cfg`.
1111

1212
* Make sure the packet_forwarder is configured with the right configuration.
1313
Each region has different frequencies as documented by the LoRaWAN specs. See

‎docs/gateways/airfy-gateboard-aytgb-137-8.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Airfy GateBoard AYTGB-137-8
2+
3+
This document describes how to setup the [packet_forwarder](https://github.com/Lora-net/packet_forwarder/)
4+
for the Airfy GateBoard AYTGB-137-8 board. It assumes your Airfy GateBoard is
5+
connected to a single-board computer like a Raspberry Pi running a Debian(like)
6+
distribution.
7+
8+
## Requirements
9+
10+
Before you're able to compile the packet_forwarder, install a few requirements:
11+
12+
```bash
13+
sudo apt-get install gcc make git
14+
```
15+
16+
## Get the source
17+
18+
!!! warning "Compatibility"
19+
As the Airfy GateBoard has an FPGA v27 (based on the Semtech SX1301AP2 Ref
20+
Design), make sure you download 4.0.1+ of
21+
[lora_gateway](https://github.com/Lora-net/lora_gateway)!
22+
23+
```bash
24+
# get the driver / hardware abstraction layer source
25+
git clone https://github.com/Lora-net/lora_gateway.git
26+
27+
# get the packet_forwarder source
28+
git clone https://github.com/Lora-net/packet_forwarder.git
29+
```
30+
31+
## Building
32+
33+
``` bash
34+
# first build the driver / hal library
35+
cd lora_gateway
36+
make all
37+
cd ..
38+
39+
# secondly, build the packet_forwarder (and tools)
40+
cd packet_forwarder
41+
make all
42+
```
43+
44+
## Configuration & usage
45+
46+
From here on, please follow the instructions documented in:
47+
48+
* [https://github.com/Lora-net/packet_forwarder/blob/master/lora_pkt_fwd/readme.md](https://github.com/Lora-net/packet_forwarder/blob/master/lora_pkt_fwd/readme.md#4-usage)
49+
* [github.com/Lora-net/packet_forwarder/](https://github.com/Lora-net/packet_forwarder/)
50+
* [Getting started](../getting-started.md)

‎docs/gateways/imst-ic880a.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# IMST iC880A
2+
3+
This document describes how to setup the [packet_forwarder](https://github.com/Lora-net/packet_forwarder/)
4+
for the [IMST iC88A](http://www.wireless-solutions.de/products/radiomodules/ic880a.html) board.
5+
It assumes the IMST iC880A is connected to a single-board compulter like
6+
a BeagleBone Black or Raspberry PI) running a Debian(like) distribution.
7+
8+
## Requirements
9+
10+
Before you're able to compile the packet_forwarder, install a few requirements:
11+
12+
```bash
13+
sudo apt-get install gcc make git
14+
```
15+
16+
## Get the source
17+
18+
```bash
19+
# get the driver / hardware abstraction layer source
20+
git clone https://github.com/Lora-net/lora_gateway.git
21+
22+
# get the packet_forwarder source
23+
git clone https://github.com/Lora-net/packet_forwarder.git
24+
```
25+
26+
## Target specific changes
27+
28+
### BeagleBone Black
29+
30+
When compiling the packet_forwarder for a BeagleBone Black, you need to set the
31+
`SPI_DEV_PATH` to `/dev/spidev1.0`. This can be changed in
32+
`lora_gateway/libloragw/src/loragw_spi.native.c`.
33+
34+
## Building
35+
36+
``` bash
37+
# first build the driver / hal library
38+
cd lora_gateway
39+
make all
40+
cd ..
41+
42+
# secondly, build the packet_forwarder (and tools)
43+
cd packet_forwarder
44+
make all
45+
```
46+
47+
## Configuration & usage
48+
49+
From here on, please follow the instructions documented in:
50+
51+
* [https://github.com/Lora-net/packet_forwarder/blob/master/lora_pkt_fwd/readme.md](https://github.com/Lora-net/packet_forwarder/blob/master/lora_pkt_fwd/readme.md#4-usage)
52+
* [github.com/Lora-net/packet_forwarder/](https://github.com/Lora-net/packet_forwarder/)

‎docs/gateways/kerlink-iot-station.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Kerlink LoRa IoT Station
2+
3+
This document describes how to setup the [packet_forwarder](https://github.com/Lora-net/packet_forwarder/)
4+
for the Kerlink LoRa IoT Station.
5+
6+
## Requirements
7+
8+
Since you can't compile the packet_forwarder on the gateway itself, the
9+
following steps describe how to cross-compile the packet_forwarder. The
10+
following commands have been tested on Ubuntu 16.04 LTS. When running them
11+
on a different distribution, you might need to change these commands.
12+
13+
Install the requirements needed to compile the packet_forwarder:
14+
15+
```bash
16+
sudo apt-get install gcc make git
17+
```
18+
19+
!!! note
20+
You also need the arm cross-compile toolchain from Kerlink in able to
21+
cross-compile the binaries for ARM. In the following examples it is assumed
22+
they are installed under /opt/toolchains/arm-2011.03-wirma2.
23+
24+
## Get the source
25+
26+
```bash
27+
# get the driver / hardware abstraction layer source
28+
git clone https://github.com/Lora-net/lora_gateway.git
29+
30+
# get the packet_forwarder source
31+
git clone https://github.com/Lora-net/packet_forwarder.git
32+
```
33+
34+
## Configuration
35+
36+
When compiling the packet_forwarder for a Kerlink, you need to set the
37+
`SPI_DEV_PATH` to `/dev/spidev32766.0`. This can be changed in
38+
`lora_gateway/libloragw/src/loragw_spi.native.c`.
39+
In addtion, `lora_gateway/libloragw/tst/test_loragw_gps.c` needs to be
40+
modified to point to the correct GPS device:
41+
`i = lgw_gps_enable("/dev/nmea", NULL, 0, &gps_tty_dev);`
42+
43+
44+
## Building
45+
46+
``` bash
47+
# first build the driver / hal library
48+
cd lora_gateway
49+
ARCH=arm CROSS_COMPILE=/opt/toolchains/arm-2011.03-wirma2/bin/arm-none-linux-gnueabi- make all
50+
cd ..
51+
52+
# secondly, build the packet_forwarder (and tools)
53+
cd packet_forwarder
54+
ARCH=arm CROSS_COMPILE=/opt/toolchains/arm-2011.03-wirma2/bin/arm-none-linux-gnueabi- make all
55+
```
56+
57+
## Configuration & usage
58+
59+
From here on, please follow the instructions documented in:
60+
61+
* [https://github.com/Lora-net/packet_forwarder/blob/master/lora_pkt_fwd/readme.md](https://github.com/Lora-net/packet_forwarder/blob/master/lora_pkt_fwd/readme.md#4-usage)
62+
* [github.com/Lora-net/packet_forwarder/](https://github.com/Lora-net/packet_forwarder/)
63+
* [Getting started](../getting-started.md)

‎docs/getting-started.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,17 @@ project provides [repositories for various Linux distributions](http://mosquitto
3737

3838
### LoRa Gateway with packet_forwarder
3939

40-
See [packet_forwarder](packet-forwarder.md) for instructions about how to
41-
setup the packet_forwarder on your gateway.
40+
The [packet_forwarder](https://github.com/Lora-net/packet_forwarder/) is an
41+
application which runs on your gateway. It's responsibility is to:
42+
43+
* forward received uplink packets (over UDP)
44+
* forward statistics (over UDP)
45+
* enqueue and transmit downlink packets (received over UDP)
46+
47+
See the **Gateways** section in the menu for instructions about how to setup the
48+
packet_forwarder on your gateway. Is your gateway not in the list? Please
49+
consider contributing to this documentation by documenting the steps needed
50+
to set your gateway up and create a pull-request!
4251

4352
## Installing the LoRa Gateway Brige
4453

‎docs/packet-forwarder.md‎

Lines changed: 0 additions & 79 deletions
This file was deleted.

‎mkdocs.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@ theme_dir: docs/material
55
pages:
66
- index.md
77
- getting-started.md
8-
- packet-forwarder.md
98
- topics.md
109
- frequently-asked-questions.md
1110
- changelog.md
11+
- Gateways:
12+
- Airfy GateBoard AYTGB-137-8: gateways/airfy-gateboard-aytgb-137-8.md
13+
- IMST iC880A: gateways/imst-ic880a.md
14+
- Kerlink IoT Station: gateways/kerlink-iot-station.md
1215

1316
extra:
1417
version: '2.0.2'

0 commit comments

Comments
 (0)