Interface Cluster

The Scenes Management cluster provides attributes and commands for setting up and recalling scenes. Each scene corresponds to a set of stored values of specified attributes for one or more clusters on the same end point as the Scenes Management cluster.

In most cases scenes are associated with a particular group identifier. Scenes may also exist without a group, in which case the value 0 replaces the group identifier. Note that extra care is required in these cases to avoid a scene identifier collision, and that commands related to scenes without a group may only be unicast, i.e., they may not be multicast or broadcast.

NOTE Support for Scenes Management cluster is provisional.

ScenesManagementCluster supports optional features that you can enable with the ScenesManagementCluster.with() factory method.

See

MatterSpecification.v13.Cluster § 1.4

interface Cluster {
    attributes: Merge<{
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    }, GlobalAttributes<{
        sceneNames: BitFlag;
    }>>;
    base: undefined;
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: FieldType<TypeFromFields<(...)>[]>;
                clusterId: FieldType<ClusterId>;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: FieldType<TypeFromFields<(...)>[]>;
                clusterId: FieldType<ClusterId>;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    events: {};
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: Branded<98, "ClusterId">;
    name: "ScenesManagement";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
                currentGroup: FieldType<GroupId>;
                currentScene: FieldType<number>;
                fabricIndex: FieldType<FabricIndex>;
                remainingCapacity: FieldType<number>;
                sceneCount: FieldType<number>;
                sceneValid: FieldType<boolean>;
            }>[], any>;
            lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
            sceneTableSize: FixedAttribute<number, any>;
        };
        commands: {
            addScene: Command<TypeFromFields<{
                extensionFieldSetStructs: FieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: FieldType<string>;
                transitionTime: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            copyScene: OptionalCommand<TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                groupIdentifierTo: FieldType<GroupId>;
                mode: FieldType<TypeFromPartialBitSchema<{
                    copyAllScenes: BitFlag;
                }>>;
                sceneIdentifierFrom: FieldType<number>;
                sceneIdentifierTo: FieldType<number>;
            }>, TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                sceneIdentifierFrom: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            getSceneMembership: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                capacity: FieldType<null | number>;
                groupId: FieldType<GroupId>;
                sceneList: OptionalFieldType<number[]>;
                status: FieldType<Status>;
            }>, any>;
            recallScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                transitionTime: OptionalFieldType<null | number>;
            }>, void, any>;
            removeAllScenes: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                status: FieldType<Status>;
            }>, any>;
            removeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            storeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            viewScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: OptionalFieldType<string>;
                status: FieldType<Status>;
                transitionTime: OptionalFieldType<number>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            sceneNames: BitFlag;
        };
        id: 98;
        name: "ScenesManagement";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
                currentGroup: FieldType<GroupId>;
                currentScene: FieldType<number>;
                fabricIndex: FieldType<FabricIndex>;
                remainingCapacity: FieldType<number>;
                sceneCount: FieldType<number>;
                sceneValid: FieldType<boolean>;
            }>[], any>;
            lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
            sceneTableSize: FixedAttribute<number, any>;
        };
        commands: {
            addScene: Command<TypeFromFields<{
                extensionFieldSetStructs: FieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: FieldType<string>;
                transitionTime: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            copyScene: OptionalCommand<TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                groupIdentifierTo: FieldType<GroupId>;
                mode: FieldType<TypeFromPartialBitSchema<{
                    copyAllScenes: BitFlag;
                }>>;
                sceneIdentifierFrom: FieldType<number>;
                sceneIdentifierTo: FieldType<number>;
            }>, TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                sceneIdentifierFrom: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            getSceneMembership: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                capacity: FieldType<null | number>;
                groupId: FieldType<GroupId>;
                sceneList: OptionalFieldType<number[]>;
                status: FieldType<Status>;
            }>, any>;
            recallScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                transitionTime: OptionalFieldType<null | number>;
            }>, void, any>;
            removeAllScenes: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                status: FieldType<Status>;
            }>, any>;
            removeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            storeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            viewScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: OptionalFieldType<string>;
                status: FieldType<Status>;
                transitionTime: OptionalFieldType<number>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            sceneNames: BitFlag;
        };
        id: 98;
        name: "ScenesManagement";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
                currentGroup: FieldType<GroupId>;
                currentScene: FieldType<number>;
                fabricIndex: FieldType<FabricIndex>;
                remainingCapacity: FieldType<number>;
                sceneCount: FieldType<number>;
                sceneValid: FieldType<boolean>;
            }>[], any>;
            lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
            sceneTableSize: FixedAttribute<number, any>;
        };
        commands: {
            addScene: Command<TypeFromFields<{
                extensionFieldSetStructs: FieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: FieldType<string>;
                transitionTime: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            copyScene: OptionalCommand<TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                groupIdentifierTo: FieldType<GroupId>;
                mode: FieldType<TypeFromPartialBitSchema<{
                    copyAllScenes: BitFlag;
                }>>;
                sceneIdentifierFrom: FieldType<number>;
                sceneIdentifierTo: FieldType<number>;
            }>, TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                sceneIdentifierFrom: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            getSceneMembership: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                capacity: FieldType<null | number>;
                groupId: FieldType<GroupId>;
                sceneList: OptionalFieldType<number[]>;
                status: FieldType<Status>;
            }>, any>;
            recallScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                transitionTime: OptionalFieldType<null | number>;
            }>, void, any>;
            removeAllScenes: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                status: FieldType<Status>;
            }>, any>;
            removeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            storeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            viewScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: OptionalFieldType<string>;
                status: FieldType<Status>;
                transitionTime: OptionalFieldType<number>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            sceneNames: BitFlag;
        };
        id: 98;
        name: "ScenesManagement";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
                currentGroup: FieldType<GroupId>;
                currentScene: FieldType<number>;
                fabricIndex: FieldType<FabricIndex>;
                remainingCapacity: FieldType<number>;
                sceneCount: FieldType<number>;
                sceneValid: FieldType<boolean>;
            }>[], any>;
            lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
            sceneTableSize: FixedAttribute<number, any>;
        };
        commands: {
            addScene: Command<TypeFromFields<{
                extensionFieldSetStructs: FieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: FieldType<string>;
                transitionTime: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            copyScene: OptionalCommand<TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                groupIdentifierTo: FieldType<GroupId>;
                mode: FieldType<TypeFromPartialBitSchema<{
                    copyAllScenes: BitFlag;
                }>>;
                sceneIdentifierFrom: FieldType<number>;
                sceneIdentifierTo: FieldType<number>;
            }>, TypeFromFields<{
                groupIdentifierFrom: FieldType<GroupId>;
                sceneIdentifierFrom: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            getSceneMembership: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                capacity: FieldType<null | number>;
                groupId: FieldType<GroupId>;
                sceneList: OptionalFieldType<number[]>;
                status: FieldType<Status>;
            }>, any>;
            recallScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                transitionTime: OptionalFieldType<null | number>;
            }>, void, any>;
            removeAllScenes: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                status: FieldType<Status>;
            }>, any>;
            removeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            storeScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                status: FieldType<Status>;
            }>, any>;
            viewScene: Command<TypeFromFields<{
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
            }>, TypeFromFields<{
                extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                    attributeValueList: ...;
                    clusterId: ...;
                }>[]>;
                groupId: FieldType<GroupId>;
                sceneId: FieldType<number>;
                sceneName: OptionalFieldType<string>;
                status: FieldType<Status>;
                transitionTime: OptionalFieldType<number>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            sceneNames: BitFlag;
        };
        id: 98;
        name: "ScenesManagement";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Identity<typeof ScenesManagement.ClusterInstance>
