BasicInformationTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface BasicInformationTrait.Attributes : ClusterStruct
BasicInformation |
API for the BasicInformation trait. |
Attributes for the BasicInformation cluster.
Summary
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
List<UInt> |
A list of client-generated commands which are supported by this cluster server instance. |
List<UInt> |
A list of the attribute IDs of the attributes supported by the cluster instance. |
BasicInformationTrait.CapabilityMinimaStruct? |
The minimum guaranteed value for some system-wide resource capabilities that are not otherwise cluster-specific and do not appear elsewhere. |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
UInt? |
|
UShort? |
The revision number of the data model against which the node is certified. |
BasicInformationTrait.Feature |
Whether the server supports zero or more optional cluster features. |
List<UInt> |
A list of server-generated commands (server to client) which are supported by this cluster server instance. |
UShort? |
The version number of the hardware of the node. |
String? |
The human-readable version number of the hardware of the node. |
Boolean? |
If set to |
String? |
The ISO 3166-1 alpha-2 code representing the country, dependent territory, or special area of geographic interest in which the node is located at the time of the attribute being set. |
String? |
The date that the node was manufactured. |
UShort? |
The maximum paths per invoke. |
String? |
The user defined name for the node. |
String? |
The human-readable (displayable) vendor assigned part number for the node whose meaning and numbering scheme is vendor defined. |
BasicInformationTrait.ProductAppearanceStruct? |
The information about the appearance of the product. |
UShort? |
The Product ID assigned by the vendor that is unique to the specific product of the Node. |
String? |
The vendor specific human-readable (displayable) product label. |
String? |
A human-readable (displayable) name of the model for the node such as the model number (or other identifier) assigned by the vendor. |
String? |
The link to a product specific web page. |
Boolean? |
Indicates whether the node can be reached. |
String? |
The human-readable (displayable) serial number. |
UInt? |
The current version number for the software running on the node. |
String? |
The current human-readable representation for the software running on the node. |
UInt? |
The specification version. |
String? |
The unique identifier for the device, which is constructed in a manufacturer specific manner. |
UShort? |
The Vendor ID. |
String? |
A human-readable (displayable) name of the vendor for the node. |
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
acceptedCommandList
val acceptedCommandList: List<UInt>
A list of client-generated commands which are supported by this cluster server instance.
attributeList
val attributeList: List<UInt>
A list of the attribute IDs of the attributes supported by the cluster instance.
capabilityMinima
val capabilityMinima: BasicInformationTrait.CapabilityMinimaStruct?
The minimum guaranteed value for some system-wide resource capabilities that are not otherwise cluster-specific and do not appear elsewhere.
Access type: Read
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
dataModelRevision
val dataModelRevision: UShort?
The revision number of the data model against which the node is certified.
Access type: Read
featureMap
val featureMap: BasicInformationTrait.Feature
Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).
generatedCommandList
val generatedCommandList: List<UInt>
A list of server-generated commands (server to client) which are supported by this cluster server instance.
hardwareVersion
val hardwareVersion: UShort?
The version number of the hardware of the node.
Access type: Read
hardwareVersionString
val hardwareVersionString: String?
The human-readable version number of the hardware of the node.
Access type: Read
localConfigDisabled
val localConfigDisabled: Boolean?
If set to true, allow a local node configuration to be disabled.
Access type: Write
location
val location: String?
The ISO 3166-1 alpha-2 code representing the country, dependent territory, or special area of geographic interest in which the node is located at the time of the attribute being set.
Access type: Write
manufacturingDate
val manufacturingDate: String?
The date that the node was manufactured.
Access type: Read
partNumber
val partNumber: String?
The human-readable (displayable) vendor assigned part number for the node whose meaning and numbering scheme is vendor defined.
Access type: Read
productAppearance
val productAppearance: BasicInformationTrait.ProductAppearanceStruct?
The information about the appearance of the product.
Access type: Read
productId
val productId: UShort?
The Product ID assigned by the vendor that is unique to the specific product of the Node.
Access type: Read
productLabel
val productLabel: String?
The vendor specific human-readable (displayable) product label.
Access type: Read
productName
val productName: String?
A human-readable (displayable) name of the model for the node such as the model number (or other identifier) assigned by the vendor.
Access type: Read
serialNumber
val serialNumber: String?
The human-readable (displayable) serial number.
Access type: Read
softwareVersion
val softwareVersion: UInt?
The current version number for the software running on the node.
Access type: Read
softwareVersionString
val softwareVersionString: String?
The current human-readable representation for the software running on the node.
Access type: Read
uniqueId
val uniqueId: String?
The unique identifier for the device, which is constructed in a manufacturer specific manner.
Access type: Read
vendorName
val vendorName: String?
A human-readable (displayable) name of the vendor for the node.
Access type: Read