Merge pull request #17 from OS2iot/stage

Release Stage to master

Author: fcv-iteratorIt

README.md

@@ -78,34 +78,38 @@ Solution:
 5. restart the application.
 
 ## Adding an ADR Algorithm
-When the ADR Algorithm has been tested, and is ready for deployment, it has to be built as a Go Module.
-
-The module is created running:
-```bash
-mkdir example-mod-name
-cd example-mod-name
-go mod init example-mod-name
-curl https://raw.githubusercontent.com/brocaar/chirpstack-network-server/master/examples/adr-plugin/main.go -o main.go
-```
-Replace the necessary parts in `main.go` with your own adr algorithm.   
-Run:
-```bash
-$env:GOOS="linux"
-$env:GOARCH="amd64"
-go build
-```
-and install the packages as described in the output of `go build`.
-finally `go build` can be run again to create the plugin, which is a binary with the name of your module `example-mod-name`.
+When the ADR Algorithm has been tested, and is ready for deployment, the ADR Algorithm has to be added to chirpstack. It is mandatory that the custom adr module is writtin in js.
+
+## Adding the Plugin to Chirpstack
+
+### Docker
 
-### Adding the Plugin to the Network Server
-If the default `docker-compose.yml` file is used, the folder `./configuration/chirpstack-network-server` is already copied to `/etc/chirpstack-network-server` in the docker container.
-Therefore a new folder can be added such as `./configuration/chirpstack-network-server/adr-plugins` in which the go module can be added.
-This makes the module available at `/etc/chirpstack-network-server/adr-plugins/example-mod-name` within the network server container.
+If the default `docker-compose.yml` file is used, the folder `./configuration/chirpstack` is already copied to `/etc/chirpstack` in the docker container.
+Therefore a new folder can be added such as `./configuration/chirpstack/adr-modules` in which the js file can be added.
+This makes the file available at `/etc/chirpstack/adr-modules/example-file.js` within the chirpstack container.
 
-The last step is to specify the file as being an adr-plugin within the `chirpstack-network-server.toml` config file by adding `adr_plugins=["/etc/chirpstack-network-server/adr-plugins/example-mod-name"]` under `[network_server.network_settings]`, like this:
+The last step is to specify the file as being an adr-plugin within the `chirpstack.toml` config file by adding `adr_plugins=["/etc/chirpstack/adr-modules/example-file.js"]` under `[network]`, like this:
 ```toml
-[network_server.network_settings]
-adr_plugins=["/etc/chirpstack-network-server/adr-plugins/example-mod-name"]
+[network]
+    adr_plugins=["/etc/chirpstack/adr-modules/example-file.js"]
 ```
 
-Your should now be able to restart the network server and the new adr algorithm should be available in the ChirpStack Application Server.
+You should now be able to restart the chirpstack server and the new adr algorithm should be available in Chirpstack.
+
+### Helm
+
+When hosting via helm the steps are slightly different.
+
+1. Make sure that the persistent volume claim belonging to the chirpstack exists in your hosted setup.
+2. Find the actual name of the network-server pod. This can be done in a few ways. If you're have a connection via a GUI like `Lens` it can be found under the `Pods` list. If you're hosting on an Azure Kubernetes service, it can be found under the side menu `Workloads -> Pods`
+3. Use `kubectl` to copy the module into the pod
+   ```bash
+   kubectl cp ./path/to/module/adr-module chirpstack-xxxxxxxxx-xxxxx:/etc/chirpstack/adr-modules
+   ```
+4. Update `configmap.yaml` located under `/helm/charts/chirpstack/templates` with the path to the plugin under `[network]`, like this:
+   ```toml
+   [network]
+       adr_plugins=["/etc/chirpstack/adr-modules/example-file.js"]
+   ```
+   The first line already exists
+5. Once the helm chart has redeployed restart the network server to enable the new module.

chirpstack-migration/chirpstack-v3-to-v4.exe

@@ -1,7 +1,30 @@
 # See https://www.chirpstack.io/gateway-bridge/install/config/ for a full
 # configuration example and documentation.
 
-[integration.mqtt.auth.generic]
-servers=["tcp://mosquitto:1883"]
-username=""
-password=""
+# Integration configuration.
+[integration]
+# Payload marshaler.
+#
+# This defines how the MQTT payloads are encoded. Valid options are:
+# * protobuf:  Protobuf encoding
+# * json:      JSON encoding (for debugging)
+marshaler="protobuf"
+
+  [integration.mqtt]
+  # Event topic template.
+  event_topic_template="gateway/{{ .GatewayID }}/event/{{ .EventType }}"
+
+  # State topic template.
+  state_topic_template="gateway/{{ .GatewayID }}/state/{{ .StateType }}"
+
+  # Command topic template.
+  command_topic_template="gateway/{{ .GatewayID }}/command/#"
+  [integration.mqtt.auth]
+    # Type defines the MQTT authentication type to use.
+    #
+    # Set this to the name of one of the sections below.
+    type="generic"
+      [integration.mqtt.auth.generic]
+      servers=["tcp://mosquitto:1883"]
+      username=""
+      password=""

configuration/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml

