WindowCovering¶
Attributes¶
- class st.matter.generated.zap_clusters.WindowCovering.server.attributes.Type¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“Type” the name of this attribute
- data_type: st.matter.generated.zap_clusters.WindowCovering.types.Type¶
the data type of this attribute
- new_value(...)¶
Create a Type object of this attribute with any additional features provided for the attribute
This is also usable with the Type(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Type- 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: Type => 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 Type 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.WindowCovering.server.attributes.PhysicalClosedLimitLift¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“PhysicalClosedLimitLift” 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 PhysicalClosedLimitLift(…) 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: PhysicalClosedLimitLift => 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 PhysicalClosedLimitLift 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.WindowCovering.server.attributes.PhysicalClosedLimitTilt¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“PhysicalClosedLimitTilt” 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 PhysicalClosedLimitTilt(…) 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: PhysicalClosedLimitTilt => 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 PhysicalClosedLimitTilt 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.WindowCovering.server.attributes.CurrentPositionLift¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“CurrentPositionLift” 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 CurrentPositionLift(…) 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: CurrentPositionLift => 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 CurrentPositionLift 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.WindowCovering.server.attributes.CurrentPositionTilt¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“CurrentPositionTilt” 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 CurrentPositionTilt(…) 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: CurrentPositionTilt => 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 CurrentPositionTilt 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.WindowCovering.server.attributes.NumberOfActuationsLift¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“NumberOfActuationsLift” 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 NumberOfActuationsLift(…) 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: NumberOfActuationsLift => 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 NumberOfActuationsLift 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.WindowCovering.server.attributes.NumberOfActuationsTilt¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“NumberOfActuationsTilt” 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 NumberOfActuationsTilt(…) 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: NumberOfActuationsTilt => 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 NumberOfActuationsTilt 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.WindowCovering.server.attributes.ConfigStatus¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“ConfigStatus” the name of this attribute
- data_type: st.matter.generated.zap_clusters.WindowCovering.types.ConfigStatus¶
the data type of this attribute
- new_value(...)¶
Create a ConfigStatus object of this attribute with any additional features provided for the attribute
This is also usable with the ConfigStatus(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ConfigStatus- Return type:
st.matter.generated.zap_clusters.WindowCovering.types.ConfigStatus
- 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: ConfigStatus => 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 ConfigStatus 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.WindowCovering.server.attributes.CurrentPositionLiftPercentage¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“CurrentPositionLiftPercentage” 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 CurrentPositionLiftPercentage(…) 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: CurrentPositionLiftPercentage => true => suggested
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 CurrentPositionLiftPercentage 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.WindowCovering.server.attributes.CurrentPositionTiltPercentage¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“CurrentPositionTiltPercentage” 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 CurrentPositionTiltPercentage(…) 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: CurrentPositionTiltPercentage => true => suggested
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 CurrentPositionTiltPercentage 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.WindowCovering.server.attributes.OperationalStatus¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“OperationalStatus” the name of this attribute
- data_type: st.matter.generated.zap_clusters.WindowCovering.types.OperationalStatus¶
the data type of this attribute
- new_value(...)¶
Create a OperationalStatus object of this attribute with any additional features provided for the attribute
This is also usable with the OperationalStatus(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OperationalStatus- Return type:
st.matter.generated.zap_clusters.WindowCovering.types.OperationalStatus
- 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: OperationalStatus => true => suggested
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 OperationalStatus 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.WindowCovering.server.attributes.TargetPositionLiftPercent100ths¶
- ID: number¶
0x000B the ID of this attribute
- NAME: str¶
“TargetPositionLiftPercent100ths” 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 TargetPositionLiftPercent100ths(…) 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: TargetPositionLiftPercent100ths => true => suggested
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 TargetPositionLiftPercent100ths 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.WindowCovering.server.attributes.TargetPositionTiltPercent100ths¶
- ID: number¶
0x000C the ID of this attribute
- NAME: str¶
“TargetPositionTiltPercent100ths” 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 TargetPositionTiltPercent100ths(…) 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: TargetPositionTiltPercent100ths => true => suggested
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 TargetPositionTiltPercent100ths 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.WindowCovering.server.attributes.EndProductType¶
- ID: number¶
0x000D the ID of this attribute
- NAME: str¶
“EndProductType” the name of this attribute
- data_type: st.matter.generated.zap_clusters.WindowCovering.types.EndProductType¶
the data type of this attribute
- new_value(...)¶
Create a EndProductType object of this attribute with any additional features provided for the attribute
This is also usable with the EndProductType(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a EndProductType- Return type:
st.matter.generated.zap_clusters.WindowCovering.types.EndProductType
- 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: EndProductType => 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 EndProductType 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.WindowCovering.server.attributes.CurrentPositionLiftPercent100ths¶
- ID: number¶
0x000E the ID of this attribute
- NAME: str¶
“CurrentPositionLiftPercent100ths” 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 CurrentPositionLiftPercent100ths(…) 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: CurrentPositionLiftPercent100ths => true => suggested
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 CurrentPositionLiftPercent100ths 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.WindowCovering.server.attributes.CurrentPositionTiltPercent100ths¶
- ID: number¶
0x000F the ID of this attribute
- NAME: str¶
“CurrentPositionTiltPercent100ths” 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 CurrentPositionTiltPercent100ths(…) 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: CurrentPositionTiltPercent100ths => true => suggested
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 CurrentPositionTiltPercent100ths 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.WindowCovering.server.attributes.InstalledOpenLimitLift¶
- ID: number¶
0x0010 the ID of this attribute
- NAME: str¶
“InstalledOpenLimitLift” 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 InstalledOpenLimitLift(…) 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: InstalledOpenLimitLift => 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 InstalledOpenLimitLift 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.WindowCovering.server.attributes.InstalledClosedLimitLift¶
- ID: number¶
0x0011 the ID of this attribute
- NAME: str¶
“InstalledClosedLimitLift” 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 InstalledClosedLimitLift(…) 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: InstalledClosedLimitLift => 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 InstalledClosedLimitLift 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.WindowCovering.server.attributes.InstalledOpenLimitTilt¶
- ID: number¶
0x0012 the ID of this attribute
- NAME: str¶
“InstalledOpenLimitTilt” 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 InstalledOpenLimitTilt(…) 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: InstalledOpenLimitTilt => 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 InstalledOpenLimitTilt 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.WindowCovering.server.attributes.InstalledClosedLimitTilt¶
- ID: number¶
0x0013 the ID of this attribute
- NAME: str¶
“InstalledClosedLimitTilt” 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 InstalledClosedLimitTilt(…) 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: InstalledClosedLimitTilt => 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 InstalledClosedLimitTilt 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.WindowCovering.server.attributes.Mode¶
- ID: number¶
0x0017 the ID of this attribute
- NAME: str¶
“Mode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.WindowCovering.types.Mode¶
the data type of this attribute
- new_value(...)¶
Create a Mode object of this attribute with any additional features provided for the attribute
This is also usable with the Mode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Mode- 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.generated.zap_clusters.WindowCovering.types.Mode) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: Mode => 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 Mode 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.WindowCovering.server.attributes.SafetyStatus¶
- ID: number¶
0x001A the ID of this attribute
- NAME: str¶
“SafetyStatus” the name of this attribute
- data_type: st.matter.generated.zap_clusters.WindowCovering.types.SafetyStatus¶
the data type of this attribute
- new_value(...)¶
Create a SafetyStatus object of this attribute with any additional features provided for the attribute
This is also usable with the SafetyStatus(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a SafetyStatus- Return type:
st.matter.generated.zap_clusters.WindowCovering.types.SafetyStatus
- 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: SafetyStatus => true => suggested
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 SafetyStatus 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.WindowCovering.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.WindowCovering.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.WindowCovering.server.commands.UpOrOpen: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“UpOrOpen” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an UpOrOpen 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 UpOrOpen 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)
- class st.matter.generated.zap_clusters.WindowCovering.server.commands.DownOrClose: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this command
- NAME: str¶
“DownOrClose” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an DownOrClose 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 DownOrClose 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)
- class st.matter.generated.zap_clusters.WindowCovering.server.commands.StopMotion: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this command
- NAME: str¶
“StopMotion” the name of this command
- build_test_command_response(device, endpoint_id, status)¶
Builds an StopMotion 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 StopMotion 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)
- class st.matter.generated.zap_clusters.WindowCovering.server.commands.GoToLiftValue: st.matter.data_types.Structure¶
- ID: number¶
0x0004 the ID of this command
- NAME: str¶
“GoToLiftValue” the name of this command
- lift_value: st.matter.data_types.Uint16¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an GoToLiftValue 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, lift_value)¶
Initialize the GoToLiftValue command
- Parameters:
device (
st.matter.Device) – the device to build this message tolift_value (
st.matter.data_types.Uint16)
- 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.WindowCovering.server.commands.GoToLiftPercentage: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this command
- NAME: str¶
“GoToLiftPercentage” the name of this command
- lift_percent100ths_value: st.matter.data_types.Uint16¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an GoToLiftPercentage 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, lift_percent100ths_value)¶
Initialize the GoToLiftPercentage command
- Parameters:
device (
st.matter.Device) – the device to build this message tolift_percent100ths_value (
st.matter.data_types.Uint16)
- 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.WindowCovering.server.commands.GoToTiltValue: st.matter.data_types.Structure¶
- ID: number¶
0x0007 the ID of this command
- NAME: str¶
“GoToTiltValue” the name of this command
- tilt_value: st.matter.data_types.Uint16¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an GoToTiltValue 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, tilt_value)¶
Initialize the GoToTiltValue command
- Parameters:
device (
st.matter.Device) – the device to build this message totilt_value (
st.matter.data_types.Uint16)
- 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.WindowCovering.server.commands.GoToTiltPercentage: st.matter.data_types.Structure¶
- ID: number¶
0x0008 the ID of this command
- NAME: str¶
“GoToTiltPercentage” the name of this command
- tilt_percent100ths_value: st.matter.data_types.Uint16¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an GoToTiltPercentage 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, tilt_percent100ths_value)¶
Initialize the GoToTiltPercentage command
- Parameters:
device (
st.matter.Device) – the device to build this message totilt_percent100ths_value (
st.matter.data_types.Uint16)
- 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.WindowCovering.types.ConfigStatus¶
- OPERATIONAL: number¶
1
- ONLINE_RESERVED: number¶
2
- LIFT_MOVEMENT_REVERSED: number¶
4
- LIFT_POSITION_AWARE: number¶
8
- TILT_POSITION_AWARE: number¶
16
- LIFT_ENCODER_CONTROLLED: number¶
32
- TILT_ENCODER_CONTROLLED: number¶
64
- is_operational_set()¶
- Returns:
True if the value of OPERATIONAL is non-zero
- Return type:
boolean
- set_operational()¶
Set the value of the bit in the OPERATIONAL field to 1
- unset_operational()¶
Set the value of the bits in the OPERATIONAL field to 0
- is_online_reserved_set()¶
- Returns:
True if the value of ONLINE_RESERVED is non-zero
- Return type:
boolean
- set_online_reserved()¶
Set the value of the bit in the ONLINE_RESERVED field to 1
- unset_online_reserved()¶
Set the value of the bits in the ONLINE_RESERVED field to 0
- is_lift_movement_reversed_set()¶
- Returns:
True if the value of LIFT_MOVEMENT_REVERSED is non-zero
- Return type:
boolean
- set_lift_movement_reversed()¶
Set the value of the bit in the LIFT_MOVEMENT_REVERSED field to 1
- unset_lift_movement_reversed()¶
Set the value of the bits in the LIFT_MOVEMENT_REVERSED field to 0
- is_lift_position_aware_set()¶
- Returns:
True if the value of LIFT_POSITION_AWARE is non-zero
- Return type:
boolean
- set_lift_position_aware()¶
Set the value of the bit in the LIFT_POSITION_AWARE field to 1
- unset_lift_position_aware()¶
Set the value of the bits in the LIFT_POSITION_AWARE field to 0
- is_tilt_position_aware_set()¶
- Returns:
True if the value of TILT_POSITION_AWARE is non-zero
- Return type:
boolean
- set_tilt_position_aware()¶
Set the value of the bit in the TILT_POSITION_AWARE field to 1
- unset_tilt_position_aware()¶
Set the value of the bits in the TILT_POSITION_AWARE field to 0
- is_lift_encoder_controlled_set()¶
- Returns:
True if the value of LIFT_ENCODER_CONTROLLED is non-zero
- Return type:
boolean
- set_lift_encoder_controlled()¶
Set the value of the bit in the LIFT_ENCODER_CONTROLLED field to 1
- unset_lift_encoder_controlled()¶
Set the value of the bits in the LIFT_ENCODER_CONTROLLED field to 0
- is_tilt_encoder_controlled_set()¶
- Returns:
True if the value of TILT_ENCODER_CONTROLLED is non-zero
- Return type:
boolean
- set_tilt_encoder_controlled()¶
Set the value of the bit in the TILT_ENCODER_CONTROLLED field to 1
- unset_tilt_encoder_controlled()¶
Set the value of the bits in the TILT_ENCODER_CONTROLLED field to 0
- class st.matter.generated.zap_clusters.WindowCovering.types.Feature¶
- LIFT: number¶
1
- TILT: number¶
2
- POSITION_AWARE_LIFT: number¶
4
- ABSOLUTE_POSITION: number¶
8
- POSITION_AWARE_TILT: number¶
16
- is_lift_set()¶
- Returns:
True if the value of LIFT is non-zero
- Return type:
boolean
- set_lift()¶
Set the value of the bit in the LIFT field to 1
- unset_lift()¶
Set the value of the bits in the LIFT field to 0
- is_tilt_set()¶
- Returns:
True if the value of TILT is non-zero
- Return type:
boolean
- set_tilt()¶
Set the value of the bit in the TILT field to 1
- unset_tilt()¶
Set the value of the bits in the TILT field to 0
- is_position_aware_lift_set()¶
- Returns:
True if the value of POSITION_AWARE_LIFT is non-zero
- Return type:
boolean
- set_position_aware_lift()¶
Set the value of the bit in the POSITION_AWARE_LIFT field to 1
- unset_position_aware_lift()¶
Set the value of the bits in the POSITION_AWARE_LIFT field to 0
- is_absolute_position_set()¶
- Returns:
True if the value of ABSOLUTE_POSITION is non-zero
- Return type:
boolean
- set_absolute_position()¶
Set the value of the bit in the ABSOLUTE_POSITION field to 1
- unset_absolute_position()¶
Set the value of the bits in the ABSOLUTE_POSITION field to 0
- is_position_aware_tilt_set()¶
- Returns:
True if the value of POSITION_AWARE_TILT is non-zero
- Return type:
boolean
- set_position_aware_tilt()¶
Set the value of the bit in the POSITION_AWARE_TILT field to 1
- unset_position_aware_tilt()¶
Set the value of the bits in the POSITION_AWARE_TILT field to 0
- class st.matter.generated.zap_clusters.WindowCovering.types.Mode¶
- MOTOR_DIRECTION_REVERSED: number¶
1
- CALIBRATION_MODE: number¶
2
- MAINTENANCE_MODE: number¶
4
- LED_FEEDBACK: number¶
8
- is_motor_direction_reversed_set()¶
- Returns:
True if the value of MOTOR_DIRECTION_REVERSED is non-zero
- Return type:
boolean
- set_motor_direction_reversed()¶
Set the value of the bit in the MOTOR_DIRECTION_REVERSED field to 1
- unset_motor_direction_reversed()¶
Set the value of the bits in the MOTOR_DIRECTION_REVERSED field to 0
- is_calibration_mode_set()¶
- Returns:
True if the value of CALIBRATION_MODE is non-zero
- Return type:
boolean
- set_calibration_mode()¶
Set the value of the bit in the CALIBRATION_MODE field to 1
- unset_calibration_mode()¶
Set the value of the bits in the CALIBRATION_MODE field to 0
- is_maintenance_mode_set()¶
- Returns:
True if the value of MAINTENANCE_MODE is non-zero
- Return type:
boolean
- set_maintenance_mode()¶
Set the value of the bit in the MAINTENANCE_MODE field to 1
- unset_maintenance_mode()¶
Set the value of the bits in the MAINTENANCE_MODE field to 0
- is_led_feedback_set()¶
- Returns:
True if the value of LED_FEEDBACK is non-zero
- Return type:
boolean
- set_led_feedback()¶
Set the value of the bit in the LED_FEEDBACK field to 1
- unset_led_feedback()¶
Set the value of the bits in the LED_FEEDBACK field to 0
- class st.matter.generated.zap_clusters.WindowCovering.types.OperationalStatus¶
- GLOBAL: number¶
3
- LIFT: number¶
12
- TILT: number¶
48
- is_global_set()¶
- Returns:
True if the value of GLOBAL is non-zero
- Return type:
boolean
- set_global()¶
Set the value of the bit in the GLOBAL field to 1
- unset_global()¶
Set the value of the bits in the GLOBAL field to 0
- is_lift_set()¶
- Returns:
True if the value of LIFT is non-zero
- Return type:
boolean
- set_lift()¶
Set the value of the bit in the LIFT field to 1
- unset_lift()¶
Set the value of the bits in the LIFT field to 0
- is_tilt_set()¶
- Returns:
True if the value of TILT is non-zero
- Return type:
boolean
- set_tilt()¶
Set the value of the bit in the TILT field to 1
- unset_tilt()¶
Set the value of the bits in the TILT field to 0
- class st.matter.generated.zap_clusters.WindowCovering.types.SafetyStatus¶
- REMOTE_LOCKOUT: number¶
1
- TAMPER_DETECTION: number¶
2
- FAILED_COMMUNICATION: number¶
4
- POSITION_FAILURE: number¶
8
- THERMAL_PROTECTION: number¶
16
- OBSTACLE_DETECTED: number¶
32
- POWER: number¶
64
- STOP_INPUT: number¶
128
- MOTOR_JAMMED: number¶
256
- HARDWARE_FAILURE: number¶
512
- MANUAL_OPERATION: number¶
1024
- PROTECTION: number¶
2048
- is_remote_lockout_set()¶
- Returns:
True if the value of REMOTE_LOCKOUT is non-zero
- Return type:
boolean
- set_remote_lockout()¶
Set the value of the bit in the REMOTE_LOCKOUT field to 1
- unset_remote_lockout()¶
Set the value of the bits in the REMOTE_LOCKOUT field to 0
- is_tamper_detection_set()¶
- Returns:
True if the value of TAMPER_DETECTION is non-zero
- Return type:
boolean
- set_tamper_detection()¶
Set the value of the bit in the TAMPER_DETECTION field to 1
- unset_tamper_detection()¶
Set the value of the bits in the TAMPER_DETECTION field to 0
- is_failed_communication_set()¶
- Returns:
True if the value of FAILED_COMMUNICATION is non-zero
- Return type:
boolean
- set_failed_communication()¶
Set the value of the bit in the FAILED_COMMUNICATION field to 1
- unset_failed_communication()¶
Set the value of the bits in the FAILED_COMMUNICATION field to 0
- is_position_failure_set()¶
- Returns:
True if the value of POSITION_FAILURE is non-zero
- Return type:
boolean
- set_position_failure()¶
Set the value of the bit in the POSITION_FAILURE field to 1
- unset_position_failure()¶
Set the value of the bits in the POSITION_FAILURE field to 0
- is_thermal_protection_set()¶
- Returns:
True if the value of THERMAL_PROTECTION is non-zero
- Return type:
boolean
- set_thermal_protection()¶
Set the value of the bit in the THERMAL_PROTECTION field to 1
- unset_thermal_protection()¶
Set the value of the bits in the THERMAL_PROTECTION field to 0
- is_obstacle_detected_set()¶
- Returns:
True if the value of OBSTACLE_DETECTED is non-zero
- Return type:
boolean
- set_obstacle_detected()¶
Set the value of the bit in the OBSTACLE_DETECTED field to 1
- unset_obstacle_detected()¶
Set the value of the bits in the OBSTACLE_DETECTED field to 0
- is_power_set()¶
- Returns:
True if the value of POWER is non-zero
- Return type:
boolean
- set_power()¶
Set the value of the bit in the POWER field to 1
- unset_power()¶
Set the value of the bits in the POWER field to 0
- is_stop_input_set()¶
- Returns:
True if the value of STOP_INPUT is non-zero
- Return type:
boolean
- set_stop_input()¶
Set the value of the bit in the STOP_INPUT field to 1
- unset_stop_input()¶
Set the value of the bits in the STOP_INPUT field to 0
- is_motor_jammed_set()¶
- Returns:
True if the value of MOTOR_JAMMED is non-zero
- Return type:
boolean
- set_motor_jammed()¶
Set the value of the bit in the MOTOR_JAMMED field to 1
- unset_motor_jammed()¶
Set the value of the bits in the MOTOR_JAMMED field to 0
- is_hardware_failure_set()¶
- Returns:
True if the value of HARDWARE_FAILURE is non-zero
- Return type:
boolean
- set_hardware_failure()¶
Set the value of the bit in the HARDWARE_FAILURE field to 1
- unset_hardware_failure()¶
Set the value of the bits in the HARDWARE_FAILURE field to 0
- is_manual_operation_set()¶
- Returns:
True if the value of MANUAL_OPERATION is non-zero
- Return type:
boolean
- set_manual_operation()¶
Set the value of the bit in the MANUAL_OPERATION field to 1
- unset_manual_operation()¶
Set the value of the bits in the MANUAL_OPERATION field to 0
- is_protection_set()¶
- Returns:
True if the value of PROTECTION is non-zero
- Return type:
boolean
- set_protection()¶
Set the value of the bit in the PROTECTION field to 1
- unset_protection()¶
Set the value of the bits in the PROTECTION field to 0
Enum types¶
- class st.matter.generated.zap_clusters.WindowCovering.types.EndProductType: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- ROLLER_SHADE: number¶
0
- ROMAN_SHADE: number¶
1
- BALLOON_SHADE: number¶
2
- WOVEN_WOOD: number¶
3
- PLEATED_SHADE: number¶
4
- CELLULAR_SHADE: number¶
5
- LAYERED_SHADE: number¶
6
- LAYERED_SHADE2D: number¶
7
- SHEER_SHADE: number¶
8
- TILT_ONLY_INTERIOR_BLIND: number¶
9
- INTERIOR_BLIND: number¶
10
- VERTICAL_BLIND_STRIP_CURTAIN: number¶
11
- INTERIOR_VENETIAN_BLIND: number¶
12
- EXTERIOR_VENETIAN_BLIND: number¶
13
- LATERAL_LEFT_CURTAIN: number¶
14
- LATERAL_RIGHT_CURTAIN: number¶
15
- CENTRAL_CURTAIN: number¶
16
- ROLLER_SHUTTER: number¶
17
- EXTERIOR_VERTICAL_SCREEN: number¶
18
- AWNING_TERRACE_PATIO: number¶
19
- AWNING_VERTICAL_SCREEN: number¶
20
- TILT_ONLY_PERGOLA: number¶
21
- SWINGING_SHUTTER: number¶
22
- SLIDING_SHUTTER: number¶
23
- UNKNOWN: number¶
255
- class st.matter.generated.zap_clusters.WindowCovering.types.Type: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- ROLLER_SHADE: number¶
0
- ROLLER_SHADE2_MOTOR: number¶
1
- ROLLER_SHADE_EXTERIOR: number¶
2
- ROLLER_SHADE_EXTERIOR2_MOTOR: number¶
3
- DRAPERY: number¶
4
- AWNING: number¶
5
- SHUTTER: number¶
6
- TILT_BLIND_TILT_ONLY: number¶
7
- TILT_BLIND_LIFT_AND_TILT: number¶
8
- PROJECTOR_SCREEN: number¶
9
- UNKNOWN: number¶
255