Variable BaseConst

Type declaration

• Readonlyattributes: {
      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>;
  }

  • 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

• Readonlycommands: {
      addScene: Command<TypeFromFields<{
          extensionFieldSetStructs: FieldType<TypeFromFields<{
              attributeValueList: FieldType<(...)[]>;
              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<(...)[]>;
              clusterId: FieldType<ClusterId>;
          }>[]>;
          groupId: FieldType<GroupId>;
          sceneId: FieldType<number>;
          sceneName: OptionalFieldType<string>;
          status: FieldType<Status>;
          transitionTime: OptionalFieldType<number>;
      }>, any>;
  }

  • ReadonlyaddScene: Command<TypeFromFields<{
        extensionFieldSetStructs: FieldType<TypeFromFields<{
            attributeValueList: FieldType<(...)[]>;
            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<(...)[]>;
            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

• Readonlyextensions: readonly []

  This metadata controls which ScenesManagementCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      sceneNames: BitFlag;
  }

  • 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

• Readonlyid: 98

• Readonlyname: "ScenesManagement"

• Readonlyrevision: 1