- Cluster

Index

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
        currentGroup: FieldType<GroupId>;
        currentScene: FieldType<number>;
        fabricIndex: FieldType<FabricIndex>;
        remainingCapacity: FieldType<number>;
        sceneCount: FieldType<number>;
        sceneValid: FieldType<boolean>;
    }>[], any>;
    lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
    sceneTableSize: FixedAttribute<number, any>;
}, GlobalAttributes<{
    sceneNames: BitFlag;
}>>

Type declaration

ReadonlyfabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
    currentGroup: FieldType<GroupId>;
    currentScene: FieldType<number>;
    fabricIndex: FieldType<FabricIndex>;
    remainingCapacity: FieldType<number>;
    sceneCount: FieldType<number>;
    sceneValid: FieldType<boolean>;
}>[], any>
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
ReadonlylastConfiguredBy: OptionalAttribute<null | NodeId, any>
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
ReadonlysceneTableSize: FixedAttribute<number, any>
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

base

base: undefined

commands

commands: {
    addScene: Command<TypeFromFields<{
        extensionFieldSetStructs: FieldType<TypeFromFields<{
            attributeValueList: FieldType<TypeFromFields<(...)>[]>;
            clusterId: FieldType<ClusterId>;
        }>[]>;
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
        sceneName: FieldType<string>;
        transitionTime: FieldType<number>;
    }>, TypeFromFields<{
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
        status: FieldType<Status>;
    }>, any>;
    copyScene: OptionalCommand<TypeFromFields<{
        groupIdentifierFrom: FieldType<GroupId>;
        groupIdentifierTo: FieldType<GroupId>;
        mode: FieldType<TypeFromPartialBitSchema<{
            copyAllScenes: BitFlag;
        }>>;
        sceneIdentifierFrom: FieldType<number>;
        sceneIdentifierTo: FieldType<number>;
    }>, TypeFromFields<{
        groupIdentifierFrom: FieldType<GroupId>;
        sceneIdentifierFrom: FieldType<number>;
        status: FieldType<Status>;
    }>, any>;
    getSceneMembership: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
    }>, TypeFromFields<{
        capacity: FieldType<null | number>;
        groupId: FieldType<GroupId>;
        sceneList: OptionalFieldType<number[]>;
        status: FieldType<Status>;
    }>, any>;
    recallScene: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
        transitionTime: OptionalFieldType<null | number>;
    }>, void, any>;
    removeAllScenes: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
    }>, TypeFromFields<{
        groupId: FieldType<GroupId>;
        status: FieldType<Status>;
    }>, any>;
    removeScene: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
    }>, TypeFromFields<{
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
        status: FieldType<Status>;
    }>, any>;
    storeScene: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
    }>, TypeFromFields<{
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
        status: FieldType<Status>;
    }>, any>;
    viewScene: Command<TypeFromFields<{
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
    }>, TypeFromFields<{
        extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
            attributeValueList: FieldType<TypeFromFields<(...)>[]>;
            clusterId: FieldType<ClusterId>;
        }>[]>;
        groupId: FieldType<GroupId>;
        sceneId: FieldType<number>;
        sceneName: OptionalFieldType<string>;
        status: FieldType<Status>;
        transitionTime: OptionalFieldType<number>;
    }>, any>;
}

