Class OccupancySensingServer

This is the default server implementation of OccupancySensingBehavior.

Hierarchy (view full)

Constructors

constructor

Properties

[reference] agent cluster context endpoint env events features session state cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString alter enable for set with

Constructors

constructor

  • new OccupancySensingServer(agent, backing): OccupancySensingServer

  • Parameters

    • agent: Agent
    • backing: BehaviorBacking

    Returns OccupancySensingServer

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<Events, never> & {
    occupancy$Changing: ClusterEvents.AttributeObservable<Attribute<TypeFromPartialBitSchema<{
        occupied: BitFlag;
    }>, any>>;
    occupancySensorType$Changing: ClusterEvents.AttributeObservable<Attribute<OccupancySensing.OccupancySensorType, any>>;
    occupancySensorTypeBitmap$Changing: ClusterEvents.AttributeObservable<Attribute<TypeFromPartialBitSchema<{
        physicalContact: BitFlag;
        pir: BitFlag;
        ultrasonic: BitFlag;
    }>, any>>;
} & {
    physicalContactOccupiedToUnoccupiedDelay$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    physicalContactUnoccupiedToOccupiedDelay$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    physicalContactUnoccupiedToOccupiedThreshold$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    pirOccupiedToUnoccupiedDelay$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    pirUnoccupiedToOccupiedDelay$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    pirUnoccupiedToOccupiedThreshold$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    ultrasonicOccupiedToUnoccupiedDelay$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    ultrasonicUnoccupiedToOccupiedDelay$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    ultrasonicUnoccupiedToOccupiedThreshold$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
} & {
    occupancy$Changed: ClusterEvents.AttributeObservable<Attribute<TypeFromPartialBitSchema<{
        occupied: BitFlag;
    }>, any>>;
    occupancySensorType$Changed: ClusterEvents.AttributeObservable<Attribute<OccupancySensing.OccupancySensorType, any>>;
    occupancySensorTypeBitmap$Changed: ClusterEvents.AttributeObservable<Attribute<TypeFromPartialBitSchema<{
        physicalContact: BitFlag;
        pir: BitFlag;
        ultrasonic: BitFlag;
    }>, any>>;
} & {
    physicalContactOccupiedToUnoccupiedDelay$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    physicalContactUnoccupiedToOccupiedDelay$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    physicalContactUnoccupiedToOccupiedThreshold$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    pirOccupiedToUnoccupiedDelay$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    pirUnoccupiedToOccupiedDelay$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    pirUnoccupiedToOccupiedThreshold$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    ultrasonicOccupiedToUnoccupiedDelay$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    ultrasonicUnoccupiedToOccupiedDelay$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
    ultrasonicUnoccupiedToOccupiedThreshold$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<number, any>>;
} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    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;
} & {} & {}

Access the behavior's state.

Type declaration

  • Readonlyoccupancy: TypeFromPartialBitSchema<{
        occupied: BitFlag;
    }>

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

    See

    MatterSpecification.v13.Cluster § 2.7.5.1

  • ReadonlyoccupancySensorType: OccupancySensing.OccupancySensorType

    This attribute specifies the type of the occupancy sensor.

    See

    MatterSpecification.v13.Cluster § 2.7.5.2

  • ReadonlyoccupancySensorTypeBitmap: 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.

    See

    MatterSpecification.v13.Cluster § 2.7.5.3

Type declaration

  • Optional ReadonlyphysicalContactOccupiedToUnoccupiedDelay?: 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?: 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?: 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?: 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?: 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?: 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?: 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?: 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?: 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

Static Readonlycluster

cluster: OccupancySensing.Cluster

Base cluster state include all attribute values but may be extended by subclasses.

Static Readonlydefaults

defaults: ClusterState.Type<OccupancySensing.Cluster, typeof ClusterBehavior>

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<OccupancySensing.Cluster, typeof ClusterBehavior>

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

The behavior ID for ClusterBehaviors is the name of the cluster.

Static ReadonlyInterface

Interface: {
    components: never[];
}

Static ReadonlyInternal

Internal: (new () => {})

Type declaration

    • new (): {}

    • Implementation of internal state. Subclasses may override to extend.

      Returns {}

    Static Readonlyname

    name: string

    Static Optional Readonlyschema

    schema?: Schema

    Static ReadonlyState

    State: (new () => ClusterState.Type<OccupancySensing.Cluster, typeof ClusterBehavior>)

    Static Readonlysupervisor

    supervisor: RootSupervisor

    Staticsupports

    supports: ((other: Type) => boolean)

    Type declaration

      • (other): boolean

      • Does this behavior support functionality of a specific implementation?

        Parameters

        Returns boolean

    Methods

    [asyncDispose]

    asAdmin

    • asAdmin(fn): void

    • Execute logic with elevated privileges.

      The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

      Elevated logic effectively ignores ACLs so should be used with care.

      Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.

      Parameters

      • fn: (() => void)

        the elevated logic

          • (): void

          • Returns void

      Returns void

    assertAttributeEnabled

    Protectedcallback

    • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

    • Create a generic callback function that has the same properties as a Reactor.

      Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      • A extends any[]
      • R

      Parameters

      Returns ((...args: A) => undefined | R)

        • (...args): undefined | R

        • Parameters

          • Rest...args: A

          Returns undefined | R

    initialize

    • initialize(_options?): MaybePromise

    • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

      This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

      Parameters

      • Optional_options: {}

        Returns MaybePromise

      ProtectedreactTo

      • reactTo<O>(observable, reactor, options?): void

      • Install a Reactor.

        Important: The reactor MUST be a real JS function - arrow functions will not work!

        Type Parameters

        Parameters

        Returns void

      requireAttributeEnabled

      • requireAttributeEnabled<This, K>(this, attributeName): Exclude<This["state"][K], undefined>

      • Type Parameters

        • This extends Behavior
        • K extends string | number | symbol

        Parameters

        • this: This
        • attributeName: K

        Returns Exclude<This["state"][K], undefined>

      toString

      • toString(): string

      • Description used in diagnostic messages.

        Returns string

      Staticalter

      Staticenable

      Staticfor

      Staticset

      • set<This>(this, defaults): This

      • Type Parameters

        Parameters

        Returns This

      Staticwith

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods