Interface Cluster

This cluster provides an interface to allow configuration of the user interface for a thermostat, or a thermostat controller device, that supports a keypad and LCD screen.

See

MatterSpecification.v13.Cluster § 4.5

interface Cluster {
    attributes: Merge<{
        keypadLockout: WritableAttribute<ThermostatUserInterfaceConfiguration.KeypadLockout, any>;
        scheduleProgrammingVisibility: OptionalWritableAttribute<ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility, any>;
        temperatureDisplayMode: WritableAttribute<ThermostatUserInterfaceConfiguration.TemperatureDisplayMode, any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<516, "ClusterId">;
    name: "ThermostatUserInterfaceConfiguration";
    revision: 2;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            keypadLockout: WritableAttribute<ThermostatUserInterfaceConfiguration.KeypadLockout, any>;
            scheduleProgrammingVisibility: OptionalWritableAttribute<ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility, any>;
            temperatureDisplayMode: WritableAttribute<ThermostatUserInterfaceConfiguration.TemperatureDisplayMode, any>;
        };
        id: 516;
        name: "ThermostatUserInterfaceConfiguration";
        revision: 2;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            keypadLockout: WritableAttribute<ThermostatUserInterfaceConfiguration.KeypadLockout, any>;
            scheduleProgrammingVisibility: OptionalWritableAttribute<ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility, any>;
            temperatureDisplayMode: WritableAttribute<ThermostatUserInterfaceConfiguration.TemperatureDisplayMode, any>;
        };
        id: 516;
        name: "ThermostatUserInterfaceConfiguration";
        revision: 2;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            keypadLockout: WritableAttribute<ThermostatUserInterfaceConfiguration.KeypadLockout, any>;
            scheduleProgrammingVisibility: OptionalWritableAttribute<ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility, any>;
            temperatureDisplayMode: WritableAttribute<ThermostatUserInterfaceConfiguration.TemperatureDisplayMode, any>;
        };
        id: 516;
        name: "ThermostatUserInterfaceConfiguration";
        revision: 2;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            keypadLockout: WritableAttribute<ThermostatUserInterfaceConfiguration.KeypadLockout, any>;
            scheduleProgrammingVisibility: OptionalWritableAttribute<ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility, any>;
            temperatureDisplayMode: WritableAttribute<ThermostatUserInterfaceConfiguration.TemperatureDisplayMode, any>;
        };
        id: 516;
        name: "ThermostatUserInterfaceConfiguration";
        revision: 2;
    }>, 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<{
    keypadLockout: WritableAttribute<ThermostatUserInterfaceConfiguration.KeypadLockout, any>;
    scheduleProgrammingVisibility: OptionalWritableAttribute<ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility, any>;
    temperatureDisplayMode: WritableAttribute<ThermostatUserInterfaceConfiguration.TemperatureDisplayMode, any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlykeypadLockout: WritableAttribute<ThermostatUserInterfaceConfiguration.KeypadLockout, any>

    Indicates the level of functionality that is available to the user via the keypad.

    See

    MatterSpecification.v13.Cluster § 4.5.6.2

  • ReadonlyscheduleProgrammingVisibility: OptionalWritableAttribute<ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility, any>

    This attribute is used to hide the weekly schedule programming functionality or menu on a thermostat from a user to prevent local user programming of the weekly schedule. The schedule programming may still be performed via a remote interface, and the thermostat may operate in schedule programming mode.

    This attribute is designed to prevent local tampering with or disabling of schedules that may have been programmed by users or service providers via a more capable remote interface. The programming schedule shall continue to run even though it is not visible to the user locally at the thermostat.

    See

    MatterSpecification.v13.Cluster § 4.5.6.3

  • ReadonlytemperatureDisplayMode: WritableAttribute<ThermostatUserInterfaceConfiguration.TemperatureDisplayMode, any>

    Indicates the units of the temperature displayed on the thermostat screen.

    See

    MatterSpecification.v13.Cluster § 4.5.6.1

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<516, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

set

with

Settings

Member Visibility

On This Page

Properties
Methods