Merge pull request #24 from artem-barysh-dev/DS3604

DS3604

VENDORS/Milesight/DS3604/ChirpStack/uplink/converter.json

@@ -0,0 +1,35 @@
+{
+  "name": "ChirpStack uplink converter for Milesight DS3604",
+  "type": "UPLINK",
+  "debugMode": true,
+  "configuration": {
+    "scriptLang": "TBEL",
+    "decoder": null,
+    "tbelDecoder": "var data = decodeToJson(payload);\nvar deviceName = \"DS3604 \" + data.deviceInfo.deviceName;\nvar deviceType = \"DS3604\";\nvar groupName = null; // If groupName is not null - created device will be added to the entity group with such name.\nvar customerName = null; // If customerName is not null - created devices will be assigned to customer with such name. \n\n// use assetName and assetType instead of deviceName and deviceType\n// to automatically create assets instead of devices.\n// var assetName = 'Asset A';\n// var assetType = 'building';\n\n// If you want to parse incoming data somehow, you can add your code to this function.\n// input: bytes\n// expected output:\n//  {\n//    \"attributes\": {\"attributeKey\": \"attributeValue\"},\n//    \"telemetry\": [{\"ts\": 1...1, \"values\": {\"telemetryKey\":\"telemetryValue\"}, {\"ts\": 1...2, \"values\":                      {\"telemetryKey\":\"telemetryValue\"}}]\n//  }\n\nfunction decodePayload(input) {\n    var output = {\n        attributes: {},\n        telemetry: []\n    };\n    \n    // --- Decoding code --- //\n    var decoded = {};\n    for (var i = 0; i < input.length - 2;) {\n        var channel_id = input[i++] & 0xff;\n        var channel_type = input[i++] & 0xff;\n        \n        // BATTERY\n        if (channel_id === 0x01 && channel_type === 0x75) {\n            decoded.battery = input[i];\n            i += 1;\n        }\n        // TEMPLATE\n        else if (channel_id == 0xff && channel_type == 0x73) {\n            decoded.template = input[i] + 1;\n            i += 1;\n        }\n        // TEMPLATE BLOCK CHANNEL DATA\n        if (channel_id == 0xfb && channel_type == 0x01) {\n            var template_id = (input[i] >> 6) + 1;\n            var block_id = input[i++] & 0x3f;\n            var block_name;\n            if (block_id < 10) {\n                block_name = \"text_\" + (block_id + 1);\n                block_length = input[i++];\n                var bytes = java.util.Arrays.copyOfRange(input, i, i + block_length);\n                decoded[block_name] = fromUtf8Bytes(bytes);\n                i += block_length;\n            } else if (block_id == 10) {\n                block_name = \"qrcode\";\n                block_length = input[i++];\n                var bytes = java.util.Arrays.copyOfRange(input, i, i + block_length);\n                decoded[block_name] = fromUtf8Bytes(bytes);\n                i += block_length;\n            }\n            decoded.template = template_id;\n        }\n    }\n\n    output.telemetry = [{\n        ts: timestamp,\n        values: decoded\n    }];\n    \n    // --- Decoding code --- //\n    return output;\n}\n\n// --- attributes and telemetry objects ---\nvar telemetry = [];\nvar attributes = {};\n// --- attributes and telemetry objects ---\n\n// --- Timestamp parsing\nvar dateString = data.time;\ntimestamp = parseDateToTimestamp(dateString);\n// --- Timestamp parsing\n\n// Passing incoming bytes to decodePayload function, to get custom decoding\nvar customDecoding = decodePayload(base64ToBytes(data\n.data));\n\n\nattributes.eui = data.deviceInfo.devEui;\n\n// Collecting data to result\nif (customDecoding.?telemetry.size() > 0) {\n    if (customDecoding.telemetry instanceof java.util.ArrayList) {\n        foreach(telemetryObj: customDecoding.telemetry) {\n            if (telemetryObj.ts != null && telemetryObj.values != null) {\n                telemetry.add(telemetryObj);\n            }\n        }\n    } else {\n        telemetry.putAll(customDecoding.telemetry);\n    }\n}\n\nif (customDecoding.?attributes.size() > 0) {\n    attributes.putAll(customDecoding.attributes);\n}\n\n// You can add some keys manually to attributes or telemetry\nattributes.eui = data.deviceInfo.?devEui;\nattributes.devAddr = data.devAddr;\nattributes.fPort = data.fPort;\nattributes.applicationId = data.deviceInfo.?applicationId;\nattributes.applicationName = data.deviceInfo.?applicationName;\nattributes.tenantId = data.deviceInfo.?tenantId;\nattributes.tenantName = data.deviceInfo.?tenantName;\nattributes.deviceProfileId = data.deviceInfo.?deviceProfileId;\nattributes.deviceProfileName = data.deviceInfo.?deviceProfileName;\nattributes.frequency = data.txInfo.?frequency;\nattributes.bandwidth = data.txInfo.?modulation.?lora.?bandwidth;\nattributes.spreadingFactor = data.txInfo.?modulation.?lora.?spreadingFactor;\nattributes.codeRate = data.txInfo.?modulation.?lora.?codeRate;\n\nvar gatewayInfo = getGatewayInfo();\nvar addDataToTelemetry = {};\naddDataToTelemetry.snr = gatewayInfo.snr;\naddDataToTelemetry.rssi = gatewayInfo.rssi;\naddDataToTelemetry.channel = gatewayInfo.channel;\naddDataToTelemetry.rfChain = gatewayInfo.rfChain;\naddDataToTelemetry.fCnt = data.fCnt;\n\nvar isIncludeGatewayInfo = metadata[\"includeGatewayInfo\"];\nif(isIncludeGatewayInfo == true) {\n   telemetry = processTelemetryData(telemetry, addDataToTelemetry);\n}\n\nvar result = {\n    deviceName: deviceName,\n    deviceType: deviceType,\n    //  assetName: assetName,\n    //  assetType: assetType,\n    attributes: attributes,\n    telemetry: telemetry\n};\n\naddAdditionalInfoForDeviceMsg(result, customerName, groupName);\n\nreturn result;\n\nfunction addAdditionalInfoForDeviceMsg(deviceInfo, customerName, groupName) {\n    if (customerName != null) {\n        deviceInfo.customerName = customerName;\n    }\n    if (groupName != null) {\n        deviceInfo.groupName = groupName;\n    }\n}\n\nfunction parseDateToTimestamp(dateString) {\n    var timestamp = -1;\n    if (dateString != null) {\n        timestamp = new Date(dateString).getTime();\n        if (timestamp == -1) {\n            var secondsSeparatorIndex = dateString.lastIndexOf(\n                '.') + 1;\n            var millisecondsEndIndex = dateString.lastIndexOf(\n                '+');\n            if (millisecondsEndIndex == -1) {\n                millisecondsEndIndex = dateString.lastIndexOf(\n                    'Z');\n            }\n            if (millisecondsEndIndex == -1) {\n                millisecondsEndIndex = dateString.lastIndexOf(\n                    '-');\n            }\n            if (millisecondsEndIndex == -1) {\n                if (dateString.length >= secondsSeparatorIndex +\n                    3) {\n                    dateString = dateString.substring(0,\n                        secondsSeparatorIndex + 3);\n                }\n            } else {\n                dateString = dateString.substring(0,\n                        secondsSeparatorIndex + 3) +\n                    dateString.substring(millisecondsEndIndex,\n                        dateString.length);\n            }\n            timestamp = new Date(dateString).getTime();\n        }\n    }\n    // If we cannot parse timestamp - we will use the current timestamp\n    if (timestamp == -1) {\n        timestamp = Date.now();\n    }\n    \n    return timestamp;\n}\n\nfunction getGatewayInfo() {\n    var gatewayList = data.rxInfo;\n    var maxRssi = Integer. MIN_VALUE;\n    var gatewayInfo = {};\n    \n    foreach (gateway : gatewayList) {\n        if(gateway.rssi > maxRssi) {\n            maxRssi = gateway.rssi;\n            gatewayInfo = gateway;\n        }\n    }\n    \n    return gatewayInfo;\n}\n\nfunction processTelemetryData(telemetry, addDataToTelemetry) {\n    if (telemetry.size > 1) {\n        telemetry = addDataToMultipleTelemetries(telemetry, addDataToTelemetry);\n    }\n    else if (telemetry.size == 1) {\n        telemetry = addDataToSingleTelemetry(telemetry, addDataToTelemetry);\n    }\n    else {\n        telemetry.add(addDataToTelemetry);\n    }\n    \n    return telemetry;\n}\n\nfunction addDataToMultipleTelemetries(telemetry, addDataToTelemetry) {\n    foreach(element : addDataToTelemetry.entrySet()) {\n        if(!telemetry[0][\"values\"].keys.contains(element.key)) {\n            telemetry[0][\"values\"][element.key] = element.value;\n        }\n        if (!telemetry[1][\"values\"].keys.contains(element.key)) {\n            telemetry[1][\"values\"][element.key] = element.value;\n        }\n    }\n    \n    return telemetry;\n}\n\nfunction addDataToSingleTelemetry(telemetry, addDataToTelemetry) {\n    foreach(element : addDataToTelemetry.entrySet()) {\n            if(!telemetry[0][\"values\"].keys.contains(element.key)) {\n                telemetry[0][\"values\"][element.key] = element.value;\n            }\n    }\n    \n    return telemetry;\n}\n\nfunction fromUtf8Bytes(bytes) {\n    var resultObject = \"\";\n    \n    foreach (b : bytes) {\n        resultObject += String.format(\"%%%02X\", b & 0xFF);\n    }\n    \n   return decodeUrlEncodedString(resultObject);\n}\n\nfunction decodeUrlEncodedString(encoded) {\n    var decoded = \"\";\n    for (int i = 0; i < encoded.length(); i++) {\n        char c = encoded.charAt(i);\n        if (c == '%' && i + 2 < encoded.length()) {\n            var hexValue = \"\" + encoded.charAt(i + 1) + encoded.charAt(i + 2);\n            var decodedChar = Integer.parseInt(hexValue, 16);\n            decoded += (char) decodedChar;\n            i += 2;\n        } else {\n            decoded += c;\n        }\n    }\n    return decoded;\n}",
+    "encoder": null,
+    "tbelEncoder": null,
+    "updateOnlyKeys": [
+      "tenantId",
+      "tenantName",
+      "applicationId",
+      "applicationName",
+      "deviceProfileId",
+      "deviceProfileName",
+      "devAddr",
+      "fPort",
+      "frequency",
+      "bandwidth",
+      "spreadingFactor",
+      "codeRate",
+      "battery",
+      "channel",
+      "rfChain",
+      "eui",
+      "beep"
+    ]
+  },
+  "additionalInfo": {
+    "description": ""
+  },
+  "edgeTemplate": false
+}

