Console

NetworkControlTrait 

struct NetworkControlTrait

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

  • List of the event types that are supported by NetworkControlTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by NetworkControlTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the NetworkControlTrait.

    Declaration

    Swift

    let attributes: Google.NetworkControlTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the NetworkControlTrait.

    Declaration

    Swift

    struct Attributes

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Google.NetworkControlTrait, rhs: Google.NetworkControlTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • Settings of the main network.

    Declaration

    Swift

    struct NetworkSettings

  • The state of one of the network profiles.

    Declaration

    Swift

    struct NetworkProfileState

  • The results of the most recent network-upload speed test.

    Declaration

    Swift

    struct LastNetworkUploadSpeedTest

  • Settings of the guest network.

    Declaration

    Swift

    struct GuestNetworkSettings

  • Results of the most recent network-download speed test.

    Declaration

    Swift

    struct LastNetworkDownloadSpeedTest

  • The follow-up event for the TestNetworkSpeed command.

    Declaration

    Swift

    struct TestNetworkSpeedFollowUpEvent

  • Whether the device supports the enableDisableGuestNetwork command for this trait.

    Declaration

    Swift

    var supportsEnableDisableGuestNetworkCommand: Bool { get }

  • Enables or disables the guest network. Secondary user verification with a PIN must be used. A user’s home security can be affected if other security devices are disabled as a result of running this command.

    Declaration

    Swift

    func enableDisableGuestNetwork(enable: Bool) async throws

    Parameters

    enable

    A value of true enables the guest network, false disables the guest network.

  • The batchable version of enableDisableGuestNetwork command above.

    See also

    enableDisableGuestNetwork

    Declaration

    Swift

    func enableDisableGuestNetworkBatchable(enable: Bool) throws -> BatchableCommand<Void>

  • Whether the device supports the enableDisableNetworkProfile command for this trait.

    Declaration

    Swift

    var supportsEnableDisableNetworkProfileCommand: Bool { get }

  • Enables or disables a network profile. Secondary user verification with a PIN must be used. A user’s home security can be affected if other security devices are disabled as a result of running this command.

    Declaration

    Swift

    func enableDisableNetworkProfile(enable: Bool, networkProfileName: String) async throws

    Parameters

    enable

    A value of true enables the profile, false disables the profile.
    networkProfileName

    The profile name from the list of available profiles.

  • The batchable version of enableDisableNetworkProfile command above.

    See also

    enableDisableNetworkProfile

    Declaration

    Swift

    func enableDisableNetworkProfileBatchable(enable: Bool, networkProfileName: String) throws -> BatchableCommand<Void>

  • Whether the device supports the getGuestNetworkPassword command for this trait.

    Declaration

    Swift

    var supportsGetGuestNetworkPasswordCommand: Bool { get }

  • Gets the password of the guest network.

    Declaration

    Swift

    func getGuestNetworkPassword() async throws -> Google.NetworkControlTrait.GetGuestNetworkPasswordCommandResponse

  • The batchable version of getGuestNetworkPassword command above.

    See also

    getGuestNetworkPassword

    Declaration

    Swift

    func getGuestNetworkPasswordBatchable() throws -> BatchableCommand<Google.NetworkControlTrait.GetGuestNetworkPasswordCommandResponse>

  • Whether the device supports the testNetworkSpeed command for this trait.

    Declaration

    Swift

    var supportsTestNetworkSpeedCommand: Bool { get }

  • Tests the network’s download and upload speed.

    Declaration

    Swift

    func testNetworkSpeed(testUploadSpeed: Bool, testDownloadSpeed: Bool) async throws

    Parameters

    testUploadSpeed

    Whether the upload speed should be tested.
    testDownloadSpeed

    Whether the download speed should be tested.

  • The batchable version of testNetworkSpeed command above.

    See also

    testNetworkSpeed

    Declaration

    Swift

    func testNetworkSpeedBatchable(testUploadSpeed: Bool, testDownloadSpeed: Bool) throws -> BatchableCommand<Void>

  • Whether the most recent network-download speed test succeeded or failed.

    Declaration

    Swift

    enum SpeedTestStatus

  • NetworkControl trait FeatureMap.

    Declaration

    Swift

    struct NetworkControlFeature