Skip to content

Commit 893b50e

Browse files
brocaarbrocaar
committed
Remove documentation references to managed packet-forwarder configuration.
This feature has been deprecated as it turned out to be more confusing than helpful. Given that there are multiple configuration templates possible for different types of gateways (single / multi antenna, single / multi board gateways), this feature did work for all gateways and was hard to make generic. TODO: as the Basic Station backend does rely on gateway configuration, this does need additional configuration parameters for this backend before this can be completely removed. See also for discussion: https://forum.loraserver.io/t/who-is-using-the-gateway-profile-how-are-you-using-it/5091.
1 parent c5536c6 commit 893b50e

File tree

13 files changed

+2
-454
lines changed

13 files changed

+2
-454
lines changed

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

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -49,42 +49,6 @@ type="{{ .Backend.Type }}"
4949
# the time would otherwise be unset.
5050
fake_rx_time={{ .Backend.SemtechUDP.FakeRxTime }}
5151
52-
# Managed packet-forwarder configuration.
53-
#
54-
# By configuring one or multiple managed packet-forwarder sections, the
55-
# LoRa Gateway Bridge updates the configuration when the backend receives
56-
# a configuration change, after which it will restart the packet-forwarder.
57-
#
58-
# Example (this configuration can be repeated):
59-
#
60-
# [[backend.semtech_udp.configuration]]
61-
# # Gateway ID.
62-
# #
63-
# # The LoRa Gateway Bridge will only apply the configuration updates for this
64-
# # gateway ID.
65-
# gateway_id="0102030405060708"
66-
67-
# # Base configuration file.
68-
# #
69-
# # This file will be used as base-configuration and will not be overwritten on
70-
# # a configuration update. This file needs to exist and contains the base
71-
# # configuration and vendor specific
72-
# base_file="/etc/lora-packet-forwarder/global_conf.json"
73-
74-
# # Output configuration file.
75-
# #
76-
# # This will be the final configuration for the packet-forwarder, containing
77-
# # a merged version of the base configuration + the requested configuration
78-
# # update.
79-
# # Warning: this file will be overwritten on a configuration update!
80-
# output_file="/etc/lora-packet-forwarder/local_conf.json"
81-
82-
# # Restart command.
83-
# #
84-
# # This command is issued by the LoRa Gateway Bridge on a configuration
85-
# # change. Make sure the LoRa Gateway Bridge process has sufficient
86-
# # permissions to execute this command.
87-
# restart_command="/etc/init.d/lora-packet-forwarder restart"
8852
{{ range $i, $config := .Backend.SemtechUDP.Configuration }}
8953
[[backend.semtech_udp.configuration]]
9054
gateway_id="{{ $config.GatewayID }}"

‎docs/content/backends/semtech-udp.md‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,27 +44,6 @@ same LoRa Gateway Bridge instance.
4444
When the LoRa Gateway Bridge is deployed on the gateway, you will benefit from
4545
the MQTT authentication / authorization layer and optional TLS.
4646

47-
## Packet-forwarder re-configuration over MQTT
48-
49-
The Semtech UDP backend supports the re-configuration of the packet-forwarder
50-
over MQTT using the `config` [Commands]({{<ref "payloads/commands.md">}}).
51-
52-
This works as follow:
53-
54-
* The LoRa Gateway Bridge will periodically send `stats` [Events]({{<relref "payloads/events.md">}})
55-
containing the current configuration version.
56-
* [LoRa Server](/loraserver/) processes these stats events and when a _Gateway Profile_
57-
is associated with the gateway, it will compare the configuration version.
58-
* In case the _Gateway Profile_ version is newer, it will send a `config`
59-
command to the LoRa Gateway Bridge.
60-
* LoRa Gateway Bridge will then read the `base_file`, update it and writes it
61-
to the `output_file`.
62-
* It then restarts the packet-forwarder using the `restart_command` causing the
63-
packet-forwarder to reload its configuration.
64-
65-
For the above to work, you must configure the _Mandaged packet-forwarder configuration_
66-
section in the `lora-gateway-bridge.toml`.
67-
6847
## Prometheus metrics
6948

