ValveConfigurationAndControl¶
Attributes¶
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.OpenDuration¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“OpenDuration” the name of this attribute
- data_type: st.matter.data_types.Uint32¶
the data type of this attribute
- new_value(...)¶
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the OpenDuration(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: OpenDuration => 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 OpenDuration test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.DefaultOpenDuration¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“DefaultOpenDuration” the name of this attribute
- data_type: st.matter.data_types.Uint32¶
the data type of this attribute
- new_value(...)¶
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the DefaultOpenDuration(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint32) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: DefaultOpenDuration => 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 DefaultOpenDuration test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.AutoCloseTime¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“AutoCloseTime” the name of this attribute
- data_type: st.matter.data_types.Uint64¶
the data type of this attribute
- new_value(...)¶
Create a Uint64 object of this attribute with any additional features provided for the attribute
This is also usable with the AutoCloseTime(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint64- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: AutoCloseTime => 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 AutoCloseTime test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.RemainingDuration¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“RemainingDuration” the name of this attribute
- data_type: st.matter.data_types.Uint32¶
the data type of this attribute
- new_value(...)¶
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the RemainingDuration(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint32- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: RemainingDuration => 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 RemainingDuration test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.CurrentState¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“CurrentState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveStateEnum¶
the data type of this attribute
- new_value(...)¶
Create a ValveStateEnum object of this attribute with any additional features provided for the attribute
This is also usable with the CurrentState(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ValveStateEnum- Return type:
st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveStateEnum
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: CurrentState => 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 CurrentState test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.TargetState¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“TargetState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveStateEnum¶
the data type of this attribute
- new_value(...)¶
Create a ValveStateEnum object of this attribute with any additional features provided for the attribute
This is also usable with the TargetState(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ValveStateEnum- Return type:
st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveStateEnum
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: TargetState => 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 TargetState test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.CurrentLevel¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“CurrentLevel” 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 CurrentLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: CurrentLevel => 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 CurrentLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.TargetLevel¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“TargetLevel” 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 TargetLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: TargetLevel => 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 TargetLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.DefaultOpenLevel¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“DefaultOpenLevel” 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 DefaultOpenLevel(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- 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:
- write(device, endpoint_id, value)¶
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)value (
st.matter.data_types.Uint8) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: DefaultOpenLevel => 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 DefaultOpenLevel test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.ValveFault¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“ValveFault” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveFaultBitmap¶
the data type of this attribute
- new_value(...)¶
Create a ValveFaultBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the ValveFault(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ValveFaultBitmap- Return type:
st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveFaultBitmap
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: ValveFault => 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 ValveFault test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.attributes.LevelStep¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“LevelStep” 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 LevelStep(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint8- Return type:
- 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:
- subscribe(device, endpoint_id)¶
Reporting policy: LevelStep => 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 LevelStep test attribute reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.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:
- 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:
- 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 forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.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:
- 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:
- 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 forendpoint_id (
number or nil)value (
any)status (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Server Commands¶
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.commands.Open: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“Open” the name of this command
- open_duration: st.matter.data_types.Uint32¶
- target_level: st.matter.data_types.Uint8¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an Open test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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, open_duration, target_level)¶
Initialize the Open command
- Parameters:
device (
st.matter.Device) – the device to build this message toopen_duration (
st.matter.data_types.Uint32)target_level (
st.matter.data_types.Uint8)
- Returns:
of type INVOKE
- Return type:
- 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.ValveConfigurationAndControl.server.commands.Close: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this command
- NAME: str¶
“Close” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an Close test command reponse for the driver integration testing framework
- Parameters:
device (
st.matter.Device) – the device to build this message toendpoint_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)¶
Initialize the Close command
- Parameters:
device (
st.matter.Device) – the device to build this message to- Returns:
of type INVOKE
- Return type:
- 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)
Events¶
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.events.ValveStateChanged: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this event
- NAME: str¶
“ValveStateChanged” the name of this event
- valve_state: st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveStateEnum¶
- valve_level: st.matter.data_types.Uint8¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an ValveStateChanged test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.server.events.ValveFault: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this event
- NAME: str¶
“ValveFault” the name of this event
- valve_fault: st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveFaultBitmap¶
- augment_type(base_type_obj)¶
Add field names to each event field
- Parameters:
base_type_obj (
st.matter.data_types.Structure)
- read(device, endpoint_id)¶
Constructs a read InteractionRequest for the Event
- Parameters:
device (
st.matter.Device)endpoint_id (
number or nil)
- Return type:
- subscribe(device, endpoint_id)¶
Constructs a subscribe InteractionRequest for the Event
- Parameters:
device (
any)endpoint_id (
number or nil)
- Return type:
- build_test_event_report(device, endpoint_id, fields, status)¶
Builds an ValveFault test event report reponse to be used by
the driver integration testing framework.
- Parameters:
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil)fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns:
of type REPORT_DATA
- Return type:
- deserialize(tlv_buf)¶
- Parameters:
tlv_buf (
any)
Bitmap types¶
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.Feature¶
- TIME_SYNC: number¶
1
- LEVEL: number¶
2
- is_time_sync_set()¶
- Returns:
True if the value of TIME_SYNC is non-zero
- Return type:
boolean
- set_time_sync()¶
Set the value of the bit in the TIME_SYNC field to 1
- unset_time_sync()¶
Set the value of the bits in the TIME_SYNC field to 0
- is_level_set()¶
- Returns:
True if the value of LEVEL is non-zero
- Return type:
boolean
- set_level()¶
Set the value of the bit in the LEVEL field to 1
- unset_level()¶
Set the value of the bits in the LEVEL field to 0
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.ValveFaultBitmap¶
- GENERAL_FAULT: number¶
1
- BLOCKED: number¶
2
- LEAKING: number¶
4
- NOT_CONNECTED: number¶
8
- SHORT_CIRCUIT: number¶
16
- CURRENT_EXCEEDED: number¶
32
- is_general_fault_set()¶
- Returns:
True if the value of GENERAL_FAULT is non-zero
- Return type:
boolean
- set_general_fault()¶
Set the value of the bit in the GENERAL_FAULT field to 1
- unset_general_fault()¶
Set the value of the bits in the GENERAL_FAULT field to 0
- is_blocked_set()¶
- Returns:
True if the value of BLOCKED is non-zero
- Return type:
boolean
- set_blocked()¶
Set the value of the bit in the BLOCKED field to 1
- unset_blocked()¶
Set the value of the bits in the BLOCKED field to 0
- is_leaking_set()¶
- Returns:
True if the value of LEAKING is non-zero
- Return type:
boolean
- set_leaking()¶
Set the value of the bit in the LEAKING field to 1
- unset_leaking()¶
Set the value of the bits in the LEAKING field to 0
- is_not_connected_set()¶
- Returns:
True if the value of NOT_CONNECTED is non-zero
- Return type:
boolean
- set_not_connected()¶
Set the value of the bit in the NOT_CONNECTED field to 1
- unset_not_connected()¶
Set the value of the bits in the NOT_CONNECTED field to 0
- is_short_circuit_set()¶
- Returns:
True if the value of SHORT_CIRCUIT is non-zero
- Return type:
boolean
- set_short_circuit()¶
Set the value of the bit in the SHORT_CIRCUIT field to 1
- unset_short_circuit()¶
Set the value of the bits in the SHORT_CIRCUIT field to 0
- is_current_exceeded_set()¶
- Returns:
True if the value of CURRENT_EXCEEDED is non-zero
- Return type:
boolean
- set_current_exceeded()¶
Set the value of the bit in the CURRENT_EXCEEDED field to 1
- unset_current_exceeded()¶
Set the value of the bits in the CURRENT_EXCEEDED field to 0
Enum types¶
- class st.matter.generated.zap_clusters.ValveConfigurationAndControl.types.StatusCodeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- FAILURE_DUE_TO_FAULT: number¶
2