diff --git a/dingtek-dt311/CHANGELOG.md b/dingtek-dt311/CHANGELOG.md new file mode 100644 index 000000000..d86775c7c --- /dev/null +++ b/dingtek-dt311/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-dt311/LICENSE.md b/dingtek-dt311/LICENSE.md new file mode 100644 index 000000000..bffeef341 --- /dev/null +++ b/dingtek-dt311/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-dt311/README.md b/dingtek-dt311/README.md new file mode 100644 index 000000000..53f7affd2 --- /dev/null +++ b/dingtek-dt311/README.md @@ -0,0 +1,55 @@ +# DT311 - Temperature & Humidity Sensor + +The CNDingtek DT311 is a wireless temperature and humidity sensor designed for indoor use in protected environments. It measures ambient temperature and humidity and transmits data to the cloud through LoRaWAN, NB-IoT, or Sigfox connectivity options. The device is ideal for monitoring conditions in rooms, cabinets, storage spaces, and other protected indoor facilities. + +## Features + +- **High Accuracy Measurements**: Temperature accuracy of ±0.3°C and humidity accuracy of ±2% RH +- **Multiple Connectivity Options**: LoRaWAN, NB-IoT, or Sigfox wireless protocols +- **Indoor Design**: Optimized for protected ambient environments +- **Cloud Integration**: Direct data transmission to cloud platforms +- **Easy Deployment**: Wireless installation with no wiring required + +## Use Cases + +- Room climate monitoring +- Cabinet and enclosure environmental control +- Storage space condition tracking +- Protected facility temperature and humidity oversight +- Indoor environmental quality management + +## Thinger.io Integration + +The DT311 can be integrated into Thinger.io through LoRaWAN connectivity, enabling real-time monitoring, data visualization, and automated control based on environmental conditions. + +## Requirements + +A LoRaWAN server is required to communicate the CNDingtek DT311 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: + +- [DT311 Product Page](https://www.dingtek.com/temperature-humitidy-sensor-dt311) +- [Thinger docs](https://docs.thinger.io) \ No newline at end of file diff --git a/dingtek-dt311/assets/dt311.png b/dingtek-dt311/assets/dt311.png new file mode 100644 index 000000000..e03c67db1 Binary files /dev/null and b/dingtek-dt311/assets/dt311.png differ diff --git a/dingtek-dt311/plugin.json b/dingtek-dt311/plugin.json new file mode 100644 index 000000000..217ef1916 --- /dev/null +++ b/dingtek-dt311/plugin.json @@ -0,0 +1,134 @@ +{ + "name": "dingtek_dt311", + "version": "1.0.0", + "description": "The CNDingtek dt311 is temperature and humidity sensor for indoor using.", + "author": "Thinger.io", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/thinger-io/plugins.git", + "directory": "dingtek-dt311" + }, + "metadata": { + "name": "Dingtek DT311", + "description": "The CNDingtek dt311 is temperature and humidity sensor for indoor using.", + "image": "assets/dt311.png", + "category": "devices", + "vendor": "dingtek" + }, + "resources": { + "products": [ + { + "description": "The CNDingtek dt311 is temperature and humidity sensor for indoor using.", + "enabled": true, + "name": "Dingtek DT311", + "product": "dingtek_dt311", + "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": "dt311_[0-9A-Fa-f]{16}" + }, + "enabled": true + } + }, + "buckets": { + "dingtek_dt311_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[3]) {\n case 1:\n case 2:\n var temp_sign = input.bytes[8];\n var temp_abs = (input.bytes[9] >> 4) * 10 + (input.bytes[9] & 0x0F) + (input.bytes[10] >> 4) / 10 + (input.bytes[10] & 0x0F) / 100;\n var humi_abs = (input.bytes[11] >> 4) * 10 + (input.bytes[11] & 0x0F) + (input.bytes[12] >> 4) / 10 + (input.bytes[12] & 0x0F) / 100;\n var temperature_temp=(temp_sign == 0 )? temp_abs : (0 - temp_abs);\n return {\n // Decoded data\n data: {\n temperature: temperature_temp.toFixed(2),\n humidity: humi_abs.toFixed(2),\n alarmHighTemperature: (input.bytes[13] & 0x10) ? true : false,\n alarmLowTemperature: (input.bytes[13] & 0x01) ? true : false,\n alarmHighHumidity: (input.bytes[14] & 0x10) ? true : false,\n alarmLowHumidity: (input.bytes[14] & 0x01) ? true : false,\n alarmBattery: (input.bytes[7] & 0x01) ? true : false,\n volt: ((input.bytes[5] << 8) + input.bytes[6]) / 100,\n frameCounter: (input.bytes[15] << 8) + input.bytes[16],\n },\n };\n case 3:\n var high_temp_abs = input.bytes[10];\n var low_temp_abs = input.bytes[12];\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 highTemperatureThreshold: input.bytes[9] ? 256 - high_temp_abs : high_temp_abs,\n lowTemperatureThreshold: input.bytes[11] ? 0 - low_temp_abs : low_temp_abs,\n highHumidityThreshold: input.bytes[13],\n lowHumidityThreshold: input.bytes[14],\n batteryThreshold: input.bytes[16],\n workMode: input.bytes[15],\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.highTemperatureThreshold != null && !isNaN(input.data.highTemperatureThreshold)) {\n var highTemperatureThreshold = input.data.highTemperatureThreshold<0?0-input.data.highTemperatureThreshold:input.data.highTemperatureThreshold;\n var highTemperatureSign=input.data.highTemperatureThreshold<0?0x31:0x30;\n var highTemperatureThreshold_high = highTemperatureThreshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var highTemperatureThreshold_low = highTemperatureThreshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (input.data.highTemperatureThreshold > 85 || input.data.highTemperatureThreshold < -30) {\n return {\n errors: ['High temperature alarm threshold range -30~+85.'],\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, 0x30,highTemperatureSign,highTemperatureThreshold_high, highTemperatureThreshold_low, 0x38, 0x31],\n };\n }\n }\n if (input.data.lowTemperatureThreshold != null && !isNaN(input.data.lowTemperatureThreshold)) {\n var lowTemperatureThreshold = input.data.lowTemperatureThreshold<0?0-input.data.lowTemperatureThreshold:input.data.lowTemperatureThreshold;\n var lowTemperatureSign=input.data.lowTemperatureThreshold<0?0x31:0x30;\n var lowTemperatureThreshold_high = lowTemperatureThreshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var lowTemperatureThreshold_low = lowTemperatureThreshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (input.data.lowTemperatureThreshold > 85 || input.data.lowTemperatureThreshold < -30) {\n return {\n errors: ['Low temperature alarm threshold range -30~+85.'],\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, 0x33, 0x30,lowTemperatureSign,lowTemperatureThreshold_high, lowTemperatureThreshold_low, 0x38, 0x31],\n };\n }\n }\n \n if (input.data.highHumidityThreshold != null && !isNaN(input.data.highHumidityThreshold)) {\n var highHumidityThreshold = input.data.highHumidityThreshold<0?0-input.data.highHumidityThreshold:input.data.highHumidityThreshold; \n var highHumidityThreshold_high = highHumidityThreshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var highHumidityThreshold_low = highHumidityThreshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (input.data.highHumidityThreshold > 100 || input.data.highHumidityThreshold < 0) {\n return {\n errors: ['High humidity alarm threshold range 0~100.'],\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, highHumidityThreshold_high, highHumidityThreshold_low, 0x38, 0x31],\n };\n }\n }\n if (input.data.lowHumidityThreshold != null && !isNaN(input.data.lowHumidityThreshold)) {\n var lowHumidityThreshold = input.data.lowHumidityThreshold<0?0-input.data.lowHumidityThreshold:input.data.lowHumidityThreshold; \n var lowHumidityThreshold_high = lowHumidityThreshold.toString(16).padStart(2, '0').toUpperCase()[0].charCodeAt(0);\n var lowHumidityThreshold_low = lowHumidityThreshold.toString(16).padStart(2, '0').toUpperCase()[1].charCodeAt(0);\n if (input.data.lowHumidityThreshold > 100 || input.data.lowHumidityThreshold < 0) {\n return {\n errors: ['High humidity alarm threshold range 0~100.'],\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, 0x45, lowHumidityThreshold_high, lowHumidityThreshold_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 < 1) {\n return {\n errors: ['Battery alarm threshold range 1-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\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 {\n return {\n errors: ['Work mode range 0-1.'],\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 var temp_abs = parseInt(String.fromCharCode(input.bytes[12]) + String.fromCharCode(input.bytes[13]), 16);\n return {\n data: {\n highTemperatureThreshold: value > 0 ? 0 - temp_abs : temp_abs,\n },\n };\n case 3:\n var temp_abs = parseInt(String.fromCharCode(input.bytes[12]) + String.fromCharCode(input.bytes[13]), 16);\n return {\n data: {\n lowTemperatureThreshold: value > 0 ? 0 - temp_abs : temp_abs,\n },\n };\n case 4:\n return {\n data: {\n highHumidityThreshold: value,\n },\n };\n case 5:\n return {\n data: {\n batteryThreshold: value,\n },\n };\n case 14:\n return {\n data: {\n lowHumidityThreshold: value,\n },\n };\n case 9:\n switch (value) {\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 default:\n return {\n errors: ['invalid parameter value.'],\n };\n }\n default:\n return {\n errors: ['invalid parameter key.'],\n };\n }\n}", + "environment": "javascript", + "storage": "", + "version": "1.0" + }, + "flows": { + "dingtek_dt311_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