Interface Cluster

This cluster provides an interface for key code based input and control on a device like a Video Player or an endpoint like a Content App. This may include text or action commands such as UP, DOWN, and SELECT.

This cluster would be supported on Video Player devices as well as devices that support remote control input from a keypad or remote. This cluster provides the list of supported keypad inputs and provides a command for sending them.

The cluster server for Keypad Input is implemented by a device that can receive keypad input, such as a Video Player, or an endpoint that can receive keypad input, such as a Content App.

The key codes used are those defined in the HDMI CEC specification (see HDMI).

Devices may understand a subset of these key codes. Feature flags are used to indicate a specific subset that is supported. Device may support additional codes beyond what is indicated in feature flags.

KeypadInputCluster supports optional features that you can enable with the KeypadInputCluster.with() factory method.

See

MatterSpecification.v13.Cluster § 6.8

interface Cluster {
    attributes: {};
    base: undefined;
    commands: {
        sendKey: Command<TypeFromFields<{
            keyCode: FieldType<KeypadInput.CecKeyCode>;
        }>, TypeFromFields<{
            status: FieldType<KeypadInput.Status>;
        }>, any>;
    };
    events: {};
    extensions: readonly [];
    features: {
        locationKeys: BitFlag;
        navigationKeyCodes: BitFlag;
        numberKeys: BitFlag;
    };
    id: Branded<1289, "ClusterId">;
    name: "KeypadInput";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        commands: {
            sendKey: Command<TypeFromFields<{
                keyCode: FieldType<KeypadInput.CecKeyCode>;
            }>, TypeFromFields<{
                status: FieldType<KeypadInput.Status>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            locationKeys: BitFlag;
            navigationKeyCodes: BitFlag;
            numberKeys: BitFlag;
        };
        id: 1289;
        name: "KeypadInput";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        commands: {
            sendKey: Command<TypeFromFields<{
                keyCode: FieldType<KeypadInput.CecKeyCode>;
            }>, TypeFromFields<{
                status: FieldType<KeypadInput.Status>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            locationKeys: BitFlag;
            navigationKeyCodes: BitFlag;
            numberKeys: BitFlag;
        };
        id: 1289;
        name: "KeypadInput";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        commands: {
            sendKey: Command<TypeFromFields<{
                keyCode: FieldType<KeypadInput.CecKeyCode>;
            }>, TypeFromFields<{
                status: FieldType<KeypadInput.Status>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            locationKeys: BitFlag;
            navigationKeyCodes: BitFlag;
            numberKeys: BitFlag;
        };
        id: 1289;
        name: "KeypadInput";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        commands: {
            sendKey: Command<TypeFromFields<{
                keyCode: FieldType<KeypadInput.CecKeyCode>;
            }>, TypeFromFields<{
                status: FieldType<KeypadInput.Status>;
            }>, any>;
        };
        extensions: readonly [];
        features: {
            locationKeys: BitFlag;
            navigationKeyCodes: BitFlag;
            numberKeys: BitFlag;
        };
        id: 1289;
        name: "KeypadInput";
        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: {
    sendKey: Command<TypeFromFields<{
        keyCode: FieldType<KeypadInput.CecKeyCode>;
    }>, TypeFromFields<{
        status: FieldType<KeypadInput.Status>;
    }>, any>;
}

Type declaration

  • ReadonlysendKey: Command<TypeFromFields<{
        keyCode: FieldType<KeypadInput.CecKeyCode>;
    }>, TypeFromFields<{
        status: FieldType<KeypadInput.Status>;
    }>, any>

    Upon receipt, this shall process a keycode as input to the media endpoint.

    If a device has multiple media endpoints implementing this cluster, such as a casting video player endpoint with one or more content app endpoints, then only the endpoint receiving the command shall process the keycode as input. In other words, a specific content app endpoint shall NOT process a keycode received by a different content app endpoint.

    If a second SendKey request with the same KeyCode value is received within 200 ms, then the endpoint will consider the first key press to be a press and hold. When such a repeat KeyCode value is not received within 200 ms, then the endpoint will consider the last key press to be a release.

    See

    MatterSpecification.v13.Cluster § 6.8.6.1

events

events: {}

extensions

extensions: readonly []

features

features: {
    locationKeys: BitFlag;
    navigationKeyCodes: BitFlag;
    numberKeys: BitFlag;
}

Type declaration

  • ReadonlylocationKeys: BitFlag

    LocationKeys

    Supports CEC keys 0x0A (Settings) and 0x09 (Home)

  • ReadonlynavigationKeyCodes: BitFlag

    NavigationKeyCodes

    Supports UP, DOWN, LEFT, RIGHT, SELECT, BACK, EXIT, MENU

  • ReadonlynumberKeys: BitFlag

    NumberKeys

    Supports numeric input 0..9

id

id: Branded<1289, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

set

with

Settings

Member Visibility

On This Page

Properties
Methods