Detalhes do pacote

matterbridge-example-dynamic-platform

Luligu2.1kApache-2.01.3.12

Matterbridge dynamic plugin

matterbridge, homebridge, matter, matter.js

readme (leia-me)

Matterbridge dynamic platform example plugin

Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.

It exposes 56 virtual devices:

a door contact sensor
a motion sensor
an illuminance sensor
a temperature sensor
an humidity sensor
a pressure sensor
a flow sensor
a climate sensor with temperature, humidity and pressure
a mode select device
a switch with onOff cluster
a light with onOff
a light with onOff and levelControl (dimmer)
a light with onOff, levelControl and colorControl (with XY, HS and CT) clusters
a light with onOff, levelControl and colorControl (with HS and CT) clusters
a light with onOff, levelControl and colorControl (with XY and CT) clusters
a light with onOff, levelControl and colorControl (with CT only) clusters
an outlet (plug) with onOff cluster
a cover with windowCovering cluster and lift feature
a cover with windowCovering cluster and both lift and tilt features
a lock with doorLock cluster
a thermo autoMode (i.e. with Auto Heat and Cool features) with thermostat cluster and 3 sub endpoints with flowMeasurement cluster, temperatureMeasurement cluster and relativeHumidityMeasurement cluster (to show how to create a composed device with sub endpoints)
a thermo heat only with two external temperature sensors (tagged like Indoor and Outdoor)
a thermo cool only
a fan with Off High presets
a fan with Off Low Med High presets
a fan with Off Low Med High Auto presets and step
a fan with all the features MultiSpeed, Auto, Step, Rock, Wind and AirflowDirection and mode Off Low Med High Auto.
a rainSensor device
a waterFreezeDetector device
a waterLeakDetector device
a smokeCoAlarm (with smoke and co features) sensor (supported by Apple Home)
a smokeCoAlarm (with smoke only feature) sensor (supported by Apple Home)
a smokeCoAlarm (with co only feature) sensor (supported by Apple Home)
an airConditioner device
an airPurifier device with temperature and humidity sensor (supported by Apple Home)
a pumpDevice device
a waterValve device
an airQuality device with all concentration measurements clusters (supported by Apple Home with the concentration measurements from version 18.5)
a momentary switch composed by three switches with Single Double Long (tagged with One Two Three and Top Middle Bottom) and three switches with Single only.
a latching switch
a Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read also https://github.com/Luligu/matterbridge/discussions/264.
a onOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
a dimmer Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
a laundry Washer device (supported by SmartThings, Alexa and Home Assistant)
a laundry Dryer device (supported by SmartThings, Alexa and Home Assistant)
a dishwasher device (supported by SmartThings, Alexa and Home Assistant)
a refrigerator device (supported by SmartThings, Alexa and Home Assistant)
an oven device (supported by SmartThings, Alexa and Home Assistant)
a microwave Oven device (supported by SmartThings, Alexa and Home Assistant)
an extractor Hood device (supported by SmartThings, Alexa and Home Assistant)
a cooktop device (supported by SmartThings, Alexa and Home Assistant)
a water heater device (supported by SmartThings and Home Assistant)
a car charger device (supported by Home Assistant)
a solar power device
a battery storage device
a heat pump device
a speaker device (supported by SmartThings)

All these devices continuously change state and position. The plugin also shows how to use all the command handlers (you can control all the devices), how to subscribe to attributes and how to trigger events.

If you want to write your plugin, the easiest way to start create a new plugin is to clone the Matterbridge Plugin Template which has Dev Container support for instant development environment and all tools and extensions (like Node.js, npm, TypeScript, ESLint, Prettier, Jest and Vitest) already loaded and configured.

If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.

Prerequisites

Matterbridge

See the guidelines on Matterbridge for more information.

Style guide

See also the Style Guide for JSDoc, naming and logging conventions used in this repository.

changelog (log de mudanças)

Matterbridge dynamic platform example plugin changelog

All notable changes to this project will be documented in this file.

If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.

[1.3.12] - 2025-09-14

Added