Type declaration

ReadonlyaddScene: Command<TypeFromFields<{
    extensionFieldSetStructs: FieldType<TypeFromFields<{
        attributeValueList: FieldType<TypeFromFields<(...)>[]>;
        clusterId: FieldType<ClusterId>;
    }>[]>;
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
    sceneName: FieldType<string>;
    transitionTime: FieldType<number>;
}>, TypeFromFields<{
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
    status: FieldType<Status>;
}>, any>
It is not mandatory for an extension field set to be included in the command for every cluster on that endpoint that has a defined extension field set. Extension field sets may be omitted, including the case of no extension field sets at all.

See
MatterSpecification.v13.Cluster § 1.4.9.2
ReadonlycopyScene: OptionalCommand<TypeFromFields<{
    groupIdentifierFrom: FieldType<GroupId>;
    groupIdentifierTo: FieldType<GroupId>;
    mode: FieldType<TypeFromPartialBitSchema<{
        copyAllScenes: BitFlag;
    }>>;
    sceneIdentifierFrom: FieldType<number>;
    sceneIdentifierTo: FieldType<number>;
}>, TypeFromFields<{
    groupIdentifierFrom: FieldType<GroupId>;
    sceneIdentifierFrom: FieldType<number>;
    status: FieldType<Status>;
}>, any>
This command allows a client to efficiently copy scenes from one group/scene identifier pair to another group/scene identifier pair.

