Merge pull request #90 from Rightech/lorawan-ex

upd lorawan example

Author: KristinaGoldinova

docs_examples/6 - LoRaWAN/Modem model.json

@@ -1,7 +1,7 @@
 {
   "version": 1,
   "origin": "dev.rightech.io",
-  "time": "2021-12-23T14:04:32.309Z",
+  "time": "2022-02-18T13:33:15.474Z",
   "user": "613645025dab3700105ae872",
   "group": "613645025dab3700105ae871",
   "store": "models",
@@ -196,129 +196,123 @@
           ]
         },
         {
-          "id": "temperature_value",
-          "name": "Temperature",
+          "id": "type",
+          "name": "Packet type",
           "active": true,
           "type": "argument",
           "dataType": "number",
           "factor": 1,
-          "linear": true,
-          "unit": "temperature-celsius"
+          "linear": true
         },
         {
-          "id": "humidity_value",
-          "name": "Humidity",
+          "id": "bat",
+          "name": "Battery charge",
           "active": true,
           "type": "argument",
           "dataType": "number",
           "factor": 1,
           "linear": true,
+          "_parentId": "root",
+          "children": [
+            {
+              "id": "bat.levels.0",
+              "name": "-Infinity",
+              "active": true,
+              "type": "level",
+              "index": 0,
+              "value": "-Infinity",
+              "color": "#f16059"
+            },
+            {
+              "id": "bat.levels.1",
+              "name": "Min",
+              "active": true,
+              "type": "level",
+              "index": 1,
+              "value": 30,
+              "color": "#f16059"
+            },
+            {
+              "id": "bat.levels.2",
+              "name": "Mid",
+              "active": true,
+              "type": "level",
+              "index": 5,
+              "value": 50,
+              "color": "#ffae62"
+            },
+            {
+              "id": "bat.levels.3",
+              "name": "Max",
+              "active": true,
+              "type": "level",
+              "index": 9,
+              "value": 80,
+              "color": "#a2ce4b"
+            }
+          ],
+          "display": {
+            "svg": "<svg viewBox=\"0 0 16 16\"><path d=\"M 1.585938 4 C 0.71875 4 0 4.71875 0 5.585938 L 0 10.410156 C 0 11.28125 0.71875 12 1.585938 12 L 12.410156 12 C 13.28125 12 14 11.28125 14 10.410156 L 14 10 L 15 10 C 15.546875 10 16 9.546875 16 9 L 16 7 C 16 6.453125 15.546875 6 15 6 L 14 6 L 14 5.585938 C 14 4.71875 13.28125 4 12.410156 4 Z M 1.585938 5 L 12.410156 5 C 12.742188 5 13 5.257813 13 5.585938 L 13 10.410156 C 13 10.742188 12.742188 11 12.410156 11 L 1.585938 11 C 1.257813 11 1 10.742188 1 10.410156 L 1 5.585938 C 1 5.257813 1.257813 5 1.585938 5 Z M 2 6 L 2 10 L 9 10 L 9 6 Z M 14 7 L 15 7 L 15 9 L 14 9 Z\" /></svg>"
+          },
           "unit": "percent"
         },
         {
-          "id": "light_value",
-          "name": "Light",
+          "id": "cfg",
+          "name": "Configuration",
+          "active": true,
+          "type": "argument",
+          "dataType": "object",
+          "factor": 1,
+          "linear": true,
+          "unit": null
+        },
+        {
+          "id": "timestamp",
+          "name": "Time",
           "active": true,
           "type": "argument",
           "dataType": "number",
-          "display": {
-            "svg": null
-          },
           "factor": 1,
           "linear": true,
-          "unit": "light-lux"
+          "unit": "duration-millisecond",
+          "_parentId": "root",
+          "children": []
         },
         {
-          "id": "switch_detected",
-          "name": "Reed switch",
+          "id": "temp",
+          "name": "Temperature",
           "active": true,
           "type": "argument",
-          "dataType": "boolean",
+          "dataType": "number",
           "factor": 1,
           "linear": true,
-          "unit": null
+          "unit": "temperature-celsius",
+          "_parentId": "root",
+          "children": []
         },
         {
-          "id": "leak_detected",
-          "name": "Leakage",
+          "id": "inputs",
+          "name": "Inputs",
           "active": true,
           "type": "argument",
-          "dataType": "boolean",
+          "dataType": "number[]",
           "factor": 1,
           "linear": true,
-          "unit": null
+          "unit": null,
+          "_parentId": "root",
+          "children": []
         },
         {
-          "id": "accelerometer",
-          "name": "Accelerometer",
+          "id": "evin",
+          "name": "Alarm input",
           "active": true,
-          "type": "subsystem",
-          "children": [
-            {
-              "id": "hit_detected",
-              "name": "Hit",
-              "active": true,
-              "type": "argument",
-              "dataType": "boolean",
-              "factor": 1,
-              "linear": true,
-              "unit": null
-            },
-            {
-              "id": "axis_1",
-              "name": "Tilt angle. Axis 1",
-              "active": true,
-              "type": "argument",
-              "dataType": "number",
-              "factor": 1,
-              "linear": true,
-              "unit": "angle-degree"
-            },
-            {
-              "id": "axis_2",
-              "name": "Tilt angle. Axis 2",
-              "active": true,
-              "type": "argument",
-              "dataType": "number",
-              "factor": 1,
-              "linear": true,
-              "unit": "angle-degree",
-              "children": []
-            },
-            {
-              "id": "axis_3",
-              "name": "Tilt angle. Axis 3",
-              "active": true,
-              "type": "argument",
-              "dataType": "number",
-              "factor": 1,
-              "linear": true,
-              "unit": "angle-degree",
-              "children": []
-            },
-            {
-              "id": "current_acceleration",
-              "name": "Current acceleration",
-              "active": true,
-              "type": "argument",
-              "dataType": "number",
-              "factor": 1,
-              "linear": true,
-              "unit": "acceleration-meter-per-second-squared",
-              "children": []
-            },
-            {
-              "id": "max_acceleration",
-              "name": "Max acceleration",
-              "active": true,
-              "type": "argument",
-              "dataType": "number",
-              "factor": 1,
-              "linear": true,
-              "unit": "acceleration-meter-per-second-squared",
-              "children": []
-            }
-          ]
+          "type": "argument",
+          "dataType": "number",
+          "factor": 1,
+          "linear": true,
+          "unit": null,
+          "_parentId": "root",
+          "children": []
         }
       ],
       "_isRoot": true,

