matterbridge-example-accessory-platform 1.0.0

package/.eslintrc.json

@@ -0,0 +1,46 @@
+{
+    "ignorePatterns":["dist/", "node_modules/"],
+    "plugins": [
+        "@typescript-eslint",
+        "@stylistic",
+        "prettier"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "prettier" 
+      ],
+    "rules": {
+        "prettier/prettier": ["error"],
+        "indent": ["error", 2],
+        "max-len": ["warn", 180],
+        "no-console": ["warn"],
+        "quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": false }],
+        "comma-spacing": ["error", { "before": false, "after": true }],
+        "space-before-function-paren": ["error", { "anonymous": "never", "named": "never", "asyncArrow": "always" }],
+        "keyword-spacing": ["error", { "before": true, "after": true }],
+        "no-multi-spaces": "error",
+        "object-curly-spacing": ["error", "always"],
+        "@typescript-eslint/type-annotation-spacing": ["error", {
+            "before": false,
+            "after": true,
+            "overrides": {
+              "arrow": {
+                "before": true,
+                "after": true
+              }
+            }
+        }]
+    }
+}

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/.prettierignore

@@ -0,0 +1,2 @@
+node_modules
+dist

package/.prettierrc.json

@@ -0,0 +1,12 @@
+{
+  "printWidth": 180,
+  "semi": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "endOfLine": "lf",
+  "bracketSpacing": true,
+  "arrowParens": "always",
+  "quoteProps": "as-needed"
+}

package/README.md

@@ -0,0 +1,2 @@
+# Matterbridge
+Matterbridge accessory platform example plugin

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { Matterbridge } from '../../matterbridge/dist/index.js';
+import { AnsiLogger } from 'node-ansi-logger';
+import { ExampleMatterbridgeAccessoryPlatform } from './platform.js';
+/**
+ * This is the standard interface for MatterBridge plugins.
+ * Each plugin should export a default function that follows this signature.
+ *
+ * @param matterbridge - An instance of MatterBridge
+ */
+export default function initializePlugin(matterbridge: Matterbridge, log: AnsiLogger): ExampleMatterbridgeAccessoryPlatform;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oCAAoC,EAAE,MAAM,eAAe,CAAC;AAErE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,wCAgBnF"}

package/dist/index.js

@@ -0,0 +1,24 @@
+import { MatterServer } from '@project-chip/matter-node.js';
+import { Format, Level, Logger } from '@project-chip/matter-node.js/log';
+import { StorageBackendJsonFile, StorageManager } from '@project-chip/matter-node.js/storage';
+import { ExampleMatterbridgeAccessoryPlatform } from './platform.js';
+/**
+ * This is the standard interface for MatterBridge plugins.
+ * Each plugin should export a default function that follows this signature.
+ *
+ * @param matterbridge - An instance of MatterBridge
+ */
+export default function initializePlugin(matterbridge, log) {
+    // set matter.js logger level and format
+    Logger.defaultLogLevel = Level.DEBUG;
+    Logger.format = Format.ANSI;
+    // Do nothing just load @project-chip/matter-node.js for the Time Crypto Net Node variant
+    const storageJson = new StorageBackendJsonFile('matterbridge-example');
+    const storageManager = new StorageManager(storageJson);
+    new MatterServer(storageManager);
+    log.info('Matterbridge accessory platform example plugin is loading...');
+    const platform = new ExampleMatterbridgeAccessoryPlatform(matterbridge, log);
+    log.info('Matterbridge accessory platform example plugin initialized successfully!');
+    return platform;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAI9F,OAAO,EAAE,oCAAoC,EAAE,MAAM,eAAe,CAAC;AAErE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,YAA0B,EAAE,GAAe;IAClF,wCAAwC;IACxC,MAAM,CAAC,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC;IACrC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC;IAE5B,yFAAyF;IACzF,MAAM,WAAW,GAAG,IAAI,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;IACvE,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IACvD,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC;IAEjC,GAAG,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;IAEzE,MAAM,QAAQ,GAAG,IAAI,oCAAoC,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAE7E,GAAG,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;IACrF,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/platform.d.ts

@@ -0,0 +1,8 @@
+import { Matterbridge, MatterbridgeAccessoryPlatform } from '../../matterbridge/dist/index.js';
+import { AnsiLogger } from 'node-ansi-logger';
+export declare class ExampleMatterbridgeAccessoryPlatform extends MatterbridgeAccessoryPlatform {
+    constructor(matterbridge: Matterbridge, log: AnsiLogger);
+    onStartAccessoryPlatform(): void;
+    onShutdown(): void;
+}
+//# sourceMappingURL=platform.d.ts.map

package/dist/platform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAsB,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACnH,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,qBAAa,oCAAqC,SAAQ,6BAA6B;gBACzE,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU;IAI9C,wBAAwB,IAAI,IAAI;IAkChC,UAAU,IAAI,IAAI;CAG5B"}

package/dist/platform.js

@@ -0,0 +1,41 @@
+import { DeviceTypes } from '@project-chip/matter-node.js/device';
+import { MatterbridgeDevice, MatterbridgeAccessoryPlatform } from '../../matterbridge/dist/index.js';
+import { WindowCovering, WindowCoveringCluster } from '@project-chip/matter-node.js/cluster';
+export class ExampleMatterbridgeAccessoryPlatform extends MatterbridgeAccessoryPlatform {
+    constructor(matterbridge, log) {
+        super(matterbridge, log);
+    }
+    onStartAccessoryPlatform() {
+        this.log.info('onStartAccessoryPlatform called');
+        const cover = new MatterbridgeDevice(DeviceTypes.WINDOW_COVERING);
+        cover.createDefaultIdentifyClusterServer();
+        cover.createDefaultBasicInformationClusterServer('Device1', 'Device1 0x9010880304', 0xfff1, 'Luligu', 0x0001, 'Device1');
+        cover.createDefaultWindowCoveringClusterServer(10000);
+        this.registerDevice(cover);
+        cover.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
+            this.log.warn(`Command identify called identifyTime:${identifyTime}`);
+        });
+        cover.addCommandHandler('goToLiftPercentage', async ({ request: { liftPercent100thsValue } }) => {
+            this.log.warn(`Command goToLiftPercentage called liftPercent100thsValue:${liftPercent100thsValue}`);
+        });
+        setInterval(() => {
+            const coverCluster = cover.getClusterServer(WindowCoveringCluster.with(WindowCovering.Feature.Lift, WindowCovering.Feature.PositionAwareLift));
+            if (coverCluster && coverCluster.getCurrentPositionLiftPercent100thsAttribute) {
+                let position = coverCluster.getCurrentPositionLiftPercent100thsAttribute() + 1000;
+                position = position > 10000 ? 0 : position;
+                coverCluster.setTargetPositionLiftPercent100thsAttribute(position);
+                coverCluster.setCurrentPositionLiftPercent100thsAttribute(position);
+                coverCluster.setOperationalStatusAttribute({
+                    global: WindowCovering.MovementStatus.Stopped,
+                    lift: WindowCovering.MovementStatus.Stopped,
+                    tilt: WindowCovering.MovementStatus.Stopped,
+                });
+                this.log.warn(`Set liftPercent100thsValue to ${position}`);
+            }
+        }, 10 * 1000);
+    }
+    onShutdown() {
+        this.log.info('onShutdown called');
+    }
+}
+//# sourceMappingURL=platform.js.map