See
MatterSpecification.v13.Cluster § 1.4.9.15
ReadonlygetSceneMembership: Command<TypeFromFields<{
    groupId: FieldType<GroupId>;
}>, TypeFromFields<{
    capacity: FieldType<null | number>;
    groupId: FieldType<GroupId>;
    sceneList: OptionalFieldType<number[]>;
    status: FieldType<Status>;
}>, any>
This command can be used to get the used scene identifiers within a certain group, for the endpoint that implements this cluster.

See
MatterSpecification.v13.Cluster § 1.4.9.13
ReadonlyrecallScene: Command<TypeFromFields<{
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
    transitionTime: OptionalFieldType<null | number>;
}>, void, any>
See
MatterSpecification.v13.Cluster § 1.4.9.12
ReadonlyremoveAllScenes: Command<TypeFromFields<{
    groupId: FieldType<GroupId>;
}>, TypeFromFields<{
    groupId: FieldType<GroupId>;
    status: FieldType<Status>;
}>, any>
See
MatterSpecification.v13.Cluster § 1.4.9.8
ReadonlyremoveScene: Command<TypeFromFields<{
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
}>, TypeFromFields<{
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
    status: FieldType<Status>;
}>, any>
See
MatterSpecification.v13.Cluster § 1.4.9.6
ReadonlystoreScene: Command<TypeFromFields<{
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
}>, TypeFromFields<{
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
    status: FieldType<Status>;
}>, any>
See
MatterSpecification.v13.Cluster § 1.4.9.10
ReadonlyviewScene: Command<TypeFromFields<{
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
}>, TypeFromFields<{
    extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
        attributeValueList: FieldType<TypeFromFields<(...)>[]>;
        clusterId: FieldType<ClusterId>;
    }>[]>;
    groupId: FieldType<GroupId>;
    sceneId: FieldType<number>;
    sceneName: OptionalFieldType<string>;
    status: FieldType<Status>;
    transitionTime: OptionalFieldType<number>;
}>, any>
See
MatterSpecification.v13.Cluster § 1.4.9.4

events

events: {}

extensions

extensions: readonly []

features

features: {
sceneNames: BitFlag;
}

Type declaration

ReadonlysceneNames: BitFlag
SceneNames

This feature indicates the ability to store a name for a scene when a scene is added.

See
MatterSpecification.v13.Cluster § 1.4.4.1

id

id: Branded<98, "ClusterId">

name

revision

supportedFeatures

supportedFeatures: {}

unknown

Methods

alter

alter<const AlterationsT>(alterations): WithAlterations<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, AlterationsT>
Modify elements using ElementModifier.alter.
Type Parameters
- const AlterationsT extends Alterations<Of<{
      attributes: {
          fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
              currentGroup: FieldType<GroupId>;
              currentScene: FieldType<number>;
              fabricIndex: FieldType<FabricIndex>;
              remainingCapacity: FieldType<number>;
              sceneCount: FieldType<number>;
              sceneValid: FieldType<boolean>;
          }>[], any>;
          lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
          sceneTableSize: FixedAttribute<number, any>;
      };
      commands: {
          addScene: Command<TypeFromFields<{
              extensionFieldSetStructs: FieldType<TypeFromFields<{
                  attributeValueList: ...;
                  clusterId: ...;
              }>[]>;
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              sceneName: FieldType<string>;
              transitionTime: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          copyScene: OptionalCommand<TypeFromFields<{
              groupIdentifierFrom: FieldType<GroupId>;
              groupIdentifierTo: FieldType<GroupId>;
              mode: FieldType<TypeFromPartialBitSchema<{
                  copyAllScenes: BitFlag;
              }>>;
              sceneIdentifierFrom: FieldType<number>;
              sceneIdentifierTo: FieldType<number>;
          }>, TypeFromFields<{
              groupIdentifierFrom: FieldType<GroupId>;
              sceneIdentifierFrom: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          getSceneMembership: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
          }>, TypeFromFields<{
              capacity: FieldType<null | number>;
              groupId: FieldType<GroupId>;
              sceneList: OptionalFieldType<number[]>;
              status: FieldType<Status>;
          }>, any>;
          recallScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              transitionTime: OptionalFieldType<null | number>;
          }>, void, any>;
          removeAllScenes: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              status: FieldType<Status>;
          }>, any>;
          removeScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          storeScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          viewScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                  attributeValueList: ...;
                  clusterId: ...;
              }>[]>;
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              sceneName: OptionalFieldType<string>;
              status: FieldType<Status>;
              transitionTime: OptionalFieldType<number>;
          }>, any>;
      };
      extensions: readonly [];
      features: {
          sceneNames: BitFlag;
      };
      id: 98;
      name: "ScenesManagement";
      revision: 1;
  }>>
