class Matter::Cluster::OccupancySensingCluster

• Matter::Cluster::OccupancySensingCluster
• Matter::Cluster::Base
• Reference
• Object

Overview

Occupancy Sensing Cluster (0x0406)

Provides an interface to occupancy sensing functionality based on various sensing modalities (PIR, Ultrasonic, Physical Contact, etc.), including configuration and provision of notifications of occupancy status.

This implementation supports PIR (Passive Infrared) sensing.

Specification: Matter 1.4 § 2.7

Defined in:

Constant Summary

ATTR_HOLD_TIME = 3_u32

ATTR_OCCUPANCY = 0_u32

Attributes

ATTR_OCCUPANCY_SENSOR_TYPE = 1_u32

ATTR_OCCUPANCY_SENSOR_TYPE_BITMAP = 2_u32

ATTR_PIR_OCCUPIED_TO_UNOCCUPIED_DELAY = 16_u32

ATTR_PIR_UNOCCUPIED_TO_OCCUPIED_DELAY = 17_u32

ATTR_PIR_UNOCCUPIED_TO_OCCUPIED_THRESH = 18_u32

CLUSTER_ID = 1030_u32

OCCUPANCY_OCCUPIED = 1_u8

Occupancy bitmap (bit 0 = occupied)

Constructors

• .new(endpoint_id : DataType::EndpointNumber, occupancy : UInt8 = 0_u8, occupancy_sensor_type : OccupancySensorType = OccupancySensorType::PIR, occupancy_sensor_type_bitmap : UInt8 = 1_u8, hold_time : UInt16 | Nil = nil, pir_occupied_to_unoccupied_delay : UInt16 | Nil = nil, pir_unoccupied_to_occupied_delay : UInt16 | Nil = nil, pir_unoccupied_to_occupied_threshold : UInt8 | Nil = nil)

Class Method Summary

• .cluster_id

  Occupancy Sensing Cluster (0x0406)

Instance Method Summary

• #attributes : Array(AttributeMetadata)

  Get all attribute metadata

• #commands : Array(CommandMetadata)

  Get all command metadata

• #hold_time : UInt16 | Nil

  Hold time in seconds (optional, writable)

• #hold_time=(hold_time : UInt16 | Nil)

  Hold time in seconds (optional, writable)

• #name : String

  Get cluster name

• #occupancy : UInt8

  Current occupancy state (bitmap, bit 0 = occupied)

• #occupancy=(occupancy : UInt8)

  Current occupancy state (bitmap, bit 0 = occupied)

• #occupancy_sensor_type : OccupancySensorType

  Sensor type (fixed)

• #occupancy_sensor_type=(occupancy_sensor_type : OccupancySensorType)

  Sensor type (fixed)

• #occupancy_sensor_type_bitmap : UInt8

  Sensor type bitmap (bit 0 = PIR)

• #occupancy_sensor_type_bitmap=(occupancy_sensor_type_bitmap : UInt8)

  Sensor type bitmap (bit 0 = PIR)

• #occupied? : Bool

  Check if currently occupied

• #on_occupancy_changed(&block : UInt8, UInt8 -> Nil)
• #pir_occupied_to_unoccupied_delay : UInt16 | Nil

  PIR-specific attributes (optional, writable)

• #pir_occupied_to_unoccupied_delay=(pir_occupied_to_unoccupied_delay : UInt16 | Nil)

  PIR-specific attributes (optional, writable)

• #pir_unoccupied_to_occupied_delay : UInt16 | Nil
• #pir_unoccupied_to_occupied_delay=(pir_unoccupied_to_occupied_delay : UInt16 | Nil)
• #pir_unoccupied_to_occupied_threshold : UInt8 | Nil
• #pir_unoccupied_to_occupied_threshold=(pir_unoccupied_to_occupied_threshold : UInt8 | Nil)
• #read_attribute(attribute_id : UInt32) : Bytes | InteractionModel::Status

  Read an attribute value

• #update_occupancy(occupied : Bool)

  Update the occupancy state

Constructor Detail

Class Method Detail

Instance Method Detail