zigbee-herdsman 6.0.1 → 6.0.3

package/package.json

@@ -38,11 +38,10 @@
   "deprecated": false,
   "description": "An open source ZigBee gateway solution with node.js.",
   "devDependencies": {
-    "@biomejs/biome": "^2.1.4",
-    "@codspeed/vitest-plugin": "^4.0.1",
+    "@biomejs/biome": "^2.2.2",
     "@serialport/binding-mock": "^10.2.2",
     "@types/debounce": "^1.2.4",
-    "@types/node": "^24.2.1",
+    "@types/node": "^24.3.0",
     "@vitest/coverage-v8": "^3.1.1",
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3",
@@ -57,14 +56,23 @@
     "zigate"
   ],
   "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js"
+  },
   "name": "zigbee-herdsman",
+  "files": [
+    "./dist",
+    "./CHANGELOG.md"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Koenkk/zigbee-herdsman.git"
   },
-  "version": "6.0.1",
+  "version": "6.0.3",
   "scripts": {
     "build": "tsc",
     "build:watch": "tsc -w",

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +0,0 @@
-blank_issues_enabled: true
-contact_links:
-    - name: Zigbee2MQTT issue tracker
-      url: https://github.com/Koenkk/zigbee2mqtt/issues/new/choose
-      about: Preferably create an issue in the Zigbee2MQTT issue tracker. Only click on "Open a blank issue" below if you are conviced it really belongs in this issue tracker.

package/.github/dependabot.yml

@@ -1,22 +0,0 @@
-version: 2
-updates:
-    - package-ecosystem: npm
-      versioning-strategy: increase
-      directory: /
-      schedule:
-          interval: weekly
-      groups:
-          minor-patch:
-              applies-to: version-updates
-              update-types:
-                  - minor
-                  - patch
-      commit-message:
-        prefix: fix(ignore)
-      ignore:
-          # https://github.com/Koenkk/zigbee-herdsman/pull/1471
-          - dependency-name: typescript
-    - package-ecosystem: github-actions
-      directory: /
-      schedule:
-        interval: weekly

package/.github/workflows/ci.yml

@@ -1,64 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - master
-    tags:
-      - "v[0-9]+.[0-9]+.[0-9]+"
-  pull_request:
-
-permissions:
-    contents: write
-    pull-requests: write
-
-jobs:
-    ci:
-        runs-on: ubuntu-latest
-        permissions:
-            id-token: write
-        steps:
-            - uses: actions/checkout@v5
-
-            - uses: pnpm/action-setup@v4
-
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 24
-                  registry-url: https://registry.npmjs.org/
-                  cache: pnpm
-
-            - name: Install dependencies
-              run: pnpm i --frozen-lockfile
-
-            - name: Check
-              run: pnpm run check
-
-            - name: Build
-              run: pnpm run build
-
-            - name: Test
-              run: pnpm run test:coverage -- --testTimeout=10000
-
-            - name: Bench
-              if: github.ref == 'refs/heads/master' || (github.event_name == 'pull_request' && !startsWith(github.head_ref, 'release-please-'))
-              uses: CodSpeedHQ/action@v3
-              with:
-                run: pnpm run bench
-                token: ${{ secrets.CODSPEED_TOKEN }}
-
-            - name: Publish new release
-              if: startsWith(github.ref, 'refs/tags/') && github.event_name == 'push'
-              run: |
-                  pnpm publish --no-git-checks
-                  PACKAGE=$(node -p "require('./package.json').name")
-                  VERSION=$(node -p "require('./package.json').version")
-                  until [ $(pnpm view $PACKAGE --json | jq --arg version "$VERSION" -r '.versions[] | select (. == $version)') ];
-                  do
-                    echo "Waiting for publish to complete"
-                    sleep 5s
-                  done
-                  curl -XPOST -H "Authorization: token ${{ secrets.GH_TOKEN }}" -H "Accept: application/vnd.github.everest-preview+json" -H "Content-Type: application/json" https://api.github.com/repos/koenkk/zigbee2mqtt/dispatches --data "{\"event_type\": \"update_dep\", \"client_payload\": { \"version\": \"$VERSION\", \"package\": \"$PACKAGE\"}}"
-              env:
-                  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN }}
-                  NPM_CONFIG_PROVENANCE: true

package/.github/workflows/release-please.yml

@@ -1,18 +0,0 @@
-name: Release Please
-
-on:
-    push:
-        branches:
-            - master
-
-permissions:
-    contents: write
-    pull-requests: write
-
-jobs:
-    release-please:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: googleapis/release-please-action@v4
-              with:
-                  token: ${{ secrets.GH_TOKEN }}

