BallastConfiguration
Attributes
- class st.matter.clusters.BallastConfiguration.PhysicalMinLevel
- ID: number
0x0000 the ID of this attribute
- NAME: str
“PhysicalMinLevel” 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 PhysicalMinLevel(…) 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: PhysicalMinLevel => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an PhysicalMinLevel 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.clusters.BallastConfiguration.PhysicalMaxLevel
- ID: number
0x0001 the ID of this attribute
- NAME: str
“PhysicalMaxLevel” 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 PhysicalMaxLevel(…) 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: PhysicalMaxLevel => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an PhysicalMaxLevel 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.clusters.BallastConfiguration.BallastStatus
- ID: number
0x0002 the ID of this attribute
- NAME: str
“BallastStatus” the name of this attribute
- data_type: st.matter.generated.zap_clusters.BallastConfiguration.types.BallastStatusBitmap
the data type of this attribute
- new_value(...)
Create a BallastStatusBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the BallastStatus(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a BallastStatusBitmap- Return type
st.matter.generated.zap_clusters.BallastConfiguration.types.BallastStatusBitmap
- 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: BallastStatus => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an BallastStatus 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.clusters.BallastConfiguration.MinLevel
- ID: number
0x0010 the ID of this attribute
- NAME: str
“MinLevel” 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 MinLevel(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint8- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- write(device, endpoint_id, value)
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –value (
st.matter.data_types.Uint8
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: MinLevel => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an MinLevel 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.clusters.BallastConfiguration.MaxLevel
- ID: number
0x0011 the ID of this attribute
- NAME: str
“MaxLevel” 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 MaxLevel(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint8- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- write(device, endpoint_id, value)
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –value (
st.matter.data_types.Uint8
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: MaxLevel => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an MaxLevel 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.clusters.BallastConfiguration.IntrinsicBallastFactor
- ID: number
0x0014 the ID of this attribute
- NAME: str
“IntrinsicBallastFactor” 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 IntrinsicBallastFactor(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint8- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- write(device, endpoint_id, value)
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –value (
st.matter.data_types.Uint8
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: IntrinsicBallastFactor => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an IntrinsicBallastFactor 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.clusters.BallastConfiguration.BallastFactorAdjustment
- ID: number
0x0015 the ID of this attribute
- NAME: str
“BallastFactorAdjustment” 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 BallastFactorAdjustment(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint8- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- write(device, endpoint_id, value)
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –value (
st.matter.data_types.Uint8
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: BallastFactorAdjustment => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an BallastFactorAdjustment 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.clusters.BallastConfiguration.LampQuantity
- ID: number
0x0020 the ID of this attribute
- NAME: str
“LampQuantity” 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 LampQuantity(…) 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: LampQuantity => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LampQuantity 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.clusters.BallastConfiguration.LampType
- ID: number
0x0030 the ID of this attribute
- NAME: str
“LampType” 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 LampType(…) 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
- 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.UTF8String1
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: LampType => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LampType 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.clusters.BallastConfiguration.LampManufacturer
- ID: number
0x0031 the ID of this attribute
- NAME: str
“LampManufacturer” 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 LampManufacturer(…) 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
- 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.UTF8String1
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: LampManufacturer => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LampManufacturer 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.clusters.BallastConfiguration.LampRatedHours
- ID: number
0x0032 the ID of this attribute
- NAME: str
“LampRatedHours” the name of this attribute
- data_type: st.matter.data_types.Uint32
the data type of this attribute
- new_value(...)
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the LampRatedHours(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint32- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- write(device, endpoint_id, value)
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –value (
st.matter.data_types.Uint32
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: LampRatedHours => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LampRatedHours 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.clusters.BallastConfiguration.LampBurnHours
- ID: number
0x0033 the ID of this attribute
- NAME: str
“LampBurnHours” the name of this attribute
- data_type: st.matter.data_types.Uint32
the data type of this attribute
- new_value(...)
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the LampBurnHours(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint32- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- write(device, endpoint_id, value)
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –value (
st.matter.data_types.Uint32
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: LampBurnHours => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LampBurnHours 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.clusters.BallastConfiguration.LampAlarmMode
- ID: number
0x0034 the ID of this attribute
- NAME: str
“LampAlarmMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.BallastConfiguration.types.LampAlarmModeBitmap
the data type of this attribute
- new_value(...)
Create a LampAlarmModeBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the LampAlarmMode(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a LampAlarmModeBitmap- Return type
st.matter.generated.zap_clusters.BallastConfiguration.types.LampAlarmModeBitmap
- 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.BallastConfiguration.types.LampAlarmModeBitmap
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: LampAlarmMode => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LampAlarmMode 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.clusters.BallastConfiguration.LampBurnHoursTripPoint
- ID: number
0x0035 the ID of this attribute
- NAME: str
“LampBurnHoursTripPoint” the name of this attribute
- data_type: st.matter.data_types.Uint32
the data type of this attribute
- new_value(...)
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the LampBurnHoursTripPoint(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint32- Return type
- read(device, endpoint_id)
Constructs an st.matter.interaction_model.InteractionRequest to read
this attribute from a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –
- Returns
containing an Interaction Request
- Return type
- write(device, endpoint_id, value)
Constructs an st.matter.interaction_model.InteractionRequest to write
this attribute to a device
- Parameters
device (
st.matter.Device
) –endpoint_id (
number or nil
) –value (
st.matter.data_types.Uint32
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: LampBurnHoursTripPoint => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an LampBurnHoursTripPoint 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.clusters.BallastConfiguration.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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
- set_parent_cluster(cluster)
- Parameters
cluster (
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.clusters.BallastConfiguration.EventList
- ID: number
0xFFFA the ID of this attribute
- NAME: str
“EventList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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 EventList(…) 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: EventList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an EventList 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.clusters.BallastConfiguration.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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
- set_parent_cluster(cluster)
- Parameters
cluster (
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
) –
Bitmap types
- class st.matter.clusters.BallastConfiguration.types.BallastStatusBitmap
- BALLAST_NON_OPERATIONAL: number
1
- LAMP_FAILURE: number
2
- is_ballast_non_operational_set()
- Returns
True if the value of BALLAST_NON_OPERATIONAL is non-zero
- Return type
boolean
- set_ballast_non_operational()
Set the value of the bit in the BALLAST_NON_OPERATIONAL field to 1
- unset_ballast_non_operational()
Set the value of the bits in the BALLAST_NON_OPERATIONAL field to 0
- is_lamp_failure_set()
- Returns
True if the value of LAMP_FAILURE is non-zero
- Return type
boolean
- set_lamp_failure()
Set the value of the bit in the LAMP_FAILURE field to 1
- unset_lamp_failure()
Set the value of the bits in the LAMP_FAILURE field to 0
- class st.matter.clusters.BallastConfiguration.types.LampAlarmModeBitmap
- LAMP_BURN_HOURS: number
1
- is_lamp_burn_hours_set()
- Returns
True if the value of LAMP_BURN_HOURS is non-zero
- Return type
boolean
- set_lamp_burn_hours()
Set the value of the bit in the LAMP_BURN_HOURS field to 1
- unset_lamp_burn_hours()
Set the value of the bits in the LAMP_BURN_HOURS field to 0