diff --git a/dingtek-df701/plugin.json b/dingtek-df701/plugin.json index 9bed11399..c652ad48c 100644 --- a/dingtek-df701/plugin.json +++ b/dingtek-df701/plugin.json @@ -1,134 +1,550 @@ { - "name": "dingtek_df701", - "version": "1.0.0", - "description": "The CNDingtek df701 is a laser level sensor for indoor waste bins. The measured data is reported to a LoRaWAN® network that notifies garbage collecting authorities to collect and empty the bins.", - "author": "Thinger.io", - "license": "MIT", - "repository": { - "type": "git", - "url": "https://github.com/thinger-io/plugins.git", - "directory": "dingtek-df701" - }, - "metadata": { - "name": "Dingtek DF701", - "description": "The CNDingtek df701 is a laser level sensor for indoor waste bins. The measured data is reported to a LoRaWAN® network that notifies garbage collecting authorities to collect and empty the bins.", - "image": "assets/df701.png", - "category": "devices", - "vendor": "dingtek" - }, - "resources": { - "products": [ - { - "description": "The CNDingtek df701 is a laser level sensor for indoor waste bins. The measured data is reported to a LoRaWAN® network that notifies garbage collecting authorities to collect and empty the bins.", - "enabled": true, + "name": "dingtek-df701", + "version": "1.0.0", + "description": "CNDingtek DF701 is a laser level sensor for indoor waste bins, reporting fill data via LoRaWAN® to notify collection authorities.", + "author": "Thinger.io", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/thinger-io/plugins.git", + "directory": "dingtek-df701" + }, + "metadata": { "name": "Dingtek DF701", - "product": "dingtek_df701", - "profile": { - "api": { - "downlink": { - "enabled": true, - "handle_connectivity": false, - "request": { - "data": { - "path": "/downlink", - "payload": "{\n \"data\" : \"{{payload.data=\"\"}}\",\n \"port\" : {{payload.port=3}},\n \"priority\": {{payload.priority=3}},\n \"confirmed\" : {{payload.confirmed=false}},\n \"uplink\" : {{property.uplink}} \n}", - "payload_function": "", - "payload_type": "", - "plugin": "{{property.uplink.source}}", - "target": "plugin_endpoint" + "description": "CNDingtek DF701 is a laser level sensor for indoor waste bins, reporting fill data via LoRaWAN® to notify collection authorities.", + "image": "assets/df701.png", + "category": "devices", + "vendor": "dingtek" + }, + "resources": { + "products": [ + { + "config": { + "icons": [] + }, + "description": "CNDingtek DF701 is a laser level sensor for indoor waste bins, reporting fill data via LoRaWAN® to notify collection authorities.", + "enabled": true, + "name": "Dingtek DF701", + "product": "dingtek_df701", + "profile": { + "api": { + "downlink": { + "enabled": true, + "handle_connectivity": false, + "request": { + "data": { + "path": "/downlink", + "payload": "{\n \"data\" : \"{{payload.data=\"\"}}\",\n \"port\" : {{payload.port=3}},\n \"priority\": {{payload.priority=3}},\n \"confirmed\" : {{payload.confirmed=false}},\n \"uplink\" : {{property.uplink}} \n}", + "payload_function": "", + "payload_type": "", + "plugin": "{{property.uplink.source}}", + "target": "plugin_endpoint" + } + } + }, + "uplink": { + "device_id_resolver": "getId", + "enabled": true, + "handle_connectivity": true, + "request": { + "data": { + "payload": "{{payload}}", + "payload_function": "", + "payload_type": "source_payload", + "resource_stream": "uplink", + "target": "resource_stream" + } + } + } + }, + "autoprovisions": { + "device_autoprovisioning": { + "config": { + "mode": "pattern", + "pattern": "df701_.*" + }, + "enabled": true + } + }, + "buckets": { + "dingtek_df701_data": { + "backend": "mongodb", + "data": { + "payload": "{{payload}}", + "payload_function": "", + "payload_type": "source_payload", + "resource_stream": "uplink_decoded", + "source": "resource_stream" + }, + "enabled": true, + "retention": { + "period": 3, + "unit": "months" + }, + "tags": [] + } + }, + "code": { + "code": "function decodeThingerUplink(thingerData) {\n // 0. If data has already been decoded, we will return it\n if (thingerData.decodedPayload) return thingerData.decodedPayload;\n \n // 1. Extract and Validate Input\n // We need 'payload' (hex string) and 'fPort' (integer)\n const hexPayload = thingerData.payload || \"\";\n const port = thingerData.fPort || 1;\n\n // 2. Convert Hex String to Byte Array\n const bytes = [];\n for (let i = 0; i < hexPayload.length; i += 2) {\n bytes.push(parseInt(hexPayload.substr(i, 2), 16));\n }\n\n // 3. Dynamic Function Detection and Execution\n \n // CASE A: (The Things Stack v3)\n if (typeof decodeUplink === 'function') {\n try {\n const input = {\n bytes: bytes,\n fPort: port\n };\n var result = decodeUplink(input);\n \n if (result.data) return result.data;\n\n return result; \n } catch (e) {\n console.error(\"Error inside decodeUplink:\", e);\n throw e;\n }\n }\n\n // CASE B: Legacy TTN (v2)\n else if (typeof Decoder === 'function') {\n try {\n return Decoder(bytes, port);\n } catch (e) {\n console.error(\"Error inside Decoder:\", e);\n throw e;\n }\n }\n\n // CASE C: No decoder found\n else {\n throw new Error(\"No compatible TTN decoder function (decodeUplink or Decoder) found in scope.\");\n }\n}\n\n\n// TTN decoder\nvar units = [' ℃', ' hours', ' minutes', ' mm', ' °', ' cm'];\n//IEEE754 hex to float convert\nfunction hex2float(num) {\n var sign = num & 0x80000000 ? -1 : 1;\n var exponent = ((num >> 23) & 0xff) - 127;\n var mantissa = 1 + (num & 0x7fffff) / 0x7fffff;\n return sign * mantissa * Math.pow(2, exponent);\n}\n\nfunction decodeUplink(input) {\n if (input.fPort != 3) {\n return {\n errors: ['unknown FPort'],\n };\n }\n\n switch (input.bytes.length) {\n case 18:\n return {\n // Decoded data\n data: {\n level: (input.bytes[5] << 8) + input.bytes[6],\n alarmLevel: Boolean(input.bytes[11] >> 4),\n alarmBattery: Boolean(input.bytes[12] & 0x0f),\n volt: ((input.bytes[13] << 8) + input.bytes[14]) / 100,\n frameCounter: (input.bytes[15] << 8) + input.bytes[16],\n },\n };\n\n case 12:\n var data_type = input.bytes[3];\n if (data_type === 0x03) {\n return {\n // Decoded parameter\n data: {\n firmware: input.bytes[5] + '.' + input.bytes[6],\n uploadInterval: input.bytes[7],\n detectInterval: input.bytes[8],\n levelThreshold: input.bytes[9],\n workMode: input.bytes[10],\n },\n };\n }\n default:\n return {\n errors: ['wrong length'],\n };\n }\n}\n\nfunction encodeDownlink(input) {\n if (input.data.uploadInterval != null && !isNaN(input.data.uploadInterval)) {\n var periodic_interval = input.data.uploadInterval;\n var periodic_interval_high = periodic_interval.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var periodic_interval_low = periodic_interval.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (periodic_interval > 168 || periodic_interval < 1) {\n return {\n errors: ['periodic upload interval range 1-168 hours.'],\n };\n } else {\n return {\n // LoRaWAN FPort used for the downlink message\n fPort: 3,\n // Encoded bytes\n bytes: [0x38, 0x30, 0x30, 0x32, 0x39, 0x39, 0x39, 0x39, 0x30, 0x31, periodic_interval_high, periodic_interval_low, 0x38, 0x31],\n };\n }\n }\n if (input.data.detectInterval != null && !isNaN(input.data.detectInterval)) {\n var detection_interval = input.data.detectInterval;\n var detection_interval_high = detection_interval.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var detection_interval_low = detection_interval.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (detection_interval > 60 || detection_interval < 1) {\n return {\n errors: ['cyclic detection interval range 1-60 minutes.'],\n };\n } else {\n return {\n // LoRaWAN FPort used for the downlink message\n fPort: 3,\n // Encoded bytes\n bytes: [0x38, 0x30, 0x30, 0x32, 0x39, 0x39, 0x39, 0x39, 0x30, 0x38, detection_interval_high, detection_interval_low, 0x38, 0x31],\n };\n }\n }\n if (input.data.levelThreshold != null && !isNaN(input.data.levelThreshold)) {\n var full_alarm_threshold = input.data.levelThreshold;\n var full_alarm_threshold_high = full_alarm_threshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var full_alarm_threshold_low = full_alarm_threshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (full_alarm_threshold > 255 || full_alarm_threshold < 15) {\n return {\n errors: ['full alarm threshold range 15-255 cm.'],\n };\n } else {\n return {\n // LoRaWAN FPort used for the downlink message\n fPort: 3,\n // Encoded bytes\n bytes: [0x38, 0x30, 0x30, 0x32, 0x39, 0x39, 0x39, 0x39, 0x30, 0x32, full_alarm_threshold_high, full_alarm_threshold_low, 0x38, 0x31],\n };\n }\n }\n\n if (input.data.workMode != null) {\n var workMode = input.data.workMode;\n switch (workMode) {\n case 0:\n return {\n // LoRaWAN FPort used for the downlink message\n fPort: 3,\n // Encoded bytes\n bytes: [0x38, 0x30, 0x30, 0x32, 0x39, 0x39, 0x39, 0x39, 0x30, 0x39, 0x30, 0x30, 0x38, 0x31],\n };\n break;\n case 1:\n return {\n // LoRaWAN FPort used for the downlink message\n fPort: 3,\n // Encoded bytes\n bytes: [0x38, 0x30, 0x30, 0x32, 0x39, 0x39, 0x39, 0x39, 0x30, 0x39, 0x30, 0x31, 0x38, 0x31],\n };\n break;\n case 2:\n return {\n // LoRaWAN FPort used for the downlink message\n fPort: 3,\n // Encoded bytes\n bytes: [0x38, 0x30, 0x30, 0x32, 0x39, 0x39, 0x39, 0x39, 0x30, 0x39, 0x30, 0x45, 0x38, 0x31],\n };\n break;\n default:\n break;\n }\n }\n\n return {\n errors: ['invalid downlink parameter.'],\n };\n}\n\nfunction decodeDownlink(input) {\n var input_length = input.bytes.length;\n if (input.fPort != 3) {\n return {\n errors: ['invalid FPort.'],\n };\n }\n\n if (\n input_length < 12 ||\n input.bytes[0] != 0x38 ||\n input.bytes[1] != 0x30 ||\n input.bytes[2] != 0x30 ||\n input.bytes[3] != 0x32 ||\n input.bytes[4] != 0x39 ||\n input.bytes[5] != 0x39 ||\n input.bytes[6] != 0x39 ||\n input.bytes[7] != 0x39 ||\n input.bytes[input_length - 2] != 0x38 ||\n input.bytes[input_length - 1] != 0x31\n ) {\n return {\n errors: ['invalid format.'],\n };\n }\n var option = parseInt(String.fromCharCode(input.bytes[8]) + String.fromCharCode(input.bytes[9]), 16);\n var value = parseInt(String.fromCharCode(input.bytes[10]) + String.fromCharCode(input.bytes[11]), 16);\n switch (option) {\n case 1:\n return {\n data: {\n uploadInterval: value,\n },\n };\n case 8:\n return {\n data: {\n detectInterval: value,\n },\n };\n case 2:\n return {\n data: {\n levelThreshold: value,\n },\n }; \n case 9:\n switch (value) {\n case 0x03:\n return {\n data: {\n activeMode: ABP,\n },\n };\n case 0x04:\n return {\n data: {\n activeMode: OTAA,\n },\n };\n case 0x05:\n return {\n data: {\n workMode: 0,\n },\n };\n case 0x06:\n return {\n data: {\n workMode: 1,\n },\n };\n case 0x0e:\n return {\n data: {\n workMode: 2,\n },\n };\n case 0x09:\n return {\n data: {\n fallEnable: false,\n },\n };\n case 0x0a:\n return {\n data: {\n fallEnable: true,\n },\n };\n default:\n return {\n errors: ['invalid parameter value.'],\n };\n }\n default:\n return {\n errors: ['invalid parameter key.'],\n };\n }\n}\n", + "environment": "javascript", + "storage": "", + "version": "1.0" + }, + "flows": { + "dingtek_df701_decoder": { + "data": { + "payload": "{{payload}}", + "payload_function": "decodeThingerUplink", + "payload_type": "source_payload", + "resource": "uplink", + "source": "resource", + "update": "events" + }, + "enabled": true, + "sink": { + "payload": "{{payload}}", + "payload_function": "", + "payload_type": "source_payload", + "resource_stream": "uplink_decoded", + "target": "resource_stream" + }, + "split_data": false + } + }, + "properties": { + "uplink": { + "data": { + "payload": "{{payload}}", + "payload_function": "", + "payload_type": "source_payload", + "resource": "uplink", + "source": "resource", + "update": "events" + }, + "default": { + "source": "value" + }, + "enabled": true + } + } + }, + "_resources": { + "properties": [ + { + "property": "dashboard", + "value": { + "tabs": [ + { + "name": "Overview", + "widgets": [ + { + "layout": { + "col": 0, + "row": 0, + "sizeX": 1, + "sizeY": 6 + }, + "panel": { + "color": "#ffffff", + "currentColor": "#ffffff", + "showOffline": { + "type": "none" + }, + "title": "Fill Level" + }, + "properties": { + "color": "#2ecc71", + "max": 200, + "min": 0, + "unit": " cm" + }, + "sources": [ + { + "bucket": { + "backend": "mongodb", + "id": "dingtek_df701_data", + "mapping": "level", + "tags": { + "device": [], + "group": [] + } + }, + "color": "#2ecc71", + "name": "Level", + "source": "bucket", + "timespan": { + "mode": "latest" + } + } + ], + "type": "donutchart" + }, + { + "layout": { + "col": 1, + "row": 0, + "sizeX": 1, + "sizeY": 6 + }, + "panel": { + "color": "#ffffff", + "currentColor": "#ffffff", + "showOffline": { + "type": "none" + }, + "title": "Battery Voltage" + }, + "properties": { + "color": "#f1c40f", + "max": 4, + "min": 0, + "unit": " V" + }, + "sources": [ + { + "bucket": { + "backend": "mongodb", + "id": "dingtek_df701_data", + "mapping": "volt", + "tags": { + "device": [], + "group": [] + } + }, + "color": "#f1c40f", + "name": "Voltage", + "source": "bucket", + "timespan": { + "mode": "latest" + } + } + ], + "type": "donutchart" + }, + { + "layout": { + "col": 2, + "row": 0, + "sizeX": 2, + "sizeY": 6 + }, + "panel": { + "color": "#ffffff", + "currentColor": "#ffffff", + "showOffline": { + "type": "none" + }, + "title": "Device Status" + }, + "properties": { + "source": "code", + "template": "
| Date | \nLevel (cm) | \nVoltage (V) | \nAlarm Level | \nAlarm Battery | \nFrame # | \n
|---|---|---|---|---|---|
| {{ entry.ts | date:'medium' }} | \n{{ entry.level || '—' }} | \n{{ entry.volt || '—' }} | \n{{ entry.alarmLevel ? '🔴 YES' : '🟢 NO' }} | \n{{ entry.alarmBattery ? '🔴 LOW' : '🟢 OK' }} | \n{{ entry.frameCounter || '—' }} | \n