Skip to content

Commit ab69717

Browse files
brocaarbrocaar
committed
Update documentation and changelog. Bump versions.
1 parent dee284b commit ab69717

File tree

7 files changed

+75
-50
lines changed

7 files changed

+75
-50
lines changed

‎README.md

+16-11
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ An image providing the Semtech Packet Forwarder and ChirpStack Gateway Bridge.
1515
Provides the following features:
1616

1717
* [Monit](https://mmonit.com/monit/) based service monitoring
18-
* Semtech [Packet Forwarder](https://github.com/lora-net/packet_forwarder)
18+
* [ChirpStack Concentratord](https://github.com/brocaar/chirpstack-concentratord/)
1919
* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)
2020

2121
### chirpstack-gateway-os-full
@@ -26,7 +26,7 @@ gateway.
2626
Provides the following features:
2727

2828
* [Monit](https://mmonit.com/monit/) based service monitoring
29-
* Semtech [Packet Forwarder](https://github.com/lora-net/packet_forwarder)
29+
* [ChirpStack Concentratord](https://github.com/brocaar/chirpstack-concentratord/)
3030
* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/)
3131
* [ChirpStack Network Server](https://www.chirpstack.io/network-server/)
3232
* [ChirpStack Application Server](https://www.chirpstack.io/application-server/)
@@ -36,17 +36,22 @@ Provides the following features:
3636

3737
## Targets
3838

39-
* [LORIX One](https://www.lorixone.io/)
39+
### Raspberry Pi
4040

41+
* Raspberry Pi 1
4142
* Raspberry Pi 3
42-
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
43-
* [IMST - iC980A](http://www.imst.com/)
44-
* [Pi Supply - LoRa Gateway Hat](https://uk.pi-supply.com/products/iot-lora-gateway-hat-for-raspberry-pi)
45-
* [RAK - RAK2245](https://store.rakwireless.com/products/rak2245-pi-hat)
46-
* [RAK - RAK831 Gateway Developer Kit](https://store.rakwireless.com/products/rak831-gateway-module?variant=22375114801252)
47-
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
48-
* [Sandbox Electronics - LoRaGo PORT](https://sandboxelectronics.com/?product=lorago-port-multi-channel-lorawan-gateway)
49-
* [Semtech - SX1302 CoreCell](https://www.semtech.com/products/wireless-rf/lora-gateways/sx1302cxxxgw1)
43+
44+
#### Shields / kits
45+
46+
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
47+
* [IMST - iC980A](http://www.imst.com/)
48+
* [IMST - Lite Gateway](https://wireless-solutions.de/products/long-range-radio/lora-lite-gateway.html)
49+
* [Pi Supply - LoRa Gateway Hat](https://uk.pi-supply.com/products/iot-lora-gateway-hat-for-raspberry-pi)
50+
* [RAK - RAK2245](https://store.rakwireless.com/products/rak2245-pi-hat)
51+
* [RAK - RAK831 Gateway Developer Kit](https://store.rakwireless.com/products/rak831-gateway-module?variant=22375114801252)
52+
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
53+
* [Sandbox Electronics - LoRaGo PORT](https://sandboxelectronics.com/?product=lorago-port-multi-channel-lorawan-gateway)
54+
* [Semtech - SX1302 CoreCell](https://www.semtech.com/products/wireless-rf/lora-gateways/sx1302cxxxgw1)
5055

5156
## Using
5257

‎docs/config.toml

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ theme = "chirpstack-hugo-theme"
3434
weight = 4
3535

3636
[params]
37-
raspberrypi_raspberrypi3_version = "3.3.0-test.1"
37+
raspberrypi_raspberrypi_version = "3.3.0-test.2"
38+
raspberrypi_raspberrypi3_version = "3.3.0-test.2"
3839
wifx_lorix_one_sd_version = "3.2.0test1"
3940
wifx_lorix_one_512_sd_version = "3.2.0test1"
4041
component = "chirpstack-gateway-os"

‎docs/content/install/_index.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ hidden: true
99

1010
# ChirpStack Gateway OS installation
1111

12-
**Important:** If your gateway is not in the list below then you can still use
13-
the ChirpStack open-source LoRaWAN<sup>&reg;</sup> Network Server stack! The ChirpStack
14-
Gateway OS is only to make things more easy, 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!
12+
**Important:** If you gatway is not listed below, then this doesn't mean you
13+
can't use the ChirpStack open-source LoRaWAN<sup>&reg;</sub> Network Server
14+
stack. The ChirpStack Gateway OS is a convenient way to get started, but there
15+
are many ways to deploy ChirpStack.

‎docs/content/install/raspberrypi.md

+23-16
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,7 @@ description: Installing ChirpStack Gateway OS on a Raspberry Pi.
88

99
# Raspberry Pi
1010

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-
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
17-
* [IMST - iC980A](http://www.imst.com/)
18-
* [Pi Supply - LoRa Gateway Hat](https://uk.pi-supply.com/products/iot-lora-gateway-hat-for-raspberry-pi)
19-
* [RAK - RAK2245](https://store.rakwireless.com/products/rak2245-pi-hat)
20-
* [RAK - RAK831 Gateway Developer Kit](https://store.rakwireless.com/products/rak831-gateway-module?variant=22375114801252)
21-
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
22-
* [Sandbox Electronics - LoRaGo PORT](https://sandboxelectronics.com/?product=lorago-port-multi-channel-lorawan-gateway)
23-
* [Semtech - SX1302 CoreCell](https://www.semtech.com/products/wireless-rf/lora-gateways/sx1302cxxxgw1)
24-
25-
### Installation
11+
## Installation
2612

2713
There are two file types:
2814

@@ -31,6 +17,27 @@ There are two file types:
3117

3218
For an initial installation:
3319

34-
* Download one of the provided SD Card images from the [Raspberry Pi 3 images folder](http://artifacts.chirpstack.io/downloads/chirpstack-gateway-os/raspberrypi/raspberrypi3/{{< raspberrypi_raspberrypi3_version >}}/).
20+
* Download the SD Card image for your Raspberry Pi version using one of the
21+
links below.
3522
* Flash the SD Card image using for example [Etcher](https://www.balena.io/etcher/) on a SD Card.
3623
* Continue with [Using the ChirpStack Gateway OS images](/gateway-os/use/).
24+
25+
### SD Card images
26+
27+
* [Raspberry Pi 1](http://artifacts.chirpstack.io/downloads/chirpstack-gateway-os/raspberrypi/raspberrypi/{{< raspberrypi_raspberrypi_version >}}/)
28+
* [Raspberry Pi 3](http://artifacts.chirpstack.io/downloads/chirpstack-gateway-os/raspberrypi/raspberrypi3/{{< raspberrypi_raspberrypi3_version >}}/)
29+
30+
## Supported shields
31+
32+
The Raspberry Pi images provide out-of-the-box support for the following
33+
concentrator shields / gateway kits:
34+
35+
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
36+
* [IMST - iC980A](http://www.imst.com/)
37+
* [IMST - Lite Gateway](https://wireless-solutions.de/products/long-range-radio/lora-lite-gateway.html)
38+
* [Pi Supply - LoRa Gateway Hat](https://uk.pi-supply.com/products/iot-lora-gateway-hat-for-raspberry-pi)
39+
* [RAK - RAK2245](https://store.rakwireless.com/products/rak2245-pi-hat)
40+
* [RAK - RAK831 Gateway Developer Kit](https://store.rakwireless.com/products/rak831-gateway-module?variant=22375114801252)
41+
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
42+
* [Sandbox Electronics - LoRaGo PORT](https://sandboxelectronics.com/?product=lorago-port-multi-channel-lorawan-gateway)
43+
* [Semtech - SX1302 CoreCell](https://www.semtech.com/products/wireless-rf/lora-gateways/sx1302cxxxgw1)

‎docs/content/overview/_index.md

+15-16
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,21 @@ Provides a full [ChirpStack Network Server](/network-server/) and [ChirpStack Ap
2929
environment running on the gateway, on top of all the features that are provided
3030
by the **chirpstack-gateway-os-base** image.
3131

32-
## Supported gateways
32+
## Targets
3333

34-
* [LORIX One](https://www.lorixone.io/)
34+
### Raspberry Pi
3535

36+
* Raspberry Pi 1
3637
* Raspberry Pi 3
37-
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
38-
* [IMST - iC980A](http://www.imst.com/)
39-
* [Pi Supply - LoRa Gateway Hat](https://uk.pi-supply.com/products/iot-lora-gateway-hat-for-raspberry-pi)
40-
* [RAK - RAK2245](https://store.rakwireless.com/products/rak2245-pi-hat)
41-
* [RAK - RAK831 Gateway Developer Kit](https://store.rakwireless.com/products/rak831-gateway-module?variant=22375114801252)
42-
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
43-
* [Sandbox Electronics - LoRaGo PORT](https://sandboxelectronics.com/?product=lorago-port-multi-channel-lorawan-gateway)
44-
45-
**Important:** If your gateway is not in the above list then you can still use
46-
the ChirpStack open-source LoRaWAN Network Server stack! The ChirpStack Gateway OS is only to make things more easy,
47-
it is not a requirement.
48-
49-
If you are a gateway vendor and would like to see your gateway added to the
50-
above list, please reach out!
38+
39+
#### Shields / kits
40+
41+
* [IMST - iC880A](https://wireless-solutions.de/products/long-range-radio/ic880a.html)
42+
* [IMST - iC980A](http://www.imst.com/)
43+
* [IMST - Lite Gateway](https://wireless-solutions.de/products/long-range-radio/lora-lite-gateway.html)
44+
* [Pi Supply - LoRa Gateway Hat](https://uk.pi-supply.com/products/iot-lora-gateway-hat-for-raspberry-pi)
45+
* [RAK - RAK2245](https://store.rakwireless.com/products/rak2245-pi-hat)
46+
* [RAK - RAK831 Gateway Developer Kit](https://store.rakwireless.com/products/rak831-gateway-module?variant=22375114801252)
47+
* [RisingHF - RHF0M301 LoRaWAN IoT Discovery Kit](http://risinghf.com/#/product-details?product_id=9&lang=en)
48+
* [Sandbox Electronics - LoRaGo PORT](https://sandboxelectronics.com/?product=lorago-port-multi-channel-lorawan-gateway)
49+
* [Semtech - SX1302 CoreCell](https://www.semtech.com/products/wireless-rf/lora-gateways/sx1302cxxxgw1)

‎docs/content/overview/changelog.md

+14
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@ menu:
88

99
# Changelog
1010

11+
## v3.3.0-test.2
12+
13+
### Updates
14+
15+
* [ChirpStack Gateway Bridge](https://www.chirpstack.io/gateway-bridge/) is updated to v3.7.0.
16+
* [ChirpStack Network Server](https://www.chirpstack.io/network-server/) is updated to v3.7.0.
17+
* [ChirpStack Application Server](https://www.chirpstack.io/application-server/) is updated to v3.8.0.
18+
* [ChirpStack Concentratord](https://github.com/brocaar/chirpstack-concentratord) is updated to v3.0.0-test.5.
19+
20+
### Supported hardware
21+
22+
* Raspberry Pi 1 B+ support has been added (for IMST Lite Gateway)
23+
* [IMST Lite Gateway](https://wireless-solutions.de/products/long-range-radio/lora-lite-gateway.html) has been added to gateway configuration script.
24+
1125
## v3.3.0-test.1
1226

1327
**This is a rewrite of the ChirpStack Gateway OS, you must re-flash your SD Card

‎docs/layouts/shortcodes/raspberrypi_raspberrypi_version.html

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{ .Site.Params.raspberrypi_raspberrypi_version }}

0 commit comments

Comments
 (0)