[jest]: Added jest helper module v. 1.0.5.
[rvc]: Added DustBinFull to the Rvc animation (https://github.com/Luligu/matterbridge-example-dynamic-platform/pull/31).

Changed

[package]: Updated dependencies.
[package]: Updated to Automator v. 2.0.6.
[workflows]: Ignore any .md anywhere.

[1.3.11] - 2025-09-09

Changed

[package]: Updated dependencies.
[platform]: Removed attributes setting when is managed by the Matterbridge servers. This add support for Apple Home Adaptive Lighting. See https://github.com/Luligu/matterbridge/discussions/390.

[1.3.10] - 2025-09-06

Added

[platform]: Added AirConditioner device class from Matterbridge.
[platform]: Added a Speaker device type.
[platform]: Added estimatedEndTime to Rvc animation.

Changed

[package]: Updated dependencies.
[package]: Required matterbridge 3.2.6.

[1.3.9] - 2025-08-30

Added

[platform]: Added a door contact sensor
[platform]: Added a motion sensor
[platform]: Added an illuminance sensor
[platform]: Added a temperature sensor
[platform]: Added an humidity sensor
[platform]: Added a pressure sensor
[platform]: Added a flow sensor
[platform]: Added a climate sensor with temperature, humidity and pressure
[platform]: Added a mode select device
[platform]: Added animation in 10 phases for refrigerator
[platform]: Added animation in 10 phases for oven
[platform]: Added animation in 10 phases for rvc

Changed

[package]: Updated dependencies.
[package]: Updated to Automator v. 2.0.5.
[devContainer]: Updated devContainer with repository name for the container and shallow clone matterbridge for speed and memory optimization.
[package]: Required matterbridge 3.2.5.

[1.3.8] - 2025-08-20

Added

[rvc]: Removed the supportedMaps workaround for the RVC maps. Thanks Ludovic BOUÉ (#25).
[platform]: Added the new MicrowaveOven() device class from Matterbridge.
[platform]: Added the new Oven() device class from Matterbridge.
[platform]: Added the new Cooktop() device class from Matterbridge.
[platform]: Added the new Refrigerator() device class from Matterbridge.
[platform]: Added the RefrigeratorTag to the Refrigerator(). Thanks Ludovic BOUÉ (#27).

Changed

[package]: Updated dependencies.
[package]: Required matterbridge 3.2.3.

[1.3.7] - 2025-08-01

Added

[airquality]: Added support of Concentration Measurements for Home app.

Changed

[package]: Updated dependencies.

Fixed

[platform]: Fixed missed softwareVersion and hardwareVersion. Thanks Tamer.
[platform]: Fixed missed BridgedDeviceBasicInformation cluster for single class devices. Thanks Tamer.

[1.3.6] - 2025-07-25

Added

[platform]: Added a Fan with Off High.
[momentary]: Added 3 other child endpoint to the Momentary Switch to show createDefaultMomentarySwitchClusterServer(). It creates a single click only switch. It is supported by the Home app.
[platform]: Refactor platform code to improve readability.

Changed

[package]: Updated dependencies.
[package]: Required matterbridge 3.1.7.

[1.3.5] - 2025-07-22

Added

[platform]: Changed to the new ExtratorHood() and Dishwasher() from Matterbridge.
[platform]: Added a Fan with On Off Low Med High.
[platform]: Added a Fan with complete set of features.

Changed

[package]: Updated dependencies.
[package]: Required matterbridge 3.1.6.

[1.3.3] - 2025-07-20

Added

[platform]: Add RVC supportedMaps attribute. Thanks Ludovic BOUÉ (#21).

Changed

[package]: Updated dependencies.
[package]: Required matterbridge 3.1.5.

[1.3.2] - 2025-07-06

Added

[platform]: Add by default Rvc in mode server for Apple Home issue.

Changed

[package]: Updated dependencies.
[package]: Require matterbridge 3.1.2.

[1.3.1] - 2025-07-04

Added

[platform]: Added solarPower device type (not supported by the Home app).
[platform]: Added batteryStoraga device type (not supported by the Home app).
[platform]: Added heatPump device type (not supported by the Home app).

Changed

[platform]: Changed imports from matterbridge/devices.
[package]: Require matterbridge 3.1.1.

[1.3.0] - 2025-06-25

Added

[DevContainer]: Added support for the Matterbridge Dev Container with an optimized named volume for node_modules.
[GitHub]: Added GitHub issue templates for bug reports and feature requests.
[ESLint]: Refactored the flat config.
[ESLint]: Added the plugins eslint-plugin-promise, eslint-plugin-jsdoc, and @vitest/eslint-plugin.
[Jest]: Refactored the flat config.
[Vitest]: Added Vitest for TypeScript project testing. It will replace Jest, which does not work correctly with ESM module mocks.
[JSDoc]: Added missing JSDoc comments, including @param and @returns tags.
[CodeQL]: Added CodeQL badge in the readme.
[Codecov]: Added Codecov badge in the readme.

Changed

[package]: Require matterbridge 3.0.6.
[package]: Updated package to Automator v. 2.0.1.
[package]: Updated dependencies.
[storage]: Bumped node-storage-manager to 2.0.0.
[logger]: Bumped node-ansi-logger to 3.1.1.

[1.2.4] - 2025-06-13

Added

[npm]: The dev of matterbridge-example-dynamic-platform is published with tag dev on npm each day at 00:00 UTC if there is a new commit.

Changed

[package]: Require matterbridge 3.0.6.
[package]: Updated package.
[package]: Updated dependencies.
[subscribe]: Prevent attribute setting when context is offline for air purifier and fan.

[1.2.3] - 2025-05-25

Added

[platform]: Added a cover device with both lift and tilt (supported by the Home app).
[platform]: Added evse (EV charger) device type (not supported by the Home app).

Changed

[package]: Require matterbridge 3.0.5.
[package]: Updated package.
[package]: Updated dependencies.

[1.2.2] - 2025-05-19

Added

[package]: Added waterHeater device type (not supported by Alexa and Apple Home)

Changed

[package]: Changed the RVC from local implementation to the new RoboticVacuumCleaner class from matterbridge.
[package]: Require matterbridge 3.0.3.
[package]: Updated package.
[package]: Updated dependencies.

[1.2.1] - 2025-05-15

Changed

[package]: Require matterbridge 3.0.1.
[package]: Updated package.
[package]: Updated dependencies.

[1.2.0] - 2025-04-30

Added

[platform]: Added Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read carefully the readme please and also https://github.com/Luligu/matterbridge/discussions/264.
[platform]: Added OnOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant).
[platform]: Added Dimmer Mounted Switch device (supported by SmartThings, Alexa, Home Assistant).
[platform]: Added Laundry Washer device (supported by SmartThings, Alexa and Home Assistant).
[platform]: Added Laundry Dryer device (supported by SmartThings, Alexa and Home Assistant).
[platform]: Added Dishwasher device (supported by SmartThings, Alexa and Home Assistant).
[platform]: Added Refrigerator device (supported by SmartThings, Alexa and Home Assistant).
[platform]: Added Oven device (supported by SmartThings, Alexa and Home Assistant).
[platform]: Added Microwave Oven device (supported by SmartThings, Alexa and Home Assistant).
[platform]: Added Extractor Hood device (supported by SmartThings, Alexa and Home Assistant).
[platform]: Added Cooktop device (supported by SmartThings, Alexa and Home Assistant).

Changed

[package]: Require matterbridge 3.0.0.
[package]: Updated package.
[package]: Updated dependencies.

[1.1.9] - 2025-04-07

Added

[platform]: Added select devices for the frontend Devices panel in the home page.
[config]: Added enableConcentrationMeasurements option to fix the Apple Home issue: Air Quality devices and all SmokeCoAlarm sensors (with or without Smoke and Co) don't show up in the Home app if any of the concentration measurements clusters is present (Carbon Monoxide Concentration Measurements included).
[platform]: Added smoke only SmokeCoAlarm sensor (supported by Apple Home 18.4).
[platform]: Added co only SmokeCoAlarm sensor (supported by Apple Home 18.4).

Changed

[package]: Require matterbridge 2.2.7.
[package]: Updated package.
[package]: Updated dependencies.

[1.1.8] - 2025-03-05

Changed

[package]: Require matterbridge 2.2.0.
[package]: Updated package.
[package]: Updated dependencies.

[1.1.7] - 2025-02-11

Added

[platform]: Added generic momentary switch device.
[platform]: Added generic latching switch device.
[platform]: Added chaining provided by the new MatterbridgeEndpoint api.

Changed

[package]: Updated package.
[package]: Updated dependencies.
[package]: Require matterbridge 2.1.5.

[1.1.6] - 2025-02-02

Changed

[package]: Require matterbridge 2.1.0.
[package]: Updated dependencies.

[1.1.4] - 2024-12-21

Added

[platform]: Added call to super.OnConfigure() and super.OnShutDown() to check endpoints numbers.

Changed

[package]: Updated dependencies.
[package]: Updated package.

Fixed

[thermostat]: Fixed temperature

[1.1.3] - 2024-12-16

Added

[package]: Added thermostat Heat only with two external temperature sensors (tagged like Indoor and Outdoor).
[package]: Added thermostat Cool only.
[package]: Added an airPurifier device with temperature and humidity sensor (supported by Apple Home).
[package]: Added a pumpDevice device.
[package]: Added a waterValve device.

Changed

[package]: Require matterbridge 1.6.7.
[package]: Updated dependencies.

[1.1.2] - 2024-12-12

Added

[package]: Added the Matter 1.3 airConditioner device (not supported by Apple Home).
[package]: Require matterbridge 1.6.6.
[package]: Added Jest test with 100% coverage.