NetworkControlTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface NetworkControlTrait.Attributes : ClusterStruct
NetworkControl |
API for the NetworkControl trait. |
Attributes for the NetworkControl 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. |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
NetworkControlTrait.NetworkControlFeature |
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. |
Boolean? |
Whether the guest network is enabled. |
NetworkControlTrait.GuestNetworkSettings? |
Contains the SSID of the guest network. |
NetworkControlTrait.LastNetworkDownloadSpeedTest? |
Results of the most recent network-download speed test. |
NetworkControlTrait.LastNetworkUploadSpeedTest? |
Results of the most recent network-upload speed test. |
Boolean? |
Whether the main network is enabled. |
List<NetworkControlTrait.NetworkProfileState>? |
States for the network profiles. |
List<String>? |
The supported network profile names. |
NetworkControlTrait.NetworkSettings? |
Contains the SSID of the main network. |
Boolean? |
Whether a network-speed test is currently being run. |
Float? |
The network usage limit for the current billing period. |
Float? |
The network usage in megabytes for the current billing period. |
Boolean? |
Whether the network usage is unlimited. |
UInt? |
Number of devices connected to the network. |
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.
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
featureMap
val featureMap: NetworkControlTrait.NetworkControlFeature
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.
guestNetworkEnabled
val guestNetworkEnabled: Boolean?
Whether the guest network is enabled.
Access type: Read
guestNetworkSettings
val guestNetworkSettings: NetworkControlTrait.GuestNetworkSettings?
Contains the SSID of the guest network.
Access type: Read
lastNetworkDownloadSpeedTest
val lastNetworkDownloadSpeedTest: NetworkControlTrait.LastNetworkDownloadSpeedTest?
Results of the most recent network-download speed test.
Access type: Read
lastNetworkUploadSpeedTest
val lastNetworkUploadSpeedTest: NetworkControlTrait.LastNetworkUploadSpeedTest?
Results of the most recent network-upload speed test.
Access type: Read
networkProfileStates
val networkProfileStates: List<NetworkControlTrait.NetworkProfileState>?
States for the network profiles.
Access type: Read
networkProfiles
val networkProfiles: List<String>?
The supported network profile names.
Access type: Read
networkSettings
val networkSettings: NetworkControlTrait.NetworkSettings?
Contains the SSID of the main network.
Access type: Read
networkSpeedTestInProgress
val networkSpeedTestInProgress: Boolean?
Whether a network-speed test is currently being run.
Access type: Read
networkUsageLimitMb
val networkUsageLimitMb: Float?
The network usage limit for the current billing period.
Access type: Read
networkUsageMb
val networkUsageMb: Float?
The network usage in megabytes for the current billing period.
Access type: Read
networkUsageUnlimited
val networkUsageUnlimited: Boolean?
Whether the network usage is unlimited. If this attribute is true, the networkUsageLimitMB attribute is ignored.
Access type: Read
numConnectedDevices
val numConnectedDevices: UInt?
Number of devices connected to the network.
Access type: Read