7049
The Semtech UDP packet-forwarder backend exposes several [Prometheus](https://prometheus.io/)

‎docs/content/install/config.md‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -101,42 +101,6 @@ type="semtech_udp"
101101
# the time would otherwise be unset.
102102
fake_rx_time=false
103103

104-
# Managed packet-forwarder configuration.
105-
#
106-
# By configuring one or multiple managed packet-forwarder sections, the
107-
# LoRa Gateway Bridge updates the configuration when the backend receives
108-
# a configuration change, after which it will restart the packet-forwarder.
109-
#
110-
# Example (this configuration can be repeated):
111-
#
112-
# [[backend.semtech_udp.configuration]]
113-
# # Gateway ID.
114-
# #
115-
# # The LoRa Gateway Bridge will only apply the configuration updates for this
116-
# # gateway ID.
117-
# gateway_id="0102030405060708"
118-
119-
# # Base configuration file.
120-
# #
121-
# # This file will be used as base-configuration and will not be overwritten on
122-
# # a configuration update. This file needs to exist and contains the base
123-
# # configuration and vendor specific
124-
# base_file="/etc/lora-packet-forwarder/global_conf.json"
125-
126-
# # Output configuration file.
127-
# #
128-
# # This will be the final configuration for the packet-forwarder, containing
129-
# # a merged version of the base configuration + the requested configuration
130-
# # update.
131-
# # Warning: this file will be overwritten on a configuration update!
132-
# output_file="/etc/lora-packet-forwarder/local_conf.json"
133-
134-
# # Restart command.
135-
# #
136-
# # This command is issued by the LoRa Gateway Bridge on a configuration
137-
# # change. Make sure the LoRa Gateway Bridge process has sufficient
138-
# # permissions to execute this command.
139-
# restart_command="/etc/init.d/lora-packet-forwarder restart"
140104

141105

142106
# Basic Station backend.

‎docs/content/payloads/commands.md‎

Lines changed: 0 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -110,111 +110,3 @@ It holds the gateway internal context (e.g. internal timing information).
110110

111111
This message is defined by the `DownlinkFrame` Protobuf message.
112112

113-
## `config` - gateway configuration
114-
115-
Request the gateway to update its channel-plan configuration.
116-
117-
The LoRa Gateway Bridge assumes this configuation will be applied to an 8-channel
118-
gateway (+ 1 single-SF LoRa and 1 FSK channel). Make sure that the channel-plan
119-
fits within the bandwidth of both radios of the gateway.
120-
121-
**Note:** in order to configure the packet-forwarder over MQTT, don't forget
122-
to configure at least one `[[packet_forwarder.configuration]]` section in the
123-
[configuration]({{<ref "/install/config.md">}}) file.
124-
125-
### JSON
126-
127-
{{<highlight json>}}
128-
{
129-
"gatewayID": "cnb/AC4GLBg=",
130-
"version": "1.2.3",
131-
"channels": [
132-
{
133-
"frequency": 868100000,
134-
"modulation": "LORA",
135-
"loRaModulationConfig": {
136-
"bandwidth": 125,
137-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
138-
}
139-
},
140-
{
141-
"frequency": 868300000,
142-
"modulation": "LORA",
143-
"loRaModulationConfig": {
144-
"bandwidth": 125,
145-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
146-
}
147-
},
148-
{
149-
"frequency": 868500000,
150-
"modulation": "LORA",
151-
"loRaModulationConfig": {
152-
"bandwidth": 125,
153-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
154-
}
155-
},
156-
{
157-
"frequency": 867100000,
158-
"modulation": "LORA",
159-
"loRaModulationConfig": {
160-
"bandwidth": 125,
161-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
162-
}
163-
},
164-
{
165-
"frequency": 867300000,
166-
"modulation": "LORA",
167-
"loRaModulationConfig": {
168-
"bandwidth": 125,
169-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
170-
}
171-
},
172-
{
173-
"frequency": 867500000,
174-
"modulation": "LORA",
175-
"loRaModulationConfig": {
176-
"bandwidth": 125,
177-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
178-
}
179-
},
180-
{
181-
"frequency": 867700000,
182-
"modulation": "LORA",
183-
"loRaModulationConfig": {
184-
"bandwidth": 125,
185-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
186-
}
187-
},
188-
{
189-
"frequency": 867900000,
190-
"modulation": "LORA",
191-
"loRaModulationConfig": {
192-
"bandwidth": 125,
193-
"spreadingFactors": [7, 8, 9, 10, 11, 12]
194-
}
195-
},
196-
{
197-
"frequency": 868300000,
198-
"modulation": "LORA",
199-
"loRaModulationConfig": {
200-
"bandwidth": 250,
201-
"spreadingFactors": [
202-
7
203-
]
204-
}
205-
},
206-
{
207-
"frequency": 868800000,
208-
"modulation": "FSK",
209-
"fskModulationConfig": {
210-
"bandwidth": 125,
211-
"bitrate": 50000
212-
}
213-
}
214-
]
215-
}
216-
{{< /highlight >}}
217-
218-
### Protobuf
219-
220-
This message is defined by the `GatewayConfiguration` Protobuf message.

‎internal/backend/semtechudp/backend.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ func (b *Backend) ApplyConfiguration(config gw.GatewayConfiguration) error {
207207
b.Unlock()
208208

209209
if pfConfig == nil {
210-
return errGatewayDoesNotExist
210+
return nil
211211
}
212212

213213
return b.applyConfiguration(*pfConfig, config)

‎internal/integration/mqtt/backend.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,7 @@ func (b *Backend) handleDownlinkFrame(c paho.Client, msg paho.Message) {
304304
b.downlinkFrameChan <- downlinkFrame
305305
}
306306

307+
// TODO: this feature is deprecated. Remove this in the next major release.
307308
func (b *Backend) handleGatewayConfiguration(c paho.Client, msg paho.Message) {
308309
log.WithFields(log.Fields{
309310
"topic": msg.Topic(),

‎packaging/files/lora-gateway-bridge.toml‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,42 +22,6 @@ type="semtech_udp"
2222
# packet-forwarder matches this port.
2323
udp_bind = "0.0.0.0:1700"
2424

25-
# Managed packet-forwarder configuration.
26-
#
27-
# By configuring one or multiple managed packet-forwarder sections, the
28-
# LoRa Gateway Bridge updates the configuration when the backend receives
29-
# a configuration change, after which it will restart the packet-forwarder.
30-
#
31-
# Example (this configuration can be repeated):
32-
#
33-
# [[backend.semtech_udp.configuration]]
34-
# # Gateway ID.
35-
# #
36-
# # The LoRa Gateway Bridge will only apply the configuration updates for this
37-
# # gateway ID.
38-
# gateway_id="0102030405060708"
39-
40-
# # Base configuration file.
41-
# #
42-
# # This file will be used as base-configuration and will not be overwritten on
43-
# # a configuration update. This file needs to exist and contains the base
44-
# # configuration and vendor specific
45-
# base_file="/etc/lora-packet-forwarder/global_conf.json"
46-
47-
# # Output configuration file.
48-
# #
49-
# # This will be the final configuration for the packet-forwarder, containing
50-
# # a merged version of the base configuration + the requested configuration
51-
# # update.
52-
# # Warning: this file will be overwritten on a configuration update!
53-
# output_file="/etc/lora-packet-forwarder/local_conf.json"
54-
55-
# # Restart command.
56-
# #
57-
# # This command is issued by the LoRa Gateway Bridge on a configuration
58-
# # change. Make sure the LoRa Gateway Bridge process has sufficient
59-
# # permissions to execute this command.
60-
# restart_command="/etc/init.d/lora-packet-forwarder restart"
6125

6226
# Integration configuration.
6327
[integration]

‎packaging/vendor/kerlink/ibts/files/lora-gateway-bridge.toml‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,42 +22,6 @@ type="semtech_udp"
2222
# packet-forwarder matches this port.
2323
udp_bind = "0.0.0.0:1700"
2424

25-
# Managed packet-forwarder configuration.
26-
#
27-
# By configuring one or multiple managed packet-forwarder sections, the
28-
# LoRa Gateway Bridge updates the configuration when the backend receives
29-
# a configuration change, after which it will restart the packet-forwarder.
30-
#
31-
# Example (this configuration can be repeated):
32-
#
33-
# [[backend.semtech_udp.configuration]]
34-
# # Gateway ID.
35-
# #
36-
# # The LoRa Gateway Bridge will only apply the configuration updates for this
37-
# # gateway ID.
38-
# gateway_id="0102030405060708"
39-
40-
# # Base configuration file.
41-
# #
42-
# # This file will be used as base-configuration and will not be overwritten on
43-
# # a configuration update. This file needs to exist and contains the base
44-
# # configuration and vendor specific
45-
# base_file="/etc/lora-packet-forwarder/global_conf.json"
46-
47-
# # Output configuration file.
48-
# #
49-
# # This will be the final configuration for the packet-forwarder, containing
50-
# # a merged version of the base configuration + the requested configuration
51-
# # update.
52-
# # Warning: this file will be overwritten on a configuration update!
53-
# output_file="/etc/lora-packet-forwarder/local_conf.json"
54-
55-
# # Restart command.
56-
# #
57-
# # This command is issued by the LoRa Gateway Bridge on a configuration
58-
# # change. Make sure the LoRa Gateway Bridge process has sufficient
59-
# # permissions to execute this command.
60-
# restart_command="/etc/init.d/lora-packet-forwarder restart"
6125

6226
# Integration configuration.
6327
[integration]

‎packaging/vendor/kerlink/ifemtocell/files/lora-gateway-bridge.toml‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,42 +22,6 @@ type="semtech_udp"
2222
# packet-forwarder matches this port.
2323
udp_bind = "0.0.0.0:1700"
2424

25-
# Managed packet-forwarder configuration.
26-
#
27-
# By configuring one or multiple managed packet-forwarder sections, the
28-
# LoRa Gateway Bridge updates the configuration when the backend receives
29-
# a configuration change, after which it will restart the packet-forwarder.
30-
#
31-
# Example (this configuration can be repeated):
32-
#
33-
# [[backend.semtech_udp.configuration]]
34-
# # Gateway ID.
35-
# #
36-
# # The LoRa Gateway Bridge will only apply the configuration updates for this
37-
# # gateway ID.
38-
# gateway_id="0102030405060708"
39-
40-
# # Base configuration file.
41-
# #
42-
# # This file will be used as base-configuration and will not be overwritten on
43-
# # a configuration update. This file needs to exist and contains the base
44-
# # configuration and vendor specific
45-
# base_file="/etc/lora-packet-forwarder/global_conf.json"
46-
47-
# # Output configuration file.
48-
# #
49-
# # This will be the final configuration for the packet-forwarder, containing
50-
# # a merged version of the base configuration + the requested configuration
51-
# # update.
52-
# # Warning: this file will be overwritten on a configuration update!
53-
# output_file="/etc/lora-packet-forwarder/local_conf.json"
54-
55-
# # Restart command.
56-
# #
57-
# # This command is issued by the LoRa Gateway Bridge on a configuration
58-
# # change. Make sure the LoRa Gateway Bridge process has sufficient
59-
# # permissions to execute this command.
60-
# restart_command="/etc/init.d/lora-packet-forwarder restart"
6125

6226
# Integration configuration.
6327
[integration]

0 commit comments

Comments
 (0)