Skip to content

Commit 3b18751

Browse files
brocaarbrocaar
committed
Add documentation.
1 parent 95dc267 commit 3b18751

25 files changed

+663
-0
lines changed

‎.gitignore

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# hidden files
2+
.*
3+
4+
# build disks
5+
*.vdi
6+
7+
# logfiles
8+
*.log
9+
10+
# VSCode
11+
/vscode-bitbake-build
12+
13+
# builds
14+
/build
15+
/deploy
16+
/docs/public/

‎docs/config.toml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
baseURL = "https://www.loraserver.io/lora-gateway-os/"
2+
languageCode = "en-us"
3+
title = "LoRa Gateway OS documentation"
4+
googleAnalytics = "UA-3512995-9"
5+
pygmentsUseClasses = true
6+
7+
[[menu.main]]
8+
pre = "<i class='fas fa-hand-point-right'></i>"
9+
name = "Overview"
10+
identifier = "overview"
11+
url = "/overview/"
12+
weight = 1
13+
14+
[[menu.main]]
15+
pre = "<i class='fas fa-download'></i>"
16+
name = "Install"
17+
identifier = "install"
18+
url = "/install/"
19+
weight = 2
20+
21+
[[menu.main]]
22+
pre = "<i class='fas fa-terminal'></i>"
23+
name = "Use"
24+
identifier = "use"
25+
url = "/use/"
26+
weight = 3
27+
28+
[[menu.main]]
29+
pre = "<i class='fab fa-github'></i>"
30+
name = "Community & support"
31+
identifier = "community"
32+
url = "/community/"
33+
weight = 4
34+
35+
[params]
36+
raspberrypi_raspberrypi3_version = "2.0.0test1"
37+
wifx_lorix_one_sd_version = "2.0.0test1"
38+
wifx_lorix_one_512_sd_version = "2.0.0test1"

‎docs/content/community/_index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Community & Support
3+
menu:
4+
main:
5+
parent: community
6+
weight: 1
7+
hidden: true
8+
---
9+
10+
# Community & Support