Parameters
- alterations: AlterationsT
Returns WithAlterations<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, AlterationsT>
Inherited from Identity.alter
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:37

enable

enable<const FlagsT>(flags): WithFlags<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, FlagsT>
Modify elements using ElementModifier.enable.
Type Parameters
- const FlagsT extends ElementFlags<Of<{
      attributes: {
          fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
              currentGroup: FieldType<GroupId>;
              currentScene: FieldType<number>;
              fabricIndex: FieldType<FabricIndex>;
              remainingCapacity: FieldType<number>;
              sceneCount: FieldType<number>;
              sceneValid: FieldType<boolean>;
          }>[], any>;
          lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
          sceneTableSize: FixedAttribute<number, any>;
      };
      commands: {
          addScene: Command<TypeFromFields<{
              extensionFieldSetStructs: FieldType<TypeFromFields<{
                  attributeValueList: ...;
                  clusterId: ...;
              }>[]>;
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              sceneName: FieldType<string>;
              transitionTime: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          copyScene: OptionalCommand<TypeFromFields<{
              groupIdentifierFrom: FieldType<GroupId>;
              groupIdentifierTo: FieldType<GroupId>;
              mode: FieldType<TypeFromPartialBitSchema<{
                  copyAllScenes: BitFlag;
              }>>;
              sceneIdentifierFrom: FieldType<number>;
              sceneIdentifierTo: FieldType<number>;
          }>, TypeFromFields<{
              groupIdentifierFrom: FieldType<GroupId>;
              sceneIdentifierFrom: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          getSceneMembership: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
          }>, TypeFromFields<{
              capacity: FieldType<null | number>;
              groupId: FieldType<GroupId>;
              sceneList: OptionalFieldType<number[]>;
              status: FieldType<Status>;
          }>, any>;
          recallScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              transitionTime: OptionalFieldType<null | number>;
          }>, void, any>;
          removeAllScenes: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              status: FieldType<Status>;
          }>, any>;
          removeScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          storeScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          viewScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                  attributeValueList: ...;
                  clusterId: ...;
              }>[]>;
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              sceneName: OptionalFieldType<string>;
              status: FieldType<Status>;
              transitionTime: OptionalFieldType<number>;
          }>, any>;
      };
      extensions: readonly [];
      features: {
          sceneNames: BitFlag;
      };
      id: 98;
      name: "ScenesManagement";
      revision: 1;
  }>>
Parameters
- flags: FlagsT
Returns WithFlags<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, FlagsT>
Inherited from Identity.enable
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:45

set

set<const ValuesT>(values): WithValues<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, ValuesT>
Modify elements using ElementModifier.set.
Type Parameters
- const ValuesT extends {
      fabricSceneInfo: {
          currentGroup: number;
          currentScene: number;
          fabricIndex: number;
          remainingCapacity: number;
          sceneCount: number;
          sceneValid: boolean;
      }[];
      lastConfiguredBy?: null | bigint;
      sceneTableSize: number;
  }
Parameters
- values: ValuesT
Returns WithValues<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, ValuesT>
Inherited from Identity.set
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:41

with

