homebridge
    Preparing search index...

    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.

    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 {
        closureControl: ClosureControlHandlers;
        colorControl: ColorControlHandlers;
        deviceEnergyManagement: DeviceEnergyManagementHandlers;
        deviceEnergyManagementMode: DeviceEnergyManagementModeHandlers;
        doorLock: DoorLockHandlers;
        energyEvse: EnergyEvseHandlers;
        energyEvseMode: EnergyEvseModeHandlers;
        fanControl: FanControlHandlers;
        identify: IdentifyHandlers;
        keypadInput: KeypadInputHandlers;
        levelControl: LevelControlHandlers;
        mediaPlayback: MediaPlaybackHandlers;
        onOff: OnOffHandlers;
        rvcCleanMode: RvcCleanModeHandlers;
        rvcOperationalState: RvcOperationalStateHandlers;
        rvcRunMode: RvcRunModeHandlers;
        serviceArea: ServiceAreaHandlers;
        thermostat: ThermostatHandlers;
        valveConfigurationAndControl: ValveConfigurationAndControlHandlers;
        waterHeaterManagement: WaterHeaterManagementHandlers;
        waterHeaterMode: WaterHeaterModeHandlers;
        windowCovering: WindowCoveringHandlers;
    }
    Index
    closureControl: ClosureControlHandlers
    colorControl: ColorControlHandlers
    deviceEnergyManagement: DeviceEnergyManagementHandlers
    deviceEnergyManagementMode: DeviceEnergyManagementModeHandlers
    energyEvse: EnergyEvseHandlers
    energyEvseMode: EnergyEvseModeHandlers
    fanControl: FanControlHandlers
    keypadInput: KeypadInputHandlers
    levelControl: LevelControlHandlers
    mediaPlayback: MediaPlaybackHandlers
    rvcCleanMode: RvcCleanModeHandlers
    rvcOperationalState: RvcOperationalStateHandlers
    rvcRunMode: RvcRunModeHandlers
    serviceArea: ServiceAreaHandlers
    thermostat: ThermostatHandlers
    valveConfigurationAndControl: ValveConfigurationAndControlHandlers
    waterHeaterManagement: WaterHeaterManagementHandlers
    waterHeaterMode: WaterHeaterModeHandlers
    windowCovering: WindowCoveringHandlers