Skip to content

Commit f9c45ce

Browse files
committed
Update docs + changelog. Bump version.
1 parent 0fb5f29 commit f9c45ce

File tree

4 files changed

+70
-2
lines changed

4 files changed

+70
-2
lines changed

docs/config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ theme = "chirpstack-hugo-theme"
6262
weight = 8
6363

6464
[params]
65-
version = "3.5.0"
65+
version = "3.6.0"
6666
component = "chirpstack-gateway-bridge"

docs/content/overview/changelog.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@ description: Lists the changes per ChirpStack Gateway Bridge release, including
1010

1111
# Changelog
1212

13+
## v3.6.0
14+
15+
### Features
16+
17+
#### Raw packet-forwarder events / commands
18+
19+
Using the raw packet-forwarder events and commands, it is possible to use the
20+
[BasicStation Remote Command](https://doc.sm.tc/station/tcproto.html#remote-command)
21+
and [BasicStation Remote Shell](https://doc.sm.tc/station/tcproto.html#remote-shell)
22+
features.
23+
24+
#### Terminate on connect error
25+
26+
The `terminate_on_connect_error` will terminate the ChirpStack Gateway Bridge
27+
process when it can't connect to the MQTT broker. In some cases this is
28+
preferred over the retry loop.
29+
30+
### Improvements
31+
32+
#### FSK FDev
33+
34+
Before the frequency deviation was always set to the FSK `datarate / 2`. It
35+
is now possible to set it manually (falling back on `datarate / 2` when unset).
36+
1337
## v3.5.0
1438

1539
### Features

docs/content/payloads/commands.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,25 @@ variables that are already exposed to the "main" process.
136136
### Protobuf
137137

138138
This message is defined by the `GatewayCommandExecRequest` Protobuf message.
139+
140+
## `raw` - Raw packet-forwarder command
141+
142+
This payload is used for raw packet-forwarder commands that are not integrated
143+
with the ChirpStack Gateway Bridge. Currently these are the:
144+
145+
* [BasicStation Remote Command](https://doc.sm.tc/station/tcproto.html#remote-command)
146+
* [BaiscStation Remote Shell](https://doc.sm.tc/station/tcproto.html#remote-shell)
147+
148+
### JSON
149+
150+
{{<highlight json>}}
151+
{
152+
"gatewayID": "cnb/AC4GLBg=",
153+
"rawID": "gsy9FN+rTwOEL8YzJJo+Kw==",
154+
"payload": "[BASE64 ENCODED BLOB]"
155+
}
156+
{{</highlight>}}
157+
158+
### Protobuf
159+
160+
This message is defined by the `RawPacketForwarderCommand` Protobuf message.

docs/content/payloads/events.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description: Events are uplinks, acks and statistics sent by the gateway.
1212
Events are generated by the ChirpStack Gateway Bridge and forwarded to the configured
1313
integration. Depending the `marshaler` configuration, these are sent as JSON or
1414
[Protobuf](https://developers.google.com/protocol-buffers/). For the Protobuf
15-
definitions, please refer to [gw.proto](https://github.com/brocaar/chirpstack-network-server/blob/master/api/gw/gw.proto).
15+
definitions, please refer to [gw.proto](https://github.com/brocaar/chirpstack-api/blob/master/protobuf/gw/gw.proto).
1616

1717
* The Protocol Buffers [JSON Mapping](https://developers.google.com/protocol-buffers/docs/proto3#json)
1818
defines that bytes must be encoded as base64 strings. This also affects the `gatewayID` field.
@@ -138,3 +138,25 @@ execution output (or possible error).
138138
### Protobuf
139139

140140
This message is defined by the `GatewayCommandExecResponse` Protobuf message.
141+
142+
## `raw` - Raw packet-forwarder event
143+
144+
This payload is used for raw packet-forwarder events that are not integrated
145+
with the ChirpStack Gateway Bridge. Currently these are the:
146+
147+
* [BasicStation Remote Command](https://doc.sm.tc/station/tcproto.html#remote-command)
148+
* [BaiscStation Remote Shell](https://doc.sm.tc/station/tcproto.html#remote-shell)
149+
150+
### JSON
151+
152+
{{<highlight json>}}
153+
{
154+
"gatewayID": "cnb/AC4GLBg=",
155+
"rawID": "gsy9FN+rTwOEL8YzJJo+Kw==",
156+
"payload": "[BASE64 ENCODED BLOB]"
157+
}
158+
{{</highlight>}}
159+
160+
### Protobuf
161+
162+
This message is defined by the `RawPacketForwarderEvent` Protobuf message.

0 commit comments

Comments
 (0)