Interface State

interface State {
    occupancy: TypeFromPartialBitSchema<{
        occupied: BitFlag;
    }>;
    occupancySensorType: OccupancySensing.OccupancySensorType;
    occupancySensorTypeBitmap: TypeFromPartialBitSchema<{
        physicalContact: BitFlag;
        pir: BitFlag;
        ultrasonic: BitFlag;
    }>;
    physicalContactOccupiedToUnoccupiedDelay?: number;
    physicalContactUnoccupiedToOccupiedDelay?: number;
    physicalContactUnoccupiedToOccupiedThreshold?: number;
    pirOccupiedToUnoccupiedDelay?: number;
    pirUnoccupiedToOccupiedDelay?: number;
    pirUnoccupiedToOccupiedThreshold?: number;
    ultrasonicOccupiedToUnoccupiedDelay?: number;
    ultrasonicUnoccupiedToOccupiedDelay?: number;
    ultrasonicUnoccupiedToOccupiedThreshold?: number;
}

Hierarchy

  • StateType
    • State

Properties

occupancy occupancySensorType occupancySensorTypeBitmap physicalContactOccupiedToUnoccupiedDelay? physicalContactUnoccupiedToOccupiedDelay? physicalContactUnoccupiedToOccupiedThreshold? pirOccupiedToUnoccupiedDelay? pirUnoccupiedToOccupiedDelay? pirUnoccupiedToOccupiedThreshold? ultrasonicOccupiedToUnoccupiedDelay? ultrasonicUnoccupiedToOccupiedDelay? ultrasonicUnoccupiedToOccupiedThreshold?

Properties

Readonlyoccupancy

occupancy: TypeFromPartialBitSchema<{
    occupied: BitFlag;
}>

This attribute indicates the sensed (processed) status of occupancy.

Type declaration

  • occupied: BitFlag

    Indicates the sensed occupancy state

    If this bit is set, it shall indicate the occupied state else if the bit if not set, it shall indicate the unoccupied state.

    See

    MatterSpecification.v13.Cluster § 2.7.4.1.1

See

MatterSpecification.v13.Cluster § 2.7.5.1

ReadonlyoccupancySensorType

occupancySensorType: OccupancySensing.OccupancySensorType

This attribute specifies the type of the occupancy sensor.

See

MatterSpecification.v13.Cluster § 2.7.5.2

ReadonlyoccupancySensorTypeBitmap

occupancySensorTypeBitmap: TypeFromPartialBitSchema<{
    physicalContact: BitFlag;
    pir: BitFlag;
    ultrasonic: BitFlag;
}>

This attribute specifies the types of the occupancy sensor. Each bit position, if set, indicates the corresponding sensing capability is implemented.

The value of the OccupancySensorType shall be aligned to the value of the OccupancySensorTypeBitmap attribute as defined below.

Type declaration

  • physicalContact: BitFlag

    Indicates a physical contact sensor.

  • pir: BitFlag

    Indicates a passive infrared sensor.

  • ultrasonic: BitFlag

    Indicates a ultrasonic sensor.

See

MatterSpecification.v13.Cluster § 2.7.5.3

Optional ReadonlyphysicalContactOccupiedToUnoccupiedDelay

physicalContactOccupiedToUnoccupiedDelay?: number

This attribute specifies the time delay, in seconds, before the physical contact occupancy sensor changes to its unoccupied state after detecting the unoccupied event.

See

MatterSpecification.v13.Cluster § 2.7.5.10

Optional ReadonlyphysicalContactUnoccupiedToOccupiedDelay

physicalContactUnoccupiedToOccupiedDelay?: number

This attribute specifies the time delay, in seconds, before the physical contact sensor changes to its occupied state after the detection of the occupied event.

See

MatterSpecification.v13.Cluster § 2.7.5.11

Optional ReadonlyphysicalContactUnoccupiedToOccupiedThreshold

physicalContactUnoccupiedToOccupiedThreshold?: number

This attribute specifies the number of movement detection events that must occur in the period PhysicalContactUnoccupiedToOccupiedDelay, before the PhysicalContact sensor changes to its occupied state.

See

MatterSpecification.v13.Cluster § 2.7.5.12

Optional ReadonlypirOccupiedToUnoccupiedDelay

pirOccupiedToUnoccupiedDelay?: number

This attribute specifies the time delay, in seconds, before the PIR sensor changes to its unoccupied state after the last detection of movement in the sensed area.

See

MatterSpecification.v13.Cluster § 2.7.5.4

Optional ReadonlypirUnoccupiedToOccupiedDelay

pirUnoccupiedToOccupiedDelay?: number

This attribute specifies the time delay, in seconds, before the PIR sensor changes to its occupied state after the detection of movement in the sensed area.

See

MatterSpecification.v13.Cluster § 2.7.5.5

Optional ReadonlypirUnoccupiedToOccupiedThreshold

pirUnoccupiedToOccupiedThreshold?: number

This attribute specifies the number of movement detection events that must occur in the period PIRUnoccupiedToOccupiedDelay, before the PIR sensor changes to its occupied state.

See

MatterSpecification.v13.Cluster § 2.7.5.6

Optional ReadonlyultrasonicOccupiedToUnoccupiedDelay

ultrasonicOccupiedToUnoccupiedDelay?: number

This attribute specifies the time delay, in seconds, before the Ultrasonic sensor changes to its unoccupied state after the last detection of movement in the sensed area.

See

MatterSpecification.v13.Cluster § 2.7.5.7

Optional ReadonlyultrasonicUnoccupiedToOccupiedDelay

ultrasonicUnoccupiedToOccupiedDelay?: number

This attribute specifies the time delay, in seconds, before the Ultrasonic sensor changes to its occupied state after the detection of movement in the sensed area.

See

MatterSpecification.v13.Cluster § 2.7.5.8

Optional ReadonlyultrasonicUnoccupiedToOccupiedThreshold

ultrasonicUnoccupiedToOccupiedThreshold?: number

This attribute specifies the number of movement detection events that must occur in the period UltrasonicUnoccupiedToOccupiedDelay, before the Ultrasonic sensor changes to its occupied state.

See

MatterSpecification.v13.Cluster § 2.7.5.9

Settings

Member Visibility

On This Page

Properties