Interface Cluster

This cluster is used to describe the configuration and capabilities of a Device’s power system. It provides an ordering overview as well as linking to the one or more endpoints each supporting a Power Source cluster.

See

MatterSpecification.v13.Core § 11.6

interface Cluster {
    attributes: Merge<{
        sources: Attribute<EndpointNumber[], any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<46, "ClusterId">;
    name: "PowerSourceConfiguration";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    sources: Attribute<EndpointNumber[], any>;
}, GlobalAttributes<{}>>

Type declaration

  • Readonlysources: Attribute<EndpointNumber[], any>

    This list shall contain the set of all power sources capable of participating in the power system of this Node. Each entry in the list shall be the endpoint number of an endpoint having a Power Source cluster, which corresponds to a physical power source. The endpoint number shall be unique within the list.

    The order of power sources on a Node is defined by the Order attribute of its associated Power Source cluster provided on the endpoint. List entries shall be sorted in increasing order, that is, an entry with a lower order shall have a lower index than any entry with a higher order. Multiple entries may have the same order, there are no restrictions on their relative sorting.

    See

    MatterSpecification.v13.Core § 11.6.4.1

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<46, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              sources: Attribute<EndpointNumber[], any>;
          };
          id: 46;
          name: "PowerSourceConfiguration";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          sources: number[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              sources: Attribute<EndpointNumber[], any>;
          };
          id: 46;
          name: "PowerSourceConfiguration";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            sources: Attribute<EndpointNumber[], any>;
        };
        id: 46;
        name: "PowerSourceConfiguration";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods