Class IlluminanceMeasurementServer

This is the default server implementation of IlluminanceMeasurementBehavior.

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

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> & {
    maxMeasuredValue$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    measuredValue$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    minMeasuredValue$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
} & {
    lightSensorType$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number, any>>;
    tolerance$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<number, any>>;
} & {
    maxMeasuredValue$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    measuredValue$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    minMeasuredValue$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
} & {
    lightSensorType$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | number, any>>;
    tolerance$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<number, any>>;
} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    maxMeasuredValue: null | number;
    measuredValue: null | number;
    minMeasuredValue: null | number;
} & {
    lightSensorType?: null | number;
    tolerance?: number;
} & {} & {}

Access the behavior's state.

Type declaration

  • ReadonlymaxMeasuredValue: null | number

    The MaxMeasuredValue attribute indicates the maximum value of MeasuredValue that can be measured. A value of null indicates that this attribute is not defined. See Measured Value for more details.

    See

    MatterSpecification.v13.Cluster § 2.2.5.3

  • ReadonlymeasuredValue: null | number

    The MeasuredValue attribute represents the illuminance in Lux (symbol lx) as follows:

    • MeasuredValue = 10,000 x log10(illuminance) + 1,

    where 1 lx <= illuminance <= 3.576 Mlx, corresponding to a MeasuredValue in the range 1 to 0xFFFE. The MeasuredValue attribute can take the following values:

    • 0 indicates a value of illuminance that is too low to be measured,

    • MinMeasuredValue <= MeasuredValue <= MaxMeasuredValue under normal circumstances,

    • null indicates that the illuminance measurement is invalid.

    The MeasuredValue attribute is updated continuously as new measurements are made.

    See

    MatterSpecification.v13.Cluster § 2.2.5.1

  • ReadonlyminMeasuredValue: null | number

    The MinMeasuredValue attribute indicates the minimum value of MeasuredValue that can be measured. A value of null indicates that this attribute is not defined. See Measured Value for more details.

    See

    MatterSpecification.v13.Cluster § 2.2.5.2

Type declaration

  • Optional ReadonlylightSensorType?: null | number

    The LightSensorType attribute specifies the electronic type of the light sensor. This attribute shall be set to one of the non-reserved values listed in LightSensorTypeEnum or null in case the sensor type is unknown.

    See

    MatterSpecification.v13.Cluster § 2.2.5.5

  • Optional Readonlytolerance?: number

    See Measured Value.

    See

    MatterSpecification.v13.Cluster § 2.2.5.4

Static Readonlycluster

cluster: IlluminanceMeasurement.Cluster

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

Static Readonlydefaults

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

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<IlluminanceMeasurement.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<IlluminanceMeasurement.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

      toString

      Staticalter

      Staticenable

      Staticfor

      Staticset

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

      • Type Parameters

        Parameters

        Returns This

      Staticwith

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods