ClosureDimension¶
Attributes¶
- class st.matter.generated.zap_clusters.ClosureDimension.server.attributes.CurrentState¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“CurrentState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.DimensionStateStruct¶
the data type of this attribute
- new_value(...)¶
Create a DimensionStateStruct 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 DimensionStateStruct- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.DimensionStateStruct
- 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.ClosureDimension.server.attributes.TargetState¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“TargetState” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.DimensionStateStruct¶
the data type of this attribute
- new_value(...)¶
Create a DimensionStateStruct 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 DimensionStateStruct- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.DimensionStateStruct
- 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.ClosureDimension.server.attributes.Resolution¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“Resolution” the name of this attribute
- data_type: st.matter.data_types.Uint16¶
the data type of this attribute
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the Resolution(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: Resolution => 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 Resolution 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.ClosureDimension.server.attributes.StepValue¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“StepValue” the name of this attribute
- data_type: st.matter.data_types.Uint16¶
the data type of this attribute
- new_value(...)¶
Create a Uint16 object of this attribute with any additional features provided for the attribute
This is also usable with the StepValue(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: StepValue => 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 StepValue 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.ClosureDimension.server.attributes.Unit¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“Unit” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.ClosureUnitEnum¶
the data type of this attribute
- new_value(...)¶
Create a ClosureUnitEnum object of this attribute with any additional features provided for the attribute
This is also usable with the Unit(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ClosureUnitEnum- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.ClosureUnitEnum
- 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: Unit => 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 Unit 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.ClosureDimension.server.attributes.UnitRange¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“UnitRange” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.UnitRangeStruct¶
the data type of this attribute
- new_value(...)¶
Create a UnitRangeStruct object of this attribute with any additional features provided for the attribute
This is also usable with the UnitRange(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a UnitRangeStruct- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.UnitRangeStruct
- 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: UnitRange => 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 UnitRange 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.ClosureDimension.server.attributes.LimitRange¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“LimitRange” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.RangePercent100thsStruct¶
the data type of this attribute
- new_value(...)¶
Create a RangePercent100thsStruct object of this attribute with any additional features provided for the attribute
This is also usable with the LimitRange(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a RangePercent100thsStruct- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.RangePercent100thsStruct
- 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: LimitRange => 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 LimitRange 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.ClosureDimension.server.attributes.TranslationDirection¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“TranslationDirection” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.TranslationDirectionEnum¶
the data type of this attribute
- new_value(...)¶
Create a TranslationDirectionEnum object of this attribute with any additional features provided for the attribute
This is also usable with the TranslationDirection(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a TranslationDirectionEnum- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.TranslationDirectionEnum
- 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: TranslationDirection => 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 TranslationDirection 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.ClosureDimension.server.attributes.RotationAxis¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“RotationAxis” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.RotationAxisEnum¶
the data type of this attribute
- new_value(...)¶
Create a RotationAxisEnum object of this attribute with any additional features provided for the attribute
This is also usable with the RotationAxis(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a RotationAxisEnum- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.RotationAxisEnum
- 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: RotationAxis => 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 RotationAxis 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.ClosureDimension.server.attributes.Overflow¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“Overflow” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.OverflowEnum¶
the data type of this attribute
- new_value(...)¶
Create a OverflowEnum object of this attribute with any additional features provided for the attribute
This is also usable with the Overflow(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OverflowEnum- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.OverflowEnum
- 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: Overflow => 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 Overflow 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.ClosureDimension.server.attributes.ModulationType¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“ModulationType” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.ModulationTypeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ModulationTypeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ModulationType(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ModulationTypeEnum- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.ModulationTypeEnum
- 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: ModulationType => 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 ModulationType 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.ClosureDimension.server.attributes.LatchControlModes¶
- ID: number¶
0x000B the ID of this attribute
- NAME: str¶
“LatchControlModes” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ClosureDimension.types.LatchControlModesBitmap¶
the data type of this attribute
- new_value(...)¶
Create a LatchControlModesBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the LatchControlModes(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a LatchControlModesBitmap- Return type:
st.matter.generated.zap_clusters.ClosureDimension.types.LatchControlModesBitmap
- 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: LatchControlModes => 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 LatchControlModes 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.ClosureDimension.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.ClosureDimension.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.ClosureDimension.server.commands.SetTarget: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“SetTarget” the name of this command
- position: st.matter.data_types.Uint16¶
- latch: st.matter.data_types.Boolean¶
- speed: st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an SetTarget 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, position, latch, speed)¶
Initialize the SetTarget command
- Parameters:
device (
st.matter.Device) – the device to build this message toposition (
st.matter.data_types.Uint16)latch (
st.matter.data_types.Boolean)speed (
st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum)
- 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.ClosureDimension.server.commands.Step: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this command
- NAME: str¶
“Step” the name of this command
- direction: st.matter.generated.zap_clusters.ClosureDimension.types.StepDirectionEnum¶
- number_of_steps: st.matter.data_types.Uint16¶
- speed: st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an Step 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, direction, number_of_steps, speed)¶
Initialize the Step command
- Parameters:
device (
st.matter.Device) – the device to build this message todirection (
st.matter.generated.zap_clusters.ClosureDimension.types.StepDirectionEnum)number_of_steps (
st.matter.data_types.Uint16)speed (
st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum)
- 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)
Bitmap types¶
- class st.matter.generated.zap_clusters.ClosureDimension.types.Feature¶
- POSITIONING: number¶
1
- MOTION_LATCHING: number¶
2
- UNIT: number¶
4
- LIMITATION: number¶
8
- SPEED: number¶
16
- TRANSLATION: number¶
32
- ROTATION: number¶
64
- MODULATION: number¶
128
- is_positioning_set()¶
- Returns:
True if the value of POSITIONING is non-zero
- Return type:
boolean
- set_positioning()¶
Set the value of the bit in the POSITIONING field to 1
- unset_positioning()¶
Set the value of the bits in the POSITIONING field to 0
- is_motion_latching_set()¶
- Returns:
True if the value of MOTION_LATCHING is non-zero
- Return type:
boolean
- set_motion_latching()¶
Set the value of the bit in the MOTION_LATCHING field to 1
- unset_motion_latching()¶
Set the value of the bits in the MOTION_LATCHING field to 0
- is_unit_set()¶
- Returns:
True if the value of UNIT is non-zero
- Return type:
boolean
- set_unit()¶
Set the value of the bit in the UNIT field to 1
- unset_unit()¶
Set the value of the bits in the UNIT field to 0
- is_limitation_set()¶
- Returns:
True if the value of LIMITATION is non-zero
- Return type:
boolean
- set_limitation()¶
Set the value of the bit in the LIMITATION field to 1
- unset_limitation()¶
Set the value of the bits in the LIMITATION field to 0
- is_speed_set()¶
- Returns:
True if the value of SPEED is non-zero
- Return type:
boolean
- set_speed()¶
Set the value of the bit in the SPEED field to 1
- unset_speed()¶
Set the value of the bits in the SPEED field to 0
- is_translation_set()¶
- Returns:
True if the value of TRANSLATION is non-zero
- Return type:
boolean
- set_translation()¶
Set the value of the bit in the TRANSLATION field to 1
- unset_translation()¶
Set the value of the bits in the TRANSLATION field to 0
- is_rotation_set()¶
- Returns:
True if the value of ROTATION is non-zero
- Return type:
boolean
- set_rotation()¶
Set the value of the bit in the ROTATION field to 1
- unset_rotation()¶
Set the value of the bits in the ROTATION field to 0
- is_modulation_set()¶
- Returns:
True if the value of MODULATION is non-zero
- Return type:
boolean
- set_modulation()¶
Set the value of the bit in the MODULATION field to 1
- unset_modulation()¶
Set the value of the bits in the MODULATION field to 0
- class st.matter.generated.zap_clusters.ClosureDimension.types.LatchControlModesBitmap¶
- REMOTE_LATCHING: number¶
1
- REMOTE_UNLATCHING: number¶
2
- is_remote_latching_set()¶
- Returns:
True if the value of REMOTE_LATCHING is non-zero
- Return type:
boolean
- set_remote_latching()¶
Set the value of the bit in the REMOTE_LATCHING field to 1
- unset_remote_latching()¶
Set the value of the bits in the REMOTE_LATCHING field to 0
- is_remote_unlatching_set()¶
- Returns:
True if the value of REMOTE_UNLATCHING is non-zero
- Return type:
boolean
- set_remote_unlatching()¶
Set the value of the bit in the REMOTE_UNLATCHING field to 1
- unset_remote_unlatching()¶
Set the value of the bits in the REMOTE_UNLATCHING field to 0
Enum types¶
- class st.matter.generated.zap_clusters.ClosureDimension.types.ClosureUnitEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- MILLIMETER: number¶
0
- DEGREE: number¶
1
- class st.matter.generated.zap_clusters.ClosureDimension.types.ModulationTypeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- SLATS_ORIENTATION: number¶
0
- SLATS_OPENWORK: number¶
1
- STRIPES_ALIGNMENT: number¶
2
- OPACITY: number¶
3
- VENTILATION: number¶
4
- class st.matter.generated.zap_clusters.ClosureDimension.types.OverflowEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- NO_OVERFLOW: number¶
0
- INSIDE: number¶
1
- OUTSIDE: number¶
2
- TOP_INSIDE: number¶
3
- TOP_OUTSIDE: number¶
4
- BOTTOM_INSIDE: number¶
5
- BOTTOM_OUTSIDE: number¶
6
- LEFT_INSIDE: number¶
7
- LEFT_OUTSIDE: number¶
8
- RIGHT_INSIDE: number¶
9
- RIGHT_OUTSIDE: number¶
10
- class st.matter.generated.zap_clusters.ClosureDimension.types.RotationAxisEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- LEFT: number¶
0
- CENTERED_VERTICAL: number¶
1
- LEFT_AND_RIGHT: number¶
2
- RIGHT: number¶
3
- TOP: number¶
4
- CENTERED_HORIZONTAL: number¶
5
- TOP_AND_BOTTOM: number¶
6
- BOTTOM: number¶
7
- LEFT_BARRIER: number¶
8
- LEFT_AND_RIGHT_BARRIERS: number¶
9
- RIGHT_BARRIER: number¶
10
- class st.matter.generated.zap_clusters.ClosureDimension.types.StepDirectionEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- DECREASE: number¶
0
- INCREASE: number¶
1
- class st.matter.generated.zap_clusters.ClosureDimension.types.TranslationDirectionEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- DOWNWARD: number¶
0
- UPWARD: number¶
1
- VERTICAL_MASK: number¶
2
- VERTICAL_SYMMETRY: number¶
3
- LEFTWARD: number¶
4
- RIGHTWARD: number¶
5
- HORIZONTAL_MASK: number¶
6
- HORIZONTAL_SYMMETRY: number¶
7
- FORWARD: number¶
8
- BACKWARD: number¶
9
- DEPTH_MASK: number¶
10
- DEPTH_SYMMETRY: number¶
11
Struct types¶
- class st.matter.generated.zap_clusters.ClosureDimension.types.DimensionStateStruct: st.matter.data_types.Structure¶
- position: st.matter.data_types.Uint16¶
- latch: st.matter.data_types.Boolean¶
- speed: st.matter.generated.zap_clusters.Global.types.ThreeLevelAutoEnum¶
- class st.matter.generated.zap_clusters.ClosureDimension.types.RangePercent100thsStruct: st.matter.data_types.Structure¶
- min: st.matter.data_types.Uint16¶
- max: st.matter.data_types.Uint16¶
- class st.matter.generated.zap_clusters.ClosureDimension.types.UnitRangeStruct: st.matter.data_types.Structure¶
- min: st.matter.data_types.Int16¶
- max: st.matter.data_types.Int16¶