CameraAvSettingsUserLevelManagement¶

Attributes¶

class st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.server.attributes.MPTZPosition¶

ID: number¶: 0x0000 the ID of this attribute

NAME: str¶: “MPTZPosition” the name of this attribute

data_type: st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.MPTZStruct¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the MPTZPosition(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a MPTZStruct
Return type:: st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.MPTZStruct

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: MPTZPosition => 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 MPTZPosition 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.CameraAvSettingsUserLevelManagement.server.attributes.MaxPresets¶

ID: number¶: 0x0001 the ID of this attribute

NAME: str¶: “MaxPresets” the name of this attribute

data_type: st.matter.data_types.Uint8¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the MaxPresets(…) syntax

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

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: MaxPresets => 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 MaxPresets 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.CameraAvSettingsUserLevelManagement.server.attributes.MPTZPresets¶

ID: number¶: 0x0002 the ID of this attribute

NAME: str¶: “MPTZPresets” 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 MPTZPresets(…) 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: MPTZPresets => 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 MPTZPresets 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.CameraAvSettingsUserLevelManagement.server.attributes.DPTZStreams¶

ID: number¶: 0x0003 the ID of this attribute

NAME: str¶: “DPTZStreams” 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 DPTZStreams(…) 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: DPTZStreams => 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 DPTZStreams 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.CameraAvSettingsUserLevelManagement.server.attributes.ZoomMax¶

ID: number¶: 0x0004 the ID of this attribute

NAME: str¶: “ZoomMax” the name of this attribute

data_type: st.matter.data_types.Uint8¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the ZoomMax(…) syntax

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

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: ZoomMax => 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 ZoomMax 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.CameraAvSettingsUserLevelManagement.server.attributes.TiltMin¶

ID: number¶: 0x0005 the ID of this attribute

NAME: str¶: “TiltMin” the name of this attribute

data_type: st.matter.data_types.Int16¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the TiltMin(…) syntax

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

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: TiltMin => 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 TiltMin 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.CameraAvSettingsUserLevelManagement.server.attributes.TiltMax¶

ID: number¶: 0x0006 the ID of this attribute

NAME: str¶: “TiltMax” the name of this attribute

data_type: st.matter.data_types.Int16¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the TiltMax(…) syntax

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

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: TiltMax => 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 TiltMax 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.CameraAvSettingsUserLevelManagement.server.attributes.PanMin¶

ID: number¶: 0x0007 the ID of this attribute

NAME: str¶: “PanMin” the name of this attribute

data_type: st.matter.data_types.Int16¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the PanMin(…) syntax

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

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: PanMin => 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 PanMin 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.CameraAvSettingsUserLevelManagement.server.attributes.PanMax¶

ID: number¶: 0x0008 the ID of this attribute

NAME: str¶: “PanMax” the name of this attribute

data_type: st.matter.data_types.Int16¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the PanMax(…) syntax

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

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: PanMax => 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 PanMax 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.CameraAvSettingsUserLevelManagement.server.attributes.MovementState¶

ID: number¶: 0x0009 the ID of this attribute

NAME: str¶: “MovementState” the name of this attribute

data_type: st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.PhysicalMovementEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the MovementState(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a PhysicalMovementEnum
Return type:: st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.PhysicalMovementEnum

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: MovementState => 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 MovementState 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.CameraAvSettingsUserLevelManagement.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:

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

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.CameraAvSettingsUserLevelManagement.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:

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

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)

Server Commands¶

class st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.server.commands.MPTZSetPosition: st.matter.data_types.Structure ¶

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

NAME: str¶: “MPTZSetPosition” the name of this command

pan: st.matter.data_types.Int16¶

tilt: st.matter.data_types.Int16¶

zoom: st.matter.data_types.Uint8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an MPTZSetPosition 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, pan, tilt, zoom)¶

Initialize the MPTZSetPosition command

Parameters:

device (st.matter.Device) – the device to build this message to
pan (st.matter.data_types.Int16)
tilt (st.matter.data_types.Int16)
zoom (st.matter.data_types.Uint8)

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.CameraAvSettingsUserLevelManagement.server.commands.MPTZRelativeMove: st.matter.data_types.Structure ¶

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

NAME: str¶: “MPTZRelativeMove” the name of this command

pan_delta: st.matter.data_types.Int16¶

tilt_delta: st.matter.data_types.Int16¶

zoom_delta: st.matter.data_types.Int8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an MPTZRelativeMove 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, pan_delta, tilt_delta, zoom_delta)¶

Initialize the MPTZRelativeMove command

Parameters:

device (st.matter.Device) – the device to build this message to
pan_delta (st.matter.data_types.Int16)
tilt_delta (st.matter.data_types.Int16)
zoom_delta (st.matter.data_types.Int8)

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.CameraAvSettingsUserLevelManagement.server.commands.MPTZMoveToPreset: st.matter.data_types.Structure ¶

ID: number¶: 0x0002 the ID of this command

NAME: str¶: “MPTZMoveToPreset” the name of this command

presetid: st.matter.data_types.Uint8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an MPTZMoveToPreset 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, presetid)¶

Initialize the MPTZMoveToPreset command

Parameters:

