ThreadNetworkManagementCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ThreadNetworkManagementCommands

Known direct subclasses

ThreadNetworkManagement

ThreadNetworkManagement

API for the ThreadNetworkManagement trait.

Commands for the ThreadNetworkManagement trait.

Summary

Public functions
`suspend ThreadNetworkManagementTrait.ActivateEpskcModeCommand.Response`	`activateEpskcMode(optionalArgs: ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs.() -> Unit)` Request to activate ePSKc mode for Thread credential sharing.
`BatchableCommand<ThreadNetworkManagementTrait.ActivateEpskcModeCommand.Response>`	`activateEpskcModeBatchable(optionalArgs: ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs.() -> Unit)` The batchable version of `activateEpskcMode` command.
`suspend Unit`	`deactivateEpskcMode()` Request to immediately deactivate ePSKc mode.
`BatchableCommand<Unit>`	`deactivateEpskcModeBatchable()` The batchable version of `deactivateEpskcMode` command.
`suspend ThreadNetworkManagementTrait.JoinNetworkCommand.Response`	`joinNetwork(operationalDatasetTlvs: ByteArray)` Request to join a Thread network using the provided operational dataset.
`BatchableCommand<ThreadNetworkManagementTrait.JoinNetworkCommand.Response>`	`joinNetworkBatchable(operationalDatasetTlvs: ByteArray)` The batchable version of `joinNetwork` command.
`suspend Unit`	`leaveNetwork()` Request to leave the current Thread network and factory reset the Thread stack.
`BatchableCommand<Unit>`	`leaveNetworkBatchable()` The batchable version of `leaveNetwork` command.

Public functions

activateEpskcMode

suspend fun activateEpskcMode(optionalArgs: ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs.() -> Unit = {}): ThreadNetworkManagementTrait.ActivateEpskcModeCommand.Response

Request to activate ePSKc mode for Thread credential sharing.

Parameters
`optionalArgs: ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`ThreadNetworkManagementTrait.ActivateEpskcModeCommand.Response`	The response from the `ActivateEpskcMode` command, containing the generated ephemeral key and the actual duration for which it is valid.

activateEpskcModeBatchable

fun activateEpskcModeBatchable(optionalArgs: ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<ThreadNetworkManagementTrait.ActivateEpskcModeCommand.Response>

The batchable version of activateEpskcMode command.

Request to activate ePSKc mode for Thread credential sharing.

Parameters
`optionalArgs: ThreadNetworkManagementTrait.ActivateEpskcModeCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<ThreadNetworkManagementTrait.ActivateEpskcModeCommand.Response>`	BatchableCommand

deactivateEpskcMode

suspend fun deactivateEpskcMode(): Unit

Request to immediately deactivate ePSKc mode.

deactivateEpskcModeBatchable

fun deactivateEpskcModeBatchable(): BatchableCommand<Unit>

The batchable version of deactivateEpskcMode command.

Request to immediately deactivate ePSKc mode.

Returns
`BatchableCommand<Unit>`	BatchableCommand

joinNetwork

suspend fun joinNetwork(operationalDatasetTlvs: ByteArray): ThreadNetworkManagementTrait.JoinNetworkCommand.Response

Request to join a Thread network using the provided operational dataset. If the border router device is already part of a network, this command will cause it to attempt to migrate to the network together with all Thread devices attached to it.

Parameters
`operationalDatasetTlvs: ByteArray`	The Thread operational dataset of the network to join, in TLV format.

Returns
`ThreadNetworkManagementTrait.JoinNetworkCommand.Response`	The response from the `JoinNetwork` command, containing the status of the command.

joinNetworkBatchable

fun joinNetworkBatchable(operationalDatasetTlvs: ByteArray): BatchableCommand<ThreadNetworkManagementTrait.JoinNetworkCommand.Response>

The batchable version of joinNetwork command.

Parameters
`operationalDatasetTlvs: ByteArray`	The Thread operational dataset of the network to join, in TLV format.

Returns
`BatchableCommand<ThreadNetworkManagementTrait.JoinNetworkCommand.Response>`	BatchableCommand

leaveNetwork

suspend fun leaveNetwork(): Unit

Request to leave the current Thread network and factory reset the Thread stack.

leaveNetworkBatchable

fun leaveNetworkBatchable(): BatchableCommand<Unit>

The batchable version of leaveNetwork command.

Request to leave the current Thread network and factory reset the Thread stack.

Returns
`BatchableCommand<Unit>`	BatchableCommand