Variable clusterNames`Const`

clusterNames: {
    AirQuality: "airQuality";
    BasicInformation: "basicInformation";
    BooleanState: "booleanState";
    BridgedDeviceBasicInformation: "bridgedDeviceBasicInformation";
    CarbonMonoxideConcentrationMeasurement: "carbonMonoxideConcentrationMeasurement";
    ColorControl: "colorControl";
    DoorLock: "doorLock";
    FanControl: "fanControl";
    Identify: "identify";
    IlluminanceMeasurement: "illuminanceMeasurement";
    LevelControl: "levelControl";
    NitrogenDioxideConcentrationMeasurement: "nitrogenDioxideConcentrationMeasurement";
    OccupancySensing: "occupancySensing";
    OnOff: "onOff";
    OzoneConcentrationMeasurement: "ozoneConcentrationMeasurement";
    Pm10ConcentrationMeasurement: "pm10ConcentrationMeasurement";
    Pm25ConcentrationMeasurement: "pm25ConcentrationMeasurement";
    PowerSource: "powerSource";
    PumpConfigurationAndControl: "pumpConfigurationAndControl";
    RelativeHumidityMeasurement: "relativeHumidityMeasurement";
    RvcCleanMode: "rvcCleanMode";
    RvcOperationalState: "rvcOperationalState";
    RvcRunMode: "rvcRunMode";
    ServiceArea: "serviceArea";
    SmokeCoAlarm: "smokeCoAlarm";
    Switch: "switch";
    TemperatureMeasurement: "temperatureMeasurement";
    Thermostat: "thermostat";
    ValveConfigurationAndControl: "valveConfigurationAndControl";
    WindowCovering: "windowCovering";
} = ...

Matter Cluster Names Commonly used cluster names for type safety and autocomplete Use these with api.updateMatterAccessoryState() and api.getAccessoryState()

Type Declaration

ReadonlyAirQuality: "airQuality"
ReadonlyBasicInformation: "basicInformation"
ReadonlyBooleanState: "booleanState"
ReadonlyBridgedDeviceBasicInformation: "bridgedDeviceBasicInformation"
ReadonlyCarbonMonoxideConcentrationMeasurement: "carbonMonoxideConcentrationMeasurement"
ReadonlyColorControl: "colorControl"
ReadonlyDoorLock: "doorLock"
ReadonlyFanControl: "fanControl"
ReadonlyIdentify: "identify"
ReadonlyIlluminanceMeasurement: "illuminanceMeasurement"
ReadonlyLevelControl: "levelControl"
ReadonlyNitrogenDioxideConcentrationMeasurement: "nitrogenDioxideConcentrationMeasurement"
ReadonlyOccupancySensing: "occupancySensing"
ReadonlyOnOff: "onOff"
ReadonlyOzoneConcentrationMeasurement: "ozoneConcentrationMeasurement"
ReadonlyPm10ConcentrationMeasurement: "pm10ConcentrationMeasurement"
ReadonlyPm25ConcentrationMeasurement: "pm25ConcentrationMeasurement"
ReadonlyPowerSource: "powerSource"
ReadonlyPumpConfigurationAndControl: "pumpConfigurationAndControl"
ReadonlyRelativeHumidityMeasurement: "relativeHumidityMeasurement"
ReadonlyRvcCleanMode: "rvcCleanMode"
ReadonlyRvcOperationalState: "rvcOperationalState"
ReadonlyRvcRunMode: "rvcRunMode"
ReadonlyServiceArea: "serviceArea"
ReadonlySmokeCoAlarm: "smokeCoAlarm"
ReadonlySwitch: "switch"
ReadonlyTemperatureMeasurement: "temperatureMeasurement"
ReadonlyThermostat: "thermostat"
ReadonlyValveConfigurationAndControl: "valveConfigurationAndControl"
ReadonlyWindowCovering: "windowCovering"

Example

With autocomplete and type safety:
api.updateMatterAccessoryState(uuid, api.matterClusterNames.OnOff, { onOff: true })
api.getAccessoryState(uuid, api.matterClusterNames.LevelControl)

Variable clusterNames`Const`

Type Declaration

`Readonly`AirQuality: "airQuality"

`Readonly`BasicInformation: "basicInformation"

`Readonly`BooleanState: "booleanState"

`Readonly`BridgedDeviceBasicInformation: "bridgedDeviceBasicInformation"

`Readonly`CarbonMonoxideConcentrationMeasurement: "carbonMonoxideConcentrationMeasurement"

`Readonly`ColorControl: "colorControl"

`Readonly`DoorLock: "doorLock"

`Readonly`FanControl: "fanControl"

`Readonly`Identify: "identify"

`Readonly`IlluminanceMeasurement: "illuminanceMeasurement"

`Readonly`LevelControl: "levelControl"

`Readonly`NitrogenDioxideConcentrationMeasurement: "nitrogenDioxideConcentrationMeasurement"

`Readonly`OccupancySensing: "occupancySensing"

`Readonly`OnOff: "onOff"

`Readonly`OzoneConcentrationMeasurement: "ozoneConcentrationMeasurement"

