iobroker.sonoff 2.5.1 → 2.5.3

package/lib/tools.js

@@ -1,99 +1,99 @@
-const axios = require('axios').default;
-
-/**
- * Tests whether the given variable is a real object and not an Array
- * @param {any} it The variable to test
- * @returns {it is Record<string, any>}
- */
-function isObject(it) {
-    // This is necessary because:
-    // typeof null === 'object'
-    // typeof [] === 'object'
-    // [] instanceof Object === true
-    return Object.prototype.toString.call(it) === '[object Object]';
-}
-
-/**
- * Tests whether the given variable is really an Array
- * @param {any} it The variable to test
- * @returns {it is any[]}
- */
-function isArray(it) {
-    if (typeof Array.isArray === 'function') return Array.isArray(it);
-    return Object.prototype.toString.call(it) === '[object Array]';
-}
-
-/**
- * Translates text to the target language. Automatically chooses the right translation API.
- * @param {string} text The text to translate
- * @param {string} targetLang The target languate
- * @param {string} [yandexApiKey] The yandex API key. You can create one for free at https://translate.yandex.com/developers
- * @returns {Promise<string>}
- */
-async function translateText(text, targetLang, yandexApiKey) {
-    if (targetLang === 'en') {
-        return text;
-    } else if (!text) {
-        return '';
-    }
-    if (yandexApiKey) {
-        return translateYandex(text, targetLang, yandexApiKey);
-    } else {
-        return translateGoogle(text, targetLang);
-    }
-}
-
-/**
- * Translates text with Yandex API
- * @param {string} text The text to translate
- * @param {string} targetLang The target languate
- * @param {string} apiKey The yandex API key. You can create one for free at https://translate.yandex.com/developers
- * @returns {Promise<string>}
- */
-async function translateYandex(text, targetLang, apiKey) {
-    if (targetLang === 'zh-cn') {
-        targetLang = 'zh';
-    }
-    try {
-        const url = `https://translate.yandex.net/api/v1.5/tr.json/translate?key=${apiKey}&text=${encodeURIComponent(text)}&lang=en-${targetLang}`;
-        const response = await axios({url, timeout: 15000});
-        if (response.data && response.data.text && isArray(response.data.text)) {
-            return response.data.text[0];
-        }
-        throw new Error('Invalid response for translate request');
-    } catch (e) {
-        throw new Error(`Could not translate to "${targetLang}": ${e}`);
-    }
-}
-
-/**
- * Translates text with Google API
- * @param {string} text The text to translate
- * @param {string} targetLang The target languate
- * @returns {Promise<string>}
- */
-async function translateGoogle(text, targetLang) {
-    try {
-        const url = `http://translate.googleapis.com/translate_a/single?client=gtx&sl=en&tl=${targetLang}&dt=t&q=${encodeURIComponent(text)}&ie=UTF-8&oe=UTF-8`;
-        const response = await axios({url, timeout: 15000});
-        if (isArray(response.data)) {
-            // we got a valid response
-            return response.data[0][0][0];
-        }
-        throw new Error('Invalid response for translate request');
-    } catch (e) {
-        if (e.response && e.response.status === 429) {
-            throw new Error(
-                `Could not translate to "${targetLang}": Rate-limited by Google Translate`
-            );
-        } else {
-            throw new Error(`Could not translate to "${targetLang}": ${e}`);
-        }
-    }
-}
-
-module.exports = {
-    isArray,
-    isObject,
-    translateText
-};
+const axios = require('axios').default;
+
+/**
+ * Tests whether the given variable is a real object and not an Array
+ * @param {any} it The variable to test
+ * @returns {it is Record<string, any>}
+ */
+function isObject(it) {
+    // This is necessary because:
+    // typeof null === 'object'
+    // typeof [] === 'object'
+    // [] instanceof Object === true
+    return Object.prototype.toString.call(it) === '[object Object]';
+}
+
+/**
+ * Tests whether the given variable is really an Array
+ * @param {any} it The variable to test
+ * @returns {it is any[]}
+ */
+function isArray(it) {
+    if (typeof Array.isArray === 'function') return Array.isArray(it);
+    return Object.prototype.toString.call(it) === '[object Array]';
+}
+
+/**
+ * Translates text to the target language. Automatically chooses the right translation API.
+ * @param {string} text The text to translate
+ * @param {string} targetLang The target languate
+ * @param {string} [yandexApiKey] The yandex API key. You can create one for free at https://translate.yandex.com/developers
+ * @returns {Promise<string>}
+ */
+async function translateText(text, targetLang, yandexApiKey) {
+    if (targetLang === 'en') {
+        return text;
+    } else if (!text) {
+        return '';
+    }
+    if (yandexApiKey) {
+        return translateYandex(text, targetLang, yandexApiKey);
+    } else {
+        return translateGoogle(text, targetLang);
+    }
+}
+
+/**
+ * Translates text with Yandex API
+ * @param {string} text The text to translate
+ * @param {string} targetLang The target languate
+ * @param {string} apiKey The yandex API key. You can create one for free at https://translate.yandex.com/developers
+ * @returns {Promise<string>}
+ */
+async function translateYandex(text, targetLang, apiKey) {
+    if (targetLang === 'zh-cn') {
+        targetLang = 'zh';
+    }
+    try {
+        const url = `https://translate.yandex.net/api/v1.5/tr.json/translate?key=${apiKey}&text=${encodeURIComponent(text)}&lang=en-${targetLang}`;
+        const response = await axios({url, timeout: 15000});
+        if (response.data && response.data.text && isArray(response.data.text)) {
+            return response.data.text[0];
+        }
+        throw new Error('Invalid response for translate request');
+    } catch (e) {
+        throw new Error(`Could not translate to "${targetLang}": ${e}`);
+    }
+}
+
+/**
+ * Translates text with Google API
+ * @param {string} text The text to translate
+ * @param {string} targetLang The target languate
+ * @returns {Promise<string>}
+ */
+async function translateGoogle(text, targetLang) {
+    try {
+        const url = `http://translate.googleapis.com/translate_a/single?client=gtx&sl=en&tl=${targetLang}&dt=t&q=${encodeURIComponent(text)}&ie=UTF-8&oe=UTF-8`;
+        const response = await axios({url, timeout: 15000});
+        if (isArray(response.data)) {
+            // we got a valid response
+            return response.data[0][0][0];
+        }
+        throw new Error('Invalid response for translate request');
+    } catch (e) {
+        if (e.response && e.response.status === 429) {
+            throw new Error(
+                `Could not translate to "${targetLang}": Rate-limited by Google Translate`
+            );
+        } else {
+            throw new Error(`Could not translate to "${targetLang}": ${e}`);
+        }
+    }
+}
+
+module.exports = {
+    isArray,
+    isObject,
+    translateText
+};

