iobroker.zwavews 0.0.3

package/admin/jsonConfig.json

@@ -0,0 +1,347 @@
+{
+  "i18n": true,
+  "type": "tabs",
+  "tabsStyle": {
+    "width": "calc(100% - 100px)"
+  },
+  "items": {
+    "_tab_Start": {
+      "type": "panel",
+      "label": "Main Settings",
+      "items": {
+        "header_Start": {
+            "type": "header",
+            "text": "zwavews adapter settings",
+            "size": 2
+        },
+        "_textStart": {
+            "type": "staticText",
+            "text": "A detailed documentation with explanations and all further information can be found on this GitHub page",
+            "xs": 12,
+            "sm": 12,
+            "md": 6,
+            "lg": 4,
+            "xl": 4,
+            "style": {
+                "fontSize": 14,
+                "marginTop": 0
+            }
+        },
+        "_documentationLink": {
+            "type": "staticLink",
+            "label": "click for Documentation",
+            "button": true,
+            "href": "https://github.com/arteck/ioBroker.zwavews/blob/main/README.md",
+            "xs": 12,
+            "sm": 12,
+            "md": 6,
+            "lg": 4,
+            "xl": 4,
+            "style": {
+                "fontSize": 18,
+                "marginTop": 0
+            }
+        },
+        "connectionHeader": {
+          "type": "header",
+          "text": "Select and configure your zwavews connection",
+          "size": 2,
+          "newLine": true
+        },
+        "connectionType": {
+          "label": "Select connection to zwavews",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "type": "select",
+          "options": [
+          {
+              "label": "Websocket",
+              "value": "ws"
+            }
+          ],
+          "newLine": true
+        },
+        "baseTopic": {
+          "type": "text",
+          "label": "Base MQTT topic",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "default": "zwave",          
+          "hidden": "data.connectionType != 'exmqtt'"
+        },
+        "spacer01": {
+          "type": "staticText",
+          "text": "",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": true
+        },
+        "wsScheme": {
+          "type": "select",
+          "label": "Scheme",
+          "options": [
+            {
+              "label": "WS",
+              "value": "ws"
+            },
+            {
+              "label": "WSS (SSL)",
+              "value": "wss"
+            }
+          ],
+          "newLine": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.connectionType != 'ws'"
+        },
+        "wsServerIP": {
+          "type": "text",
+          "label": "Websocket IP-Address",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": false,
+          "hidden": "data.connectionType != 'ws'"
+        },
+        "wsServerPort": {
+          "type": "number",
+          "label": "Websocket Port",
+          "newLine": false,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.connectionType != 'ws'"
+        },
+        "wsTokenEnabled": {
+          "type": "checkbox",
+          "label": "Use Auth-Token",
+          "newLine": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.connectionType != 'ws'"
+        },
+        "wsToken": {
+          "type": "password",
+          "label": "Auth-Token (special characters are not supported)",
+          "newLine": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 5,
+          "xl": 4,
+          "hidden": "data.wsTokenEnabled != true || data.connectionType != 'ws'"
+        },
+        "dummyMqtt": {
+          "type": "checkbox",
+          "label": "Create a dummy MQTT-Server for Zigbee2MQTT",
+          "newLine": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.connectionType != 'ws'"
+        },
+        
+        "externalMqttServerIP": {
+          "type": "text",
+          "label": "External MQTT-Server IP-Address",
+          "newLine": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.connectionType != 'exmqtt'"
+        },
+        "externalMqttServerPort": {
+          "type": "number",
+          "label": "External MQTT-Server Port",
+          "newLine": false,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.connectionType != 'exmqtt'"
+        },
+        "externalMqttServerCredentials": {
+          "type": "checkbox",
+          "label": "Use MQTT Credentials",
+          "newLine": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.connectionType != 'exmqtt'"
+        },
+        "externalMqttServerUsername": {
+          "type": "text",
+          "label": "MQTT Username",
+          "newLine": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "hidden": "data.externalMqttServerCredentials != true ||data.connectionType != 'exmqtt'"
+        },
+        "externalMqttServerPassword": {
+          "type": "password",
+          "label": "MQTT Password",
+          "newLine": false,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "visible": true,
+          "hidden": "data.externalMqttServerCredentials != true ||data.connectionType != 'exmqtt'"
+        },
+        "mqttServerIPBind": {
+          "type": "ip",
+          "label": "MQTT-Server IP-Address bind",
+          "listenOnAllPorts": true,
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": true,
+          "hidden": "data.connectionType == 'exmqtt' || data.dummyMqtt == false && data.connectionType == 'ws'"
+        },
+        "mqttServerPort": {
+          "type": "number",
+          "label": "MQTT-Server Port",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": false,
+          "hidden": "data.connectionType == 'exmqtt' || data.dummyMqtt == false && data.connectionType == 'ws'"
+        },
+        "spacer02": {
+          "type": "staticText",
+          "text": "",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": true,
+          "hidden": "data.connectionType == 'ws'"
+        },
+        "webUIHeader": {
+          "type": "header",
+          "text": "Configure your zwavews WebUi connection",
+          "size": 2,
+          "newLine": true
+        },
+        "webUIScheme": {
+          "type": "select",
+          "label": "Scheme",
+          "options": [
+            {
+              "label": "HTTP",
+              "value": "http"
+            },
+            {
+              "label": "HTTPS",
+              "value": "https"
+            }
+          ],
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": true
+        },
+        "webUIServer": {
+          "type": "text",
+          "label": "WebUi Address",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": false
+        },
+        "webUIPort": {
+          "type": "number",
+          "label": "WebUi Port",
+          "xs": 12,
+          "sm": 12,
+          "md": 6,
+          "lg": 4,
+          "xl": 4,
+          "newLine": false
+        }
+      }
+    },
+    "_tab_Other Settings": {
+      "type": "panel",
+      "label": "Other configurations",
+      "items": {
+        "showNodeInfoMessage": {
+          "type": "checkbox",
+          "label": "Show Node Info messages to ioBroker log",
+          "xs": 12,
+          "sm": 12,
+          "md": 12,
+          "lg": 12,
+          "xl": 12,
+          "newLine": true
+        },
+         "useEventInDesc": {
+          "type": "checkbox",
+          "label": "The events such as 'Device removed' or 'Disabled' are displayed in the description instead of in the name",
+          "xs": 12,
+          "sm": 12,
+          "md": 12,
+          "lg": 12,
+          "xl": 12
+        },
+        "wakeUpInfo": {
+          "type": "checkbox",
+          "label": "Inform about wake up and sleep of battery devices in the log",
+          "xs": 12,
+          "sm": 12,
+          "md": 12,
+          "lg": 12,
+          "xl": 12
+        },
+        "newTypeEvent": {
+          "type": "checkbox",
+          "label": "new Type event Warning in log",
+          "xs": 12,
+          "sm": 12,
+          "md": 12,
+          "lg": 12,
+          "xl": 12
+        }
+      }
+    }
+  }
+}