`Readonly`Pm10ConcentrationMeasurement: "pm10ConcentrationMeasurement"

`Readonly`Pm25ConcentrationMeasurement: "pm25ConcentrationMeasurement"

`Readonly`PowerSource: "powerSource"

`Readonly`PumpConfigurationAndControl: "pumpConfigurationAndControl"

`Readonly`RelativeHumidityMeasurement: "relativeHumidityMeasurement"

`Readonly`RvcCleanMode: "rvcCleanMode"

`Readonly`RvcOperationalState: "rvcOperationalState"

`Readonly`RvcRunMode: "rvcRunMode"

`Readonly`ServiceArea: "serviceArea"

`Readonly`SmokeCoAlarm: "smokeCoAlarm"

`Readonly`Switch: "switch"

`Readonly`TemperatureMeasurement: "temperatureMeasurement"

`Readonly`Thermostat: "thermostat"

`Readonly`ValveConfigurationAndControl: "valveConfigurationAndControl"

`Readonly`WindowCovering: "windowCovering"

Example

Settings

Variable clusterNamesConst

Type Declaration

ReadonlyAirQuality: "airQuality"

ReadonlyBasicInformation: "basicInformation"

ReadonlyBooleanState: "booleanState"

ReadonlyBridgedDeviceBasicInformation: "bridgedDeviceBasicInformation"

ReadonlyCarbonMonoxideConcentrationMeasurement: "carbonMonoxideConcentrationMeasurement"

ReadonlyColorControl: "colorControl"

ReadonlyDoorLock: "doorLock"

ReadonlyFanControl: "fanControl"

ReadonlyIdentify: "identify"

ReadonlyIlluminanceMeasurement: "illuminanceMeasurement"

ReadonlyLevelControl: "levelControl"

ReadonlyNitrogenDioxideConcentrationMeasurement: "nitrogenDioxideConcentrationMeasurement"

ReadonlyOccupancySensing: "occupancySensing"

ReadonlyOnOff: "onOff"

ReadonlyOzoneConcentrationMeasurement: "ozoneConcentrationMeasurement"

ReadonlyPm10ConcentrationMeasurement: "pm10ConcentrationMeasurement"

ReadonlyPm25ConcentrationMeasurement: "pm25ConcentrationMeasurement"

ReadonlyPowerSource: "powerSource"

ReadonlyPumpConfigurationAndControl: "pumpConfigurationAndControl"

ReadonlyRelativeHumidityMeasurement: "relativeHumidityMeasurement"

ReadonlyRvcCleanMode: "rvcCleanMode"

ReadonlyRvcOperationalState: "rvcOperationalState"

ReadonlyRvcRunMode: "rvcRunMode"

ReadonlyServiceArea: "serviceArea"

ReadonlySmokeCoAlarm: "smokeCoAlarm"

ReadonlySwitch: "switch"

ReadonlyTemperatureMeasurement: "temperatureMeasurement"

ReadonlyThermostat: "thermostat"

ReadonlyValveConfigurationAndControl: "valveConfigurationAndControl"

ReadonlyWindowCovering: "windowCovering"

Example

Settings

Variable clusterNames`Const`

`Readonly`AirQuality: "airQuality"

`Readonly`BasicInformation: "basicInformation"

`Readonly`BooleanState: "booleanState"

`Readonly`BridgedDeviceBasicInformation: "bridgedDeviceBasicInformation"

`Readonly`CarbonMonoxideConcentrationMeasurement: "carbonMonoxideConcentrationMeasurement"

`Readonly`ColorControl: "colorControl"

`Readonly`DoorLock: "doorLock"

`Readonly`FanControl: "fanControl"

`Readonly`Identify: "identify"

`Readonly`IlluminanceMeasurement: "illuminanceMeasurement"

`Readonly`LevelControl: "levelControl"

`Readonly`NitrogenDioxideConcentrationMeasurement: "nitrogenDioxideConcentrationMeasurement"

`Readonly`OccupancySensing: "occupancySensing"

`Readonly`OnOff: "onOff"

`Readonly`OzoneConcentrationMeasurement: "ozoneConcentrationMeasurement"

`Readonly`Pm10ConcentrationMeasurement: "pm10ConcentrationMeasurement"

`Readonly`Pm25ConcentrationMeasurement: "pm25ConcentrationMeasurement"

`Readonly`PowerSource: "powerSource"

`Readonly`PumpConfigurationAndControl: "pumpConfigurationAndControl"

`Readonly`RelativeHumidityMeasurement: "relativeHumidityMeasurement"

`Readonly`RvcCleanMode: "rvcCleanMode"

`Readonly`RvcOperationalState: "rvcOperationalState"

`Readonly`RvcRunMode: "rvcRunMode"

`Readonly`ServiceArea: "serviceArea"

`Readonly`SmokeCoAlarm: "smokeCoAlarm"

`Readonly`Switch: "switch"

`Readonly`TemperatureMeasurement: "temperatureMeasurement"

`Readonly`Thermostat: "thermostat"

`Readonly`ValveConfigurationAndControl: "valveConfigurationAndControl"

`Readonly`WindowCovering: "windowCovering"