Interface AddSceneRequest

Input to the ScenesManagement addScene command

See

MatterSpecification.v13.Cluster § 1.4.9.2

interface AddSceneRequest {
    extensionFieldSetStructs: TypeFromFields<{
        attributeValueList: FieldType<TypeFromFields<{
            attributeId: FieldType<AttributeId>;
            valueSigned16: OptionalFieldType<number>;
            valueSigned32: OptionalFieldType<number>;
            valueSigned64: OptionalFieldType<number | bigint>;
            valueSigned8: OptionalFieldType<number>;
            valueUnsigned16: OptionalFieldType<number>;
            valueUnsigned32: OptionalFieldType<number>;
            valueUnsigned64: OptionalFieldType<number | bigint>;
            valueUnsigned8: OptionalFieldType<number>;
        }>[]>;
        clusterId: FieldType<ClusterId>;
    }>[];
    groupId: GroupId;
    sceneId: number;
    sceneName: string;
    transitionTime: number;
}

Hierarchy (view full)

Properties

extensionFieldSetStructs groupId sceneId sceneName transitionTime

Properties

extensionFieldSetStructs

extensionFieldSetStructs: TypeFromFields<{
    attributeValueList: FieldType<TypeFromFields<{
        attributeId: FieldType<AttributeId>;
        valueSigned16: OptionalFieldType<number>;
        valueSigned32: OptionalFieldType<number>;
        valueSigned64: OptionalFieldType<number | bigint>;
        valueSigned8: OptionalFieldType<number>;
        valueUnsigned16: OptionalFieldType<number>;
        valueUnsigned32: OptionalFieldType<number>;
        valueUnsigned64: OptionalFieldType<number | bigint>;
        valueUnsigned8: OptionalFieldType<number>;
    }>[]>;
    clusterId: FieldType<ClusterId>;
}>[]

This field shall contains the list of extension fields.

See

MatterSpecification.v13.Cluster § 1.4.9.2.5

groupId

groupId: GroupId

This field shall indicate the group identifier in the Group Table.

See

MatterSpecification.v13.Cluster § 1.4.9.2.1

sceneId

sceneId: number

This field shall indicate the scene identifier in the Scene Table.

See

MatterSpecification.v13.Cluster § 1.4.9.2.2

sceneName

sceneName: string

This field shall indicate the name of the scene.

See

MatterSpecification.v13.Cluster § 1.4.9.2.4

transitionTime

transitionTime: number

This field shall indicate the transition time of the scene, measured in milliseconds.

See

MatterSpecification.v13.Cluster § 1.4.9.2.3

Settings

Member Visibility

On This Page

Properties