device (st.matter.Device) – the device to build this message to
presetid (st.matter.data_types.Uint8)

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.CameraAvSettingsUserLevelManagement.server.commands.MPTZSavePreset: st.matter.data_types.Structure ¶

ID: number¶: 0x0003 the ID of this command

NAME: str¶: “MPTZSavePreset” the name of this command

presetid: st.matter.data_types.Uint8¶

name: st.matter.data_types.UTF8String1¶

build_test_command_response(device, endpoint_id, status)¶

Builds an MPTZSavePreset 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, presetid, name)¶

Initialize the MPTZSavePreset command

Parameters:

device (st.matter.Device) – the device to build this message to
presetid (st.matter.data_types.Uint8)
name (st.matter.data_types.UTF8String1)

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.CameraAvSettingsUserLevelManagement.server.commands.MPTZRemovePreset: st.matter.data_types.Structure ¶

ID: number¶: 0x0004 the ID of this command

NAME: str¶: “MPTZRemovePreset” the name of this command

presetid: st.matter.data_types.Uint8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an MPTZRemovePreset 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, presetid)¶

Initialize the MPTZRemovePreset command

Parameters:

device (st.matter.Device) – the device to build this message to
presetid (st.matter.data_types.Uint8)

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.CameraAvSettingsUserLevelManagement.server.commands.DPTZSetViewport: st.matter.data_types.Structure ¶

ID: number¶: 0x0005 the ID of this command

NAME: str¶: “DPTZSetViewport” the name of this command

video_streamid: st.matter.data_types.Uint16¶

viewport: st.matter.generated.zap_clusters.Global.types.ViewportStruct¶

build_test_command_response(device, endpoint_id, status)¶

Builds an DPTZSetViewport 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, video_streamid, viewport)¶

Initialize the DPTZSetViewport command

Parameters:

device (st.matter.Device) – the device to build this message to
video_streamid (st.matter.data_types.Uint16)
viewport (st.matter.generated.zap_clusters.Global.types.ViewportStruct)

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.CameraAvSettingsUserLevelManagement.server.commands.DPTZRelativeMove: st.matter.data_types.Structure ¶

ID: number¶: 0x0006 the ID of this command

NAME: str¶: “DPTZRelativeMove” the name of this command

video_streamid: st.matter.data_types.Uint16¶

deltax: st.matter.data_types.Int16¶

deltay: st.matter.data_types.Int16¶

zoom_delta: st.matter.data_types.Int8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an DPTZRelativeMove 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, video_streamid, deltax, deltay, zoom_delta)¶

Initialize the DPTZRelativeMove command

Parameters:

device (st.matter.Device) – the device to build this message to
video_streamid (st.matter.data_types.Uint16)
deltax (st.matter.data_types.Int16)
deltay (st.matter.data_types.Int16)
zoom_delta (st.matter.data_types.Int8)

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.CameraAvSettingsUserLevelManagement.types.Feature¶

DIGITALPTZ: number¶: 1

MECHANICAL_PAN: number¶: 2

MECHANICAL_TILT: number¶: 4

MECHANICAL_ZOOM: number¶: 8

MECHANICAL_PRESETS: number¶: 16

is_digitalptz_set()¶

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

set_digitalptz()¶: Set the value of the bit in the DIGITALPTZ field to 1

unset_digitalptz()¶: Set the value of the bits in the DIGITALPTZ field to 0

is_mechanical_pan_set()¶

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

set_mechanical_pan()¶: Set the value of the bit in the MECHANICAL_PAN field to 1

unset_mechanical_pan()¶: Set the value of the bits in the MECHANICAL_PAN field to 0

is_mechanical_tilt_set()¶

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

set_mechanical_tilt()¶: Set the value of the bit in the MECHANICAL_TILT field to 1

unset_mechanical_tilt()¶: Set the value of the bits in the MECHANICAL_TILT field to 0

is_mechanical_zoom_set()¶

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

set_mechanical_zoom()¶: Set the value of the bit in the MECHANICAL_ZOOM field to 1

unset_mechanical_zoom()¶: Set the value of the bits in the MECHANICAL_ZOOM field to 0

is_mechanical_presets_set()¶

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

set_mechanical_presets()¶: Set the value of the bit in the MECHANICAL_PRESETS field to 1

unset_mechanical_presets()¶: Set the value of the bits in the MECHANICAL_PRESETS field to 0

Enum types¶

class st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.PhysicalMovementEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

IDLE: number¶: 0

MOVING: number¶: 1

Struct types¶

class st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.MPTZStruct: st.matter.data_types.Structure ¶

pan: st.matter.data_types.Int16¶

tilt: st.matter.data_types.Int16¶

zoom: st.matter.data_types.Uint8¶

class st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.MPTZPresetStruct: st.matter.data_types.Structure ¶

preset_id: st.matter.data_types.Uint8¶

name: st.matter.data_types.UTF8String1¶

settings: st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.MPTZStruct¶

class st.matter.generated.zap_clusters.CameraAvSettingsUserLevelManagement.types.DPTZStruct: st.matter.data_types.Structure ¶

video_stream_id: st.matter.data_types.Uint16¶

viewport: st.matter.generated.zap_clusters.Global.types.ViewportStruct¶