Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@home-assistant-matter-hub/core

t0bst4r45Apache-2.0deprecated2.7.2TypeScript support: included

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Expose your Home Assistant instance as a Matter device hub.

matter, home, assistant, home assistant, home-assistant, homeassistant

readme

Publish your Home Assistant Instance as a Matter-Hub


This project provides an application to connect Home Assistant to any matter enabled controller like Alexa, Google Home or Apple Home.

"Buy Me A Coffee"


Project Structure

This project consists of two packages with different purposes. Both utilize matterbridge.

  1. @home-assistant-matter-hub/core integrate Home Assistant with Matter. At the moment this package is not an application on its own. It is used by matterbridge-home-assistant to connect with home assistant.
  2. matterbridge-home-assistant provides a matterbridge plugin, which finally connects Home Assistant with any matter enabled controller

Installation

Manual or Docker installation

Please follow the installation instructions to install matterbridge-home-assistant.

Home Assistant Addon Installation (Home Assistant OS only)

This project is also built into a native Home Assistant Addon. Please follow these instructions to install the Addon.

Contribution, Bug Reports and Enhancements

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the contribution guideline for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved.

Please also review the code of conduct.

The community looks forward to your contributions. 🎉

Contributors

t0bst4r bassrock

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.7.2 (2024-08-23)

🚀 Chore

  • deps: update all dependencies (2c27241)

2.7.1 (2024-08-17)

🚀 Chore

  • expose SSL port in Dockerfile and enable SSL in matterbridge o… (#265) (dc2b5e4)

2.7.0 (2024-08-16)

✨ Features

  • climate: enable basic support for climate devices (#47) (6ffebb3)

2.6.2 (2024-08-14)

🐛 Bug Fixes

  • sensor: add NaN check to temperature and humidity sensors (#264) (be15131)

2.6.1 (2024-08-14)

🐛 Bug Fixes

  • matterbridge: patch NodeAnsiLogger until fix is provided by matterbridge (#262) (09b8914)

2.6.0 (2024-08-13)

✨ Features

  • sensor: add humidity & temperature sensor (f730905)

2.5.6 (2024-08-07)

🐛 Bug Fixes

  • ci: use full sha for docker builds (edd97c5)

2.5.5 (2024-08-07)

🐛 Bug Fixes

  • ci: minor pipeline fixes (2fb30c8)

2.5.4 (2024-08-07)

🐛 Bug Fixes

  • ci: split release into multiple jobs (095aed4)

2.5.3 (2024-08-07)

🐛 Bug Fixes

  • level-control: add more re-usable null checks (#253) (6ab2d9c)

2.5.2 (2024-08-05)

🐛 Bug Fixes

  • add publish config to scoped packages (8551f4f)

2.5.1 (2024-08-05)

🐛 Bug Fixes

2.5.0 (2024-08-05)

✨ Features

  • refactored core implementation to not use matterbridge anymore (ccb6656)

2.4.0 (2024-08-03)

✨ Features

  • fan: add support for fans as dimmable switch (#70) (38ee981)

2.3.5 (2024-08-02)

🐛 Bug Fixes

  • cover: support configuration of single or all covers (#234) (0a908da)

2.3.4 (2024-08-02)

🐛 Bug Fixes

  • update renovate config and setup pre-commit hooks (23cb179)

2.3.3 (2024-08-01)

🐛 Bug Fixes

  • only include included entities into warnings (#238) (4a0e8f2)

2.3.2 (2024-08-01)

🐛 Bug Fixes

2.3.1 (2024-07-29)

🐛 Bug Fixes

2.3.0 (2024-07-28)

✨ Features

  • cover: add basic support for covers (#86) (c6d3fac)

2.2.0 (2024-07-28)

✨ Features

  • docker: allow specifiying matter and frontend ports (#229) (2fd1b5a)

2.1.3 (2024-07-28)

🐛 Bug Fixes

  • improved documentation and logging (3751d10)

2.1.2 (2024-07-27)

🐛 Bug Fixes

  • revert conventional changelog to 7.x (#222) (b1fd8a3)

2.1.1 (2024-07-26)

🚀 Chore

  • add more detailed manual installation instructions (#214) (b6d25fe)

2.1.0 (2024-07-24)

✨ Features

2.0.3 (2024-07-24)

🐛 Bug Fixes

  • remove legacy peer deps (07ca7a4)

2.0.2 (2024-07-24)

🐛 Bug Fixes

  • remove failure state from docker-entrypoint (3175127)

2.0.1 (2024-07-24)

🚀 Chore

  • update node-types to 20 (45bdaa6)

2.0.0 (2024-07-24)

⚠ BREAKING CHANGES

  • Version 2 requires several configuration changes. See the documentation for more details.

  • In version 1.x matterbridge was not listed as a dependencies or peerDependency. This has been changed in version 2.0.0. It is now listed as a peer dependency. When installed in a local package.json file, this is not a problem. But since matterbridge installs all its plugins globally, this will lead to an error running matterbridge with matterbridge-home-assistant, because of npm's "new" (>= 7) strategy for peer-dependencies. To solve this, you need to enable legacy-peer-deps in your npm config (npm config set legacy-peer-deps true) or in an environment variable (npm_config_legacy_peer_deps=true). In the pre-built docker image and the native Home Assistant Addon, this is already configured.

  • In version 1.x this plugin was meant to be configured using multiple environment variables. Due to the growing number of configuration options, this has been changed. This plugin requires to be configured using a configuration JSON file or one single environment variable containing the whole JSON configuration. Please see the configuration section in the projects readme.

✨ Features

  • split matterbridge-home-assistant into multiple libraries (3b87b78)