package/main.js

@@ -1,93 +1,93 @@
-/* jshint -W097 */
-/* jshint strict:true */
-/* jslint node: true */
-/* jslint esversion: 6 */
-
-/**
- *
- *      ioBroker sonoff Adapter
- *
- *      (c) 2017-2021 bluefox
- *
- *      MIT License
- *
- */
-'use strict';
-
-const utils       = require('@iobroker/adapter-core'); // Get common adapter utils
-const adapterName = require('./package.json').name.split('.').pop();
-const Server      = require('./lib/server');
-let   server      = null;
-let   adapter;
-
-function decrypt(key, value) {
-    let result = '';
-    for (let i = 0; i < value.length; ++i) {
-        result += String.fromCharCode(key[i % key.length].charCodeAt(0) ^ value.charCodeAt(i));
-    }
-    return result;
-}
-
-function startAdapter(options) {
-    options = options || {};
-    Object.assign(options, {name: adapterName});
-
-    adapter = new utils.Adapter(options);
-
-    adapter.on('ready', () => {
-        // it must be like this
-
-        adapter.getForeignObject('system.config', (err, obj) => {
-            if (obj && obj.native && obj.native.secret) {
-                //noinspection JSUnresolvedVariable
-                adapter.config.pass = decrypt(obj.native.secret, adapter.config.pass);
-            } else {
-                //noinspection JSUnresolvedVariable
-                adapter.config.pass = decrypt('Zgfr56gFe87jJOM', adapter.config.pass);
-            }
-            main();
-        });
-    });
-
-    adapter.on('unload', cb => {
-        if (server) {
-            server.destroy(cb);
-            server = null;
-        } else if (typeof cb === 'function') {
-            cb();
-        }
-    });
-
-    // is called if a subscribed state changes
-    adapter.on('stateChange', (id, state) => {
-        adapter.log.debug(`stateChange ${id}: ${JSON.stringify(state)}`);
-        // you can use the ack flag to detect if state is desired or acknowledged
-        state && !state.ack && server && server.onStateChange(id, state);
-    });
-    return adapter;
-}
-
-function main() {
-    adapter.config.TELE_SENSOR = adapter.config.TELE_SENSOR === true || adapter.config.TELE_SENSOR === 'true';
-    adapter.config.TELE_STATE  = adapter.config.TELE_STATE  === true || adapter.config.TELE_STATE  === 'true';
-    adapter.config.STAT_RESULT = adapter.config.STAT_RESULT === true || adapter.config.STAT_RESULT === 'true';
-    adapter.config.OBJ_TREE    = adapter.config.OBJ_TREE    === true || adapter.config.OBJ_TREE    === 'true';
-
-    // subscribe for all own variables
-    adapter.subscribeStates('*');
-
-    // read all states and set alive to false
-    adapter.getStatesOf('', '', (err, states) =>
-        states && states.length && states.forEach(state =>
-                state._id.match(/\.alive$/) && adapter.setForeignState(state._id, false, true)));
-
-    server = new Server(adapter);
-}
-
-// If started as allInOne/compact mode => return function to create instance
-if (module && module.parent) {
-    module.exports = startAdapter;
-} else {
-    // or start the instance directly
-    startAdapter();
-}
+/* jshint -W097 */
+/* jshint strict:true */
+/* jslint node: true */
+/* jslint esversion: 6 */
+
+/**
+ *
+ *      ioBroker sonoff Adapter
+ *
+ *      (c) 2017-2023 bluefox
+ *
+ *      MIT License
+ *
+ */
+'use strict';
+
+const utils       = require('@iobroker/adapter-core'); // Get common adapter utils
+const adapterName = require('./package.json').name.split('.').pop();
+const Server      = require('./lib/server');
+let   server      = null;
+let   adapter;
+
+function decrypt(key, value) {
+    let result = '';
+    for (let i = 0; i < value.length; ++i) {
+        result += String.fromCharCode(key[i % key.length].charCodeAt(0) ^ value.charCodeAt(i));
+    }
+    return result;
+}
+
+function startAdapter(options) {
+    options = options || {};
+    Object.assign(options, {name: adapterName});
+
+    adapter = new utils.Adapter(options);
+
+    adapter.on('ready', () => {
+        // it must be like this
+
+        adapter.getForeignObject('system.config', (err, obj) => {
+            if (obj && obj.native && obj.native.secret) {
+                //noinspection JSUnresolvedVariable
+                adapter.config.pass = decrypt(obj.native.secret, adapter.config.pass);
+            } else {
+                //noinspection JSUnresolvedVariable
+                adapter.config.pass = decrypt('Zgfr56gFe87jJOM', adapter.config.pass);
+            }
+            main();
+        });
+    });
+
+    adapter.on('unload', cb => {
+        if (server) {
+            server.destroy(cb);
+            server = null;
+        } else if (typeof cb === 'function') {
+            cb();
+        }
+    });
+
+    // is called if a subscribed state changes
+    adapter.on('stateChange', (id, state) => {
+        adapter.log.debug(`stateChange ${id}: ${JSON.stringify(state)}`);
+        // you can use the ack flag to detect if state is desired or acknowledged
+        state && !state.ack && server && server.onStateChange(id, state);
+    });
+    return adapter;
+}
+
+function main() {
+    adapter.config.TELE_SENSOR = adapter.config.TELE_SENSOR === true || adapter.config.TELE_SENSOR === 'true';
+    adapter.config.TELE_STATE  = adapter.config.TELE_STATE  === true || adapter.config.TELE_STATE  === 'true';
+    adapter.config.STAT_RESULT = adapter.config.STAT_RESULT === true || adapter.config.STAT_RESULT === 'true';
+    adapter.config.OBJ_TREE    = adapter.config.OBJ_TREE    === true || adapter.config.OBJ_TREE    === 'true';
+
+    // subscribe for all own variables
+    adapter.subscribeStates('*');
+
+    // read all states and set alive to false
+    adapter.getStatesOf('', '', (err, states) =>
+        states && states.length && states.forEach(state =>
+                state._id.match(/\.alive$/) && adapter.setForeignState(state._id, false, true)));
+
+    server = new Server(adapter);
+}
+
+// If started as allInOne/compact mode => return function to create instance
+if (module && module.parent) {
+    module.exports = startAdapter;
+} else {
+    // or start the instance directly
+    startAdapter();
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "iobroker.sonoff",
   "description": "The adapter allows to send and receive MQTT messages from ioBroker and to be a broker.",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "author": "bluefox <dogafox@gmail.com>",
   "homepage": "https://github.com/ioBroker/ioBroker.sonoff",
   "repository": {
@@ -17,25 +17,36 @@
   ],
   "dependencies": {
     "mqtt-connection": "^4.1.0",
-    "@iobroker/adapter-core": "^2.6.0"
+    "@iobroker/adapter-core": "^2.6.8"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.5.6",
-    "@alcalzone/release-script-plugin-iobroker": "^3.5.7",
-    "@alcalzone/release-script-plugin-license": "^3.5.3",
-    "axios": "^0.26.1",
+    "@alcalzone/release-script": "^3.5.9",
+    "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
+    "@alcalzone/release-script-plugin-license": "^3.5.9",
+    "@iobroker/legacy-testing": "^0.1.1",
+    "axios": "^1.3.4",
     "mqtt": "^4.3.7",
     "gulp": "^4.0.2",
-    "mocha": "^9.2.2",
-    "chai": "^4.3.6"
+    "mocha": "^10.2.0",
+    "chai": "^4.3.7"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.sonoff/issues"
   },
   "main": "main.js",
+  "files": [
+    "main.js",
+    "admin/",
+    "lib/",
+    "io-package.json",
+    "LICENSE"
+  ],
   "scripts": {
     "test": "node node_modules/mocha/bin/mocha --exit",
-    "release": "release-script"
+    "release": "release-script",
+    "release-patch": "release-script patch --yes",
+    "release-minor": "release-script minor --yes",
+    "release-major": "release-script major --yes"
   },
   "engines": {
     "node": ">=4.0.0"

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,37 +0,0 @@
----
-name: Bug report
-about: Something is not working as it should
-title: ''
-labels: ''
-assignees: ''
----
-
-**Check if the Bug maybe is with Amazon**  
-The adapter is using the same API as the Alexa mobile App. This means:
-* If you can not do this what you want with the App then the Adapter also can not do it!
-* Also if the App can do it please test if the same effect then the bug also happens with the App (e.g. a speak command do not work on a certain device ... can you do a speak via Alexa App? If not - Amazon problem!)
-
-**Describe the bug**  
-A clear and concise description of what the bug is. Especially describe what you verified using the Alexa App (see above).
-
-**To Reproduce**  
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '...'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**  
-A clear and concise description of what you expected to happen.
-
-**Screenshots & Logfiles**  
-If applicable, add screenshots and logfiles to help explain your problem.
-
-**Versions:**  
- - Adapter version: <adapter-version>
- - JS-Controller version: <js-controller-version> <!-- determine this with `iobroker -v` on the console -->
- - Node version: <node-version> <!-- determine this with `node -v` on the console -->
- - Operating system: <os-name>
-
-**Additional context**  
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,24 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-**Consider the Reality**  
-The adapter is using the same API as the Alexa mobile App. This means:
-
-If you can not do this what you want with the App then the Adapter also can not do it! Also a feature rewuest most likely will not be possible.
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/auto-merge.yml

@@ -1,17 +0,0 @@
-# Configure here which dependency updates should be merged automatically.
-# The recommended configuration is the following:
-- match:
-      # Only merge patches for production dependencies
-      dependency_type: production
-      update_type: "semver:patch"
-- match:
-      # Except for security fixes, here we allow minor patches
-      dependency_type: production
-      update_type: "security:minor"
-- match:
-      # and development dependencies can have a minor update, too
-      dependency_type: development
-      update_type: "semver:minor"
-
-# The syntax is based on the legacy dependabot v1 automerged_updates syntax, see:
-# https://dependabot.com/docs/config-file/#automerged_updates

package/.github/dependabot.yml

@@ -1,16 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: github-actions
-    directory: "/"
-    schedule:
-      interval: monthly
-      time: "04:00"
-      timezone: Europe/Berlin
-  - package-ecosystem: npm
-    directory: "/"
-    schedule:
-      interval: monthly
-      time: "04:00"
-      timezone: Europe/Berlin
-    open-pull-requests-limit: 20
-    versioning-strategy: increase

package/.github/stale.yml

@@ -1,78 +0,0 @@
-# Configuration for probot-stale - https://github.com/probot/stale
-
-# Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 90
-
-# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
-# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
-daysUntilClose: 7
-
-# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
-onlyLabels: []
-
-# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
-exemptLabels:
-  - enhancement
-  - security
-
-# Set to true to ignore issues in a project (defaults to false)
-exemptProjects: true
-
-# Set to true to ignore issues in a milestone (defaults to false)
-exemptMilestones: true
-
-# Set to true to ignore issues with an assignee (defaults to false)
-exemptAssignees: false
-
-# Label to use when marking as stale
-staleLabel: wontfix
-
-# Comment to post when marking as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs within the next 7 days.
-  Please check if the issue is still relevant in the most current version of the adapter
-  and tell us. Also check that all relevant details, logs and reproduction steps
-  are included and update them if needed.
-  Thank you for your contributions.
-
-  Dieses Problem wurde automatisch als veraltet markiert, da es in letzter Zeit keine Aktivitäten gab.
-  Es wird geschlossen, wenn nicht innerhalb der nächsten 7 Tage weitere Aktivitäten stattfinden.
-  Bitte überprüft, ob das Problem auch in der aktuellsten Version des Adapters noch relevant ist,
-  und teilt uns dies mit. Überprüft auch, ob alle relevanten Details, Logs und Reproduktionsschritte
-  enthalten sind bzw. aktualisiert diese.
-  Vielen Dank für Eure Unterstützung.
-
-# Comment to post when removing the stale label.
-# unmarkComment: >
-#   Your comment here.
-
-# Comment to post when closing a stale Issue or Pull Request.
-closeComment: >
-  This issue has been automatically closed because of inactivity. Please open a new
-  issue if still relevant and make sure to include all relevant details, logs and
-  reproduction steps.
-  Thank you for your contributions.
-
-  Dieses Problem wurde aufgrund von Inaktivität automatisch geschlossen. Bitte öffnet ein
-  neues Issue, falls dies noch relevant ist und stellt sicher das alle relevanten Details,
-  Logs und Reproduktionsschritte enthalten sind.
-  Vielen Dank für Eure Unterstützung.
-
-# Limit the number of actions per hour, from 1-30. Default is 30
-limitPerRun: 30
-
-# Limit to only `issues` or `pulls`
-only: issues
-
-# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
-# pulls:
-#   daysUntilStale: 30
-#   markComment: >
-#     This pull request has been automatically marked as stale because it has not had
-#     recent activity. It will be closed if no further activity occurs. Thank you
-#     for your contributions.
-
-# issues:
-#   exemptLabels:
-#     - confirmed

package/.github/workflows/dependabot-automerge.yml

@@ -1,22 +0,0 @@
-# Automatically merge Dependabot PRs when version comparison is within the range
-# that is configured in .github/auto-merge.yml
-
-name: Auto-Merge Dependabot PRs
-
-on:
-  pull_request_target:
-
-jobs:
-  auto-merge:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Check if PR should be auto-merged
-        uses: ahmadnassri/action-dependabot-auto-merge@v2
-        with:
-          # This must be a personal access token with push access
-          github-token: ${{ secrets.AUTO_MERGE_TOKEN }}
-          # By default, squash and merge, so Github chooses nice commit messages
-          command: squash and merge