Channel

Attributes

class st.matter.generated.zap_clusters.Channel.server.attributes.ChannelList
ID: number

0x0000 the ID of this attribute

NAME: str

“ChannelList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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 ChannelList(…) 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:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: ChannelList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an ChannelList 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.generated.zap_clusters.Channel.server.attributes.Lineup
ID: number

0x0001 the ID of this attribute

NAME: str

“Lineup” the name of this attribute

data_type: st.matter.generated.zap_clusters.Channel.types.LineupInfoStruct

the data type of this attribute

new_value(...)

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

This is also usable with the Lineup(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a LineupInfoStruct

Return type:

st.matter.generated.zap_clusters.Channel.types.LineupInfoStruct

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: Lineup => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an Lineup 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.generated.zap_clusters.Channel.server.attributes.CurrentChannel
ID: number

0x0002 the ID of this attribute

NAME: str

“CurrentChannel” the name of this attribute

data_type: st.matter.generated.zap_clusters.Channel.types.ChannelInfoStruct

the data type of this attribute

new_value(...)

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

This is also usable with the CurrentChannel(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a ChannelInfoStruct

Return type:

st.matter.generated.zap_clusters.Channel.types.ChannelInfoStruct

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: CurrentChannel => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an CurrentChannel 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.generated.zap_clusters.Channel.server.attributes.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(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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:
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

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.generated.zap_clusters.Channel.server.attributes.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(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_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:
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

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.generated.zap_clusters.Channel.client.commands.ChangeChannelResponse: st.matter.data_types.Structure
ID: number

0x0001 the ID of this command

NAME: str

“ChangeChannelResponse” the name of this command

status: st.matter.generated.zap_clusters.Channel.types.StatusEnum
data: st.matter.data_types.UTF8String1
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, data)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the ChangeChannelResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.Channel.client.commands.ProgramGuideResponse: st.matter.data_types.Structure
ID: number

0x0005 the ID of this command

NAME: str

“ProgramGuideResponse” the name of this command

paging: st.matter.generated.zap_clusters.Channel.types.ChannelPagingStruct
program_list: st.matter.data_types.Array
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, paging, program_list)

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

Parameters:
Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init()

Initialize the ProgramGuideResponse command

Return type:

nil

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Server Commands

class st.matter.generated.zap_clusters.Channel.server.commands.ChangeChannel: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“ChangeChannel” the name of this command

match: st.matter.data_types.UTF8String1
init(device, match)

Refer to ChangeChannelResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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)

class st.matter.generated.zap_clusters.Channel.server.commands.ChangeChannelByNumber: st.matter.data_types.Structure
ID: number

0x0002 the ID of this command

NAME: str

“ChangeChannelByNumber” the name of this command

major_number: st.matter.data_types.Uint16
minor_number: st.matter.data_types.Uint16
build_test_command_response(device, endpoint_id, status)

Builds an ChangeChannelByNumber 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 (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, major_number, minor_number)

Initialize the ChangeChannelByNumber command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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)

class st.matter.generated.zap_clusters.Channel.server.commands.SkipChannel: st.matter.data_types.Structure
ID: number

0x0003 the ID of this command

NAME: str

“SkipChannel” the name of this command

count: st.matter.data_types.Int16
build_test_command_response(device, endpoint_id, status)

Builds an SkipChannel 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 (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, count)

Initialize the SkipChannel command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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)

class st.matter.generated.zap_clusters.Channel.server.commands.GetProgramGuide: st.matter.data_types.Structure
ID: number

0x0004 the ID of this command

NAME: str

“GetProgramGuide” the name of this command

start_time: st.matter.data_types.Uint32
end_time: st.matter.data_types.Uint32
channel_list: st.matter.data_types.Array
page_token: st.matter.generated.zap_clusters.Channel.types.PageTokenStruct
recording_flag: st.matter.generated.zap_clusters.Channel.types.RecordingFlagBitmap
externalid_list: st.matter.data_types.Array
data: st.matter.data_types.OctetString1
init(device, start_time, end_time, channel_list, page_token, recording_flag, externalid_list, data)