@@ -0,0 +1,156 @@
+// This must return the name of the ADR algorithm.
+export function name() {
+  return "Slowly Correcting ADR Algorithm";
+}
+
+// This must return the id of the ADR algorithm.
+export function id() {
+  return "scadra";
+}
+
+// This handles the ADR request.
+//
+// Input object example:
+// {
+//  regionName: "eu868",
+//  regionCommonName: "EU868",
+//  devEui: "0102030405060708",
+//  macVersion: "1.0.3",
+//  regParamsRevision: "A",
+//  adr: true,
+//  dr: 1,
+//  txPowerIndex: 0,
+//  nbTrans: 1,
+//  maxTxPowerIndex: 15,
+//  requiredSnrForDr: -17.5,
+//  installationMargin: 10,
+//  minDr: 0,
+//  maxDr: 5,
+//  uplinkHistory: [
+//    {
+//      "fCnt": 10,
+//      "maxSnr": 7.5,
+//      "maxRssi": -110,
+//      "txPowerIndex": 0,
+//      "gatewayCount": 3
+//    }
+//  ]
+// }
+//
+// This function must return an object, example:
+// {
+//  dr: 2,
+//  txPowerIndex: 1,
+//  nbTrans: 1
+// }
+// Handle function for ADR request.
+export function handle(req) {
+  // This defines the default response, which is equal to the current device state.
+  let resp = {
+    dr: req.DR,
+    txPowerIndex: req.TxPowerIndex,
+    nbTrans: req.NbTrans,
+  };
+
+  resp.txPowerIndex = 0;
+
+  // If ADR is disabled, return with current values.
+  if (!req.ADR) {
+    return [resp, null];
+  }
+
+  let lostPackageCnt = getLostPackageCount(req);
+  // If 5 or more packages are lost during the last received packages, decrease the data-rate
+  if (lostPackageCnt >= 5) {
+    resp.dr -= 1;
+  } else if (
+    req.UplinkHistory.length === 20 &&
+    getLostPackageCount(req, 20) <= 2
+  ) {
+    // If 2 or fewer packages are lost during the last 20 received packages, the dr might be able to be increased
+
+    // We only want to increase the dr if none of the previously received packages
+    // are within the installationMargin of the minimum required snr for the current dr
+    // The installationMargin should prevent us from increasing the dr too much, such that packages are lost
+    // when cars park in a spot.
+    let minSNR = getMinSNR(req);
+    let installationMargin = 10;
+    // A margin of around 10 seems okay
+    // This value has been chosen based on the loRaSNR values from sensors installed in a parking lot,
+    // where a fluctuation of +- 10 can be seen (should be caused by cars parking and leaving).
+    let diffSNR = minSNR - req.requiredHistoryCount - installationMargin;
+
+    // Examples:
+    // minSNR = -5
+    // requiredSNRforDR = -10
+    // installationMargin = 10
+    // diffSNR = -5 - -10 - 10 = -5
+    // => Not safe to increase the dr
+
+    // minSNR = 5
+    // requiredSNRforDR = -10
+    // installationMargin = 10
+    // diffSNR = 5 - -10 - 10 = 5
+    // => The dr should be safe to increase
+
+    if (diffSNR > 0) {
+      resp.dr += 1;
+    }
+  }
+
+  // If the data rate is increased or reduced to something outside the Min - Max range,
+  // set it to the respective limit
+  if (req.maxDr < resp.dr) {
+    resp.dr = req.maxDr;
+  }
+
+  if (req.MinDR > resp.dr) {
+    resp.dr = req.MinDR;
+  }
+
+  return [resp, null];
+}
+
+function getMinSNR(req) {
+  let snrM = 999;
+
+  for (const uh of req.uplinkHistory) {
+    if (uh.maxSnr < snrM) {
+      snrM = uh.maxSnr;
+    }
+  }
+  return snrM;
+}
+
+// Function to get the count of lost packages from the request.
+function getLostPackageCount(req, ...lastXElement) {
+  if (req.uplinkHistory.length < 2) {
+    return 0;
+  }
+
+  let elements = req.uplinkHistory;
+
+  if (lastXElement.length > 0) {
+    let x = lastXElement[0];
+    if (x < elements.length) {
+      elements = elements.slice(elements.length - x);
+    }
+  }
+
+  let lostPackets = 0;
+  let previousFCnt = 0;
+
+  for (let i = 0; i < elements.length; i++) {
+    const m = elements[i];
+
+    if (i === 0) {
+      previousFCnt = m.FCnt;
+      continue;
+    }
+
+    lostPackets += m.FCnt - previousFCnt - 1; // there is always an expected difference of 1
+    previousFCnt = m.FCnt;
+  }
+
+  return lostPackets;
+}

configuration/chirpstack/adr-modules/sensade-adr-mod/sensade-adr.js

@@ -0,0 +1,22 @@
+[postgresql]
+dsn="postgres://chirpstack:chirpstack@postgresChirpstackV4/chirpstack?sslmode=disable"
+
+[redis]
+servers=["redis://redis:6379"]
+
+[network]
+  net_id="000000"
+  adr_plugins=["/etc/chirpstack/adr-modules/sensade-adr-mod/sensade-adr.js"]
+  
+  enabled_regions=["eu868"]
+
+[api]
+bind="0.0.0.0:8080"
+jwt_secret="verysecret"
+
+[integration]
+enabled=["mqtt"]
+
+[integration.mqtt]
+server="tcp://mosquitto:1883"
+json=true