diff --git a/dingtek-df555/CHANGELOG.md b/dingtek-df555/CHANGELOG.md new file mode 100644 index 000000000..d86775c7c --- /dev/null +++ b/dingtek-df555/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## 1.0.0 - 2026-06-09 + +- First version of plugin \ No newline at end of file diff --git a/dingtek-df555/LICENSE.md b/dingtek-df555/LICENSE.md new file mode 100644 index 000000000..bffeef341 --- /dev/null +++ b/dingtek-df555/LICENSE.md @@ -0,0 +1,7 @@ +Copyright 2026 Thinger.io + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/dingtek-df555/README.md b/dingtek-df555/README.md new file mode 100644 index 000000000..c7e59b638 --- /dev/null +++ b/dingtek-df555/README.md @@ -0,0 +1,62 @@ +# DF555 - Ultrasonic Tank Level Sensor + +The CNDingtek DF555 is an ultrasonic level sensor for various types of tanks, which is installed on top of the tank. It provides non-contact measurement for liquid and solid level monitoring with wireless LoRaWAN connectivity, suitable for both open and closed containers with a measurement range of up to 5 meters. + +## Key Features + +- **Non-contact ultrasonic measurement** up to 5 meters range +- **LoRaWAN wireless connectivity** with global frequency band support +- **IP67 waterproof** rating for harsh environments +- **Low power consumption** with battery or DC power options +- **Dual mounting options**: threaded or screw mounting +- **Temperature range**: -20°C to 70°C operating temperature +- **Integrated sensors**: level, GPS, and temperature +- **ATEX certified** version available (II 0 G Ex ia IIC T6 Ga) +- **Compact design**: 95mm diameter, 123mm height + +## Thinger.io Integration + +The DF555 integrates seamlessly with Thinger.io through LoRaWAN network servers, enabling remote monitoring of tank levels with real-time data visualization and alerts. + +## Requirements + +A LoRaWAN server is required to communicate the CNDingtek DF555 into Thinger.io, some options are: + +- [The Things Stack](https://www.thethingsindustries.com/stack/) +- [LORIOT](https://loriot.io/) +- [ChirpStack](https://www.chirpstack.io/) + +Alongside, the corresponding plugin for the selected LoRaWAN server needs to be installed in your Thinger.io instance. + +## Get Started + +### Installation + +Look for the plugin in the [Thinger.io Plugin Store](https://marketplace.thinger.io/) and install it in your Thinger.io instance. Once the plugin is installed a new Product will be created for this device. + +### Configuration + +The Product is already preconfigured, check that the auto provision prefix matches the one selected in your LoRaWAN server plugin in Thinger.io, or change it to your desire. + +### Usage + +Start sending uplinks for autoprovisioning devices and buckets. +This product also provides a predefined dashboard and downlinks. + +## Use Cases + +- Industrial tank level monitoring +- Water and wastewater management +- Chemical storage monitoring +- Fuel tank level detection +- Silo and hopper monitoring +- Agricultural storage management + +## Additional Resources + +CNDingtek resources can be found at: + +- [Official Website](https://www.dingtek.com) +- [Product Page](https://www.dingtek.com/top-installation-level-sensor-df555) +- [Device Repository](https://www.thethingsnetwork.org/device-repository/devices/dingtek/df555) +- [Thinger docs](https://docs.thinger.io) \ No newline at end of file diff --git a/dingtek-df555/assets/df555.png b/dingtek-df555/assets/df555.png new file mode 100644 index 000000000..7015492fd Binary files /dev/null and b/dingtek-df555/assets/df555.png differ diff --git a/dingtek-df555/plugin.json b/dingtek-df555/plugin.json new file mode 100644 index 000000000..7db84783a --- /dev/null +++ b/dingtek-df555/plugin.json @@ -0,0 +1,134 @@ +{ + "name": "dingtek_df555", + "version": "1.0.0", + "description": "The CNDingtek df555 is an ultrasonic level for kinds tank, which is installed on top of the tank.", + "author": "Thinger.io", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/thinger-io/plugins.git", + "directory": "dingtek-df555" + }, + "metadata": { + "name": "Dingtek DF555", + "description": "The CNDingtek df555 is an ultrasonic level for kinds tank, which is installed on top of the tank.", + "image": "assets/df555.png", + "category": "devices", + "vendor": "dingtek" + }, + "resources": { + "products": [ + { + "description": "The CNDingtek df555 is an ultrasonic level for kinds tank, which is installed on top of the tank.", + "enabled": true, + "name": "Dingtek DF555", + "product": "dingtek_df555", + "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": "df555_[0-9A-Fa-f]{16}" + }, + "enabled": true + } + }, + "buckets": { + "dingtek_df555_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\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 switch (input.bytes.length) {\n case 17:\n if (input.bytes[3] != 0x03) {\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 temperature: input.bytes[8],\n frameCounter: (input.bytes[13] << 8) + input.bytes[14],\n },\n };\n } else {\n return {\n // Decoded data\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[14],\n },\n };\n }\n\n case 25:\n return {\n // Decoded data\n data: {\n level: (input.bytes[5] << 8) + input.bytes[6],\n alarmLevel: Boolean(input.bytes[19] >> 4),\n alarmBattery: Boolean(input.bytes[20] & 0x0f),\n longitude: hex2float((input.bytes[11] << 24) + (input.bytes[10] << 16) + (input.bytes[9] << 8) + input.bytes[8]).toFixed(6),\n latitude: hex2float((input.bytes[15] << 24) + (input.bytes[14] << 16) + (input.bytes[13] << 8) + input.bytes[12]).toFixed(6),\n temperature: input.bytes[16],\n frameCounter: (input.bytes[21] << 8) + input.bytes[22],\n },\n };\n default:\n return {\n errors: ['wrong length'],\n };\n }\n}\n\n// Encode downlink function.\n//\n// Input is an object with the following fields:\n// - data = Object representing the payload that must be encoded.\n// - variables = Object containing the configured device variables.\n//\n// Output must be an object with the following fields:\n// - bytes = Byte array containing the downlink payload.\nfunction encodeDownlink(input) {\n if (input.data.uploadInterval != null && !isNaN(input.data.uploadInterval)) {\n var uploadInterval = input.data.uploadInterval;\n var uploadInterval_high = uploadInterval.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var uploadInterval_low = uploadInterval.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (uploadInterval > 255 || uploadInterval < 1) {\n return {\n errors: ['upload interval range 1-255 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, uploadInterval_high, uploadInterval_low, 0x38, 0x31],\n };\n }\n }\n if (input.data.detectInterval != null && !isNaN(input.data.detectInterval)) {\n var detectInterval = input.data.detectInterval;\n var detectInterval_high = detectInterval.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var detectInterval_low = detectInterval.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (detectInterval > 255 || detectInterval < 1) {\n return {\n errors: ['detection interval range 1-255 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, detectInterval_high, detectInterval_low, 0x38, 0x31],\n };\n }\n }\n if (input.data.levelThreshold != null && !isNaN(input.data.levelThreshold)) {\n var levelThreshold = input.data.levelThreshold;\n var levelThreshold_high = levelThreshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var levelThreshold_low = levelThreshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (levelThreshold > 255 || levelThreshold < 15) {\n return {\n errors: ['Level alarm threshold range 15-255.'],\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, levelThreshold_high, levelThreshold_low, 0x38, 0x31],\n };\n }\n } \n if (input.data.batteryThreshold != null && !isNaN(input.data.batteryThreshold)) {\n var batteryThreshold = input.data.batteryThreshold;\n var batteryThreshold_high = batteryThreshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var batteryThreshold_low = batteryThreshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (batteryThreshold > 99 || batteryThreshold < 5) {\n return {\n errors: ['Battery alarm threshold range 5-99.'],\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, 0x35, batteryThreshold_high, batteryThreshold_low, 0x38, 0x31],\n };\n }\n } \n if (input.data.gpsEnable != null && !isNaN(input.data.gpsEnable)) {\n var gpsEnable = input.data.gpsEnable;\n if (gpsEnable == true || gpsEnable == 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 } 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, 0x39, 0x30, 0x30, 0x38, 0x31],\n };\n }\n }\n if (input.data.workMode != null && !isNaN(input.data.workMode)) {\n var workMode = input.data.workMode;\n if (workMode === 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, 0x35, 0x38, 0x31],\n };\n } else if (workMode === 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, 0x36, 0x38, 0x31],\n };\n } else if (workMode === 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 }else{\n return {\n errors: ['Work mode range 0-2.'],\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 5:\n return {\n data: {\n batteryThreshold: value,\n },\n };\n case 9:\n switch (value) {\n case 0x00:\n return {\n data: {\n gpsEnable: 0,\n },\n };\n case 0x01:\n return {\n data: {\n gpsEnable: 1,\n },\n };\n case 0x02:\n return {\n data: {\n reset: 1,\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 default:\n return {\n errors: ['invalid parameter value.'],\n };\n }\n default:\n return {\n errors: ['invalid parameter key.'],\n };\n }\n}\n\n", + "environment": "javascript", + "storage": "", + "version": "1.0" + }, + "flows": { + "dingtek_df555_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": [] + } + } + ] + } +} \ No newline at end of file