Class ScenesManagementServer

This is the default server implementation of ScenesManagementBehavior.

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] addScene asAdmin assertAttributeEnabled callback copyScene getSceneMembership initialize reactTo recallScene removeAllScenes removeScene requireAttributeEnabled storeScene toString viewScene 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<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    fabricSceneInfo$Changing: ClusterEvents.AttributeObservable<FabricScopedAttribute<TypeFromFields<{
        currentGroup: FieldType<GroupId>;
        currentScene: FieldType<number>;
        fabricIndex: FieldType<FabricIndex>;
        remainingCapacity: FieldType<number>;
        sceneCount: FieldType<number>;
        sceneValid: FieldType<boolean>;
    }>[], any>>;
    sceneTableSize$Changing: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>;
} & {
    lastConfiguredBy$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | NodeId, any>>;
} & {
    fabricSceneInfo$Changed: ClusterEvents.AttributeObservable<FabricScopedAttribute<TypeFromFields<{
        currentGroup: FieldType<GroupId>;
        currentScene: FieldType<number>;
        fabricIndex: FieldType<FabricIndex>;
        remainingCapacity: FieldType<number>;
        sceneCount: FieldType<number>;
        sceneValid: FieldType<boolean>;
    }>[], any>>;
    sceneTableSize$Changed: ClusterEvents.AttributeObservable<FixedAttribute<number, any>>;
} & {
    lastConfiguredBy$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<null | NodeId, any>>;
} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
    sceneNames: BitFlag;
}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    fabricSceneInfo: TypeFromFields<{
        currentGroup: FieldType<GroupId>;
        currentScene: FieldType<number>;
        fabricIndex: FieldType<FabricIndex>;
        remainingCapacity: FieldType<number>;
        sceneCount: FieldType<number>;
        sceneValid: FieldType<boolean>;
    }>[];
} & {
    lastConfiguredBy?: null | NodeId;
} & {
    sceneTableSize: number;
} & {}

Access the behavior's state.

Type declaration

  • ReadonlyfabricSceneInfo: TypeFromFields<{
        currentGroup: FieldType<GroupId>;
        currentScene: FieldType<number>;
        fabricIndex: FieldType<FabricIndex>;
        remainingCapacity: FieldType<number>;
        sceneCount: FieldType<number>;
        sceneValid: FieldType<boolean>;
    }>[]

    Indicates a list of fabric scoped information about scenes on this endpoint.

    The number of list entries for this attribute shall NOT exceed the number of supported fabrics by the device.

    See

    MatterSpecification.v13.Cluster § 1.4.8.3

Type declaration

  • Optional ReadonlylastConfiguredBy?: null | NodeId

    Indicates the Node ID of the node that last configured the Scene Table.

    The null value indicates that the server has not been configured, or that the identifier of the node that last configured the Scenes Management cluster is not known.

    The Node ID is scoped to the accessing fabric.

    See

    MatterSpecification.v13.Cluster § 1.4.8.1

Type declaration

  • ReadonlysceneTableSize: number

    Indicates the number of entries in the Scene Table on this endpoint. This is the total across all fabrics; note that a single fabric cannot use all those entries (see Handling of fabric- scoping). The minimum size of this table, (i.e., the minimum number of scenes to support across all fabrics per endpoint) shall be 16, unless a device type in which this cluster is used, defines a larger value in the device type definition.

    See

    MatterSpecification.v13.Cluster § 1.4.8.2

Static Readonlycluster

cluster: ScenesManagement.Cluster

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

Static Readonlydefaults

defaults: ClusterState.Type<ScenesManagement.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ScenesManagementInterface>>

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<ScenesManagement.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ScenesManagementInterface>>

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

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

Static ReadonlyInterface

Interface: ScenesManagementInterface

Static ReadonlyInternal

Internal: (new () => {})

Static Readonlyname

name: string

Static Optional Readonlyschema

schema?: Schema

Static ReadonlyState

State: (new () => ClusterState.Type<ScenesManagement.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ScenesManagementInterface>>)

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]

addScene

asAdmin

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

copyScene

getSceneMembership

initialize

ProtectedreactTo

recallScene

removeAllScenes

removeScene

requireAttributeEnabled

storeScene

toString

viewScene

Staticalter

Staticenable

Staticfor

Staticset

Staticwith

Settings

Member Visibility

On This Page

Constructors
Properties
Methods