package/dist/platform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.js","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAElE,OAAO,EAAgB,kBAAkB,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AAEnH,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAE7F,MAAM,OAAO,oCAAqC,SAAQ,6BAA6B;IACrF,YAAY,YAA0B,EAAE,GAAe;QACrD,KAAK,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEQ,wBAAwB;QAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QAEjD,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAClE,KAAK,CAAC,kCAAkC,EAAE,CAAC;QAC3C,KAAK,CAAC,0CAA0C,CAAC,SAAS,EAAE,sBAAsB,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QACzH,KAAK,CAAC,wCAAwC,CAAC,KAAK,CAAC,CAAC;QACtD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE3B,KAAK,CAAC,iBAAiB,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;YAC1E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,YAAY,EAAE,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,sBAAsB,EAAE,EAAE,EAAE,EAAE;YAC9F,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4DAA4D,sBAAsB,EAAE,CAAC,CAAC;QACtG,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,GAAG,EAAE;YACf,MAAM,YAAY,GAAG,KAAK,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC/I,IAAI,YAAY,IAAI,YAAY,CAAC,4CAA4C,EAAE,CAAC;gBAC9E,IAAI,QAAQ,GAAG,YAAY,CAAC,4CAA4C,EAAG,GAAG,IAAI,CAAC;gBACnF,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAC3C,YAAY,CAAC,2CAA2C,CAAC,QAAQ,CAAC,CAAC;gBACnE,YAAY,CAAC,4CAA4C,CAAC,QAAQ,CAAC,CAAC;gBACpE,YAAY,CAAC,6BAA6B,CAAC;oBACzC,MAAM,EAAE,cAAc,CAAC,cAAc,CAAC,OAAO;oBAC7C,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC,OAAO;oBAC3C,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC,OAAO;iBAC5C,CAAC,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iCAAiC,QAAQ,EAAE,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAChB,CAAC;IAEQ,UAAU;QACjB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrC,CAAC;CACF"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "matterbridge-example-accessory-platform",
+  "version": "1.0.0",
+  "description": "Matterbridge accessory platform plugin example",
+  "author": "https://github.com/Luligu",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Luligu/matterbridge-example-accessory-platform"
+  },
+  "bugs": {
+    "url": "https://github.com/Luligu/matterbridge-example-accessory-platform/issues"
+  },
+  "keywords": [
+    "matterbridge",
+    "homebridge",
+    "matter",
+    "matter.js"
+  ],
+  "engines": {
+    "node": "^18.19.0 || ^20.11.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "start": "node ./dist/index.js",
+    "test": "jest",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch",
+    "lint": "eslint src/**.ts",
+    "lint:fix": "eslint src/**.ts --fix",
+    "format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,css,md}\"",
+    "format:check": "prettier --check \"src/**/*.{js,jsx,ts,tsx,json,css,md}\"",
+    "clean": "rimraf tsconfig.tsbuildinfo ./dist",
+    "cleanBuild": "npm run clean && tsc",
+    "deepClean": "rimraf tsconfig.tsbuildinfo package-lock.json ./dist ./node_modules",
+    "prepublishOnly": "npm run lint && npm run cleanBuild",
+    "checkDependencies": "npx npm-check-updates",
+    "updateDependencies": "npx npm-check-updates -u",
+    "updateMatter": "npm install @project-chip/matter.js@dev && npm install @project-chip/matter-node.js@dev && npm install @project-chip/matter.js-tools@dev && npm install @project-chip/matter-node-ble.js@dev"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^1.6.2",
+    "@tsconfig/node-lts": "^20.1.1",
+    "@types/node": "^20.11.20",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "prettier": "^3.2.5",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@project-chip/matter-node.js": "^0.7.5",
+    "node-ansi-logger": "^1.9.1",
+    "node-persist-manager": "^1.0.3"
+  }
+}