Interface Cluster

This cluster provides an interface for managing low power mode on a device.

This cluster would be supported on an endpoint that represents a physical device with a low power mode. This cluster provides a sleep() command to allow clients to manually put the device into low power mode. There is no command here to wake up a sleeping device because that operation often involves other protocols such as Wake On LAN. Most devices automatically enter low power mode based upon inactivity.

The cluster server for Low Power is implemented by a device that supports a low power mode, such as a TV, Set-top box, or Smart Speaker.

NOTE

We have considered a “DisableLowPowerMode” command but have not added it due to suspected issues with energy consumption regulations. This can be added in the future.

See

MatterSpecification.v13.Cluster § 1.11

interface Cluster {
    attributes: {};
    base: undefined;
    commands: {
        sleep: Command<void, void, any>;
    };
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<1288, "ClusterId">;
    name: "LowPower";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        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: {}

base

base: undefined

commands

commands: {
    sleep: Command<void, void, any>;
}

Type declaration

  • Readonlysleep: Command<void, void, any>

    This command shall put the device into low power mode.

    See

    MatterSpecification.v13.Cluster § 1.11.4.1

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<1288, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          commands: {
              sleep: Command<void, void, any>;
          };
          id: 1288;
          name: "LowPower";
          revision: 1;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          commands: {
              sleep: Command<void, void, any>;
          };
          id: 1288;
          name: "LowPower";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {}

    Parameters

    Returns WithValues<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          commands: {
              sleep: Command<void, void, any>;
          };
          id: 1288;
          name: "LowPower";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        commands: {
            sleep: Command<void, void, any>;
        };
        id: 1288;
        name: "LowPower";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods