ColorControl¶
Attributes¶
- class st.matter.generated.zap_clusters.ColorControl.server.attributes.CurrentHue¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“CurrentHue” 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 CurrentHue(…) 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: CurrentHue => 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 CurrentHue 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.ColorControl.server.attributes.CurrentSaturation¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“CurrentSaturation” 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 CurrentSaturation(…) 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: CurrentSaturation => 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 CurrentSaturation 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.ColorControl.server.attributes.RemainingTime¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“RemainingTime” 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 RemainingTime(…) 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: RemainingTime => 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 RemainingTime 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.ColorControl.server.attributes.CurrentX¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“CurrentX” 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 CurrentX(…) 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: CurrentX => 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 CurrentX 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.ColorControl.server.attributes.CurrentY¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“CurrentY” 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 CurrentY(…) 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: CurrentY => 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 CurrentY 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.ColorControl.server.attributes.DriftCompensation¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“DriftCompensation” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ColorControl.types.DriftCompensationEnum¶
the data type of this attribute
- new_value(...)¶
Create a DriftCompensationEnum object of this attribute with any additional features provided for the attribute
This is also usable with the DriftCompensation(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a DriftCompensationEnum- Return type:
st.matter.generated.zap_clusters.ColorControl.types.DriftCompensationEnum
- 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: DriftCompensation => 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 DriftCompensation 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.ColorControl.server.attributes.CompensationText¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“CompensationText” the name of this attribute
- data_type: st.matter.data_types.UTF8String1¶
the data type of this attribute
- new_value(...)¶
Create a UTF8String1 object of this attribute with any additional features provided for the attribute
This is also usable with the CompensationText(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a UTF8String1- 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: CompensationText => 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 CompensationText 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.ColorControl.server.attributes.ColorTemperatureMireds¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“ColorTemperatureMireds” 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 ColorTemperatureMireds(…) 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: ColorTemperatureMireds => 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 ColorTemperatureMireds 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.ColorControl.server.attributes.ColorMode¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“ColorMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ColorControl.types.ColorModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ColorModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ColorMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ColorModeEnum- Return type:
st.matter.generated.zap_clusters.ColorControl.types.ColorModeEnum
- 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: ColorMode => 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 ColorMode 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.ColorControl.server.attributes.Options¶
- ID: number¶
0x000F the ID of this attribute
- NAME: str¶
“Options” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
the data type of this attribute
- new_value(...)¶
Create a OptionsBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the Options(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OptionsBitmap- Return type:
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap
- 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.ColorControl.types.OptionsBitmap) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: Options => 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 Options 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.ColorControl.server.attributes.NumberOfPrimaries¶
- ID: number¶
0x0010 the ID of this attribute
- NAME: str¶
“NumberOfPrimaries” 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 NumberOfPrimaries(…) 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: NumberOfPrimaries => 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 NumberOfPrimaries 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.ColorControl.server.attributes.Primary1X¶
- ID: number¶
0x0011 the ID of this attribute
- NAME: str¶
“Primary1X” 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 Primary1X(…) 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: Primary1X => 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 Primary1X 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.ColorControl.server.attributes.Primary1Y¶
- ID: number¶
0x0012 the ID of this attribute
- NAME: str¶
“Primary1Y” 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 Primary1Y(…) 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: Primary1Y => 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 Primary1Y 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.ColorControl.server.attributes.Primary1Intensity¶
- ID: number¶
0x0013 the ID of this attribute
- NAME: str¶
“Primary1Intensity” 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 Primary1Intensity(…) 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: Primary1Intensity => 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 Primary1Intensity 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.ColorControl.server.attributes.Primary2X¶
- ID: number¶
0x0015 the ID of this attribute
- NAME: str¶
“Primary2X” 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 Primary2X(…) 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: Primary2X => 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 Primary2X 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.ColorControl.server.attributes.Primary2Y¶
- ID: number¶
0x0016 the ID of this attribute
- NAME: str¶
“Primary2Y” 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 Primary2Y(…) 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: Primary2Y => 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 Primary2Y 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.ColorControl.server.attributes.Primary2Intensity¶
- ID: number¶
0x0017 the ID of this attribute
- NAME: str¶
“Primary2Intensity” 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 Primary2Intensity(…) 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: Primary2Intensity => 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 Primary2Intensity 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.ColorControl.server.attributes.Primary3X¶
- ID: number¶
0x0019 the ID of this attribute
- NAME: str¶
“Primary3X” 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 Primary3X(…) 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: Primary3X => 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 Primary3X 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.ColorControl.server.attributes.Primary3Y¶
- ID: number¶
0x001A the ID of this attribute
- NAME: str¶
“Primary3Y” 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 Primary3Y(…) 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: Primary3Y => 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 Primary3Y 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.ColorControl.server.attributes.Primary3Intensity¶
- ID: number¶
0x001B the ID of this attribute
- NAME: str¶
“Primary3Intensity” 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 Primary3Intensity(…) 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: Primary3Intensity => 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 Primary3Intensity 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.ColorControl.server.attributes.Primary4X¶
- ID: number¶
0x0020 the ID of this attribute
- NAME: str¶
“Primary4X” 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 Primary4X(…) 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: Primary4X => 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 Primary4X 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.ColorControl.server.attributes.Primary4Y¶
- ID: number¶
0x0021 the ID of this attribute
- NAME: str¶
“Primary4Y” 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 Primary4Y(…) 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: Primary4Y => 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 Primary4Y 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.ColorControl.server.attributes.Primary4Intensity¶
- ID: number¶
0x0022 the ID of this attribute
- NAME: str¶
“Primary4Intensity” 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 Primary4Intensity(…) 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: Primary4Intensity => 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 Primary4Intensity 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.ColorControl.server.attributes.Primary5X¶
- ID: number¶
0x0024 the ID of this attribute
- NAME: str¶
“Primary5X” 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 Primary5X(…) 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: Primary5X => 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 Primary5X 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.ColorControl.server.attributes.Primary5Y¶
- ID: number¶
0x0025 the ID of this attribute
- NAME: str¶
“Primary5Y” 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 Primary5Y(…) 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: Primary5Y => 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 Primary5Y 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.ColorControl.server.attributes.Primary5Intensity¶
- ID: number¶
0x0026 the ID of this attribute
- NAME: str¶
“Primary5Intensity” 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 Primary5Intensity(…) 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: Primary5Intensity => 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 Primary5Intensity 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.ColorControl.server.attributes.Primary6X¶
- ID: number¶
0x0028 the ID of this attribute
- NAME: str¶
“Primary6X” 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 Primary6X(…) 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: Primary6X => 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 Primary6X 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.ColorControl.server.attributes.Primary6Y¶
- ID: number¶
0x0029 the ID of this attribute
- NAME: str¶
“Primary6Y” 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 Primary6Y(…) 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: Primary6Y => 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 Primary6Y 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.ColorControl.server.attributes.Primary6Intensity¶
- ID: number¶
0x002A the ID of this attribute
- NAME: str¶
“Primary6Intensity” 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 Primary6Intensity(…) 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: Primary6Intensity => 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 Primary6Intensity 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.ColorControl.server.attributes.WhitePointX¶
- ID: number¶
0x0030 the ID of this attribute
- NAME: str¶
“WhitePointX” 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 WhitePointX(…) 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: WhitePointX => 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 WhitePointX 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.ColorControl.server.attributes.WhitePointY¶
- ID: number¶
0x0031 the ID of this attribute
- NAME: str¶
“WhitePointY” 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 WhitePointY(…) 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: WhitePointY => 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 WhitePointY 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.ColorControl.server.attributes.ColorPointRX¶
- ID: number¶
0x0032 the ID of this attribute
- NAME: str¶
“ColorPointRX” 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 ColorPointRX(…) 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: ColorPointRX => 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 ColorPointRX 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.ColorControl.server.attributes.ColorPointRY¶
- ID: number¶
0x0033 the ID of this attribute
- NAME: str¶
“ColorPointRY” 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 ColorPointRY(…) 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: ColorPointRY => 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 ColorPointRY 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.ColorControl.server.attributes.ColorPointRIntensity¶
- ID: number¶
0x0034 the ID of this attribute
- NAME: str¶
“ColorPointRIntensity” 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 ColorPointRIntensity(…) 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: ColorPointRIntensity => 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 ColorPointRIntensity 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.ColorControl.server.attributes.ColorPointGX¶
- ID: number¶
0x0036 the ID of this attribute
- NAME: str¶
“ColorPointGX” 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 ColorPointGX(…) 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: ColorPointGX => 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 ColorPointGX 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.ColorControl.server.attributes.ColorPointGY¶
- ID: number¶
0x0037 the ID of this attribute
- NAME: str¶
“ColorPointGY” 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 ColorPointGY(…) 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: ColorPointGY => 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 ColorPointGY 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.ColorControl.server.attributes.ColorPointGIntensity¶
- ID: number¶
0x0038 the ID of this attribute
- NAME: str¶
“ColorPointGIntensity” 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 ColorPointGIntensity(…) 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: ColorPointGIntensity => 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 ColorPointGIntensity 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.ColorControl.server.attributes.ColorPointBX¶
- ID: number¶
0x003A the ID of this attribute
- NAME: str¶
“ColorPointBX” 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 ColorPointBX(…) 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: ColorPointBX => 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 ColorPointBX 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.ColorControl.server.attributes.ColorPointBY¶
- ID: number¶
0x003B the ID of this attribute
- NAME: str¶
“ColorPointBY” 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 ColorPointBY(…) 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: ColorPointBY => 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 ColorPointBY 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.ColorControl.server.attributes.ColorPointBIntensity¶
- ID: number¶
0x003C the ID of this attribute
- NAME: str¶
“ColorPointBIntensity” 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 ColorPointBIntensity(…) 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: ColorPointBIntensity => 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 ColorPointBIntensity 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.ColorControl.server.attributes.EnhancedCurrentHue¶
- ID: number¶
0x4000 the ID of this attribute
- NAME: str¶
“EnhancedCurrentHue” 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 EnhancedCurrentHue(…) 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: EnhancedCurrentHue => 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 EnhancedCurrentHue 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.ColorControl.server.attributes.EnhancedColorMode¶
- ID: number¶
0x4001 the ID of this attribute
- NAME: str¶
“EnhancedColorMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ColorControl.types.EnhancedColorModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a EnhancedColorModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the EnhancedColorMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a EnhancedColorModeEnum- Return type:
st.matter.generated.zap_clusters.ColorControl.types.EnhancedColorModeEnum
- 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: EnhancedColorMode => 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 EnhancedColorMode 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.ColorControl.server.attributes.ColorLoopActive¶
- ID: number¶
0x4002 the ID of this attribute
- NAME: str¶
“ColorLoopActive” 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 ColorLoopActive(…) 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: ColorLoopActive => 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 ColorLoopActive 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.ColorControl.server.attributes.ColorLoopDirection¶
- ID: number¶
0x4003 the ID of this attribute
- NAME: str¶
“ColorLoopDirection” 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 ColorLoopDirection(…) 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: ColorLoopDirection => 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 ColorLoopDirection 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.ColorControl.server.attributes.ColorLoopTime¶
- ID: number¶
0x4004 the ID of this attribute
- NAME: str¶
“ColorLoopTime” 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 ColorLoopTime(…) 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: ColorLoopTime => 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 ColorLoopTime 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.ColorControl.server.attributes.ColorLoopStartEnhancedHue¶
- ID: number¶
0x4005 the ID of this attribute
- NAME: str¶
“ColorLoopStartEnhancedHue” 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 ColorLoopStartEnhancedHue(…) 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: ColorLoopStartEnhancedHue => 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 ColorLoopStartEnhancedHue 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.ColorControl.server.attributes.ColorLoopStoredEnhancedHue¶
- ID: number¶
0x4006 the ID of this attribute
- NAME: str¶
“ColorLoopStoredEnhancedHue” 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 ColorLoopStoredEnhancedHue(…) 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: ColorLoopStoredEnhancedHue => 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 ColorLoopStoredEnhancedHue 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.ColorControl.server.attributes.ColorCapabilities¶
- ID: number¶
0x400A the ID of this attribute
- NAME: str¶
“ColorCapabilities” the name of this attribute
- data_type: st.matter.generated.zap_clusters.ColorControl.types.ColorCapabilitiesBitmap¶
the data type of this attribute
- new_value(...)¶
Create a ColorCapabilitiesBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the ColorCapabilities(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ColorCapabilitiesBitmap- Return type:
st.matter.generated.zap_clusters.ColorControl.types.ColorCapabilitiesBitmap
- 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: ColorCapabilities => 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 ColorCapabilities 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.ColorControl.server.attributes.ColorTempPhysicalMinMireds¶
- ID: number¶
0x400B the ID of this attribute
- NAME: str¶
“ColorTempPhysicalMinMireds” 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 ColorTempPhysicalMinMireds(…) 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: ColorTempPhysicalMinMireds => 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 ColorTempPhysicalMinMireds 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.ColorControl.server.attributes.ColorTempPhysicalMaxMireds¶
- ID: number¶
0x400C the ID of this attribute
- NAME: str¶
“ColorTempPhysicalMaxMireds” 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 ColorTempPhysicalMaxMireds(…) 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: ColorTempPhysicalMaxMireds => 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 ColorTempPhysicalMaxMireds 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.ColorControl.server.attributes.CoupleColorTempToLevelMinMireds¶
- ID: number¶
0x400D the ID of this attribute
- NAME: str¶
“CoupleColorTempToLevelMinMireds” 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 CoupleColorTempToLevelMinMireds(…) 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: CoupleColorTempToLevelMinMireds => 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 CoupleColorTempToLevelMinMireds 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.ColorControl.server.attributes.StartUpColorTemperatureMireds¶
- ID: number¶
0x4010 the ID of this attribute
- NAME: str¶
“StartUpColorTemperatureMireds” 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 StartUpColorTemperatureMireds(…) 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:
- 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.Uint16) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: StartUpColorTemperatureMireds => 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 StartUpColorTemperatureMireds 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.ColorControl.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.ColorControl.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.ColorControl.server.commands.MoveToHue: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this command
- NAME: str¶
“MoveToHue” the name of this command
- hue: st.matter.data_types.Uint8¶
- direction: st.matter.generated.zap_clusters.ColorControl.types.DirectionEnum¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveToHue 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, hue, direction, transition_time, options_mask, options_override)¶
Initialize the MoveToHue command
- Parameters:
device (
st.matter.Device) – the device to build this message todirection (
st.matter.generated.zap_clusters.ColorControl.types.DirectionEnum)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveHue: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this command
- NAME: str¶
“MoveHue” the name of this command
- move_mode: st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum¶
- rate: st.matter.data_types.Uint8¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveHue 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, move_mode, rate, options_mask, options_override)¶
Initialize the MoveHue command
- Parameters:
device (
st.matter.Device) – the device to build this message tomove_mode (
st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum)rate (
st.matter.data_types.Uint8)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.StepHue: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this command
- NAME: str¶
“StepHue” the name of this command
- step_mode: st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum¶
- step_size: st.matter.data_types.Uint8¶
- transition_time: st.matter.data_types.Uint8¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an StepHue 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, step_mode, step_size, transition_time, options_mask, options_override)¶
Initialize the StepHue command
- Parameters:
device (
st.matter.Device) – the device to build this message tostep_mode (
st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum)step_size (
st.matter.data_types.Uint8)transition_time (
st.matter.data_types.Uint8)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveToSaturation: st.matter.data_types.Structure¶
- ID: number¶
0x0003 the ID of this command
- NAME: str¶
“MoveToSaturation” the name of this command
- saturation: st.matter.data_types.Uint8¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveToSaturation 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, saturation, transition_time, options_mask, options_override)¶
Initialize the MoveToSaturation command
- Parameters:
device (
st.matter.Device) – the device to build this message tosaturation (
st.matter.data_types.Uint8)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveSaturation: st.matter.data_types.Structure¶
- ID: number¶
0x0004 the ID of this command
- NAME: str¶
“MoveSaturation” the name of this command
- move_mode: st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum¶
- rate: st.matter.data_types.Uint8¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveSaturation 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, move_mode, rate, options_mask, options_override)¶
Initialize the MoveSaturation command
- Parameters:
device (
st.matter.Device) – the device to build this message tomove_mode (
st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum)rate (
st.matter.data_types.Uint8)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.StepSaturation: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this command
- NAME: str¶
“StepSaturation” the name of this command
- step_mode: st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum¶
- step_size: st.matter.data_types.Uint8¶
- transition_time: st.matter.data_types.Uint8¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an StepSaturation 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, step_mode, step_size, transition_time, options_mask, options_override)¶
Initialize the StepSaturation command
- Parameters:
device (
st.matter.Device) – the device to build this message tostep_mode (
st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum)step_size (
st.matter.data_types.Uint8)transition_time (
st.matter.data_types.Uint8)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveToHueAndSaturation: st.matter.data_types.Structure¶
- ID: number¶
0x0006 the ID of this command
- NAME: str¶
“MoveToHueAndSaturation” the name of this command
- hue: st.matter.data_types.Uint8¶
- saturation: st.matter.data_types.Uint8¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveToHueAndSaturation 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, hue, saturation, transition_time, options_mask, options_override)¶
Initialize the MoveToHueAndSaturation command
- Parameters:
device (
st.matter.Device) – the device to build this message tosaturation (
st.matter.data_types.Uint8)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveToColor: st.matter.data_types.Structure¶
- ID: number¶
0x0007 the ID of this command
- NAME: str¶
“MoveToColor” the name of this command
- colorx: st.matter.data_types.Uint16¶
- colory: st.matter.data_types.Uint16¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveToColor 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, colorx, colory, transition_time, options_mask, options_override)¶
Initialize the MoveToColor command
- Parameters:
device (
st.matter.Device) – the device to build this message tocolorx (
st.matter.data_types.Uint16)colory (
st.matter.data_types.Uint16)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveColor: st.matter.data_types.Structure¶
- ID: number¶
0x0008 the ID of this command
- NAME: str¶
“MoveColor” the name of this command
- ratex: st.matter.data_types.Int16¶
- ratey: st.matter.data_types.Int16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveColor 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, ratex, ratey, options_mask, options_override)¶
Initialize the MoveColor command
- Parameters:
device (
st.matter.Device) – the device to build this message toratex (
st.matter.data_types.Int16)ratey (
st.matter.data_types.Int16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.StepColor: st.matter.data_types.Structure¶
- ID: number¶
0x0009 the ID of this command
- NAME: str¶
“StepColor” the name of this command
- stepx: st.matter.data_types.Int16¶
- stepy: st.matter.data_types.Int16¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an StepColor 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, stepx, stepy, transition_time, options_mask, options_override)¶
Initialize the StepColor command
- Parameters:
device (
st.matter.Device) – the device to build this message tostepx (
st.matter.data_types.Int16)stepy (
st.matter.data_types.Int16)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveToColorTemperature: st.matter.data_types.Structure¶
- ID: number¶
0x000A the ID of this command
- NAME: str¶
“MoveToColorTemperature” the name of this command
- color_temperature_mireds: st.matter.data_types.Uint16¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveToColorTemperature 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, color_temperature_mireds, transition_time, options_mask, options_override)¶
Initialize the MoveToColorTemperature command
- Parameters:
device (
st.matter.Device) – the device to build this message tocolor_temperature_mireds (
st.matter.data_types.Uint16)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.EnhancedMoveToHue: st.matter.data_types.Structure¶
- ID: number¶
0x0040 the ID of this command
- NAME: str¶
“EnhancedMoveToHue” the name of this command
- enhanced_hue: st.matter.data_types.Uint16¶
- direction: st.matter.generated.zap_clusters.ColorControl.types.DirectionEnum¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an EnhancedMoveToHue 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, enhanced_hue, direction, transition_time, options_mask, options_override)¶
Initialize the EnhancedMoveToHue command
- Parameters:
device (
st.matter.Device) – the device to build this message toenhanced_hue (
st.matter.data_types.Uint16)direction (
st.matter.generated.zap_clusters.ColorControl.types.DirectionEnum)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.EnhancedMoveHue: st.matter.data_types.Structure¶
- ID: number¶
0x0041 the ID of this command
- NAME: str¶
“EnhancedMoveHue” the name of this command
- move_mode: st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum¶
- rate: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an EnhancedMoveHue 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, move_mode, rate, options_mask, options_override)¶
Initialize the EnhancedMoveHue command
- Parameters:
device (
st.matter.Device) – the device to build this message tomove_mode (
st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum)rate (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.EnhancedStepHue: st.matter.data_types.Structure¶
- ID: number¶
0x0042 the ID of this command
- NAME: str¶
“EnhancedStepHue” the name of this command
- step_mode: st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum¶
- step_size: st.matter.data_types.Uint16¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an EnhancedStepHue 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, step_mode, step_size, transition_time, options_mask, options_override)¶
Initialize the EnhancedStepHue command
- Parameters:
device (
st.matter.Device) – the device to build this message tostep_mode (
st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum)step_size (
st.matter.data_types.Uint16)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.EnhancedMoveToHueAndSaturation: st.matter.data_types.Structure¶
- ID: number¶
0x0043 the ID of this command
- NAME: str¶
“EnhancedMoveToHueAndSaturation” the name of this command
- enhanced_hue: st.matter.data_types.Uint16¶
- saturation: st.matter.data_types.Uint8¶
- transition_time: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an EnhancedMoveToHueAndSaturation 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, enhanced_hue, saturation, transition_time, options_mask, options_override)¶
Initialize the EnhancedMoveToHueAndSaturation command
- Parameters:
device (
st.matter.Device) – the device to build this message toenhanced_hue (
st.matter.data_types.Uint16)saturation (
st.matter.data_types.Uint8)transition_time (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.ColorLoopSet: st.matter.data_types.Structure¶
- ID: number¶
0x0044 the ID of this command
- NAME: str¶
“ColorLoopSet” the name of this command
- update_flags: st.matter.generated.zap_clusters.ColorControl.types.UpdateFlagsBitmap¶
- action: st.matter.generated.zap_clusters.ColorControl.types.ColorLoopActionEnum¶
- direction: st.matter.generated.zap_clusters.ColorControl.types.ColorLoopDirectionEnum¶
- time: st.matter.data_types.Uint16¶
- start_hue: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an ColorLoopSet 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, update_flags, action, direction, time, start_hue, options_mask, options_override)¶
Initialize the ColorLoopSet command
- Parameters:
device (
st.matter.Device) – the device to build this message toupdate_flags (
st.matter.generated.zap_clusters.ColorControl.types.UpdateFlagsBitmap)action (
st.matter.generated.zap_clusters.ColorControl.types.ColorLoopActionEnum)direction (
st.matter.generated.zap_clusters.ColorControl.types.ColorLoopDirectionEnum)time (
st.matter.data_types.Uint16)start_hue (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.StopMoveStep: st.matter.data_types.Structure¶
- ID: number¶
0x0047 the ID of this command
- NAME: str¶
“StopMoveStep” the name of this command
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an StopMoveStep 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, options_mask, options_override)¶
Initialize the StopMoveStep command
- Parameters:
device (
st.matter.Device) – the device to build this message tooptions_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.MoveColorTemperature: st.matter.data_types.Structure¶
- ID: number¶
0x004B the ID of this command
- NAME: str¶
“MoveColorTemperature” the name of this command
- move_mode: st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum¶
- rate: st.matter.data_types.Uint16¶
- color_temperature_minimum_mireds: st.matter.data_types.Uint16¶
- color_temperature_maximum_mireds: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an MoveColorTemperature 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, move_mode, rate, color_temperature_minimum_mireds, color_temperature_maximum_mireds, options_mask, options_override)¶
Initialize the MoveColorTemperature command
- Parameters:
device (
st.matter.Device) – the device to build this message tomove_mode (
st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum)rate (
st.matter.data_types.Uint16)color_temperature_minimum_mireds (
st.matter.data_types.Uint16)color_temperature_maximum_mireds (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.server.commands.StepColorTemperature: st.matter.data_types.Structure¶
- ID: number¶
0x004C the ID of this command
- NAME: str¶
“StepColorTemperature” the name of this command
- step_mode: st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum¶
- step_size: st.matter.data_types.Uint16¶
- transition_time: st.matter.data_types.Uint16¶
- color_temperature_minimum_mireds: st.matter.data_types.Uint16¶
- color_temperature_maximum_mireds: st.matter.data_types.Uint16¶
- options_mask: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- options_override: st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- build_test_command_response(device, endpoint_id, status)¶
Builds an StepColorTemperature 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, step_mode, step_size, transition_time, color_temperature_minimum_mireds, color_temperature_maximum_mireds, options_mask, options_override)¶
Initialize the StepColorTemperature command
- Parameters:
device (
st.matter.Device) – the device to build this message tostep_mode (
st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum)step_size (
st.matter.data_types.Uint16)transition_time (
st.matter.data_types.Uint16)color_temperature_minimum_mireds (
st.matter.data_types.Uint16)color_temperature_maximum_mireds (
st.matter.data_types.Uint16)options_mask (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)options_override (
st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap)
- 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.ColorControl.types.ColorCapabilitiesBitmap¶
- HUE_SATURATION: number¶
1
- ENHANCED_HUE: number¶
2
- COLOR_LOOP: number¶
4
- XY: number¶
8
- COLOR_TEMPERATURE: number¶
16
- is_hue_saturation_set()¶
- Returns:
True if the value of HUE_SATURATION is non-zero
- Return type:
boolean
- set_hue_saturation()¶
Set the value of the bit in the HUE_SATURATION field to 1
- unset_hue_saturation()¶
Set the value of the bits in the HUE_SATURATION field to 0
- is_enhanced_hue_set()¶
- Returns:
True if the value of ENHANCED_HUE is non-zero
- Return type:
boolean
- set_enhanced_hue()¶
Set the value of the bit in the ENHANCED_HUE field to 1
- unset_enhanced_hue()¶
Set the value of the bits in the ENHANCED_HUE field to 0
- is_color_loop_set()¶
- Returns:
True if the value of COLOR_LOOP is non-zero
- Return type:
boolean
- set_color_loop()¶
Set the value of the bit in the COLOR_LOOP field to 1
- unset_color_loop()¶
Set the value of the bits in the COLOR_LOOP field to 0
- is_xy_set()¶
- Returns:
True if the value of XY is non-zero
- Return type:
boolean
- set_xy()¶
Set the value of the bit in the XY field to 1
- unset_xy()¶
Set the value of the bits in the XY field to 0
- is_color_temperature_set()¶
- Returns:
True if the value of COLOR_TEMPERATURE is non-zero
- Return type:
boolean
- set_color_temperature()¶
Set the value of the bit in the COLOR_TEMPERATURE field to 1
- unset_color_temperature()¶
Set the value of the bits in the COLOR_TEMPERATURE field to 0
- class st.matter.generated.zap_clusters.ColorControl.types.Feature¶
- HUE_AND_SATURATION: number¶
1
- ENHANCED_HUE: number¶
2
- COLOR_LOOP: number¶
4
- XY: number¶
8
- COLOR_TEMPERATURE: number¶
16
- is_hue_and_saturation_set()¶
- Returns:
True if the value of HUE_AND_SATURATION is non-zero
- Return type:
boolean
- set_hue_and_saturation()¶
Set the value of the bit in the HUE_AND_SATURATION field to 1
- unset_hue_and_saturation()¶
Set the value of the bits in the HUE_AND_SATURATION field to 0
- is_enhanced_hue_set()¶
- Returns:
True if the value of ENHANCED_HUE is non-zero
- Return type:
boolean
- set_enhanced_hue()¶
Set the value of the bit in the ENHANCED_HUE field to 1
- unset_enhanced_hue()¶
Set the value of the bits in the ENHANCED_HUE field to 0
- is_color_loop_set()¶
- Returns:
True if the value of COLOR_LOOP is non-zero
- Return type:
boolean
- set_color_loop()¶
Set the value of the bit in the COLOR_LOOP field to 1
- unset_color_loop()¶
Set the value of the bits in the COLOR_LOOP field to 0
- is_xy_set()¶
- Returns:
True if the value of XY is non-zero
- Return type:
boolean
- set_xy()¶
Set the value of the bit in the XY field to 1
- unset_xy()¶
Set the value of the bits in the XY field to 0
- is_color_temperature_set()¶
- Returns:
True if the value of COLOR_TEMPERATURE is non-zero
- Return type:
boolean
- set_color_temperature()¶
Set the value of the bit in the COLOR_TEMPERATURE field to 1
- unset_color_temperature()¶
Set the value of the bits in the COLOR_TEMPERATURE field to 0
- class st.matter.generated.zap_clusters.ColorControl.types.OptionsBitmap¶
- EXECUTE_IF_OFF: number¶
1
- is_execute_if_off_set()¶
- Returns:
True if the value of EXECUTE_IF_OFF is non-zero
- Return type:
boolean
- set_execute_if_off()¶
Set the value of the bit in the EXECUTE_IF_OFF field to 1
- unset_execute_if_off()¶
Set the value of the bits in the EXECUTE_IF_OFF field to 0
- class st.matter.generated.zap_clusters.ColorControl.types.UpdateFlagsBitmap¶
- UPDATE_ACTION: number¶
1
- UPDATE_DIRECTION: number¶
2
- UPDATE_TIME: number¶
4
- UPDATE_START_HUE: number¶
8
- is_update_action_set()¶
- Returns:
True if the value of UPDATE_ACTION is non-zero
- Return type:
boolean
- set_update_action()¶
Set the value of the bit in the UPDATE_ACTION field to 1
- unset_update_action()¶
Set the value of the bits in the UPDATE_ACTION field to 0
- is_update_direction_set()¶
- Returns:
True if the value of UPDATE_DIRECTION is non-zero
- Return type:
boolean
- set_update_direction()¶
Set the value of the bit in the UPDATE_DIRECTION field to 1
- unset_update_direction()¶
Set the value of the bits in the UPDATE_DIRECTION field to 0
- is_update_time_set()¶
- Returns:
True if the value of UPDATE_TIME is non-zero
- Return type:
boolean
- set_update_time()¶
Set the value of the bit in the UPDATE_TIME field to 1
- unset_update_time()¶
Set the value of the bits in the UPDATE_TIME field to 0
- is_update_start_hue_set()¶
- Returns:
True if the value of UPDATE_START_HUE is non-zero
- Return type:
boolean
- set_update_start_hue()¶
Set the value of the bit in the UPDATE_START_HUE field to 1
- unset_update_start_hue()¶
Set the value of the bits in the UPDATE_START_HUE field to 0
Enum types¶
- class st.matter.generated.zap_clusters.ColorControl.types.ColorLoopActionEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- DEACTIVATE: number¶
0
- ACTIVATE_FROM_COLOR_LOOP_START_ENHANCED_HUE: number¶
1
- ACTIVATE_FROM_ENHANCED_CURRENT_HUE: number¶
2
- class st.matter.generated.zap_clusters.ColorControl.types.ColorLoopDirectionEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- DECREMENT: number¶
0
- INCREMENT: number¶
1
- class st.matter.generated.zap_clusters.ColorControl.types.ColorModeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- CURRENT_HUE_AND_CURRENT_SATURATION: number¶
0
- CURRENTX_AND_CURRENTY: number¶
1
- COLOR_TEMPERATURE_MIREDS: number¶
2
- class st.matter.generated.zap_clusters.ColorControl.types.DirectionEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- SHORTEST: number¶
0
- LONGEST: number¶
1
- UP: number¶
2
- DOWN: number¶
3
- class st.matter.generated.zap_clusters.ColorControl.types.DriftCompensationEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- NONE: number¶
0
- OTHER_OR_UNKNOWN: number¶
1
- TEMPERATURE_MONITORING: number¶
2
- OPTICAL_LUMINANCE_MONITORING_AND_FEEDBACK: number¶
3
- OPTICAL_COLOR_MONITORING_AND_FEEDBACK: number¶
4
- class st.matter.generated.zap_clusters.ColorControl.types.EnhancedColorModeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- CURRENT_HUE_AND_CURRENT_SATURATION: number¶
0
- CURRENTX_AND_CURRENTY: number¶
1
- COLOR_TEMPERATURE_MIREDS: number¶
2
- ENHANCED_CURRENT_HUE_AND_CURRENT_SATURATION: number¶
3
- class st.matter.generated.zap_clusters.ColorControl.types.MoveModeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- STOP: number¶
0
- UP: number¶
1
- DOWN: number¶
3
- class st.matter.generated.zap_clusters.ColorControl.types.StepModeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- UP: number¶
1
- DOWN: number¶
3