https://github.com/luligu/matterbridge-example-dynamic-platform

Matterbridge dynamic platform plugin example
https://github.com/luligu/matterbridge-example-dynamic-platform

Last synced: about 14 hours ago
JSON representation

Matterbridge dynamic platform plugin example

• Host: GitHub
• URL: https://github.com/luligu/matterbridge-example-dynamic-platform
• Owner: Luligu
• Created: 2024-02-24T10:56:23.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-13T21:03:40.000Z (6 months ago)
• Last Synced: 2024-04-14T11:00:17.827Z (6 months ago)
• Language: TypeScript
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
#    Matterbridge dynamic platform example plugin

[![npm version](https://img.shields.io/npm/v/matterbridge-example-dynamic-platform.svg)](https://www.npmjs.com/package/matterbridge-example-dynamic-platform)

[![npm downloads](https://img.shields.io/npm/dt/matterbridge-example-dynamic-platform.svg)](https://www.npmjs.com/package/matterbridge-example-dynamic-platform)

[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)

[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)

![Node.js CI](https://github.com/Luligu/matterbridge-example-dynamic-platform/actions/workflows/build-matterbridge-plugin.yml/badge.svg)

[![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)

---

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

It exposes:

- 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 only) clusters

- a light with onOff, levelControl and colorControl (with XY only) clusters

- a light with onOff, levelControl and colorControl (with CT only) clusters

- an outlet (plug) with onOff cluster

- a cover with windowCovering cluster

- a lock with doorLock cluster

- a thermo 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 fan with FanControl cluster

- a rainSensor device

- a waterFreezeDetector device

- a waterLeakDetector device

- a smokeCoAlarm device

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) and how to subscribe to attributes.

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](https://github.com/Luligu/matterbridge/blob/main/README.md) for more information.