Refer to ProgramGuideResponse:build_test_command_response for

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

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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)

class st.matter.generated.zap_clusters.Channel.server.commands.RecordProgram: st.matter.data_types.Structure
ID: number

0x0006 the ID of this command

NAME: str

“RecordProgram” the name of this command

program_identifier: st.matter.data_types.UTF8String1
should_record_series: st.matter.data_types.Boolean
externalid_list: st.matter.data_types.Array
data: st.matter.data_types.OctetString1
build_test_command_response(device, endpoint_id, status)

Builds an RecordProgram 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 (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, program_identifier, should_record_series, externalid_list, data)

Initialize the RecordProgram command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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)

class st.matter.generated.zap_clusters.Channel.server.commands.CancelRecordProgram: st.matter.data_types.Structure
ID: number

0x0007 the ID of this command

NAME: str

“CancelRecordProgram” the name of this command

program_identifier: st.matter.data_types.UTF8String1
should_record_series: st.matter.data_types.Boolean
externalid_list: st.matter.data_types.Array
data: st.matter.data_types.OctetString1
build_test_command_response(device, endpoint_id, status)

Builds an CancelRecordProgram 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 (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, program_identifier, should_record_series, externalid_list, data)

Initialize the CancelRecordProgram command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

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.generated.zap_clusters.Channel.types.Feature
CHANNEL_LIST: number

1

LINEUP_INFO: number

2

ELECTRONIC_GUIDE: number

4

RECORD_PROGRAM: number

8

is_channel_list_set()
Returns:

True if the value of CHANNEL_LIST is non-zero

Return type:

boolean

set_channel_list()

Set the value of the bit in the CHANNEL_LIST field to 1

unset_channel_list()

Set the value of the bits in the CHANNEL_LIST field to 0

is_lineup_info_set()
Returns:

True if the value of LINEUP_INFO is non-zero

Return type:

boolean

set_lineup_info()

Set the value of the bit in the LINEUP_INFO field to 1

unset_lineup_info()

Set the value of the bits in the LINEUP_INFO field to 0

is_electronic_guide_set()
Returns:

True if the value of ELECTRONIC_GUIDE is non-zero

Return type:

boolean

set_electronic_guide()

Set the value of the bit in the ELECTRONIC_GUIDE field to 1

unset_electronic_guide()

Set the value of the bits in the ELECTRONIC_GUIDE field to 0

is_record_program_set()
Returns:

True if the value of RECORD_PROGRAM is non-zero

Return type:

boolean

set_record_program()

Set the value of the bit in the RECORD_PROGRAM field to 1

unset_record_program()

Set the value of the bits in the RECORD_PROGRAM field to 0

class st.matter.generated.zap_clusters.Channel.types.RecordingFlagBitmap
SCHEDULED: number

1

RECORD_SERIES: number

2

RECORDED: number

4

is_scheduled_set()
Returns:

True if the value of SCHEDULED is non-zero

Return type:

boolean

set_scheduled()

Set the value of the bit in the SCHEDULED field to 1

unset_scheduled()

Set the value of the bits in the SCHEDULED field to 0

is_record_series_set()
Returns:

True if the value of RECORD_SERIES is non-zero

Return type:

boolean

set_record_series()

Set the value of the bit in the RECORD_SERIES field to 1

unset_record_series()

Set the value of the bits in the RECORD_SERIES field to 0

is_recorded_set()
Returns:

True if the value of RECORDED is non-zero

Return type:

boolean

set_recorded()

Set the value of the bit in the RECORDED field to 1

unset_recorded()

Set the value of the bits in the RECORDED field to 0

Enum types

class st.matter.generated.zap_clusters.Channel.types.ChannelTypeEnum: st.matter.data_types.Uint8
byte_length: number

1

SATELLITE: number