VENDORS/Milesight/DS3604/ChirpStack/uplink/metadata.json

@@ -0,0 +1,4 @@
+{
+  "integrationName": "ChirpStack integration",
+  "includeGatewayInfo": false
+}

VENDORS/Milesight/DS3604/ChirpStack/uplink/payload.json

@@ -0,0 +1,48 @@
+{
+  "deduplicationId": "57433366-50a6-4dc2-8145-2df1bbc70d9e",
+  "time": "2023-05-22T07:47:05.404859+00:00",
+  "deviceInfo": {
+    "tenantId": "52f14cd4-c6f1-4fbd-8f87-4025e1d49242",
+    "tenantName": "ChirpStack",
+    "applicationId": "ca739e26-7b67-4f14-b69e-d568c22a5a75",
+    "applicationName": "Chirpstack application",
+    "deviceProfileId": "605d08d4-65f5-4d2c-8a5a-3d2457662f79",
+    "deviceProfileName": "Chirpstack default device profile",
+    "deviceName": "Device name",
+    "devEui": "1000000000000001",
+    "tags": {}
+  },
+  "devAddr": "20000001",
+  "adr": true,
+  "dr": 5,
+  "fCnt": 4,
+  "fPort": 85,
+  "confirmed": false,
+  "data": "AXVk+wEABU1pbGVz+wEKBWhlbGxv",
+  "rxInfo": [{
+    "gatewayId": "6a7e111a10000000",
+    "uplinkId": 24022,
+    "time": "2023-05-22T07:47:05.404859+00:00",
+    "rssi": -35,
+    "snr": 11.5,
+    "channel": 2,
+    "rfChain": 1,
+    "location": {},
+    "context": "EFwMtA==",
+    "metadata": {
+      "region_common_name": "EU868",
+      "region_config_id": "eu868"
+    },
+    "crcStatus": "CRC_OK"
+  }],
+  "txInfo": {
+    "frequency": 868500000,
+    "modulation": {
+      "lora": {
+        "bandwidth": 125000,
+        "spreadingFactor": 7,
+        "codeRate": "CR_4_5"
+      }
+    }
+  }
+}

VENDORS/Milesight/DS3604/ChirpStack/uplink/result.json

@@ -0,0 +1,28 @@
+{
+  "deviceName": "DS3604 Device name",
+  "deviceType": "DS3604",
+  "attributes": {
+    "eui": "1000000000000001",
+    "devAddr": "20000001",
+    "fPort": 85,
+    "applicationId": "ca739e26-7b67-4f14-b69e-d568c22a5a75",
+    "applicationName": "Chirpstack application",
+    "tenantId": "52f14cd4-c6f1-4fbd-8f87-4025e1d49242",
+    "tenantName": "ChirpStack",
+    "deviceProfileId": "605d08d4-65f5-4d2c-8a5a-3d2457662f79",
+    "deviceProfileName": "Chirpstack default device profile",
+    "frequency": 868500000,
+    "bandwidth": 125000,
+    "spreadingFactor": 7,
+    "codeRate": "CR_4_5"
+  },
+  "telemetry": [{
+    "ts": 1684741625404,
+    "values": {
+      "battery": 100,
+      "text_1": "Miles",
+      "template": 1,
+      "qrcode": "hello"
+    }
+  }]
+}