iobroker.zigbee 1.8.1 → 1.8.3

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules/*
+test/*

package/.eslintrc.json

@@ -0,0 +1,37 @@
+{
+    "env": {
+        "es6": true,
+        "node": true,
+        "mocha": true
+    },
+    "extends": "eslint:recommended",
+    "rules": {
+        "indent": [
+            "error",
+            4,
+            {
+                "SwitchCase": 1
+            }
+        ],
+        "linebreak-style": 0,
+        "no-console": "off",
+        "no-var": "error",
+        "prefer-const": "error",
+        "quotes": [
+            "error",
+            "single",
+            {
+                "avoidEscape": true,
+                "allowTemplateLiterals": true
+            }
+        ],
+        "semi": [
+            "error",
+            "always"
+        ],
+        "no-prototype-builtins": "off"
+    },
+    "parserOptions": {
+        "ecmaVersion": 2019
+    }
+}

package/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+custom: ['https://www.paypal.me/goofyk', 'https://paypal.me/ArthurRupp']

package/.github/auto-merge.yml

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,24 @@
+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: 5
+    versioning-strategy: increase
+  - package-ecosystem: npm
+    directory: "/src"
+    schedule:
+      interval: monthly
+      time: "04:00"
+      timezone: Europe/Berlin
+    open-pull-requests-limit: 5
+    versioning-strategy: increase

package/.github/stale.yml

@@ -0,0 +1,13 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue 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. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

package/.github/workflows/codeql.yml

@@ -0,0 +1,41 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: "54 15 * * 0"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ javascript ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"

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

@@ -0,0 +1,22 @@
+# 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

package/.github/workflows/test-and-release.yml

@@ -0,0 +1,149 @@
+name: Test and Release
+
+# Run this job on all pushes and pull requests
+# as well as tags with a semantic version
+on:
+  push:
+    branches:
+      - "*"
+    tags:
+      # normal versions
+      - "v[0-9]+.[0-9]+.[0-9]+"
+      # pre-releases
+      - "v[0-9]+.[0-9]+.[0-9]+-**"
+  pull_request: {}
+
+jobs:
+  # Performs quick checks before the expensive test runs
+  check-and-lint:
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install Dependencies
+        run: npm i
+
+      - name: Test package files
+        run: npm run test:package
+
+  # Runs adapter tests on all supported node versions and OSes
+  adapter-tests:
+    if: contains(github.event.head_commit.message, '[skip ci]') == false
+
+    needs: [check-and-lint]
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        os: [ubuntu-latest, macos-latest]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install Dependencies
+        run: npm i
+
+      - name: Run unit tests
+        run: npm run test:unit
+
+      - name: Run integration tests (unix only)
+        if: startsWith(runner.OS, 'windows') == false
+        run: DEBUG=testing:* npm run test:integration
+
+      - name: Run integration tests (windows only)
+        if: startsWith(runner.OS, 'windows')
+        run: set DEBUG=testing:* & npm run test:integration
+
+  # Deploys the final package to NPM
+  deploy:
+    needs: [adapter-tests]
+
+    # Trigger this step only when a commit on any branch is tagged with a version number
+    if: |
+      contains(github.event.head_commit.message, '[skip ci]') == false &&
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/v')
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Extract the version and commit body from the tag
+        id: extract_release
+        # The body may be multiline, therefore newlines and % need to be escaped
+        run: |
+          VERSION="${{ github.ref }}"
+          VERSION=${VERSION##*/v}
+          echo "::set-output name=VERSION::$VERSION"
+          BODY=$(git show -s --format=%b)
+          BODY="${BODY//'%'/'%25'}"
+          BODY="${BODY//$'\n'/'%0A'}"
+          BODY="${BODY//$'\r'/'%0D'}"
+          echo "::set-output name=BODY::$BODY"
+
+#     If you like, activate automated version publish to NPM
+#     Only if commit contains a version, see : https://github.com/AlCalzone/release-script
+
+      - name: Publish package to npm
+        run: |
+          npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
+          npm whoami
+          npm publish
+
+#      - name: Create Github Release
+#        uses: actions/create-release@v1
+#        env:
+#          GITHUB_TOKEN: ${{ secrets.Github_Token}}
+#        with:
+#          tag_name: ${{ github.ref }}
+#          release_name: Release v${{ steps.extract_release.outputs.VERSION }}
+#          draft: false
+#          # Prerelease versions create prereleases on Github
+#          prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }}
+#          body: ${{ steps.extract_release.outputs.BODY }}
+#
+#      - name: Notify Sentry.io about the release
+#        run: |
+#          npm i -g @sentry/cli
+#          export SENTRY_AUTH_TOKEN=${{ secrets.SENTRY_AUTH_TOKEN }}
+#          export SENTRY_URL=https://sentry.iobroker.net
+#          export SENTRY_ORG=iobroker
+#          export SENTRY_PROJECT=iobroker-zigbee
+#          export SENTRY_VERSION=iobroker.zigbee@${{ steps.extract_release.outputs.VERSION }}
+#          sentry-cli releases new $SENTRY_VERSION
+#          sentry-cli releases finalize $SENTRY_VERSION
+#        # Add the following line BEFORE finalize if repositories are connected in Sentry
+#        # sentry-cli releases set-commits $SENTRY_VERSION --auto
+#
+#        # Add the following line BEFORE finalize if sourcemap uploads are needed
+#        # sentry-cli releases files $SENTRY_VERSION upload-sourcemaps build/

