Interface Cluster

The server cluster provides an interface to occupancy sensing functionality, including configuration and provision of notifications of occupancy status.

See

MatterSpecification.v13.Cluster § 2.7

interface Cluster {
    attributes: Merge<{
        occupancy: Attribute<TypeFromPartialBitSchema<{
            occupied: BitFlag;
        }>, any>;
        occupancySensorType: Attribute<OccupancySensing.OccupancySensorType, any>;
        occupancySensorTypeBitmap: Attribute<TypeFromPartialBitSchema<{
            physicalContact: BitFlag;
            pir: BitFlag;
            ultrasonic: BitFlag;
        }>, any>;
        physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
        physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
        physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
        pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
        pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
        pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
        ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
        ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
        ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<1030, "ClusterId">;
    name: "OccupancySensing";
    revision: 4;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            occupancy: Attribute<TypeFromPartialBitSchema<{
                occupied: BitFlag;
            }>, any>;
            occupancySensorType: Attribute<OccupancySensing.OccupancySensorType, any>;
            occupancySensorTypeBitmap: Attribute<TypeFromPartialBitSchema<{
                physicalContact: BitFlag;
                pir: BitFlag;
                ultrasonic: BitFlag;
            }>, any>;
            physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
        };
        id: 1030;
        name: "OccupancySensing";
        revision: 4;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            occupancy: Attribute<TypeFromPartialBitSchema<{
                occupied: BitFlag;
            }>, any>;
            occupancySensorType: Attribute<OccupancySensing.OccupancySensorType, any>;
            occupancySensorTypeBitmap: Attribute<TypeFromPartialBitSchema<{
                physicalContact: BitFlag;
                pir: BitFlag;
                ultrasonic: BitFlag;
            }>, any>;
            physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
        };
        id: 1030;
        name: "OccupancySensing";
        revision: 4;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            occupancy: Attribute<TypeFromPartialBitSchema<{
                occupied: BitFlag;
            }>, any>;
            occupancySensorType: Attribute<OccupancySensing.OccupancySensorType, any>;
            occupancySensorTypeBitmap: Attribute<TypeFromPartialBitSchema<{
                physicalContact: BitFlag;
                pir: BitFlag;
                ultrasonic: BitFlag;
            }>, any>;
            physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
        };
        id: 1030;
        name: "OccupancySensing";
        revision: 4;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            occupancy: Attribute<TypeFromPartialBitSchema<{
                occupied: BitFlag;
            }>, any>;
            occupancySensorType: Attribute<OccupancySensing.OccupancySensorType, any>;
            occupancySensorTypeBitmap: Attribute<TypeFromPartialBitSchema<{
                physicalContact: BitFlag;
                pir: BitFlag;
                ultrasonic: BitFlag;
            }>, any>;
            physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
            ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
            ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
        };
        id: 1030;
        name: "OccupancySensing";
        revision: 4;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    occupancy: Attribute<TypeFromPartialBitSchema<{
        occupied: BitFlag;
    }>, any>;
    occupancySensorType: Attribute<OccupancySensing.OccupancySensorType, any>;
    occupancySensorTypeBitmap: Attribute<TypeFromPartialBitSchema<{
        physicalContact: BitFlag;
        pir: BitFlag;
        ultrasonic: BitFlag;
    }>, any>;
    physicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
    physicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
    physicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
    pirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
    pirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
    pirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
    ultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>;
    ultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>;
    ultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>;
}, GlobalAttributes<{}>>

Type declaration

  • Readonlyoccupancy: Attribute<TypeFromPartialBitSchema<{
        occupied: BitFlag;
    }>, any>

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

    See

    MatterSpecification.v13.Cluster § 2.7.5.1

  • ReadonlyoccupancySensorType: Attribute<OccupancySensing.OccupancySensorType, any>

    This attribute specifies the type of the occupancy sensor.

    See

    MatterSpecification.v13.Cluster § 2.7.5.2

  • ReadonlyoccupancySensorTypeBitmap: Attribute<TypeFromPartialBitSchema<{
        physicalContact: BitFlag;
        pir: BitFlag;
        ultrasonic: BitFlag;
    }>, any>

    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.

    See

    MatterSpecification.v13.Cluster § 2.7.5.3

  • ReadonlyphysicalContactOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>

    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

  • ReadonlyphysicalContactUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>

    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

  • ReadonlyphysicalContactUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>

    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

  • ReadonlypirOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>

    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

  • ReadonlypirUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>

    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

  • ReadonlypirUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>

    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

  • ReadonlyultrasonicOccupiedToUnoccupiedDelay: OptionalWritableAttribute<number, any>

    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

  • ReadonlyultrasonicUnoccupiedToOccupiedDelay: OptionalWritableAttribute<number, any>

    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

  • ReadonlyultrasonicUnoccupiedToOccupiedThreshold: OptionalWritableAttribute<number, any>

    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

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<1030, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

set

with

Settings

Member Visibility

On This Page

Properties
Methods