with<const SelectionT>(...selection): Of<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, SelectionT>
Select features using ClusterComposer.compose.
Type Parameters
- const SelectionT extends FeatureSelection<Of<{
      attributes: {
          fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
              currentGroup: FieldType<GroupId>;
              currentScene: FieldType<number>;
              fabricIndex: FieldType<FabricIndex>;
              remainingCapacity: FieldType<number>;
              sceneCount: FieldType<number>;
              sceneValid: FieldType<boolean>;
          }>[], any>;
          lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
          sceneTableSize: FixedAttribute<number, any>;
      };
      commands: {
          addScene: Command<TypeFromFields<{
              extensionFieldSetStructs: FieldType<TypeFromFields<{
                  attributeValueList: ...;
                  clusterId: ...;
              }>[]>;
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              sceneName: FieldType<string>;
              transitionTime: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          copyScene: OptionalCommand<TypeFromFields<{
              groupIdentifierFrom: FieldType<GroupId>;
              groupIdentifierTo: FieldType<GroupId>;
              mode: FieldType<TypeFromPartialBitSchema<{
                  copyAllScenes: BitFlag;
              }>>;
              sceneIdentifierFrom: FieldType<number>;
              sceneIdentifierTo: FieldType<number>;
          }>, TypeFromFields<{
              groupIdentifierFrom: FieldType<GroupId>;
              sceneIdentifierFrom: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          getSceneMembership: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
          }>, TypeFromFields<{
              capacity: FieldType<null | number>;
              groupId: FieldType<GroupId>;
              sceneList: OptionalFieldType<number[]>;
              status: FieldType<Status>;
          }>, any>;
          recallScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              transitionTime: OptionalFieldType<null | number>;
          }>, void, any>;
          removeAllScenes: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              status: FieldType<Status>;
          }>, any>;
          removeScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          storeScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              status: FieldType<Status>;
          }>, any>;
          viewScene: Command<TypeFromFields<{
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
          }>, TypeFromFields<{
              extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                  attributeValueList: ...;
                  clusterId: ...;
              }>[]>;
              groupId: FieldType<GroupId>;
              sceneId: FieldType<number>;
              sceneName: OptionalFieldType<string>;
              status: FieldType<Status>;
              transitionTime: OptionalFieldType<number>;
          }>, any>;
      };
      extensions: readonly [];
      features: {
          sceneNames: BitFlag;
      };
      id: 98;
      name: "ScenesManagement";
      revision: 1;
  }>>
Parameters
- Rest...selection: SelectionT
Returns Of<Of<{
    attributes: {
        fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
            currentGroup: FieldType<GroupId>;
            currentScene: FieldType<number>;
            fabricIndex: FieldType<FabricIndex>;
            remainingCapacity: FieldType<number>;
            sceneCount: FieldType<number>;
            sceneValid: FieldType<boolean>;
        }>[], any>;
        lastConfiguredBy: OptionalAttribute<null | NodeId, any>;
        sceneTableSize: FixedAttribute<number, any>;
    };
    commands: {
        addScene: Command<TypeFromFields<{
            extensionFieldSetStructs: FieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: FieldType<string>;
            transitionTime: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        copyScene: OptionalCommand<TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            groupIdentifierTo: FieldType<GroupId>;
            mode: FieldType<TypeFromPartialBitSchema<{
                copyAllScenes: BitFlag;
            }>>;
            sceneIdentifierFrom: FieldType<number>;
            sceneIdentifierTo: FieldType<number>;
        }>, TypeFromFields<{
            groupIdentifierFrom: FieldType<GroupId>;
            sceneIdentifierFrom: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        getSceneMembership: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            capacity: FieldType<null | number>;
            groupId: FieldType<GroupId>;
            sceneList: OptionalFieldType<number[]>;
            status: FieldType<Status>;
        }>, any>;
        recallScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            transitionTime: OptionalFieldType<null | number>;
        }>, void, any>;
        removeAllScenes: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            status: FieldType<Status>;
        }>, any>;
        removeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        storeScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            status: FieldType<Status>;
        }>, any>;
        viewScene: Command<TypeFromFields<{
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
        }>, TypeFromFields<{
            extensionFieldSetStructs: OptionalFieldType<TypeFromFields<{
                attributeValueList: ...;
                clusterId: ...;
            }>[]>;
            groupId: FieldType<GroupId>;
            sceneId: FieldType<number>;
            sceneName: OptionalFieldType<string>;
            status: FieldType<Status>;
            transitionTime: OptionalFieldType<number>;
        }>, any>;
    };
    extensions: readonly [];
    features: {
        sceneNames: BitFlag;
    };
    id: 98;
    name: "ScenesManagement";
    revision: 1;
}>, SelectionT>
Inherited from Identity.with
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:33

