Merge Plugin dingtek_dc413 into Main

dingtek-dc413/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog 
+
+## 1.0.0 - 2026-06-09
+
+- First version of plugin

dingtek-dc413/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.

dingtek-dc413/README.md

@@ -0,0 +1,59 @@
+# DC413 - Manhole Sensor
+
+The CNDingtek DC413 is a smart manhole sensor that integrates a liquid/solid level sensor and a movement sensor. Suitable for measuring water and sewage levels in wells and manholes. The data is sent to a LoRaWAN network, then the application server for further processing.
+
+## Features
+
+- **Dual Sensing Technology**: Combines manhole cover status detection and ultrasonic water/sewage level monitoring in a single device
+- **Cover Movement Detection**: Monitors cover movement and abnormal opening using acceleration detection
+- **Ultrasonic Level Monitoring**: Measures water and sewage levels inside manholes and drainage wells
+- **IP68 Protection**: Fully waterproof outdoor enclosure for harsh environments
+- **LoRaWAN Connectivity**: Long-range wireless transmission for remote monitoring
+- **Compact Design**: 119 x 119 x 40 mm dimensions, 450g weight
+- **Operating Temperature**: -20°C to 70°C
+- **Durable Construction**: ABS material in black color
+
+## Use Cases
+
+- Municipal manhole cover safety monitoring
+- Urban drainage system level monitoring
+- Sewage overflow prevention and early warning
+- Smart city infrastructure management
+- Flood risk detection in drainage networks
+- Theft and unauthorized access detection
+
+## Thinger.io Integration
+
+The DC413 manhole sensor integrates seamlessly with Thinger.io through LoRaWAN network servers, enabling real-time monitoring of manhole cover status and water levels with automated alerts and historical trend analysis.
+
+## Requirements
+
+A LoRaWAN server is required to communicate the CNDingtek DC413 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.
+
+## Additional Resources
+
+CNDingtek resources can be found at:
+
+- [Product Page](https://www.dingtek.com/manhole-sensor-dc413)
+- [Device Repository](https://www.thethingsnetwork.org/device-repository/devices/dingtek/dc413)
+- [Thinger docs](https://docs.thinger.io)

dingtek-dc413/plugin.json

@@ -0,0 +1,125 @@
+{
+  "name": "dingtek_dc413",
+  "version": "1.0.0",
+  "description": "The CNDingtek dc413 is a smart manhole sensor that integrates a liquid/solid level sensor and a movement sensor. Suitable for measuring water and sewage levels in wells and manholes. The data is sent to a LoRaWAN network, then the application server for f",
+  "author": "Thinger.io",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thinger-io/plugins.git",
+    "directory": "dingtek-dc413"
+  },
+  "metadata": {
+    "name": "Dingtek DC413",
+    "description": "The CNDingtek dc413 is a smart manhole sensor that integrates a liquid/solid level sensor and a movement sensor. Suitable for measuring water and sewage levels in wells and manholes. The data is sent to a LoRaWAN network, then the application server for f",
+    "image": "assets/dc413.png",
+    "category": "devices",
+    "vendor": "dingtek"
+  },
+  "resources": {
+    "products": [
+      {
+        "description": "The CNDingtek dc413 is a smart manhole sensor that integrates a liquid/solid level sensor and a movement sensor. Suitable for measuring water and sewage levels in wells and manholes. The data is sent to a LoRaWAN network, then the application server for f",
+        "enabled": true,
+        "name": "Dingtek DC413",
+        "product": "dingtek_dc413",
+        "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"
+                }
+              }
+            }
+          },
+          "buckets": {
+            "dingtek_dc413_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 17:\n      return {\n        // Decoded data\n        data: {\n          level: (input.bytes[5] << 8) + input.bytes[6],\n          alarmLevel: Boolean(input.bytes[11] >> 4),\n          alarmFall: Boolean(input.bytes[12] >> 4),\n          alarmBattery: Boolean(input.bytes[12] & 0x0f),\n          angle: input.bytes[9] & (0x0f === 0x00) ? input.bytes[10] : 0 - input.bytes[10],\n          temperature: input.bytes[8],\n          frameCounter: (input.bytes[13] << 8) + input.bytes[14],\n        },\n      };\n    case 25:\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            fallThreshold: input.bytes[11],\n            fallEnable: Boolean(input.bytes[12]),\n            workMode: input.bytes[14],\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: ['periodic 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.fallThreshold != null && !isNaN(input.data.fallThreshold)) {\n    var tilt_alarm_threshold = input.data.fallThreshold;\n    var tilt_alarm_threshold_high = tilt_alarm_threshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n    var tilt_alarm_threshold_low = tilt_alarm_threshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n    if (tilt_alarm_threshold > 90 || tilt_alarm_threshold < 15) {\n      return {\n        errors: ['tilt alarm threshold range 15-90 °.'],\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, 0x34, tilt_alarm_threshold_high, tilt_alarm_threshold_low, 0x38, 0x31],\n      };\n    }\n  }\n  if (input.data.fallEnable != null && input.data.fallEnable === !!input.data.fallEnable) {\n    var tilt_enable = input.data.fallEnable;\n    if (tilt_enable === true) {\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, 0x41, 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, 0x39, 0x38, 0x31],\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 4:\n      return {\n        data: {\n          fallThreshold: value,\n        },\n      };\n    case 9:\n      switch (value) {        \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_dc413_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": []
+        }
+      }
+    ]
+  }
+}