Interface ClusterHandlerMap

Maps known cluster names to their typed handler interfaces.

Plugin developers get autocomplete for handler methods within each cluster. Handler argument types are derived from matter.js where possible, so they auto-update when the matter.js dependency is bumped.

Example

const accessory: MatterAccessory = {
  // ...
  handlers: {
    onOff: {
      on: async () => { await device.turnOn() },
      off: async () => { await device.turnOff() },
    },
    levelControl: {
      moveToLevel: async (args) => {
        // args is typed as LevelControl.MoveToLevelRequest
        await device.setBrightness(args?.level ?? 0)
      },
    },
  },
}

interface ClusterHandlerMap {
    colorControl: ColorControlHandlers;
    doorLock: DoorLockHandlers;
    fanControl: FanControlHandlers;
    identify: IdentifyHandlers;
    levelControl: LevelControlHandlers;
    onOff: OnOffHandlers;
    rvcCleanMode: RvcCleanModeHandlers;
    rvcOperationalState: RvcOperationalStateHandlers;
    rvcRunMode: RvcRunModeHandlers;
    serviceArea: ServiceAreaHandlers;
    thermostat: ThermostatHandlers;
    valveConfigurationAndControl: ValveConfigurationAndControlHandlers;
    windowCovering: WindowCoveringHandlers;
}

Index

Properties

colorControl doorLock fanControl identify levelControl onOff rvcCleanMode rvcOperationalState rvcRunMode serviceArea thermostat valveConfigurationAndControl windowCovering

Properties

valveConfigurationAndControl

valveConfigurationAndControl: ValveConfigurationAndControlHandlers

windowCovering

windowCovering: WindowCoveringHandlers

Interface ClusterHandlerMap

Example

Index

Properties

Properties

colorControl

doorLock

fanControl

identify

levelControl

onOff

rvcCleanMode

rvcOperationalState

rvcRunMode

serviceArea

thermostat

valveConfigurationAndControl

windowCovering

Settings

On This Page