package/.github/workflows/stale.yml

@@ -1,20 +0,0 @@
-name: Stale
-
-on:
-    schedule:
-        - cron: '0 0 * * *'
-    workflow_dispatch:
-
-jobs:
-    stale:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/stale@v9
-              with:
-                  repo-token: ${{ secrets.GITHUB_TOKEN }}
-                  stale-issue-message: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days'
-                  stale-pr-message: 'This pull request is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days'
-                  days-before-stale: 60
-                  days-before-close: 7
-                  exempt-issue-labels: dont-stale
-                  operations-per-run: 500

package/.github/workflows/typedoc.yaml

@@ -1,47 +0,0 @@
-name: Publish typedoc on Github Pages
-
-on:
-    release:
-        types:
-            - published
-    workflow_dispatch:
-
-jobs:
-    build:
-        runs-on: ubuntu-latest
-        permissions:
-            contents: write
-        steps:
-            - uses: actions/checkout@v5
-            - uses: pnpm/action-setup@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: 24
-                  registry-url: https://registry.npmjs.org/
-                  cache: pnpm
-
-            - run: pnpm install --frozen-lockfile
-            - run: pnpm add -g typedoc
-
-            - name: Generate docs
-              run: typedoc --gitRevision "$(git describe --tag --abbrev=0)" --tsconfig tsconfig.json --excludePrivate --excludeProtected --excludeExternals --entryPointStrategy expand ./src --sourceLinkTemplate "https://github.com/Koenkk/zigbee-herdsman/blob/{gitRevision}/{path}#L{line}" -out typedoc
-
-            - uses: actions/upload-pages-artifact@v3
-              with:
-                  name: github-pages
-                  # typedoc "out" path
-                  path: ./typedoc
-
-    deploy:
-        needs: build
-        runs-on: ubuntu-latest
-        permissions:
-            pages: write # to deploy to Pages
-            id-token: write # to verify the deployment originates from an appropriate source
-        environment:
-            name: github-pages
-            url: ${{ steps.deployment.outputs.page_url }}
-        steps:
-            - name: Deploy to GitHub Pages
-              id: deployment
-              uses: actions/deploy-pages@v4

package/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-    ".": "6.0.1"
-}

package/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-    "recommendations": ["biomejs.biome", "vitest.explorer"]
-}

package/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-    "editor.defaultFormatter": "biomejs.biome",
-    "notebook.defaultFormatter": "biomejs.biome",
-    "editor.tabSize": 4,
-    "editor.insertSpaces": true,
-    "files.defaultLanguage": "typescript",
-    "files.eol": "\n",
-    "[typescript]": {
-        "editor.defaultFormatter": "biomejs.biome"
-    }
-}

package/biome.json

@@ -1,98 +0,0 @@
-{
-    "$schema": "https://biomejs.dev/schemas/2.1.4/schema.json",
-    "vcs": {
-        "enabled": true,
-        "clientKind": "git",
-        "useIgnoreFile": true
-    },
-    "formatter": {
-        "indentStyle": "space",
-        "indentWidth": 4,
-        "lineWidth": 150,
-        "bracketSpacing": false
-    },
-    "files": {
-        "includes": ["**", "!package.json"]
-    },
-    "linter": {
-        "includes": ["**", "!src/adapter/ezsp/driver/types/**/*"],
-        "rules": {
-            "correctness": {
-                "noUnusedImports": "error",
-                "noUnusedVariables": {
-                    "level": "warn",
-                    "fix": "none"
-                }
-            },
-            "style": {
-                "noParameterAssign": "off",
-                "useThrowNewError": "error",
-                "useThrowOnlyError": "error",
-                "useNamingConvention": {
-                    "level": "error",
-                    "options": {
-                        "strictCase": false,
-                        "conventions": [
-                            {
-                                "selector": {
-                                    "kind": "objectLiteralProperty"
-                                },
-                                "formats": ["snake_case", "camelCase", "CONSTANT_CASE", "PascalCase"]
-                            },
-                            {
-                                "selector": {
-                                    "kind": "const"
-                                },
-                                "formats": ["snake_case", "camelCase", "CONSTANT_CASE", "PascalCase"]
-                            },
-                            {
-                                "selector": {
-                                    "kind": "typeProperty"
-                                },
-                                "formats": ["snake_case", "camelCase", "CONSTANT_CASE", "PascalCase"]
-                            },
-                            {
-                                "selector": {
-                                    "kind": "enumMember"
-                                },
-                                "formats": ["CONSTANT_CASE", "PascalCase"]
-                            }
-                        ]
-                    }
-                },
-                "useAsConstAssertion": "error",
-                "useDefaultParameterLast": "error",
-                "useEnumInitializers": "error",
-                "useSelfClosingElements": "error",
-                "useSingleVarDeclarator": "error",
-                "noUnusedTemplateLiteral": "error",
-                "useNumberNamespace": "error",
-                "noInferrableTypes": "error",
-                "noUselessElse": "error"
-            },
-            "performance": {
-                "noDelete": "off"
-            },
-            "suspicious": {
-                "noConstEnum": "off",
-                "useAwait": "error"
-            }
-        }
-    },
-    "overrides": [
-        {
-            "includes": ["src/adapter/ezsp/driver/types/**/*", "test/**"],
-            "linter": {
-                "rules": {
-                    "style": {
-                        "noNonNullAssertion": "off",
-                        "useNamingConvention": "off"
-                    },
-                    "suspicious": {
-                        "noImplicitAnyLet": "off"
-                    }
-                }
-            }
-        }
-    ]
-}

