NetworkControl

@Generated(value = ["GoogleHomePlatformCodegen"])
interface NetworkControl : NetworkControlTrait.Attributes, MatterTrait, NetworkControlCommands

API for the NetworkControl trait. This trait belongs to devices that can report network data and perform network-specific operations.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<NetworkControl>

Inherited functions
From com.google.home.google.NetworkControlCommands
suspend Unit

Enables or disables the guest network.
BatchableCommand<Unit>

The batchable version of enableDisableGuestNetwork command.
suspend Unit
enableDisableNetworkProfile(enable: Boolean, networkProfileName: String)

Enables or disables a network profile.
BatchableCommand<Unit>
enableDisableNetworkProfileBatchable(
    enable: Boolean,
    networkProfileName: String
)

The batchable version of enableDisableNetworkProfile command.
suspend NetworkControlTrait.GetGuestNetworkPasswordCommand.Response

Gets the password of the guest network.
BatchableCommand<NetworkControlTrait.GetGuestNetworkPasswordCommand.Response>

The batchable version of getGuestNetworkPassword command.
suspend Unit
testNetworkSpeed(testUploadSpeed: Boolean, testDownloadSpeed: Boolean)

Tests the network's download and upload speed.
BatchableCommand<Unit>
testNetworkSpeedBatchable(
    testUploadSpeed: Boolean,
    testDownloadSpeed: Boolean
)

The batchable version of testNetworkSpeed command.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.google.NetworkControlTrait.Attributes
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.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: NetworkControl.Attribute): Boolean

supports

fun supports(command: NetworkControl.Command): Boolean

Public properties

factory

open val factory: TraitFactory<NetworkControl>