Interface Cluster

See

Hierarchy (view full)

Index

Properties

Methods

Properties

attributes

Type declaration

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

See

ReadonlylastConfiguredBy: OptionalAttribute<null | NodeId, any>

See

ReadonlysceneTableSize: FixedAttribute<number, any>

See

base

commands

Type declaration

See

See

ReadonlygetSceneMembership: Command<TypeFromFields<{ groupId: FieldType<GroupId>; }>, TypeFromFields<{ capacity: FieldType<null | number>; groupId: FieldType<GroupId>; sceneList: OptionalFieldType<number[]>; status: FieldType<Status>; }>, any>

See

ReadonlyrecallScene: Command<TypeFromFields<{ groupId: FieldType<GroupId>; sceneId: FieldType<number>; transitionTime: OptionalFieldType<null | number>; }>, void, any>

See

ReadonlyremoveAllScenes: Command<TypeFromFields<{ groupId: FieldType<GroupId>; }>, TypeFromFields<{ groupId: FieldType<GroupId>; status: FieldType<Status>; }>, any>

See

ReadonlyremoveScene: Command<TypeFromFields<{ groupId: FieldType<GroupId>; sceneId: FieldType<number>; }>, TypeFromFields<{ groupId: FieldType<GroupId>; sceneId: FieldType<number>; status: FieldType<Status>; }>, any>

See

ReadonlystoreScene: Command<TypeFromFields<{ groupId: FieldType<GroupId>; sceneId: FieldType<number>; }>, TypeFromFields<{ groupId: FieldType<GroupId>; sceneId: FieldType<number>; status: FieldType<Status>; }>, any>

See

See

events

extensions

features

Type declaration

ReadonlysceneNames: BitFlag

See

id

name

revision

supportedFeatures

unknown

Methods

alter

Type Parameters

Parameters

enable

Type Parameters

Parameters

set

Type Parameters

Parameters

with

Type Parameters

Parameters

Settings

On This Page

`Readonly`fabricSceneInfo: FabricScopedAttribute<TypeFromFields<{
currentGroup: FieldType<GroupId>;
currentScene: FieldType<number>;
fabricIndex: FieldType<FabricIndex>;
remainingCapacity: FieldType<number>;
sceneCount: FieldType<number>;
sceneValid: FieldType<boolean>;
}>[], any>

`Readonly`lastConfiguredBy: OptionalAttribute<null | NodeId, any>

`Readonly`sceneTableSize: FixedAttribute<number, any>

`Readonly`getSceneMembership: Command<TypeFromFields<{
groupId: FieldType<GroupId>;
}>, TypeFromFields<{
capacity: FieldType<null | number>;
groupId: FieldType<GroupId>;
sceneList: OptionalFieldType<number[]>;
status: FieldType<Status>;
}>, any>

`Readonly`recallScene: Command<TypeFromFields<{
groupId: FieldType<GroupId>;
sceneId: FieldType<number>;
transitionTime: OptionalFieldType<null | number>;
}>, void, any>

`Readonly`removeAllScenes: Command<TypeFromFields<{
groupId: FieldType<GroupId>;
}>, TypeFromFields<{
groupId: FieldType<GroupId>;
status: FieldType<Status>;
}>, any>

`Readonly`removeScene: Command<TypeFromFields<{
groupId: FieldType<GroupId>;
sceneId: FieldType<number>;
}>, TypeFromFields<{
groupId: FieldType<GroupId>;
sceneId: FieldType<number>;
status: FieldType<Status>;
}>, any>

`Readonly`storeScene: Command<TypeFromFields<{
groupId: FieldType<GroupId>;
sceneId: FieldType<number>;
}>, TypeFromFields<{
groupId: FieldType<GroupId>;
sceneId: FieldType<number>;
status: FieldType<Status>;
}>, any>

`Readonly`sceneNames: BitFlag