package/.releaseconfig.json

@@ -0,0 +1,3 @@
+{
+  "plugins": ["iobroker", "license"]
+}

package/.travis/wiki.sh

@@ -0,0 +1,28 @@
+#!/bin/sh -e
+
+setup_git() {
+  git config --global user.email "travis@travis-ci.org"
+  git config --global user.name "Travis CI"
+}
+
+update_wiki() {
+  rm -rf ioBroker.zigbee.wiki
+  git clone https://${GH_TOKEN}@github.com/ioBroker/ioBroker.zigbee.wiki.git
+  npm run docgen ioBroker.zigbee.wiki
+  cd ioBroker.zigbee.wiki
+  git add -A
+  git diff-index --quiet HEAD || git commit -m "Travis CI: update wiki"
+  git push origin
+  cd ..
+  rm -rf ioBroker.zigbee.wiki
+}
+
+# Only update wiki if on master branch and not pull request
+if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]
+then
+  echo "Updating wiki!"
+  setup_git
+  update_wiki
+else
+  echo "Not updating wiki, triggered by pull request or not on master branch"
+fi

package/.travis.yml

@@ -0,0 +1,41 @@
+os:
+  - linux
+  - osx
+  - windows
+sudo: required
+language: node_js
+node_js:
+  - '12'
+  - '14'
+  - '16'
+before_install:
+  - 'if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo ln -s `which node` `which node`js; fi'
+  - 'if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then which nodejs || which node; fi'
+  - 'if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export CC=clang++; export CXX=clang++; export CXXFLAGS=-std=c++11; fi'
+  - 'if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew unlink pkg-config; fi'
+  - 'if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then export CXX=g++-6; CC=gcc-6; fi'
+  - npm install -g node-gyp
+install:
+  - npm install --unsafe-perm
+before_script:
+  - export NPMVERSION=$(echo "$($(which npm) -v)"|cut -c1)
+  - 'if [[ $NPMVERSION == 5 ]]; then npm install -g npm@5; fi'
+  - npm -v
+after_success:
+  - .travis/wiki.sh
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - gcc-6
+      - g++-6
+env:
+  global:
+    - secure: >-
+        jYhOGVA5M7ZP9n4ccCr5J9DiODgRyVnKqAqyIE7+TA0jBg1jSPyWydoNuG02htIiNRMp4se+t8mFWIG3QqiFtoJbOdBt3yZYhVdfkx+4JyQpZAZq790C3jGdTSM/sVdaw2D+5Uvhqb4y7YOQ7SUYsRb5IH0NN2ZnOIZuGiOq8eVZ+np3gYNgsJwRWxrOrUi8lIA7APMe8esmOuTmKuFNfxhVWu98WegztBxnQmfCfwUl0OxgXxpdoElIQcbEV2zkJPOowZSioQvE5dxgIuf+leBeWdDm6g7bDmV84CkXmHlWkJoyyz1DYM7XFib4vSX9nJ2HZ2U7/wtbBd9/92JPoClvmiagb4wtICVO98LMXdayF3kRO/h7uH9HTHY1Mo98HHhxWMyfXVh6cWkDPYutSkFBG+a/tQB1jvbHq8j6O98VNpkLVqlbBIV8i0+uzoWOyaCVjZgcc7PtzfuWeNYB4c5cTu+HuofKwx3aBGJvnIukIeD/BJjnB76d4hfm++K6bDjKU61Gd7rY0/C1Ik8HsKxDdGvM5Ro6XARugoLTgym9Xk/ByU0AYrD05F+JzC2T+Hv1xACCq50HtsDAflpc9T4kLV3towQ69bE+N5kMfX5/X4rnVCkeerb+5X3EZjjslcUbwT4REahmihXR+8Mzz6f3O7ATUUA0BclD773ZFFY=
+script:
+  - 'npm run test:package'
+  - 'npm run test:unit'
+  - 'npm run test:integration'
+  - 'if [ "$TRAVIS_OS_NAME" != "windows" ]; then if [ "$TRAVIS_COMMIT_RANGE" != "" ]; then COMMIT_RANGE=$TRAVIS_COMMIT_RANGE; else COMMIT_RANGE="HEAD^..HEAD"; fi; echo "Lint check of commit range $COMMIT_RANGE"; lint-diff $COMMIT_RANGE; fi;'