package/io-package.json

@@ -0,0 +1,246 @@
+{
+  "common": {
+    "name": "zwavews",
+    "version": "0.0.3",
+    "news": {
+      "0.0.3": {
+        "en": "fix title",
+        "de": "bersetzung titel",
+        "ru": "исправить название",
+        "pt": "corrigir título",
+        "nl": "titel herstellen",
+        "fr": "fixer le titre",
+        "it": "titolo di correzione",
+        "es": "fijar título",
+        "pl": "ustaw tytuł",
+        "uk": "заголовок",
+        "zh-cn": "固定标题"
+      },
+      "0.0.2": {
+        "en": "first release",
+        "de": "erste veröffentlichung",
+        "ru": "первый выпуск",
+        "pt": "primeira versão",
+        "nl": "eerste release",
+        "fr": "première sortie",
+        "it": "primo rilascio",
+        "es": "primera liberación",
+        "pl": "pierwsze wydanie",
+        "uk": "перший реліз",
+        "zh-cn": "第一次发布"
+      },
+      "0.0.1": {
+        "en": "init",
+        "de": "init",
+        "ru": "инициализация",
+        "pt": "inicialização",
+        "nl": "init",
+        "fr": "initialisation",
+        "it": "inizializzazione",
+        "es": "inicialización",
+        "pl": "init",
+        "uk": "ініціалізація",
+        "zh-cn": "初始化"
+      }
+    },
+    "messages": [],
+    "titleLang": {
+      "en": "zwavews",
+      "de": "zwavews",
+      "ru": "zwavews",
+      "pt": "zwavews",
+      "nl": "zwavews",
+      "fr": "zwavews",
+      "it": "zwavews",
+      "es": "zwavews",
+      "pl": "zwavews",
+      "zh-cn": "zwavews",
+      "uk": "zwavews"
+    },
+    "desc": {
+      "en": "zwavews adapter for ioBroker",
+      "de": "zwavews-Adapter für ioBroker",
+      "ru": "Адаптер zwavews для ioBroker",
+      "pt": "Adaptador zwavews para ioBroker",
+      "nl": "zwavews-adapter voor ioBroker",
+      "fr": "Adaptateur zwavews pour ioBroker",
+      "it": "Adattatore zwavews per ioBroker",
+      "es": "Adaptador zwavews para ioBroker",
+      "pl": "Adapter zwavews do ioBroker",
+      "zh-cn": "用于 ioBroker 的 zwavews 适配器",
+      "uk": "Адаптер zwavews для ioBroker"
+    },
+    "authors": [
+      "arteck <arteck@outlook.com>"
+    ],
+    "keywords": [
+      "zwave",
+      "zwavews",
+      "zwave-js-ui",
+      "zwave-js"
+    ],
+    "licenseInformation": {
+      "license": "MIT",
+      "type": "free"
+    },
+    "platform": "Javascript/Node.js",
+    "icon": "zwavews.png",
+    "enabled": false,
+    "extIcon": "https://raw.githubusercontent.com/arteck/ioBroker.zwavews/main/admin/zwavews.png",
+    "readme": "https://github.com/arteck/ioBroker.zwavews/blob/main/README.md",
+    "loglevel": "info",
+    "mode": "daemon",
+    "type": "hardware",
+    "compact": true,
+    "supportedMessages": {
+      "deviceManager": true
+    },
+    "stopTimeout": 2000,
+    "tier": 2,
+    "connectionType": "local",
+    "dataSource": "push",
+    "adminUI": {
+      "config": "json"
+    },
+    "adminTab": {
+      "name": {
+        "en": "zwavews",
+        "de": "zwavews",
+        "ru": "zwavews",
+        "pt": "zwavews",
+        "nl": "zwavews",
+        "fr": "zwavews",
+        "it": "zwavews",
+        "es": "zwavews",
+        "pl": "zwavews",
+        "zh-cn": "zwavews"
+      },
+      "link": "%webUIScheme%://%webUIServer%:%webUIPort%",
+      "fa-icon": "</i><img style='width:24px;margin-bottom:-6px;' src='/adapter/zwavews/zwavews.png'><i>"
+    },
+    "localLinks": {
+      "_default": {
+        "link": "%webUIScheme%://%webUIServer%:%webUIPort%"
+      }
+    },
+    "dependencies": [
+      {
+        "js-controller": ">=6.0.11"
+      }
+    ],
+    "globalDependencies": [
+      {
+        "admin": ">=7.4.10"
+      }
+    ]
+  },
+  "native": {
+    "connectionType": "ws",
+    "wsScheme": "ws",
+    "wsServerIP": "",
+    "wsServerPort": 3000,
+    "wsTokenEnabled": false,
+    "wsToken": "",
+    "dummyMqtt": false,
+    "baseTopic": "zwave",
+    "externalMqttServerIP": "",
+    "externalMqttServerPort": 1883,
+    "externalMqttServerCredentials": false,
+    "externalMqttServerUsername": "",
+    "externalMqttServerPassword": "",
+    "mqttServerIPBind": "0.0.0.0",
+    "mqttServerPort": 1885,
+    "webUIScheme": "http",
+    "webUIServer": "",
+    "webUIPort": 8091,
+    "showNodeInfoMessages": true,
+    "renewNodeInfo": true,
+    "useEventInDesc": false,
+    "wakeUpInfo": false,
+    "newTypeEvent": true
+  },
+  "protectedNative": [
+    "externalMqttServerPassword",
+    "wsToken"
+  ],
+  "encryptedNative": [
+    "externalMqttServerPassword",
+    "wsToken"
+  ],
+  "objects": [],
+  "instanceObjects": [
+    {
+      "_id": "info",
+      "type": "channel",
+      "common": {
+        "name": "Information"
+      },
+      "native": {}
+    },
+    {
+      "_id": "info.connection",
+      "type": "state",
+      "common": {
+        "role": "indicator.connected",
+        "name": "zwavews connected",
+        "type": "boolean",
+        "read": true,
+        "write": false,
+        "def": false
+      },
+      "native": {}
+    },
+    {
+      "_id": "info.zwave_gateway_status",
+      "type": "state",
+      "common": {
+        "name": "ZWAVE GATEWAY Status",
+        "type": "string",
+        "role": "indicator.connected",
+        "read": true,
+        "write": false,
+        "def": ""
+      },
+      "native": {}
+    },
+    {
+      "_id": "info.zwave_gateway_version",
+      "type": "state",
+      "common": {
+        "name": "ZWAVE GATEWAY Version",
+        "type": "string",
+        "role": "state",
+        "read": true,
+        "write": false,
+        "def": ""
+      },
+      "native": {}
+    },
+    {
+      "_id": "info.debugId",
+      "type": "state",
+      "common": {
+        "name": "Log changes for xxx",
+        "type": "string",
+        "role": "state",
+        "read": true,
+        "write": true,
+        "def": ""
+      },
+      "native": {}
+    },
+    {
+      "_id": "info.debugmessages",
+      "type": "state",
+      "common": {
+        "name": "Log changes for debugId",
+        "type": "string",
+        "role": "state",
+        "read": true,
+        "write": true,
+        "def": ""
+      },
+      "native": {}
+    }
+  ]
+}

package/lib/adapter-config.d.ts

@@ -0,0 +1,19 @@
+// This file extends the AdapterConfig type from "@types/iobroker"
+// using the actual properties present in io-package.json
+// in order to provide typings for adapter.config properties
+
+import { native } from '../io-package.json';
+
+type _AdapterConfig = typeof native;
+
+// Augment the globally declared type ioBroker.AdapterConfig
+declare global {
+	namespace ioBroker {
+		interface AdapterConfig extends _AdapterConfig {
+			// Do not enter anything here!
+		}
+	}
+}
+
+// this is required so the above AdapterConfig is found by TypeScript / type checking
+export {};

package/lib/constants.js

@@ -0,0 +1,25 @@
+ 
+'use strict';
+
+const timeKey = [
+      "lastActive",
+      "lastUpdate"
+    ];
+const noInfoDP = [
+      "eventsQueue",
+      "rfRegions",
+      "Scene Actuator Configuration",
+      "dimmingDuration",
+    ];
+const mixedType  = [
+       "status",
+        "interviewStage"
+    ];
+const RGB = ["Red", "Green", "Blue"];
+
+module.exports = {
+    timeKey,
+    noInfoDP,
+    mixedType,
+    RGB
+};