0

CABLE: number

1

TERRESTRIAL: number

2

OTT: number

3

class st.matter.generated.zap_clusters.Channel.types.LineupInfoTypeEnum: st.matter.data_types.Uint8
byte_length: number

1

MSO: number

0

class st.matter.generated.zap_clusters.Channel.types.StatusEnum: st.matter.data_types.Uint8
byte_length: number

1

SUCCESS: number

0

MULTIPLE_MATCHES: number

1

NO_MATCHES: number

2

Struct types

class st.matter.generated.zap_clusters.Channel.types.ProgramCastStruct: st.matter.data_types.Structure
name: st.matter.data_types.UTF8String1
role: st.matter.data_types.UTF8String1
class st.matter.generated.zap_clusters.Channel.types.ProgramCategoryStruct: st.matter.data_types.Structure
category: st.matter.data_types.UTF8String1
sub_category: st.matter.data_types.UTF8String1
class st.matter.generated.zap_clusters.Channel.types.SeriesInfoStruct: st.matter.data_types.Structure
season: st.matter.data_types.UTF8String1
episode: st.matter.data_types.UTF8String1
class st.matter.generated.zap_clusters.Channel.types.ChannelInfoStruct: st.matter.data_types.Structure
major_number: st.matter.data_types.Uint16
minor_number: st.matter.data_types.Uint16
name: st.matter.data_types.UTF8String1
call_sign: st.matter.data_types.UTF8String1
affiliate_call_sign: st.matter.data_types.UTF8String1
identifier: st.matter.data_types.UTF8String1
type: st.matter.generated.zap_clusters.Channel.types.ChannelTypeEnum
class st.matter.generated.zap_clusters.Channel.types.ProgramStruct: st.matter.data_types.Structure
identifier: st.matter.data_types.UTF8String1
channel: st.matter.generated.zap_clusters.Channel.types.ChannelInfoStruct
start_time: st.matter.data_types.Uint32
end_time: st.matter.data_types.Uint32
title: st.matter.data_types.UTF8String1
subtitle: st.matter.data_types.UTF8String1
description: st.matter.data_types.UTF8String1
audio_languages: st.matter.data_types.Array
ratings: st.matter.data_types.Array
thumbnail_url: st.matter.data_types.UTF8String1
poster_art_url: st.matter.data_types.UTF8String1
dvbi_url: st.matter.data_types.UTF8String1
release_date: st.matter.data_types.UTF8String1
parental_guidance_text: st.matter.data_types.UTF8String1
recording_flag: st.matter.generated.zap_clusters.Channel.types.RecordingFlagBitmap
series_info: st.matter.generated.zap_clusters.Channel.types.SeriesInfoStruct
category_list: st.matter.data_types.Array
cast_list: st.matter.data_types.Array
external_id_list: st.matter.data_types.Array
class st.matter.generated.zap_clusters.Channel.types.PageTokenStruct: st.matter.data_types.Structure
limit: st.matter.data_types.Uint16
after: st.matter.data_types.UTF8String1
before: st.matter.data_types.UTF8String1
class st.matter.generated.zap_clusters.Channel.types.ChannelPagingStruct: st.matter.data_types.Structure
previous_token: st.matter.generated.zap_clusters.Channel.types.PageTokenStruct
next_token: st.matter.generated.zap_clusters.Channel.types.PageTokenStruct
class st.matter.generated.zap_clusters.Channel.types.AdditionalInfoStruct: st.matter.data_types.Structure
name: st.matter.data_types.UTF8String1
value: st.matter.data_types.UTF8String1
class st.matter.generated.zap_clusters.Channel.types.LineupInfoStruct: st.matter.data_types.Structure
operator_name: st.matter.data_types.UTF8String1
lineup_name: st.matter.data_types.UTF8String1
postal_code: st.matter.data_types.UTF8String1
lineup_info_type: st.matter.generated.zap_clusters.Channel.types.LineupInfoTypeEnum