package/README.md

@@ -10,12 +10,17 @@
 [![Downloads](https://img.shields.io/npm/dm/iobroker.zigbee.svg)](https://www.npmjs.com/package/iobroker.zigbee)
 
 ## ioBroker adapter for Zigbee devices via TI cc2531/cc2530/cc26x2r/cc2538 and deCONZ ConBee/RaspBee.
-With the Zigbee-coordinator based on `Texas Instruments SoC, deCONZ ConBee/RaspBee` modules, `Silicon Labs EZSP v8` or `ZIGate USB-TTL` it creates its own zigbee-network, into which zigbee-devices are connected. By work directly with the coordinator, the driver allows you to manage devices without additional application / gateways / bridge from device manufacturers (Xiaomi / TRADFRI / Hue / Tuya). About the device Zigbee-network can be read [here (in English)](https://www.zigbee2mqtt.io/information/zigbee_network.html).
+
+With the Zigbee-coordinator based on Texas Instruments SoC, deCONZ ConBee/RaspBee modules, Silicon Labs EZSP v8 or ZIGate USB-TTL it creates its own zigbee-network, into which zigbee-devices are connected. By work directly with the coordinator, the driver allows you to manage devices without additional application / gateways / bridge from device manufacturers (Xiaomi / TRADFRI / Hue / Tuya). About the device Zigbee-network can be read [here (in English)](https://www.zigbee2mqtt.io/information/zigbee_network.html).
 
 ## Hardware
+
+
 One coordinator device is required for each zigbee Adapter instance. The device must be flashed with the respective coordinator firmware. A list of supported coordinators, the necessary equipment for the firmware and the device preparation process for different coordinator devices are described [here (in English)](https://www.zigbee2mqtt.io/guide/adapters/) or [here (in Russian)](https://myzigbee.ru/books/%D0%BF%D1%80%D0%BE%D1%88%D0%B8%D0%B2%D0%BA%D0%B8/page/%D0%BF%D1%80%D0%BE%D1%88%D0%B8%D0%B2%D0%BA%D0%B0-cc2531cc2530)
 
+
 ### Texas Instruments SoC
+
 Recommended devices are based on either the CC2652 or CC1352 chip. Devices based on cc253x chips are still supported but are no longer recommended.
 Only CC26xx/cc1352/cc2538 Devices support extraction of the NVRam backup which should allow to swap coordinator hardware without having to reconnect all zigbee devices to the network.
 Current firmware files for these devices can be found [on GitHub](https://github.com/Koenkk/Z-Stack-firmware)
@@ -27,7 +32,9 @@ Current firmware files for these devices can be found [on GitHub](https://github
 <span><img src="docs/de/img/CC2538_CC2592_PA.PNG" width="100"></span>
 <span><img src="docs/de/img/cc26x2r.PNG" width="100"></span>
 
+
 ### Dresden Elektronik SoC
+
 <span><img src="docs/en/img/deconz.png"></span>
 
 recommended:
@@ -38,18 +45,23 @@ no longer recommended:
 - ConBee I
 - RaspBee
 
-While `Conbee/RaspBee` Support is no longer considered experimental in the zigbee-herdsman and zigbee-herdsman-converters libraries used by the zigbee Adapter, use of these devices with the adapter may limit functionality. Known issues are:
+While Conbee/RaspBee Support is no longer considered experimental in the zigbee-herdsman and zigbee-herdsman-converters libraries used by the zigbee Adapter, use of these devices with the adapter may limit functionality. Known issues are:
 - link quality display may be incorrect
 - device map metrics may be incorrect
 - NVRam Backup is not supported.
 
 ### Silicon Labs SoC
-Support for [Silicon Lab Zigbee](https://www.silabs.com/wireless/zigbee) based adapters is experimental. The initial support for EZSP v8 is still not yet considered stable and the project is in need of more developers volunteering to help with this integration. Please refer to the respective documentation on [this page](https://www.zigbee2mqtt.io/guide/adapters/) and [ongoing development discussion](https://github.com/Koenkk/zigbee-herdsman/issues/319) with regard to the state of Silabs EmberZNet Serial Protocol (EZSP) adapter implementation integration into the zigbee-herdsman and zigbee-herdsman-converters libraries which it depends on.
+
+Support for [Silicon Lab Zigbee](https://www.silabs.com/wireless/zigbee) based adapters is experimental. The initial support for EZSP v8 is still not yet considered stable and the project is in need of more developers volenteering to help with this integration. Please refer to the respective documentation on [this page](https://www.zigbee2mqtt.io/guide/adapters/) and [ongoing development discussion](https://github.com/Koenkk/zigbee-herdsman/issues/319) with regards to the state of Silabs EmberZNet Serial Protocol (EZSP) adapter implementation integration into the zigbee-herdsman and zigbee-herdsman-converters libraries which it depends on.
+
 
 ### ZiGate SoC
-Support for [ZiGate](https://zigate.fr) based adapters is experimental. The initial support for ZiGate is still not yet considered stable and the project is in need of more developers volunteering to help with this integration. Please refer to the respective documentation on [this page](https://www.zigbee2mqtt.io/guide/adapters/) and [ongoing development discussion](https://github.com/Koenkk/zigbee-herdsman/issues/242) with regard to the state of ZiGate adapter implementation into the zigbee-herdsman and zigbee-herdsman-converters libraries which it depends on.
+
+Support for [ZiGate](https://zigate.fr) based adapters is experimental. The initial support for ZiGate is still not yet considered stable and the project is in need of more developers volenteering to help with this integration. Please refer to the respective documentation on [this page](https://www.zigbee2mqtt.io/guide/adapters/) and [ongoing development discussion](https://github.com/Koenkk/zigbee-herdsman/issues/242) with regards to the state of ZiGate adapter implementation into the zigbee-herdsman and zigbee-herdsman-converters libraries which it depends on.
+
 
 ## Work with adapter
+
 ![](docs/tutorial/zigbee.png)
 
 To start the driver, you must specify the name of the port on which the Zigbee-module (stick) is connected. Usually this is the port `/dev/ttyACM0` or `/dev/ttyUSB0` for the UART-connection. Or you can find with `ls -l /dev/serial/by-id` the device direct.
@@ -57,6 +69,7 @@ To start the driver, you must specify the name of the port on which the Zigbee-m
 open the settings and change port
 ![](docs/tutorial/settings.png)
 
+
 For Windows this will be the COM port number.
 
 Starting from version 1.0.0 you can also use *tcp connection* for cases using esp8266 (or other microcontrollers) as serial-bridge. For example `tcp://192.168.1.46:8880`. Read more info here https://www.zigbee2mqtt.io/information/connecting_cc2530#via-an-esp8266
@@ -79,14 +92,18 @@ It is a Zigbee feature, intended for example to switch bulbs synchronized. Assig
 
 Note: Not all devices support groups (not supported by end devices like sensors).
 
+
 ### Binding
+
 https://www.zigbee2mqtt.io/information/binding
 
 ### Developer Tab
-This is a tool for advanced users to test currently unsupported devices or enhance this adapter's functionality. More instructions can be found on tab.
+
+This is a tool for advanced users to test currently unsupported devices or enhance this adapters functionality. More instructions can be found on tab.
 ![](docs/tutorial/tab-dev-1.png)
 
 ## Additional info
+
 There is a [friendly project](https://github.com/koenkk/zigbee2mqtt) with similar functionality on the same technologies, where you can work with the same devices using the MQTT protocol. Therefore, if any improvements or support for new zigbee-devices occur in the Zigbee2MQTT project, we can transfer and add the same functionality to this adapter. If you notice this, then write the issue - we'll postpone it.
 
 There are knowledge bases that can be useful for working with Zigbee-devices and equipment:
@@ -94,9 +111,11 @@ There are knowledge bases that can be useful for working with Zigbee-devices and
 * in Russian https://myzigbee.ru/
 
 ## Supported devices
+
 Works with devices from this list https://github.com/ioBroker/ioBroker.zigbee/wiki/Supported-devices
 
 ## Donate
+
 You can thank the authors by these links:
 * to Kirov Ilya https://www.paypal.me/goofyk
 * to Arthur Rupp https://paypal.me/ArthurRupp
@@ -112,7 +131,11 @@ You can thank the authors by these links:
     ### **WORK IN PROGRESS**
 -->
 
+
 ## Changelog
+### 1.8.3 (2022-11-30)
+* (arteck) back to old source
+
 ### 1.8.1 (2022-11-28)
 * (bluefox) Packages updated
 * (bluefox) Added names of serial ports in configuration dialog
@@ -163,8 +186,8 @@ You can thank the authors by these links:
   - when a pingable device is marked active (from being inactive) it will be pinged again.
   - inactive devices are excluded from OTA updates.
 * (asgothian) Group rework part 2:
-  - state `device.groups` will now be deleted with state Cleanup
-  - state `info.groups` is now obsolete and will be deleted at adapter start (after transferring data to
+  - state device.groups will now be deleted with state Cleanup
+  - state info.groups is now obsolete and will be deleted at adapter start (after transferring data to
     the new storage)
 * (asgothian) Device name persistance.
   - Changes to device names made within the zigbee adapter are stored in the file dev_names.json. This file
@@ -178,7 +201,7 @@ You can thank the authors by these links:
 
 ### 1.6.12 (2022-01)
 * (asgothian) Groups were newly revised (read [here](https://github.com/ioBroker/ioBroker.zigbee/pull/1327) )
-   -  object `device.groups` is obsolet. The old one is no longer up to date
+   -  object device.groups is obsolet..the old one is no longer up to date
 
 ### 1.6.9 (2021-12)
 * (simatec) fix admin Dark-Mode