https://github.com/luligu/matterbridge-hass
Matterbridge Home Assistant plugin
https://github.com/luligu/matterbridge-hass
Last synced: 5 months ago
JSON representation
Matterbridge Home Assistant plugin
- Host: GitHub
- URL: https://github.com/luligu/matterbridge-hass
- Owner: Luligu
- License: apache-2.0
- Created: 2024-09-13T20:32:24.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-03T21:30:04.000Z (5 months ago)
- Last Synced: 2024-12-03T21:40:29.565Z (5 months ago)
- Language: TypeScript
- Size: 504 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# 
Matterbridge Home Assistant plugin
[](https://www.npmjs.com/package/matterbridge-hass)
[](https://www.npmjs.com/package/matterbridge-hass)
[](https://hub.docker.com/r/luligu/matterbridge)
[](https://hub.docker.com/r/luligu/matterbridge)
[](https://www.npmjs.com/package/matterbridge)
[](https://www.npmjs.com/package/node-ansi-logger)
[](https://www.npmjs.com/package/node-persist-manager)
---
Work in progress, this release is still at development stage!
Other device types will be added each new release.
This plugin allows you to expose the Home Assistant devices to Matter.
It is the ideal companion of the official [Matterbridge Home Assistant Add-on](https://github.com/Luligu/matterbridge-home-assistant-addon/blob/main/README.md).
Features:
- the plugin can run with Matterbridge running in the Matterbridge Official Add-on or outside Home Assistant.
- the connection with Home Assistant is made throught WebSocket: so Matterbridge can be also in another network if the Home Assistant host is reachable.
Supported devices:
- switch (with state on/off)
- light (with state on/off and attributes brightness/color_mode/color_temp/hs_color/xy_color)
- lock (with state locked/locking/unlocking/unlocked)
- fan (with state on/off and attributes percentage/preset_mode)
- cover (with state open/close/opening/closing and attribute current_position)
> **Warning:** Since this plugin takes the devices from Home Assistant, it cannot be paired back to Home Assistant. This would lead to duplicate devices! If you run Matterbridge like a Home Assistant Add-on and also use other plugins to expose their devices to Home Assistant, then change to child bridge mode and pair the other plugins to Home Assistant and this plugin wherever you need it.
If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-hass and sponsoring it.
## Prerequisites
### Matterbridge
Follow these steps to install or update Matterbridge if it is not already installed and up to date:
```
npm install -g matterbridge --omit=dev
```
on Linux you may need the necessary permissions:
```
sudo npm install -g matterbridge --omit=dev
```
See the complete guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob/main/README.md) for more information.
## How to install the plugin
### With the frontend (preferred method)
Just open the frontend, select the matterbridge-hass plugin and click on install. If you are using Matterbridge with Docker (I suggest you do it), all plugins are already loaded in the container so you just need to select and add it.
### Without the frontend
On windows:
```
cd $HOME\Matterbridge
npm install -g matterbridge-hass --omit=dev
matterbridge -add matterbridge-hass
```
On linux:
```
cd ~/Matterbridge
sudo npm install -g matterbridge-hass --omit=dev
matterbridge -add matterbridge-hass
```
Then start Matterbridge from a terminal
```
matterbridge
```
## How to use it
You may need to set some config values in the frontend (wait that the plugin has been configured before changing the config):
I suggest to use the whiteList adding each device you want to expose to Matter
If any device creates issues put it in the blackList.
### host
Your Home Assistance address (eg. http://homeassistant.local:8123 or http://IP-ADDRESS:8123). It is better to use the IP if it is stable.
### token
Home Assistant long term token used to connect to Home Assistant with WebSocket. Click on your user name in the bottom left corner of the Home Assistand frontend, then Security and create a Long-Lived Access Tokens.
### whiteList
If the whiteList is defined only the devices included are exposed to Matter.
### blackList
If the blackList is defined the devices included will not be exposed to Matter.
### debug
Should be enabled only if you want to debug some issue using the log.
### unregisterOnShutdown
Should be enabled only if you want to remove the devices from the controllers on shutdown.