Base: {
    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;
} = ...

These elements and properties are present in all KeypadInput clusters.

Type declaration

  • Readonlycommands: {
        sendKey: Command<TypeFromFields<{
            keyCode: FieldType<KeypadInput.CecKeyCode>;
        }>, TypeFromFields<{
            status: FieldType<KeypadInput.Status>;
        }>, any>;
    }
    • 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.

      MatterSpecification.v13.Cluster § 6.8.6.1

  • Readonlyextensions: readonly []

    This metadata controls which KeypadInputCluster elements matter.js activates for specific feature combinations.

  • Readonlyfeatures: {
        locationKeys: BitFlag;
        navigationKeyCodes: BitFlag;
        numberKeys: BitFlag;
    }
    • 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

  • Readonlyid: 1289
  • Readonlyname: "KeypadInput"
  • Readonlyrevision: 1