package/examples/join-and-log.js

@@ -1,24 +0,0 @@
-const {Controller} = require("zigbee-herdsman");
-
-const SERIAL = "/dev/ttyACM0";
-const DB = "./devices.db";
-
-const coordinator = new Controller({
-    serialPort: {path: SERIAL},
-    databasePath: DB,
-});
-
-coordinator.on("message", (msg) => {
-    console.log(msg);
-});
-
-coordinator
-    .start()
-    .then(() => {
-        console.log("started with device", SERIAL);
-        return coordinator.permitJoin(true, null, 600);
-    })
-    .catch((err) => {
-        console.error(err);
-        process.exit(1);
-    });

package/release-please-config.json

@@ -1,9 +0,0 @@
-{
-    "packages": {
-        ".": {
-            "release-type": "node",
-            "include-component-in-tag": false
-        }
-    },
-    "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
-}

package/src/adapter/adapter.ts

@@ -1,189 +0,0 @@
-import events from "node:events";
-
-import type * as Models from "../models";
-import type {BroadcastAddress} from "../zspec/enums";
-import * as Zcl from "../zspec/zcl";
-import type * as Zdo from "../zspec/zdo";
-import type * as ZdoTypes from "../zspec/zdo/definition/tstypes";
-import {discoverAdapter} from "./adapterDiscovery";
-import type * as AdapterEvents from "./events";
-import type * as TsType from "./tstype";
-
-interface AdapterEventMap {
-    deviceJoined: [payload: AdapterEvents.DeviceJoinedPayload];
-    zclPayload: [payload: AdapterEvents.ZclPayload];
-    zdoResponse: [clusterId: Zdo.ClusterId, response: ZdoTypes.GenericZdoResponse];
-    disconnected: [];
-    deviceLeave: [payload: AdapterEvents.DeviceLeavePayload];
-}
-
-export abstract class Adapter extends events.EventEmitter<AdapterEventMap> {
-    public hasZdoMessageOverhead: boolean;
-    public manufacturerID: Zcl.ManufacturerCode;
-    protected networkOptions: TsType.NetworkOptions;
-    protected adapterOptions: TsType.AdapterOptions;
-    protected serialPortOptions: TsType.SerialPortOptions;
-    protected backupPath: string;
-
-    protected constructor(
-        networkOptions: TsType.NetworkOptions,
-        serialPortOptions: TsType.SerialPortOptions,
-        backupPath: string,
-        adapterOptions: TsType.AdapterOptions,
-    ) {
-        super();
-        this.hasZdoMessageOverhead = true;
-        this.manufacturerID = Zcl.ManufacturerCode.RESERVED_10;
-        this.networkOptions = networkOptions;
-        this.adapterOptions = adapterOptions;
-        this.serialPortOptions = serialPortOptions;
-        this.backupPath = backupPath;
-    }
-
-    /**
-     * Utility
-     */
-
-    public static async create(
-        networkOptions: TsType.NetworkOptions,
-        serialPortOptions: TsType.SerialPortOptions,
-        backupPath: string,
-        adapterOptions: TsType.AdapterOptions,
-    ): Promise<Adapter> {
-        const [adapter, path] = await discoverAdapter(serialPortOptions.adapter, serialPortOptions.path);
-        serialPortOptions.adapter = adapter;
-        serialPortOptions.path = path;
-
-        switch (adapter) {
-            case "zstack": {
-                const {ZStackAdapter} = await import("./z-stack/adapter/zStackAdapter.js");
-
-                return new ZStackAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
-            }
-            case "ember": {
-                const {EmberAdapter} = await import("./ember/adapter/emberAdapter.js");
-
-                return new EmberAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
-            }
-            case "deconz": {
-                const {DeconzAdapter} = await import("./deconz/adapter/deconzAdapter.js");
-
-                return new DeconzAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
-            }
-            case "zigate": {
-                const {ZiGateAdapter} = await import("./zigate/adapter/zigateAdapter.js");
-
-                return new ZiGateAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
-            }
-            case "zboss": {
-                const {ZBOSSAdapter} = await import("./zboss/adapter/zbossAdapter.js");
-
-                return new ZBOSSAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
-            }
-            case "zoh": {
-                const {ZoHAdapter} = await import("./zoh/adapter/zohAdapter.js");
-
-                return new ZoHAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
-            }
-            // @deprecated
-            case "ezsp": {
-                const {EZSPAdapter} = await import("./ezsp/adapter/ezspAdapter.js");
-
-                return new EZSPAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
-            }
-            default: {
-                throw new Error(`Adapter '${adapter}' does not exists, possible options: zstack, ember, deconz, zigate, zboss, zoh, ezsp`);
-            }
-        }
-    }
-
-    public abstract start(): Promise<TsType.StartResult>;
-
-    public abstract stop(): Promise<void>;
-
-    public abstract getCoordinatorIEEE(): Promise<string>;
-
-    public abstract getCoordinatorVersion(): Promise<TsType.CoordinatorVersion>;
-
-    public abstract reset(type: "soft" | "hard"): Promise<void>;
-
-    public abstract supportsBackup(): Promise<boolean>;
-
-    public abstract backup(ieeeAddressesInDatabase: string[]): Promise<Models.Backup>;
-
-    public abstract getNetworkParameters(): Promise<TsType.NetworkParameters>;
-
-    public abstract addInstallCode(ieeeAddress: string, key: Buffer, hashed: boolean): Promise<void>;
-
-    public abstract waitFor(
-        networkAddress: number | undefined,
-        endpoint: number,
-        frameType: Zcl.FrameType,
-        direction: Zcl.Direction,
-        transactionSequenceNumber: number | undefined,
-        clusterID: number,
-        commandIdentifier: number,
-        timeout: number,
-    ): {promise: Promise<AdapterEvents.ZclPayload>; cancel: () => void};
-
-    /**
-     * ZDO
-     */
-
-    public abstract sendZdo(
-        ieeeAddress: string,
-        networkAddress: number,
-        clusterId: Zdo.ClusterId,
-        payload: Buffer,
-        disableResponse: true,
-    ): Promise<void>;
-    public abstract sendZdo<K extends keyof ZdoTypes.RequestToResponseMap>(
-        ieeeAddress: string,
-        networkAddress: number,
-        clusterId: K,
-        payload: Buffer,
-        disableResponse: false,
-    ): Promise<ZdoTypes.RequestToResponseMap[K]>;
-    public abstract sendZdo<K extends keyof ZdoTypes.RequestToResponseMap>(
-        ieeeAddress: string,
-        networkAddress: number,
-        clusterId: K,
-        payload: Buffer,
-        disableResponse: boolean,
-    ): Promise<ZdoTypes.RequestToResponseMap[K] | undefined>;
-
-    public abstract permitJoin(seconds: number, networkAddress?: number): Promise<void>;
-
-    /**
-     * ZCL
-     */
-
-    public abstract sendZclFrameToEndpoint(
-        ieeeAddr: string,
-        networkAddress: number,
-        endpoint: number,
-        zclFrame: Zcl.Frame,
-        timeout: number,
-        disableResponse: boolean,
-        disableRecovery: boolean,
-        sourceEndpoint?: number,
-    ): Promise<AdapterEvents.ZclPayload | undefined>;
-
-    public abstract sendZclFrameToGroup(groupID: number, zclFrame: Zcl.Frame, sourceEndpoint?: number): Promise<void>;
-
-    public abstract sendZclFrameToAll(endpoint: number, zclFrame: Zcl.Frame, sourceEndpoint: number, destination: BroadcastAddress): Promise<void>;
-
-    /**
-     * InterPAN
-     */
-
-    public abstract setChannelInterPAN(channel: number): Promise<void>;
-
-    public abstract sendZclFrameInterPANToIeeeAddr(zclFrame: Zcl.Frame, ieeeAddress: string): Promise<void>;
-
-    public abstract sendZclFrameInterPANBroadcast(zclFrame: Zcl.Frame, timeout: number): Promise<AdapterEvents.ZclPayload>;
-
-    public abstract restoreChannelInterPAN(): Promise<void>;
-}
-
-export default Adapter;