Skip to content

Commit d408cdd

Browse files
brocaarbrocaar
committed
Update connect gateway guide.
1 parent 4c4372f commit d408cdd

File tree

1 file changed

+75
-56
lines changed

1 file changed

+75
-56
lines changed

‎src/guides/connect-gateway.md‎

Lines changed: 75 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,99 @@
11
# Connecting a Gateway
22

3-
This guide describes how to connect your gateway to ChirpStack and how
4-
to validate that it is successfully communicating with the ChirpStack Network Server.
5-
At this point it is expected that you have a working ChirpStack installation.
3+
This guide describes how to connect your gateway to ChirpStack, and how to
4+
validate that it is successfully communicating with ChirpStack.
65

76
**Note:** This guide does not cover the configuration of MQTT credentials and / or
87
(client) certificates.
98

109
## Requirements
1110

12-
Before continuing, please make sure that you have installed both a
13-
packet-forwarder and the ChirpStack Gateway Bridge.
14-
The packet-forwarder that is installed on your gateway and
15-
the steps needed to install the ChirpStack Gateway Bridge vary per gateway vendor
16-
and model. In some cases you must also install the ChirpStack Gateway Bridge on the
17-
gateway. Please refer to the ChirpStack Gateway Bridge [Installation](../chirpstack-gateway-bridge/gateway/index.md)
18-
documentation, which contains instructions for various gateway models.
11+
### ChirpStack
1912

20-
### Packet-forwarders
13+
It is expected that at this point, ChirpStack is up-and-running.
2114

22-
There are different packet-forwarder implementations.
23-
The packet-forwarder that is installed on your gateway depends on the gateway vendor and model.
24-
The packet-forwarders that are compatible with ChirpStack:
15+
### ChirpStack Concentratord / Packet Forwarder
2516

