Update docs + changelog. Bump version.

chirpstack · Jan 13, 2020 · f9c45ce · f9c45ce
1 parent 0fb5f29
commit f9c45ce
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 2 deletions.
diff --git a/docs/config.toml b/docs/config.toml
@@ -62,5 +62,5 @@ theme = "chirpstack-hugo-theme"
     weight = 8
 
 [params]
-    version = "3.5.0"
+    version = "3.6.0"
 	component = "chirpstack-gateway-bridge"
diff --git a/docs/content/overview/changelog.md b/docs/content/overview/changelog.md
@@ -10,6 +10,30 @@ description: Lists the changes per ChirpStack Gateway Bridge release, including
 
 # Changelog
 
+## v3.6.0
+
+### Features
+
+#### Raw packet-forwarder events / commands
+
+Using the raw packet-forwarder events and commands, it is possible to use the
+[BasicStation Remote Command](https://doc.sm.tc/station/tcproto.html#remote-command)
+and [BasicStation Remote Shell](https://doc.sm.tc/station/tcproto.html#remote-shell)
+features.
+
+#### Terminate on connect error
+
+The `terminate_on_connect_error` will terminate the ChirpStack Gateway Bridge
+process when it can't connect to the MQTT broker. In some cases this is
+preferred over the retry loop.
+
+### Improvements
+
+#### FSK FDev
+
+Before the frequency deviation was always set to the FSK `datarate / 2`. It
+is now possible to set it manually (falling back on `datarate / 2` when unset).
+
 ## v3.5.0
 
 ### Features

diff --git a/docs/content/payloads/commands.md b/docs/content/payloads/commands.md
@@ -136,3 +136,25 @@ variables that are already exposed to the "main" process.
 ### Protobuf
 
 This message is defined by the `GatewayCommandExecRequest` Protobuf message.
+
+## `raw` - Raw packet-forwarder command
+
+This payload is used for raw packet-forwarder commands that are not integrated
+with the ChirpStack Gateway Bridge. Currently these are the:
+
+* [BasicStation Remote Command](https://doc.sm.tc/station/tcproto.html#remote-command)
+* [BaiscStation Remote Shell](https://doc.sm.tc/station/tcproto.html#remote-shell)
+
+### JSON
+
+{{<highlight json>}}
+{
+    "gatewayID": "cnb/AC4GLBg=",
+    "rawID": "gsy9FN+rTwOEL8YzJJo+Kw==",
+    "payload": "[BASE64 ENCODED BLOB]"
+}
+{{</highlight>}}
+
+### Protobuf
+
+This message is defined by the `RawPacketForwarderCommand` Protobuf message.
diff --git a/docs/content/payloads/events.md b/docs/content/payloads/events.md
@@ -12,7 +12,7 @@ description: Events are uplinks, acks and statistics sent by the gateway.
 Events are generated by the ChirpStack Gateway Bridge and forwarded to the configured
 integration. Depending the `marshaler` configuration, these are sent as JSON or
 [Protobuf](https://developers.google.com/protocol-buffers/). For the Protobuf
-definitions, please refer to [gw.proto](https://github.com/brocaar/chirpstack-network-server/blob/master/api/gw/gw.proto).
+definitions, please refer to [gw.proto](https://github.com/brocaar/chirpstack-api/blob/master/protobuf/gw/gw.proto).
 
 * The Protocol Buffers [JSON Mapping](https://developers.google.com/protocol-buffers/docs/proto3#json)
   defines that bytes must be encoded as base64 strings. This also affects the `gatewayID` field.
@@ -138,3 +138,25 @@ execution output (or possible error).
 ### Protobuf
 
 This message is defined by the `GatewayCommandExecResponse` Protobuf message.
+
+## `raw` - Raw packet-forwarder event
+
+This payload is used for raw packet-forwarder events that are not integrated
+with the ChirpStack Gateway Bridge. Currently these are the:
+
+* [BasicStation Remote Command](https://doc.sm.tc/station/tcproto.html#remote-command)
+* [BaiscStation Remote Shell](https://doc.sm.tc/station/tcproto.html#remote-shell)
+
+### JSON
+
+{{<highlight json>}}
+{
+    "gatewayID": "cnb/AC4GLBg=",
+    "rawID": "gsy9FN+rTwOEL8YzJJo+Kw==",
+    "payload": "[BASE64 ENCODED BLOB]"
+}
+{{</highlight>}}
+
+### Protobuf
+
+This message is defined by the `RawPacketForwarderEvent` Protobuf message.