Class OccupancySensingServer

This is the default server implementation of OccupancySensingBehavior.

Hierarchy (view full)

OccupancySensingBehavior
- OccupancySensingServer

Constructors

constructor

new OccupancySensingServer(agent, backing): OccupancySensingServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns OccupancySensingServer
Inherited from OccupancySensingBehavior.constructor
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:198

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

`Readonly`events

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

`Readonly`state

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` `Readonly`cluster

cluster: OccupancySensing.Cluster

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

`Static` `Readonly`defaults

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

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

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

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

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

`Static` `Readonly`Interface

Interface: {
components: never[];
}

`Static` `Readonly`Internal

Internal: (new () => {})

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`State

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

`Static` `Readonly`supervisor

supervisor: RootSupervisor

`Static`supports

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

Type declaration

- (other): boolean
- Does this behavior support functionality of a specific implementation?
  Parameters
  - other: Type
  Returns boolean

Methods

[asyncDispose]

[asyncDispose](): MaybePromise
Release resources. This is the public API for releasing application resources held by behaviors in internal state.

Returns MaybePromise
Inherited from OccupancySensingBehavior.[asyncDispose]
- Defined in packages/node/src/behavior/Behavior.ts:206

asAdmin

asAdmin(fn): void
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from OccupancySensingBehavior.asAdmin
- Defined in packages/node/src/behavior/Behavior.ts:135

assertAttributeEnabled

assertAttributeEnabled<This, K>(this, attributeName): void
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns void
Inherited from OccupancySensingBehavior.assertAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:180

`Protected`callback

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
- reactor: Reactor<A, R>
- Optionaloptions: Reactor.Options
Returns ((...args: A) => undefined | R)
- - (...args): undefined | R
  - Parameters
    - Rest...args: A
    Returns undefined | R
Inherited from OccupancySensingBehavior.callback
- Defined in packages/node/src/behavior/Behavior.ts:234

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
Inherited from OccupancySensingBehavior.initialize
- Defined in packages/node/src/behavior/Behavior.ts:200

`Protected`reactTo

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
- O extends Observable<any[], any>
Parameters
- observable: O
- reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>
- Optionaloptions: Reactor.Options
Returns void
Inherited from OccupancySensingBehavior.reactTo
- Defined in packages/node/src/behavior/Behavior.ts:220

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>
Inherited from OccupancySensingBehavior.requireAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:168

toString

toString(): string
Returns string
Inherited from OccupancySensingBehavior.toString
- Defined in packages/node/src/behavior/Behavior.ts:211

`Static`alter

alter<This, const AlterationsT>(this, alterations): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const AlterationsT extends Alterations<This["cluster"]>
Parameters
- this: This
- alterations: AlterationsT
Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from OccupancySensingBehavior.alter
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:251

`Static`enable

enable<This, const FlagsT>(this, flags): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FlagsT extends ElementFlags<This["cluster"]>
Parameters
- this: This
- flags: FlagsT
Returns Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Inherited from OccupancySensingBehavior.enable
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:261

`Static`for

for<This, const ClusterT>(this, cluster, schema?): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const ClusterT extends ClusterType
Parameters
- this: This
- cluster: ClusterT
- Optionalschema: Schema
Returns Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Inherited from OccupancySensingBehavior.for
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:237

`Static`set

set<This>(this, defaults): This
Type Parameters
- This extends Type
Parameters
- this: This
- defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>
Returns This
Inherited from OccupancySensingBehavior.set
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:259

`Static`with

with<This, const FeaturesT>(this, ...features): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FeaturesT extends FeatureSelection<This["cluster"]>
Parameters
- this: This
- Rest...features: FeaturesT
Returns Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from OccupancySensingBehavior.with
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:243

Class OccupancySensingServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OccupancySensingServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

features

session

Readonlystate

Type declaration

Readonlyoccupancy: TypeFromPartialBitSchema<{ occupied: BitFlag; }>

See

ReadonlyoccupancySensorType: OccupancySensing.OccupancySensorType

See

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

See

Type declaration

Optional ReadonlyphysicalContactOccupiedToUnoccupiedDelay?: number

See

Optional ReadonlyphysicalContactUnoccupiedToOccupiedDelay?: number

See

Optional ReadonlyphysicalContactUnoccupiedToOccupiedThreshold?: number

See

Optional ReadonlypirOccupiedToUnoccupiedDelay?: number

See

Optional ReadonlypirUnoccupiedToOccupiedDelay?: number

See

Optional ReadonlypirUnoccupiedToOccupiedThreshold?: number

See

Optional ReadonlyultrasonicOccupiedToUnoccupiedDelay?: number

See

Optional ReadonlyultrasonicUnoccupiedToOccupiedDelay?: number

See

Optional ReadonlyultrasonicUnoccupiedToOccupiedThreshold?: number

See

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Static Readonlyname

Static Optional Readonlyschema

Static ReadonlyState

Static Readonlysupervisor

Staticsupports

Type declaration

Parameters

Returns boolean

Methods

[asyncDispose]

Returns MaybePromise

asAdmin

Parameters

Returns void

Returns void

assertAttributeEnabled

Type Parameters

Parameters

Returns void

Protectedcallback

Type Parameters

Parameters

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

Parameters

`Readonly`events

`Readonly`state

`Readonly`occupancy: TypeFromPartialBitSchema<{
occupied: BitFlag;
}>

`Readonly`occupancySensorType: OccupancySensing.OccupancySensorType

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

`Optional` `Readonly`physicalContactOccupiedToUnoccupiedDelay?: number

`Optional` `Readonly`physicalContactUnoccupiedToOccupiedDelay?: number

`Optional` `Readonly`physicalContactUnoccupiedToOccupiedThreshold?: number

`Optional` `Readonly`pirOccupiedToUnoccupiedDelay?: number

`Optional` `Readonly`pirUnoccupiedToOccupiedDelay?: number

`Optional` `Readonly`pirUnoccupiedToOccupiedThreshold?: number

`Optional` `Readonly`ultrasonicOccupiedToUnoccupiedDelay?: number

`Optional` `Readonly`ultrasonicUnoccupiedToOccupiedDelay?: number

`Optional` `Readonly`ultrasonicUnoccupiedToOccupiedThreshold?: number

`Static` `Readonly`cluster

`Static` `Readonly`defaults

`Static` `Optional` `Readonly`dependencies

`Static` `Readonly`early

`Static` `Readonly`Events

`Static` `Readonly`ExtensionInterface

`Static` `Readonly`id

`Static` `Readonly`Interface

`Static` `Readonly`Internal

`Static` `Readonly`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`State

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with