From b6d25fe569ae6243860a25784271c423c0cf2aab Mon Sep 17 00:00:00 2001 From: Tobias Glatthar Date: Thu, 25 Jul 2024 07:31:38 +0200 Subject: [PATCH] chore: add more detailed manual installation instructions (#214) --- .../matterbridge-home-assistant/README.md | 34 ++++++++++++++++--- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/packages/matterbridge-home-assistant/README.md b/packages/matterbridge-home-assistant/README.md index 012a4d9..aea23c7 100644 --- a/packages/matterbridge-home-assistant/README.md +++ b/packages/matterbridge-home-assistant/README.md @@ -20,15 +20,37 @@ connect [HomeAssistant](https://www.home-assistant.io/) to [Matterbridge](https: ## Installation -### Manual Setup +### Manual Setup / Global installation -- Follow [those instructions](https://github.com/Luligu/matterbridge/?tab=readme-ov-file#installation) to set - up `matterbridge`. -- Install the plugin `npm install -g matterbridge-home-assistant` +- Install matterbridge and the plugin `npm install -g matterbridge matterbridge-home-assistant` - Make sure the plugin is configured properly (see [Configuration](#configuration)). - Activate the plugin `matterbridge -add matterbridge-home-assistant` - Start matterbridge using `matterbridge -bridge` +If you are getting the error message `Only supported EndpointInterface implementation is Endpoint`: +- This is caused by npm's module resolution of globally installed modules and project-chip's way of doing an `instanceOf` check. +- It happens when matterbridge and matterbridge-home-assistant are not installed in **one** install command as above. + +### Manual installation / using a package.json + +- create a new working directory +- create a `package.json` with the following content +```json +{ + "dependencies": { + "matterbridge": "^1.4.0", + "matterbridge-home-assistant": "^2.0.3" + }, + "scripts": { + "register": "matterbridge -add ./node_modules/matterbridge-home-assistant", + "start": "matterbridge -bridge" + } +} +``` +- run `npm run register` and `npm run start` + +**Important: ** this method does not allow installing or updating matterbridge plugins using the UI! + ### Home Assistant Add-On Follow the [Home Assistant Add-On Repository](https://github.com/t0bst4r/matterbridge-home-assistant-addon) to install @@ -199,6 +221,10 @@ Both are only checked once during startup, so changes will apply after restartin hidden state of an entity (can be found in the entity details in Home Assistant). Both are only checked once during startup, so changes will apply after restarting Matterbridge. +### I am getting this error message `Only supported EndpointInterface implementation is Endpoint`: +- This is caused by npm's module resolution of globally installed modules and project-chip's way of doing an `instanceOf` check. +- It happens when matterbridge and matterbridge-home-assistant are not installed in **one** install command as above. See the [installation section](#installation) above. + ## Contribution, Bug Reports and Enhancements Please head over to the [GitHub Repository](https://github.com/t0bst4r/matterbridge-home-assistant) and review the