matterbridge-eve-door 1.0.2

package/README.md

@@ -0,0 +1,15 @@
+# <img src="https://github.com/Luligu/matterbridge/blob/main/frontend/public/matterbridge%2064x64.png" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge eve door with history
+
+[![npm version](https://img.shields.io/npm/v/matterbridge-eve-door.svg)](https://www.npmjs.com/package/matterbridge-eve-door)
+[![npm downloads](https://img.shields.io/npm/dt/matterbridge-eve-door.svg)](https://www.npmjs.com/package/matterbridge-eve-door)
+
+[![power by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge)
+[![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
+[![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
+[![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
+
+---
+
+This plugin shows how to use the Matter history and how to create passive device in matter.js.
+
+It create a contact sensor device that continuously changes state.

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { Matterbridge, PlatformConfig } from 'matterbridge';
+import { AnsiLogger } from 'node-ansi-logger';
+import { EveDoorPlatform } 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, config: PlatformConfig): EveDoorPlatform;
+//# 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":"AAAA,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,mBAE3G"}

package/dist/index.js

@@ -0,0 +1,11 @@
+import { EveDoorPlatform } 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, config) {
+    return new EveDoorPlatform(matterbridge, log, config);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,YAA0B,EAAE,GAAe,EAAE,MAAsB;IAC1G,OAAO,IAAI,eAAe,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AACxD,CAAC"}

package/dist/platform.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" resolution-mode="require"/>
+import { PlatformConfig } from 'matterbridge';
+import { Matterbridge, MatterbridgeDevice, MatterbridgeAccessoryPlatform, MatterHistory } from 'matterbridge';
+import { AnsiLogger } from 'node-ansi-logger';
+export declare class EveDoorPlatform extends MatterbridgeAccessoryPlatform {
+    door: MatterbridgeDevice | undefined;
+    history: MatterHistory | undefined;
+    interval: NodeJS.Timeout | undefined;
+    constructor(matterbridge: Matterbridge, log: AnsiLogger, config: PlatformConfig);
+    onStart(reason?: string): Promise<void>;
+    onConfigure(): Promise<void>;
+    onShutdown(reason?: string): Promise<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":";AAAA,OAAO,EAA6B,cAAc,EAAE,MAAM,cAAc,CAAC;AAEzE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC9G,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,qBAAa,eAAgB,SAAQ,6BAA6B;IAChE,IAAI,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACrC,OAAO,EAAE,aAAa,GAAG,SAAS,CAAC;IACnC,QAAQ,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;gBAEzB,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc;IAIhE,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;IAyBvB,WAAW;IAmBX,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM;CAK1C"}

package/dist/platform.js

@@ -0,0 +1,50 @@
+import { DeviceTypes, BooleanState } from 'matterbridge';
+import { MatterbridgeDevice, MatterbridgeAccessoryPlatform, MatterHistory } from 'matterbridge';
+export class EveDoorPlatform extends MatterbridgeAccessoryPlatform {
+    door;
+    history;
+    interval;
+    constructor(matterbridge, log, config) {
+        super(matterbridge, log, config);
+    }
+    async onStart(reason) {
+        this.log.info('onStart called with reason:', reason ?? 'none');
+        this.history = new MatterHistory(this.log, 'Eve door', { filePath: this.matterbridge.matterbridgeDirectory });
+        this.door = new MatterbridgeDevice(DeviceTypes.CONTACT_SENSOR);
+        this.door.createDefaultIdentifyClusterServer();
+        this.door.createDefaultBasicInformationClusterServer('Eve door', '0x88030475', 4874, 'Eve Systems', 77, 'Eve Door 20EBN9901', 1144, '1.2.8');
+        this.door.createDefaultBooleanStateClusterServer(true);
+        this.door.createDefaultPowerSourceReplaceableBatteryClusterServer(75);
+        this.door.createDefaultPowerSourceConfigurationClusterServer(1);
+        // Add the EveHistory cluster to the device as last cluster!
+        this.door.createDoorEveHistoryClusterServer(this.history, this.log);
+        this.history.autoPilot(this.door);
+        await this.registerDevice(this.door);
+        this.door.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
+            this.log.warn(`Command identify called identifyTime:${identifyTime}`);
+            this.history?.logHistory(false);
+        });
+    }
+    async onConfigure() {
+        this.log.info('onConfigure called');
+        this.interval = setInterval(() => {
+            if (!this.door || !this.history)
+                return;
+            let contact = this.door.getClusterServerById(BooleanState.Cluster.id)?.getStateValueAttribute();
+            contact = !contact;
+            this.door.getClusterServerById(BooleanState.Cluster.id)?.setStateValueAttribute(contact);
+            this.door.getClusterServerById(BooleanState.Cluster.id)?.triggerStateChangeEvent({ stateValue: contact });
+            if (contact === false)
+                this.history.addToTimesOpened();
+            this.history.setLastEvent();
+            this.history.addEntry({ time: this.history.now(), contact: contact === true ? 0 : 1 });
+            this.log.info(`Set contact to ${contact}`);
+        }, 60 * 1000 + 100);
+    }
+    async onShutdown(reason) {
+        this.log.info('onShutdown called with reason:', reason ?? 'none');
+        await this.history?.close();
+        clearInterval(this.interval);
+    }
+}
+//# 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,YAAY,EAAkB,MAAM,cAAc,CAAC;AAEzE,OAAO,EAAgB,kBAAkB,EAAE,6BAA6B,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG9G,MAAM,OAAO,eAAgB,SAAQ,6BAA6B;IAChE,IAAI,CAAiC;IACrC,OAAO,CAA4B;IACnC,QAAQ,CAA6B;IAErC,YAAY,YAA0B,EAAE,GAAe,EAAE,MAAsB;QAC7E,KAAK,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IACnC,CAAC;IAEQ,KAAK,CAAC,OAAO,CAAC,MAAe;QACpC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC;QAE/D,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAE9G,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAkB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC;QAC/C,IAAI,CAAC,IAAI,CAAC,0CAA0C,CAAC,UAAU,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7I,IAAI,CAAC,IAAI,CAAC,sCAAsC,CAAC,IAAI,CAAC,CAAC;QAEvD,IAAI,CAAC,IAAI,CAAC,uDAAuD,CAAC,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC,CAAC,CAAC;QAEhE,4DAA4D;QAC5D,IAAI,CAAC,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACpE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAElC,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAErC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE;YAC9E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wCAAwC,YAAY,EAAE,CAAC,CAAC;YACtE,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAEQ,KAAK,CAAC,WAAW;QACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAEpC,IAAI,CAAC,QAAQ,GAAG,WAAW,CACzB,GAAG,EAAE;YACH,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,OAAO;YACxC,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,sBAAsB,EAAE,CAAC;YAChG,OAAO,GAAG,CAAC,OAAO,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAC;YACzF,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,uBAAuB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1G,IAAI,OAAO,KAAK,KAAK;gBAAE,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACvF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAC;QAC7C,CAAC,EACD,EAAE,GAAG,IAAI,GAAG,GAAG,CAChB,CAAC;IACJ,CAAC;IAEQ,KAAK,CAAC,UAAU,CAAC,MAAe;QACvC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gCAAgC,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC;QAClE,MAAM,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC;QAC5B,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;CACF"}

package/link-matterbridge-script.js

@@ -0,0 +1,14 @@
+import { exec } from 'child_process';
+
+const command = process.platform === 'win32' ? 'npm link matterbridge' : 'sudo npm link matterbridge';
+
+exec(command, (error, stdout, stderr) => {
+  if (error) {
+    console.error(`exec error: ${error}`);
+    return;
+  }
+  console.log(`stdout: ${stdout}`);
+  if (stderr) {
+    console.error(`stderr: ${stderr}`);
+  }
+});

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "matterbridge-eve-door",
+  "version": "1.0.2",
+  "description": "Matterbridge eve door with history",
+  "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-eve-door"
+  },
+  "bugs": {
+    "url": "https://github.com/Luligu/matterbridge-eve-door/issues"
+  },
+  "keywords": [
+    "matterbridge",
+    "homebridge",
+    "matter",
+    "matter.js",
+    "plugin",
+    "eve",
+    "door",
+    "history"
+  ],
+  "engines": {
+    "node": "^18.19.0 || ^20.11.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "start:bridge": "matterbridge -bridge",
+    "start:childbridge": "matterbridge -childbridge",
+    "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",
+    "matterbridge:add": "matterbridge -add .\\",
+    "matterbridge:remove": "matterbridge -remove .\\",
+    "matterbridge:enable": "matterbridge -enable .\\",
+    "matterbridge:disable": "matterbridge -disable .\\",
+    "matterbridge:list": "matterbridge -list",
+    "dev:link": "npm link --save-dev matterbridge",
+    "dev:install": "npm install --save-dev matterbridge",
+    "dev:uninstall": "npm uninstall matterbridge && npm unlink matterbridge",
+    "install": "node link-matterbridge-script.js"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^1.7.0",
+    "@tsconfig/node-lts": "^20.1.2",
+    "@types/node": "^20.11.30",
+    "@typescript-eslint/eslint-plugin": "^7.3.1",
+    "@typescript-eslint/parser": "^7.3.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "prettier": "^3.2.5",
+    "typescript": "^5.4.3"
+  },
+  "dependencies": {
+    "node-ansi-logger": "^1.9.2"
+  }
+}