26-
* [ChirpStack Concentratord](../chirpstack-concentratord/index.md)
27-
* [Semtech UDP Packet Forwarder](https://github.com/lora-net/packet_forwarder)
28-
* [Semtech BasicStation](https://doc.sm.tc/station/)
17+
Please make sure that your gateway either has the [ChirpStack Concentratord](../chirpstack-concentratord/index.md),
18+
[Semtech UDP Packet Forwarder](https://github.com/lora-net/packet_forwarder) or
19+
the [LoRa Basics Station](https://doc.sm.tc/station/) installed.
2920

30-
### ChirpStack Gateway Bridge
21+
### ChirpStack MQTT Forwarder
22+
23+
The steps needed to install the ChirpStack MQTT Forwarder vary per gateway
24+
vendor and model. Please see [ChirpStack MQTT Forwarder installation](../chirpstack-mqtt-forwarder/install/index.md)
25+
for more information.
3126

32-
The ChirpStack Gateway Bridge component acts as a backend for the above
33-
packet-forwarders. It uses [MQTT](https://mqtt.org/) to communicate with ChirpStack.
27+
In the case it is not possible to install the ChirpStack MQTT Forwarder on the
28+
gateway, you must install the [ChirpStack Gateway Bridge](../chirpstack-gateway-bridge/index.md)
29+
on a server and connect your gateway to it.
3430

3531
## Configuration
3632

37-
There are two components that you need to configure. This section covers a
38-
summary. Please refer to the ChirpStack Gateway Bridge [Installation](../chirpstack-gateway-bridge/gateway/index.md)
39-
for instructions specific to your gateway model.
33+
There are two components that you need to configure; the ChirpStack Concentratord
34+
or packet-forwarder and the ChirpStack MQTT Forwarder or ChirpStack Gateway Bridge.
35+
Please note that this section only covers a summary. For more information,
36+
please refer to the documentation of each component.
4037

41-
### Packet-forwarder
38+
### ChirpStack Concentratord / Packet Forwarder
4239

43-
The packet-forwarder that is configured on your gateway must forward its data
44-
to the ChirpStack Gateway Bridge. As it controls the LoRa<sup>&reg;</sup> chipset of the
45-
gateway, it also must be configured for the correct frequencies. A mismatch
46-
in frequencies means that the gateway will not receive uplinks sent by a device
47-
and / or is unable to send downlink payloads when the downlink frequency is
48-
outside the configured frequency range. Usually gateway vendors provide
49-
configuration examples for various bands. Please validate that the configuration
50-
matches region configuration of ChirpStack which you want to use.
40+
#### ChirpStack Concentratord
5141

52-
### ChirpStack Gateway Bridge
42+
ChirpStack provides pre-configured packages for various gateway models. No
43+
further configuration is required. Please see [ChirpStack Concentratord installation](../chirpstack-concentratord/installation/index.md)
44+
for more information.
5345

54-
The ChirpStack Gateway Bridge must be configured
55-
with the correct packet-forwarder backend. Please refer to the ChirpStack Gateway Bridge [Installation](../../chirpstack-gateway-bridge/gateway/index.md)
56-
for instructions specific to your gateway model. When you have installed a
57-
vendor specific package, this has already been pre-configured for you.
58-
59-
What you still need to configure is to which MQTT broker the ChirpStack Gateway
60-
Bridge will connect. This is configured in the following [Configuration](../chirpstack-gateway-bridge/configuration.md)
61-
section of the ChirpStack Gateway Bridge:
62-
63-
```toml
64-
# Generic MQTT authentication.
65-
[integration.mqtt.auth.generic]
66-
# MQTT servers.
67-
#
68-
# Configure one or multiple MQTT server to connect to. Each item must be in
69-
# the following format: scheme://host:port where scheme is tcp, ssl or ws.
70-
servers=[
71-
"tcp://127.0.0.1:1883",
72-
]
73-
```
46+
#### Packet Forwarder
47+
48+
In case the gateway comes with a Packet Forwarder pre-installed and you wish
49+
to use it instead of the ChirpStack Concentratord, then there are several
50+
scenarios:
51+
52+
##### Semtech UDP Forwarder
53+
54+
In case it is possible to install the [ChirpStack MQTT Forwarder](../chirpstack-mqtt-forwarder/index.md)
55+
on the gateway, you must configure the Semtech UDP Packet Forwarder to forward
56+
its data to `localhost:1700`. In case it is **not** possible to install the
57+
ChirpStack MQTT Forwarder on the gateway, then you must point it to the
58+
hostname / IP of your [ChirpStack Gateway Bridge](../chirpstack-gateway-bridge/index.md)
59+
instance running in the cloud.
60+
61+
##### LoRa Basics Station
62+
63+
In this case you must configure the LoRa Basics Station to connect to the
64+
hostname / IP of your [ChirpStack Gateway Bridge](../chirpstack-gateway-bridge/index.md)
65+
instance running in the cloud.
66+
67+
### ChirpStack MQTT Forwarder / ChirpStack Gateway Bridge
68+
69+
#### ChirpStack MQTT Forwarder
70+
71+
There are two important bits to configure:
72+
73+
* You must configure the correct backend which is either the Semtech UDP Packet
74+
Forwarder or the ChirpStack Concentratord.
75+
* You must configure it to connect to a MQTT broker. Please make sure to use
76+
the correct MQTT topic prefix, matching the region-configuration of your gateway!
77+
78+
Please refer to [ChirpStack MQTT Forwarder configuration](../chirpstack-mqtt-forwarder/configuration.md)
79+
for more information.
80+
81+
#### ChirpStack Gateway Bridge
82+
83+
In case it is not possible to install the ChirpStack MQTT Forwarder on the
84+
gateway, then you must install the [ChirpStack Gateway Bridge](../chirpstack-gateway-bridge/index.md)
85+
in the cloud.
86+
87+
There are two important bits to configure:
88+
89+
* You must configure the coorect backend which is either the Semtech UDP Packet
90+
Forwarder or the LoRa Basics Station.
91+
* You must configure it to connect to a MQTT broker. If all components are
92+
running on the same machine, then the default configuration will most
93+
likely to be sufficient.
7494

75-
Please refer to the ChirpStack Gateway Bridge [Configuration](../chirpstack-gateway-bridge/configuration.md)
76-
documentation for a full configuration example. After making changes to the
77-
configuration file, do not forget to restart the ChirpStack Gateway Bridge.
95+
Please refer to the [ChirpStack Gateway Bridge configuration](../chirpstack-gateway-bridge/configuration.md)
96+
for more information.
7897

7998
## Adding the gateway to ChirpStack
8099

0 commit comments

Comments
 (0)