KeypadInput

class st.matter.clusters.KeypadInput.AcceptedCommandList

ID: number: 0xFFF9 the ID of this attribute

NAME: str: “AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AcceptedCommandList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.KeypadInput.EventList

ID: number: 0xFFFA the ID of this attribute

NAME: str: “EventList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the EventList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: EventList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an EventList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

class st.matter.clusters.KeypadInput.AttributeList

ID: number: 0xFFFB the ID of this attribute

NAME: str: “AttributeList” the name of this attribute

data_type: st.matter.data_types.Array: the data type of this attribute

augment_type(base_type_obj)

Add additional functionality to the base type object

Parameters: base_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AttributeList(…) syntax

Parameters: vararg (vararg) – the values needed to construct a Array
Return type: st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters

device (st.matter.Device) –
endpoint_id (number or nil) –

Returns

containing an Interaction Request

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters

device (any) –
endpoint_id (number or nil) –

Return type

any

set_parent_cluster(cluster)

Parameters: cluster (any) –

build_test_report_data(device, endpoint_id, value, status)

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil) –
value (any) –
status (str) – Interaction status associated with the path

Returns

of type REPORT_DATA

Return type

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Client Commands

class st.matter.clusters.KeypadInput.SendKeyResponse

ID: number: 0x0001 the ID of this command

NAME: str: “SendKeyResponse” the name of this command

status: st.matter.generated.zap_clusters.KeypadInput.types.StatusEnum

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

build_test_command_response(device, endpoint_id, status)

Builds an SendKeyResponse test command reponse for the driver integration testing framework

Parameters

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil) –
status (st.matter.generated.zap_clusters.KeypadInput.types.StatusEnum) –

Returns

of type COMMAND_RESPONSE

Return type

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the SendKeyResponse command

Return type: nil

set_parent_cluster(cluster)

Parameters: cluster (any) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Server Commands

class st.matter.clusters.KeypadInput.SendKey

ID: number: 0x0000 the ID of this command

NAME: str: “SendKey” the name of this command

key_code: st.matter.generated.zap_clusters.KeypadInput.types.CECKeyCodeEnum

init(self, device, key_code)

Refer to SendKeyResponse:build_test_command_response for

building a test command reponse for the driver integration testing framework Initialize the SendKey command

Parameters

self (SendKey) – the template class for this command
device (st.matter.Device) – the device to build this message to
key_code (st.matter.generated.zap_clusters.KeypadInput.types.CECKeyCodeEnum) –

Returns

of type INVOKE

Return type

st.matter.interaction_model.InteractionRequest

set_parent_cluster(cluster)

Parameters: cluster (any) –

augment_type(base_type_obj)

Add field names to each command field

Parameters: base_type_obj (st.matter.data_types.Structure) –

deserialize(tlv_buf)

Parameters: tlv_buf (any) –

Bitmap types

class st.matter.clusters.KeypadInput.types.Feature

NAVIGATION_KEY_CODES: number: 1

LOCATION_KEYS: number: 2

NUMBER_KEYS: number: 4

is_navigation_key_codes_set()

Returns: True if the value of NAVIGATION_KEY_CODES is non-zero
Return type: boolean

set_navigation_key_codes(): Set the value of the bit in the NAVIGATION_KEY_CODES field to 1

unset_navigation_key_codes(): Set the value of the bits in the NAVIGATION_KEY_CODES field to 0

is_location_keys_set()

Returns: True if the value of LOCATION_KEYS is non-zero
Return type: boolean

set_location_keys(): Set the value of the bit in the LOCATION_KEYS field to 1

unset_location_keys(): Set the value of the bits in the LOCATION_KEYS field to 0

is_number_keys_set()

Returns: True if the value of NUMBER_KEYS is non-zero
Return type: boolean

set_number_keys(): Set the value of the bit in the NUMBER_KEYS field to 1

unset_number_keys(): Set the value of the bits in the NUMBER_KEYS field to 0

Enum types

class st.matter.clusters.KeypadInput.types.CECKeyCodeEnum: st.matter.data_types.Uint8 

byte_length: number: 1

SELECT: number: 0

UP: number: 1

DOWN: number: 2

LEFT: number: 3

RIGHT: number: 4

RIGHT_UP: number: 5

RIGHT_DOWN: number: 6

LEFT_UP: number: 7

LEFT_DOWN: number: 8

ROOT_MENU: number: 9

SETUP_MENU: number: 10

CONTENTS_MENU: number: 11

FAVORITE_MENU: number: 12

EXIT: number: 13

MEDIA_TOP_MENU: number: 16

MEDIA_CONTEXT_SENSITIVE_MENU: number: 17

NUMBER_ENTRY_MODE: number: 29

NUMBER11: number: 30

NUMBER12: number: 31

NUMBER0_OR_NUMBER10: number: 32

NUMBERS1: number: 33

NUMBERS2: number: 34

NUMBERS3: number: 35

NUMBERS4: number: 36

NUMBERS5: number: 37

NUMBERS6: number: 38

NUMBERS7: number: 39

NUMBERS8: number: 40

NUMBERS9: number: 41

DOT: number: 42

ENTER: number: 43

CLEAR: number: 44

NEXT_FAVORITE: number: 47

CHANNEL_UP: number: 48

CHANNEL_DOWN: number: 49

PREVIOUS_CHANNEL: number: 50

SOUND_SELECT: number: 51

INPUT_SELECT: number: 52

DISPLAY_INFORMATION: number: 53

HELP: number: 54

PAGE_UP: number: 55

PAGE_DOWN: number: 56

POWER: number: 64

VOLUME_UP: number: 65

VOLUME_DOWN: number: 66

MUTE: number: 67

PLAY: number: 68

STOP: number: 69

PAUSE: number: 70

RECORD: number: 71

REWIND: number: 72

FAST_FORWARD: number: 73

EJECT: number: 74

FORWARD: number: 75

BACKWARD: number: 76

STOP_RECORD: number: 77

PAUSE_RECORD: number: 78

RESERVED: number: 79

ANGLE: number: 80

SUB_PICTURE: number: 81

VIDEO_ON_DEMAND: number: 82

ELECTRONIC_PROGRAM_GUIDE: number: 83

TIMER_PROGRAMMING: number: 84

INITIAL_CONFIGURATION: number: 85

SELECT_BROADCAST_TYPE: number: 86

SELECT_SOUND_PRESENTATION: number: 87

PLAY_FUNCTION: number: 96

PAUSE_PLAY_FUNCTION: number: 97

RECORD_FUNCTION: number: 98

PAUSE_RECORD_FUNCTION: number: 99

STOP_FUNCTION: number: 100

MUTE_FUNCTION: number: 101

RESTORE_VOLUME_FUNCTION: number: 102

TUNE_FUNCTION: number: 103

SELECT_MEDIA_FUNCTION: number: 104

SELECT_AV_INPUT_FUNCTION: number: 105

SELECT_AUDIO_INPUT_FUNCTION: number: 106

POWER_TOGGLE_FUNCTION: number: 107

POWER_OFF_FUNCTION: number: 108

POWER_ON_FUNCTION: number: 109

F1_BLUE: number: 113

F2_RED: number: 114

F3_GREEN: number: 115

F4_YELLOW: number: 116

F5: number: 117

DATA: number: 118

class st.matter.clusters.KeypadInput.types.StatusEnum: st.matter.data_types.Uint8 

byte_length: number: 1

SUCCESS: number: 0

UNSUPPORTED_KEY: number: 1

INVALID_KEY_IN_CURRENT_STATE: number: 2