docs_examples/6 - LoRaWAN/Modem.json

@@ -1,7 +1,7 @@
 {
   "version": 1,
   "origin": "dev.rightech.io",
-  "time": "2021-12-23T13:56:36.134Z",
+  "time": "2022-02-18T13:38:25.030Z",
   "user": "613645025dab3700105ae872",
   "group": "613645025dab3700105ae871",
   "store": "objects",

docs_examples/6 - LoRaWAN/Parse payload.js

@@ -2,80 +2,92 @@
 //@handler  : Parse payload
 //@author   : Kristina Goldinova
 
+const EVENT_PACKET = 1;
+const EVENT_ALARM = 2;
+
 /**
- * @param {string} payload base64 sensors data
+ * Check if n-th bit set for number
+ * @param value {number} number value
+ * @param bit   {number} bit position
  */
+function bit(value, bit) {
+  return (value & (1 << bit)) !== 0;
+}
 
-// Types codes
-var temp_and_humid_sensor = 0x01;
-var light_sensor = 0x02;
-var accelerometer = 0x03;
-var switch_sensor = 0x04;
-var leakage_sensor = 0x05;
-
+/**
+ * Parse Vega SI-11 Payload
+ * https://en.iotvega.com/product/si11
+ *
+ * ```
+ *                   | 0    | 1   | 2   | 3 | 4 | 5 | 6 | 7 | 8-11  | 12-15 | 16-19 | 20-23
+ *  1 - EVENT_PACKET | type | bat | cfg |  timestamp    | t | in[0] | in[1] | in[2] | in[3]
+ *  2 - EVENT_ALARM  | type | bat | cfg | i |   timestamp   | in[0] | in[1] | in[2] | in[3]
+ *
+ * ```
+ * @param payload {string} base64 encoded payload
+ */
 function process(payload) {
-  const buf = ric.base64.decode(payload); // decode
+  const data = ric.base64.decode(payload);
   let offset = 0;
 
-  let sensor_type = buf.getUint8(offset++);
-  switch (sensor_type) {
-    case temp_and_humid_sensor:
-      let temperature = buf.getUint16(offset, true) * 0.01; offset += 2;
-      let humidity = buf.getUint16(offset, true) * 0.01;
-      return { temperature, humidity };
-
-    case light_sensor:
-      let light = buf.getUint16(offset, true) * 0.01;
-      return { light };
+  /* - option 1 - parse binary payload from raw byte array */
+  const bytes = new Uint8Array(data.buffer);
 
-    case accelerometer:
-      let hit_detected = buf.getUint16(offset, true) == 1; offset += 2;
-      let axis1 = buf.getUint16(offset, true); offset += 2;
-      let axis2 = buf.getUint16(offset, true); offset += 2;
-      let axis3 = buf.getUint16(offset, true); offset += 2;
-      let current_accel = buf.getUint16(offset, true); offset += 2;
-      let max_accel = buf.getUint16(offset, true);
-      return { hit_detected, axis1, axis2, axis3, current_accel, max_accel };
+  const evtype = bytes[offset++];
+  const battery = bytes[offset++];
+  const configByte = bytes[offset++];
+  const config = {
+    activation: bit(configByte, 0) ? "abp": "otaa",
+    inputs: [
+      +bit(configByte, 4),
+      +bit(configByte, 5),
+      +bit(configByte, 6),
+      +bit(configByte, 7)
+    ],
+  };
+  const evin = evtype === EVENT_ALARM
+      ? bytes[offset++]
+      : undefined;
 
-    case switch_sensor:
-      let switch_detected = buf.getUint8(offset) == 1;
-      return { switch_detected };
+  /* - option 2 - use JS `DataView` interface (like Node's `Buffer`) */
+  const evtime = data.getUint32(offset, true) * 1000;
+  offset += 4;
 
-    case leakage_sensor:
-      let leak_detected = buf.getUint8(offset) == 1;
-      return { leak_detected };
+  const temperature = evtype === EVENT_PACKET
+      ? data.getInt8(offset++)
+      : undefined;
 
-    default:
-      break;
+  const inputs = [];
+  for (let i = 0; i < 4; i++) {
+    inputs[i] = data.getUint32(offset, true);
+    offset += 4;
   }
+
+  return { evtype, battery, config, evin, evtime, temperature, inputs };
 }
 
 /* ↑ here ends original handler code  */
 /* ↓ here goes generated debug  code  */
 
-/* 01. define test values for model "Modem model" */
+/* 01. define test values */
 const config = {};
 const packet = {
   "payload": "string"
 };
 
 /* 02. run handler code */
 const result = process(
-  packet["payload"]
+    packet["payload"]
 );
 
-/* 03. log handler results converted back to "Modem model" */
+/* 03. log handler results */
 console.log({
-  "temperature_value": result["temperature"],
-  "humidity_value": result["humidity"],
-  "light_value": result["light"],
-  "hit_detected": result["hit_detected"],
-  "axis_1": result["axis1"],
-  "axis_2": result["axis2"],
-  "axis_3": result["axis3"],
-  "current_acceleration": result["current_accel"],
-  "max_acceleration": result["max_accel"],
-  "switch_detected": result["switch_detected"],
-  "leak_detected": result["leak_detected"]
+  "evtype": result["evtype"],
+  "battery": result["battery"],
+  "config": result["config"],
+  "evin": result["evin"],
+  "evtime": result["evtime"],
+  "temperature": result["temperature"],
+  "inputs": result["inputs"]
 });