‎docs/content/community/contribute.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Contribute
3+
menu:
4+
main:
5+
parent: community
6+
weight: 2
7+
description: Information how you can contribute to the LoRa Gateway OS project.
8+
---
9+
10+
# Contribute
11+
12+
There are a couple of ways to get involved:
13+
14+
* Join the discussions:
15+
* LoRa Server project forum [https://forum.loraserver.io/](https://forum.loraserver.io/)
16+
* Report bugs or make feature-requests by opening an issue at [https://github.com/brocaar/lora-gateway-os/issues](https://github.com/brocaar/lora-gateway-os/issues)
17+
* Help fixing issues or improve documentation by creating pull-requests
18+
19+
20+
When you would like to add new features, please discuss the feature first
21+
by creating an issue describing your feature, how you're planning to implement
22+
it, what the usecase is etc...

‎docs/content/community/source.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Source
3+
menu:
4+
main:
5+
parent: community
6+
weight: 3
7+
description: How to compile the LoRa Gateway OS images yourself.
8+
---
9+
10+
# LoRa Gateway OS source
11+
12+
The [Yocto](https://www.yoctoproject.org/) recipes can be found at:
13+
[https://github.com/brocaar/lora-gateway-os](https://github.com/brocaar/lora-gateway-os).
14+
15+
## Building
16+
17+
The LoRa Gateway OS uses [Docker](https://www.docker.com/) and
18+
[Docker Compose](https://docs.docker.com/compose/). Make sure you have
19+
these tools installed.
20+
21+
22+
### Initial setup
23+
24+
Run the following command to set the `/build` folder permissions:
25+
26+
```bash
27+
# on the host
28+
docker-compose run --rm busybox
29+
30+
# within the container
31+
chown 999:999 /build
32+
```
33+
34+
### Building
35+
36+
Run the following command to setup the build environment:
37+
38+
```bash
39+
# on the host
40+
docker-compose run --rm yocto bash
41+
42+
# within the container
43+
44+
# update the submodules
45+
make submodules
46+
47+
# initialize the yocto / openembedded build environment
48+
source oe-init-build-env /build/ /lora-gateway-os/bitbake/
49+
50+
51+
# build the lora-gateway-os-base image
52+
bitbake lora-gateway-os-base
53+
```
54+
55+
#### Configuration
56+
57+
By default, Raspberry Pi3 is configured as the target platform. You need to
58+
update the following configuration files to configure a different target:
59+
60+
* `/build/config/local.conf`
61+
* `/build/config/bblayers.conf`

‎docs/content/community/support.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Support
3+
menu:
4+
main:
5+
parent: community
6+
weight: 1
7+
description: Where to report bugs, discuss new features and get support from the community.
8+
---
9+
10+
# Support
11+
12+
## Bugs
13+
14+
Did you find a bug or want to request a new feature? Please first check if
15+
this issue has already been reported. If not, please create an issue:
16+
[https://github.com/brocaar/lora-gateway-os/issues](https://github.com/brocaar/lora-gateway-os/issues).
17+
18+
## Questions
19+
20+
For support questions, please refer to the [LoRa Server project forum](https://forum.loraserver.io/).

‎docs/content/install/_index.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: LoRa Gateway OS installation
3+
menu:
4+
main:
5+
parent: install
6+
weight: 1
7+
hidden: true
8+
---
9+
10+
# LoRa Gateway OS installation
11+
12+
**Important:** If your gateway is not in the list below then you can still use
13+
the LoRa Server project! The LoRa Gateway OS is only to make things more easy,
14+
it is not a requirement.
15+
16+
If you are a gateway vendor and would like to see your gateway added to the
17+
list, please reach out!

‎docs/content/install/raspberrypi.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Raspberry Pi
3+
menu:
4+
main:
5+
parent: install
6+
description: Installing LoRa Gateway OS on a Raspberry Pi.
7+
---
8+
9+
# Raspberry Pi
10+
11+
## Raspberry Pi 3
12+
13+
The Raspberry Pi 3 images contain out-of-the-box support for the following
14+
concentrator shields:
15+
16+
* [RAK - RAK381 Gateway Developer Kit](https://www.rakwireless.com/en/WisKeyOSH/RAK831)
17+
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
18+
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
19+
20+
### Installation
21+
22+
* Download one of the provided SD Card images from the [Raspberry Pi 3 images folder](http://artifacts.loraserver.io/downloads/lora-gateway-os/raspberrypi/raspberrypi3/{{< raspberrypi_raspberrypi3_version >}}/).
23+
* Flash the SD Card image using for example [Etcher](https://www.balena.io/etcher/) on a SD Card.
24+
* Continue with [Using the LoRa Gateway OS images](/lora-gateway-os/use/).

‎docs/content/install/wifx.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Wifx LORIX One
3+
menu:
4+
main:
5+
parent: install
6+
description: Installing LoRa Gateway OS on a Wifx LORIX One gateway.
7+
---
8+
9+
# Wifx
10+
11+
## LORIX One
12+
13+
**[LORIX One product page](https://www.lorixone.io/)**.
14+
15+
The LORIX One gateway is capable of booting from a SD Card. Because of this,
16+
you don't need to overwrite the factory firmware to use the LoRa Gateway OS
17+
image. To "revert" to the factory firmware, you simple remove the SD Card.
18+
19+
### Installation
20+
21+
* Download one of the provided SD Card images from the LORIX One images folder.
22+
Please note, there are two LORIX One versions, one with 256MB and one with
23+
512MB flash. Make sure you download the right version:
24+
* [256MB version](http://artifacts.loraserver.io/downloads/lora-gateway-os/wifx/sama5d4-lorix-one-sd/{{< wifx_lorix_one_sd_version >}}/)
25+
* [512MB version](http://artifacts.loraserver.io/downloads/lora-gateway-os/wifx/sama5d4-lorix-one-512-sd/{{< wifx_lorix_one_512_sd_version >}}/)
26+
* Flash the SD Card image using for example [Etcher](https://www.balena.io/etcher/) on a SD Card.
27+
* Continue with [Using the LoRa Gateway OS images](/lora-gateway-os/use/).

‎docs/content/overview/_index.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: LoRa Gateway OS
3+
menu:
4+
main:
5+
parent: overview
6+
weight: 1
7+
listPages: false
8+
---
9+
10+
# LoRa Gateway OS
11+
12+
LoRa Gateway OS is an open-source Linux based embedded OS which can run on
13+
various LoRa gateway models. The goal is to make it easy to get started with
14+
LoRaWAN and the LoRa Server project with the minimum steps required to setup
15+
your gateway(s).
16+
17+
![gateway-config](/lora-gateway-os/img/gateway-config.png)
18+
19+
## Image types
20+
21+
### lora-gateway-os-base
22+
23+
Provides the Semtech packet-forwarder and LoRa Gateway Bridge pre-installed
24+
including a CLI utility for gateway configuration.
25+
26+
### lora-gateway-os-full
27+
28+
Provides a full [LoRa Server](/loraserver/) and [LoRa App Server](/lora-app-server/)
29+
environment running on the gateway, on top of all the features that are provided
30+
by the **lora-gateway-os-base** image.
31+
32+
## Supported gateways
33+
34+
* [Raspberry Pi 3](https://www.raspberrypi.org/) based gateways
35+
36+
* [RAK - RAK381 Gateway Developer Kit](https://www.rakwireless.com/en/WisKeyOSH/RAK831)
37+
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
38+
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
39+
40+
* Wifx
41+
42+
* [LORIX One](https://www.lorixone.io/)
43+
44+
**Important:** If your gateway is not in the above list then you can still use
45+
the LoRa Server project! The LoRa Gateway OS is only to make things more easy,
46+
it is not a requirement.
47+
48+
If you are a gateway vendor and would like to see your gateway added to the
49+
above list, please reach out!

‎docs/content/overview/changelog.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Changelog
3+
menu:
4+
main:
5+
parent: overview
6+
weight: 2
7+
---
8+
9+
# Changelog
10+
11+
## v2.0.0test1
12+
13+
* Initial test release.

‎docs/content/use/_index.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Using the LoRa Gateway OS images
3+
menu:
4+
main:
5+
parent: use
6+
weight: 1
7+
hidden: true
8+
---
9+
10+
# Using the LoRa Gateway OS images
11+
12+
The following images are provided:

0 commit comments

Comments
 (0)