Back to Homebridge

Variable clustersConst

docs/variables/clusters.html

2.0.25.2 KB
Original Source
  • clusters

Variable clustersConst

clusters: {
AirQuality: typeof AirQuality;
BooleanState: typeof BooleanState;
CarbonMonoxideConcentrationMeasurement: typeof CarbonMonoxideConcentrationMeasurement;
ColorControl: typeof ColorControl;
DoorLock: typeof DoorLock;
FanControl: typeof FanControl;
LevelControl: typeof LevelControl;
NitrogenDioxideConcentrationMeasurement: typeof NitrogenDioxideConcentrationMeasurement;
OnOff: typeof OnOff;
OzoneConcentrationMeasurement: typeof OzoneConcentrationMeasurement;
Pm10ConcentrationMeasurement: typeof Pm10ConcentrationMeasurement;
Pm25ConcentrationMeasurement: typeof Pm25ConcentrationMeasurement;
RvcOperationalState: typeof RvcOperationalState;
Thermostat: typeof Thermostat;
ValveConfigurationAndControl: typeof ValveConfigurationAndControl;
WindowCovering: typeof WindowCovering;
} = ...

Matter cluster types

All supported Matter cluster types, imported from individual files for optimal performance.

Type Declaration

AirQuality: typeof AirQuality

Definitions for the AirQuality cluster.

This cluster provides an interface to air quality classification using distinct levels with human-readable labels.

See

MatterSpecification.v142.Cluster § 2.9

BooleanState: typeof BooleanState

Definitions for the BooleanState cluster.

This cluster provides an interface to a boolean state.

See

MatterSpecification.v142.Cluster § 1.7

CarbonMonoxideConcentrationMeasurement: typeof CarbonMonoxideConcentrationMeasurement

Definitions for the CarbonMonoxideConcentrationMeasurement cluster.

ColorControl: typeof ColorControl

Definitions for the ColorControl cluster.

This cluster provides an interface for changing the color of a light. Color is specified according to the CIE 1931 Color space. Color control is carried out in terms of x,y values, as defined by this specification.

Additionally, color may optionally be controlled in terms of color temperature, or as hue and saturation values based on optionally variable RGB and W color points. It is recommended that the hue and saturation are interpreted according to the HSV (a.k.a. HSB) color model.

Control over luminance is not included, as this is provided by means of the Level Control for Lighting cluster. It is recommended that the level provided by this cluster be interpreted as representing a proportion of the maximum intensity achievable at the current color.

See

MatterSpecification.v142.Cluster § 3.2

DoorLock: typeof DoorLock

Definitions for the DoorLock cluster.

The door lock cluster provides an interface to a generic way to secure a door. The physical object that provides the locking functionality is abstracted from the cluster. The cluster has a small list of mandatory attributes and functions and a list of optional features.

See

MatterSpecification.v142.Cluster § 5.2

FanControl: typeof FanControl

Definitions for the FanControl cluster.

This cluster specifies an interface to control the speed of a fan.

See

MatterSpecification.v142.Cluster § 4.4

LevelControl: typeof LevelControl

Definitions for the LevelControl cluster.

This cluster provides an interface for controlling a characteristic of a device that can be set to a level, for example the brightness of a light, the degree of closure of a door, or the power output of a heater.

See

MatterSpecification.v142.Cluster § 1.6

NitrogenDioxideConcentrationMeasurement: typeof NitrogenDioxideConcentrationMeasurement

Definitions for the NitrogenDioxideConcentrationMeasurement cluster.

OnOff: typeof OnOff

Definitions for the OnOff cluster.

Attributes and commands for turning devices on and off.

See

MatterSpecification.v142.Cluster § 1.5

OzoneConcentrationMeasurement: typeof OzoneConcentrationMeasurement

Definitions for the OzoneConcentrationMeasurement cluster.

Pm10ConcentrationMeasurement: typeof Pm10ConcentrationMeasurement

Definitions for the Pm10ConcentrationMeasurement cluster.

Pm25ConcentrationMeasurement: typeof Pm25ConcentrationMeasurement

Definitions for the Pm25ConcentrationMeasurement cluster.

RvcOperationalState: typeof RvcOperationalState

Definitions for the RvcOperationalState cluster.

This cluster is derived from the Operational State cluster and provides an interface for monitoring the operational state of a robotic vacuum cleaner.

See

MatterSpecification.v142.Cluster § 7.4

Thermostat: typeof Thermostat

Definitions for the Thermostat cluster.

This cluster provides an interface to the functionality of a thermostat.

See

MatterSpecification.v142.Cluster § 4.3

ValveConfigurationAndControl: typeof ValveConfigurationAndControl

Definitions for the ValveConfigurationAndControl cluster.

This cluster is used to configure a valve.

See

MatterSpecification.v142.Cluster § 4.6

WindowCovering: typeof WindowCovering

Definitions for the WindowCovering cluster.

The window covering cluster provides an interface for controlling and adjusting automatic window coverings such as drapery motors, automatic shades, curtains and blinds.

See

MatterSpecification.v142.Cluster § 5.3

Settings

Member Visibility

  • Inherited

ThemeOSLightDark