Interface Cluster

This cluster provides an interface to a boolean state.

See

MatterSpecification.v13.Cluster § 1.7

interface Cluster {
    attributes: Merge<{
        stateValue: Attribute<boolean, any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {
        stateChange: OptionalEvent<TypeFromFields<{
            stateValue: FieldType<boolean>;
        }>, any>;
    };
    extensions: undefined;
    features: {};
    id: Branded<69, "ClusterId">;
    name: "BooleanState";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        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<{
    stateValue: Attribute<boolean, any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlystateValue: Attribute<boolean, any>

    This represents a boolean state.

    The semantics of this boolean state are defined by the device type using this cluster.

    For example, in a Contact Sensor device type, FALSE=open or no contact, TRUE=closed or contact.

    See

    MatterSpecification.v13.Cluster § 1.7.4.1

base

base: undefined

commands

commands: {}

events

events: {
    stateChange: OptionalEvent<TypeFromFields<{
        stateValue: FieldType<boolean>;
    }>, any>;
}

Type declaration

  • ReadonlystateChange: OptionalEvent<TypeFromFields<{
        stateValue: FieldType<boolean>;
    }>, any>

    If this event is supported, it shall be generated when the StateValue attribute changes.

    See

    MatterSpecification.v13.Cluster § 1.7.5.1

extensions

extensions: undefined

features

features: {}

id

id: Branded<69, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          attributes: {
              stateValue: Attribute<boolean, any>;
          };
          events: {
              stateChange: OptionalEvent<TypeFromFields<{
                  stateValue: FieldType<boolean>;
              }>, any>;
          };
          id: 69;
          name: "BooleanState";
          revision: 1;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              stateValue: Attribute<boolean, any>;
          };
          events: {
              stateChange: OptionalEvent<TypeFromFields<{
                  stateValue: FieldType<boolean>;
              }>, any>;
          };
          id: 69;
          name: "BooleanState";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          stateValue: boolean;
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              stateValue: Attribute<boolean, any>;
          };
          events: {
              stateChange: OptionalEvent<TypeFromFields<{
                  stateValue: FieldType<boolean>;
              }>, any>;
          };
          id: 69;
          name: "BooleanState";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            stateValue: Attribute<boolean, any>;
        };
        events: {
            stateChange: OptionalEvent<TypeFromFields<{
                stateValue: FieldType<boolean>;
            }>, any>;
        };
        id: 69;
        name: "BooleanState";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods