From 7af7bf203611d2e8cdc7f26b950f59a13e80159f Mon Sep 17 00:00:00 2001 From: Lars Dannijs <117638911+LDannijs@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:28:23 +0100 Subject: [PATCH] Add onboarding guide URL definition (#765) * add onboardingGuideURL * add ethernet options to device properties * Update onboarding text --- schema.json | 10 +++++++--- vendor/browan/tbms100.yaml | 3 +++ vendor/dragino/lht52.yaml | 4 ++++ vendor/elsys/ers-lite.yaml | 3 +++ vendor/example/windsensor.yaml | 12 ++++++++---- vendor/milesight-iot/em300-th.yaml | 3 +++ vendor/moko/lw001-bgpro.yaml | 3 +++ vendor/sensative/strips.yaml | 3 +++ vendor/sensecap/sensecaps2100-data-logger.yaml | 3 +++ vendor/sensecap/sensecaps2101-temp-humid.yaml | 3 +++ vendor/sensecap/sensecaps2102-light.yaml | 3 +++ vendor/sensecap/sensecaps2103-co2-temp-humid.yaml | 3 +++ .../sensecap/sensecaps2104-soil-moisture-temp.yaml | 3 +++ .../sensecaps2105-soll-moisture-temp-ec.yaml | 3 +++ .../generic-node-sensor-edition.yaml | 14 ++++++++++++++ 15 files changed, 66 insertions(+), 7 deletions(-) diff --git a/schema.json b/schema.json index e7686ec901..055256eb52 100644 --- a/schema.json +++ b/schema.json @@ -1008,7 +1008,7 @@ "bridgeInterfaces": { "type": "array", "items": { - "enum": ["modbus", "m-bus", "can bus", "rs-485", "sdi-12", "analog"] + "enum": ["modbus", "m-bus", "can bus", "rs-485", "sdi-12", "analog", "ethernet"] }, "uniqueItems": true }, @@ -1110,7 +1110,7 @@ "keyProgramming": { "type": "array", "items": { - "enum": ["bluetooth", "nfc", "wifi", "serial", "firmware"] + "enum": ["bluetooth", "nfc", "wifi", "ethernet", "serial", "firmware"] }, "uniqueItems": true }, @@ -1120,7 +1120,7 @@ "firmwareProgramming": { "type": "array", "items": { - "enum": ["serial", "fuota lorawan", "fuota other"] + "enum": ["serial", "ethernet", "fuota lorawan", "fuota other"] }, "uniqueItems": true }, @@ -1132,6 +1132,10 @@ "type": "string", "format": "uri" }, + "onboardingGuideURL": { + "type": "string", + "format": "uri" + }, "resellerURLs": { "type": "array", "items": { diff --git a/vendor/browan/tbms100.yaml b/vendor/browan/tbms100.yaml index 0c7168b6f1..e9b034fa07 100644 --- a/vendor/browan/tbms100.yaml +++ b/vendor/browan/tbms100.yaml @@ -45,6 +45,9 @@ operatingConditions: ipCode: IP50 productURL: http://www.browan.com/product/motion-sensor-pir/detail +# Link to simple, easy onboarding instructions for the device. +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/browan-tbms100/ photos: main: tbms100.png diff --git a/vendor/dragino/lht52.yaml b/vendor/dragino/lht52.yaml index 02717a1478..0592644bff 100644 --- a/vendor/dragino/lht52.yaml +++ b/vendor/dragino/lht52.yaml @@ -102,6 +102,10 @@ sensors: # Product and data sheet URLs (optional) productURL: https://www.dragino.com/products/temperature-humidity-sensor/item/199-lht52.html dataSheetURL: https://www.dragino.com/products/temperature-humidity-sensor/item/199-lht52.html +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/dragino-lht52/ + sellerURLs: - name: 'Dragino' region: diff --git a/vendor/elsys/ers-lite.yaml b/vendor/elsys/ers-lite.yaml index 8b31eabf80..c3e72b8147 100644 --- a/vendor/elsys/ers-lite.yaml +++ b/vendor/elsys/ers-lite.yaml @@ -95,6 +95,9 @@ operatingConditions: # Product and data sheet URLs (optional) productURL: https://www.elsys.se/en/ers-lite/ dataSheetURL: https://elsys.se/public/datasheets/ERS_Lite_datasheet.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/elsys-ers-lite/ # Photos photos: diff --git a/vendor/example/windsensor.yaml b/vendor/example/windsensor.yaml index e163faf335..7925cb0791 100644 --- a/vendor/example/windsensor.yaml +++ b/vendor/example/windsensor.yaml @@ -80,7 +80,7 @@ additionalRadios: - cellular # Bridge interfaces (optional) -# Valid values are: modbus, m-bus, can bus, rs-485, sdi-12, analog. +# Valid values are: modbus, m-bus, can bus, rs-485, sdi-12, analog, ethernet. bridgeInterfaces: - m-bus - rs-485 @@ -121,7 +121,7 @@ keyProvisioning: - join server # Key programming (optional) -# Valid values are: bluetooth, nfc, wifi, serial (when the user has a serial interface to set the keys) +# Valid values are: bluetooth, nfc, wifi, ethernet (via a webpage), serial (when the user has a serial interface to set the keys) # and firmware (when the user should change the firmware to set the keys). keyProgramming: - serial @@ -132,7 +132,7 @@ keyProgramming: keySecurity: none # Firmware programming (optional) -# Valid values are: serial (when the user has a serial interface to update the firmware), fuota lorawan (when the device +# Valid values are: serial (when the user has a serial interface to update the firmware), ethernet, fuota lorawan (when the device # supports LoRaWAN FUOTA via standard interfaces) and fuota other (other wireless update mechanism). firmwareProgramming: - serial @@ -141,11 +141,15 @@ firmwareProgramming: # Product and data sheet URLs (optional) productURL: https://example.org/wind-sensor dataSheetURL: https://example.org/wind-sensor/datasheet.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/windsensor # Commercial information resellerURLs: - name: 'Reseller 1' - region: + region: # valid regions are: Argentina, Australia, Brazil, Canada, China, European Union, India, Indonesia. + # Japan, Mexico, Russia, Saudi Arabia, South Africa, South Korea, Turkey, United States, Other - European Union url: https://example.org/reseller1 - name: 'Reseller 2' diff --git a/vendor/milesight-iot/em300-th.yaml b/vendor/milesight-iot/em300-th.yaml index e946ece4d3..c28a27bbdd 100644 --- a/vendor/milesight-iot/em300-th.yaml +++ b/vendor/milesight-iot/em300-th.yaml @@ -68,6 +68,9 @@ keyProvisioning: keySecurity: none productURL: https://www.milesight-iot.com/lorawan/sensor/em300-th/ dataSheetURL: https://resource.milesight-iot.com/milesight/document/em300-th-datasheet-en.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/milesight-em300-th/ resellerURLs: - name: 'iot.sales@milesight.com' region: diff --git a/vendor/moko/lw001-bgpro.yaml b/vendor/moko/lw001-bgpro.yaml index e6be89ebac..e22957d8af 100644 --- a/vendor/moko/lw001-bgpro.yaml +++ b/vendor/moko/lw001-bgpro.yaml @@ -156,6 +156,9 @@ firmwareProgramming: # Product and data sheet URLs (optional) productURL: https://www.mokosmart.co/lorawan-tracker-lw001-bg-pro/ dataSheetURL: https://www.dropbox.com/s/o11fg58vcgn47kc/LW001-BG%20PRO%20Specification%20V1.1-.pdf?dl=0 +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/lw001-bg-pro/ # Photos photos: diff --git a/vendor/sensative/strips.yaml b/vendor/sensative/strips.yaml index 38fdb494e6..50334e9dc6 100644 --- a/vendor/sensative/strips.yaml +++ b/vendor/sensative/strips.yaml @@ -40,3 +40,6 @@ photos: # Product and data sheet URLs (optional) productURL: https://sensative.com/sensors/strips-lorawan-sensors/ dataSheetURL: https://sensative.com/sensors/strips-brochure-2021-lineup/ +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/sensative-strips/ diff --git a/vendor/sensecap/sensecaps2100-data-logger.yaml b/vendor/sensecap/sensecaps2100-data-logger.yaml index e898308909..b8f1a53918 100644 --- a/vendor/sensecap/sensecaps2100-data-logger.yaml +++ b/vendor/sensecap/sensecaps2100-data-logger.yaml @@ -91,6 +91,9 @@ keySecurity: none # Product and data sheet URLs (optional) productURL: https://www.seeedstudio.com/SenseCAP-S2100-LoRaWAN-Data-Logger-p-5361.html dataSheetURL: https://files.seeedstudio.com/products/114992867/SenseCAP%20S210X%20LoRaWAN%20Sensor%20Catalogue.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/seeed-s210x/ # Commercial information resellerURLs: diff --git a/vendor/sensecap/sensecaps2101-temp-humid.yaml b/vendor/sensecap/sensecaps2101-temp-humid.yaml index bddc67a91a..90b0228ca7 100644 --- a/vendor/sensecap/sensecaps2101-temp-humid.yaml +++ b/vendor/sensecap/sensecaps2101-temp-humid.yaml @@ -103,6 +103,9 @@ keySecurity: none # Product and data sheet URLs (optional) productURL: https://www.seeedstudio.com/SenseCAP-S2101-LoRaWAN-Air-Temperature-and-Humidity-Sensor-p-5354.html dataSheetURL: https://files.seeedstudio.com/products/114992867/SenseCAP%20S210X%20LoRaWAN%20Sensor%20Catalogue.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/seeed-s210x/ # Commercial information resellerURLs: diff --git a/vendor/sensecap/sensecaps2102-light.yaml b/vendor/sensecap/sensecaps2102-light.yaml index 47e9bed194..f461f21217 100644 --- a/vendor/sensecap/sensecaps2102-light.yaml +++ b/vendor/sensecap/sensecaps2102-light.yaml @@ -102,6 +102,9 @@ keySecurity: none # Product and data sheet URLs (optional) productURL: https://www.seeedstudio.com/SenseCAP-S2102-LoRaWAN-Light-Intensity-Sensor-p-5355.html dataSheetURL: https://files.seeedstudio.com/products/114992867/SenseCAP%20S210X%20LoRaWAN%20Sensor%20Catalogue.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/seeed-s210x/ # Commercial information resellerURLs: diff --git a/vendor/sensecap/sensecaps2103-co2-temp-humid.yaml b/vendor/sensecap/sensecaps2103-co2-temp-humid.yaml index 120c21f286..48fa31daff 100644 --- a/vendor/sensecap/sensecaps2103-co2-temp-humid.yaml +++ b/vendor/sensecap/sensecaps2103-co2-temp-humid.yaml @@ -105,6 +105,9 @@ keySecurity: none # Product and data sheet URLs (optional) productURL: https://www.seeedstudio.com/SenseCAP-S2103-LoRaWAN-CO2-Temperature-and-Humidity-Sensor-p-5356.html dataSheetURL: https://files.seeedstudio.com/products/114992867/SenseCAP%20S210X%20LoRaWAN%20Sensor%20Catalogue.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/seeed-s210x/ # Commercial information resellerURLs: diff --git a/vendor/sensecap/sensecaps2104-soil-moisture-temp.yaml b/vendor/sensecap/sensecaps2104-soil-moisture-temp.yaml index aeb83b8523..76fe2a3c17 100644 --- a/vendor/sensecap/sensecaps2104-soil-moisture-temp.yaml +++ b/vendor/sensecap/sensecaps2104-soil-moisture-temp.yaml @@ -103,6 +103,9 @@ keySecurity: none # Product and data sheet URLs (optional) productURL: https://www.seeedstudio.com/SenseCAP-S2104-LoRaWAN-Soil-Temperature-and-Moisture-Sensor-p-5357.html dataSheetURL: https://files.seeedstudio.com/products/114992867/SenseCAP%20S210X%20LoRaWAN%20Sensor%20Catalogue.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/seeed-s210x/ # Commercial information resellerURLs: diff --git a/vendor/sensecap/sensecaps2105-soll-moisture-temp-ec.yaml b/vendor/sensecap/sensecaps2105-soll-moisture-temp-ec.yaml index 4ad18f37cb..ea5f01831f 100644 --- a/vendor/sensecap/sensecaps2105-soll-moisture-temp-ec.yaml +++ b/vendor/sensecap/sensecaps2105-soll-moisture-temp-ec.yaml @@ -103,6 +103,9 @@ keySecurity: none # Product and data sheet URLs (optional) productURL: https://www.seeedstudio.com/SenseCAP-S2105-LoRaWAN-Soil-Temperature-Moisture-and-EC-Sensor-p-5358.html dataSheetURL: https://files.seeedstudio.com/products/114992867/SenseCAP%20S210X%20LoRaWAN%20Sensor%20Catalogue.pdf +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/seeed-s210x/ # Commercial information resellerURLs: diff --git a/vendor/the-things-industries/generic-node-sensor-edition.yaml b/vendor/the-things-industries/generic-node-sensor-edition.yaml index 18b356f9b0..b91e3a4c51 100644 --- a/vendor/the-things-industries/generic-node-sensor-edition.yaml +++ b/vendor/the-things-industries/generic-node-sensor-edition.yaml @@ -1,7 +1,9 @@ name: Generic Node (Sensor Edition) description: The Things Industries Generic Node Sensor Edition is a LoRaWAN® development board that consists of a temperature and humidity sensor and an accelerometer. These onboard sensors can be used to measure temperature, humidity, motion, free fall, and orientation. In addition to that, it provides expansion slots for connecting various sensors. It is suitable for a wide range of use cases that cover industrial, farming, facility management, and leisure. + hardwareVersions: - version: '1.1' + firmwareVersions: - version: '1.0' hardwareVersions: @@ -15,17 +17,29 @@ firmwareVersions: id: generic-node-sensor-edition-915 lorawanCertified: false codec: generic-node-sensor-edition-codec + sensors: - accelerometer - battery - button - humidity - temperature + battery: replaceable: true type: 2x AA + keyProvisioning: - custom + keySecurity: read protected + +# Product and data sheet URLs (optional) +productURL: https://www.genericnode.com/ +dataSheetURL: https://github.com/TheThingsIndustries/generic-node-se +# Link to simple, easy onboarding instructions for the device (optional). +# Please do not use this for marketing or overly technical documents like a data sheet. +onboardingGuideURL: https://www.thethingsindustries.com/docs/devices/models/generic-node-se/ + photos: main: gnse.png