booleanstateconfiguration

Documentation

Overview

Package booleanstateconfiguration implements the Matter Boolean State Configuration cluster (0x0080).

Index

• Constants
• type EnableDisableAlarmRequest
• type SuppressAlarmRequest

Constants

const (
	// ID is the Matter cluster ID for Boolean State Configuration.
	ID uint32 = 0x0080
	// Name is the CLI-friendly cluster name.
	Name = "BooleanStateConfiguration"
	// DisplayName is the human-friendly cluster name.
	DisplayName = "Boolean State Configuration"
)

const (
	FeatureVisual           uint32 = 1 << 0 // VIS
	FeatureAudible          uint32 = 1 << 1 // AUD
	FeatureAlarmSuppress    uint32 = 1 << 2 // SPRS
	FeatureSensitivityLevel uint32 = 1 << 3 // SENSLVL
)

Feature bits for the FeatureMap attribute.

const (
	AttrCurrentSensitivityLevel    uint32 = 0x0000
	AttrSupportedSensitivityLevels uint32 = 0x0001
	AttrDefaultSensitivityLevel    uint32 = 0x0002
	AttrAlarmsActive               uint32 = 0x0003
	AttrAlarmsSuppressed           uint32 = 0x0004
	AttrAlarmsEnabled              uint32 = 0x0005
	AttrAlarmsSupported            uint32 = 0x0006
	AttrSensorFault                uint32 = 0x0007
)

Attribute IDs.

const (
	CmdSuppressAlarm      uint32 = 0x00
	CmdEnableDisableAlarm uint32 = 0x01
)

Command IDs.

Types

type EnableDisableAlarmRequest

type EnableDisableAlarmRequest struct {
	AlarmsToEnableDisable uint8 `tlv:"0,uint"`
}

EnableDisableAlarmRequest is the request payload for the EnableDisableAlarm command.

type SuppressAlarmRequest

type SuppressAlarmRequest struct {
	AlarmsToSuppress uint8 `tlv:"0,uint"`
}

SuppressAlarmRequest is the request payload for the SuppressAlarm command.