# NetworkControlTrait

    struct NetworkControlTrait

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


  ### [supportedEventTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV014supportedEventC0Say0aB3SDK0H0_pXpGvpZ)


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

  #### Declaration

  Swift

      static let supportedEventTypes: [any Event.Type]

- `


  ### [supportedCommandTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV016supportedCommandC0Say0aB3SDK0H0_pXpGvpZ)


  ` List of the commands that are supported by `NetworkControlTrait`.

  #### Declaration

  Swift

      static let supportedCommandTypes: [any Command.Type]

- `


  ### [identifier](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV10identifierSSvpZ)


  ` The trait identifier.

  #### Declaration

  Swift

      static let identifier: String

- `


  ### [metadata](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV8metadata0aB3SDK0F8MetadataVvp)


  ` Metadata about this `Trait`.

  #### Declaration

  Swift

      let metadata: TraitMetadata

- `


  ### [attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV10attributesAE10AttributesVvp)


  ` List of attributes for the `NetworkControlTrait`.

  #### Declaration

  Swift

      let attributes: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.NetworkControlTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/Attributes.html

- `


  ### [init(decoder:interactionProxy:metadata:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV7decoder16interactionProxy8metadataAE0aB3SDK0F7DecoderV_AI011InteractionI0_pSgAI0F8MetadataVtKcfc)


  ` 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. |

- `


  ### [encode(with:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV6encode4withy0aB3SDK0F7EncoderC_tKF)


  ` 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

- `


  ### [forceRead()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV9forceReadyyYaKF)


  ` 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 `HomeError`s thrown by this call.

  #### Declaration

  Swift

      func forceRead() async throws

- `


  ### [Attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/Attributes.html)


  ` Attributes for the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait.html`.

  #### Declaration

  Swift

      struct Attributes

- `


  ### [==(_:_:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV2eeoiySbAE_AEtFZ)


  ` 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: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.NetworkControlTrait, rhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.NetworkControlTrait) -> Bool

  #### Parameters

  |---|---|
  | ` lhs ` | A value to compare. |
  | ` rhs ` | Another value to compare. |

- `


  ### [hash(into:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV4hash4intoys6HasherVz_tF)


  ` 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)

- `


  ### [NetworkSettings](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/NetworkSettings.html)


  ` Settings of the main network.

  #### Declaration

  Swift

      struct NetworkSettings

- `


  ### [NetworkProfileState](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/NetworkProfileState.html)


  ` The state of one of the network profiles.

  #### Declaration

  Swift

      struct NetworkProfileState

- `


  ### [LastNetworkUploadSpeedTest](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/LastNetworkUploadSpeedTest.html)


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

  #### Declaration

  Swift

      struct LastNetworkUploadSpeedTest

- `


  ### [GuestNetworkSettings](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/GuestNetworkSettings.html)


  ` Settings of the guest network.

  #### Declaration

  Swift

      struct GuestNetworkSettings

- `


  ### [LastNetworkDownloadSpeedTest](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/LastNetworkDownloadSpeedTest.html)


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

  #### Declaration

  Swift

      struct LastNetworkDownloadSpeedTest

- `


  ### [TestNetworkSpeedFollowUpEvent](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/TestNetworkSpeedFollowUpEvent.html)


  ` The follow-up event for the `TestNetworkSpeed` command.

  #### Declaration

  Swift

      struct TestNetworkSpeedFollowUpEvent

- `


  ### [supportsEnableDisableGuestNetworkCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV026supportsEnableDisableGuestD7CommandSbvp)


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

  #### Declaration

  Swift

      var supportsEnableDisableGuestNetworkCommand: Bool { get }

- `


  ### [enableDisableGuestNetwork(enable:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV018enableDisableGuestD00G0ySb_tYaKF)


  ` 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. |

- `


  ### [enableDisableGuestNetworkBatchable(enable:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV018enableDisableGuestD9Batchable0G00aB3SDK0J7CommandVyytGSb_tKF)


  ` The batchable version of enableDisableGuestNetwork command above.
  See also
  enableDisableGuestNetwork

  #### Declaration

  Swift

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

- `


  ### [supportsEnableDisableNetworkProfileCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV021supportsEnableDisableD14ProfileCommandSbvp)


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

  #### Declaration

  Swift

      var supportsEnableDisableNetworkProfileCommand: Bool { get }

- `


  ### [enableDisableNetworkProfile(enable:networkProfileName:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV013enableDisableD7Profile0G007networkI4NameySb_SStYaKF)


  ` 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. |

- `


  ### [enableDisableNetworkProfileBatchable(enable:networkProfileName:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV013enableDisableD16ProfileBatchable0G007networkI4Name0aB3SDK0J7CommandVyytGSb_SStKF)


  ` The batchable version of enableDisableNetworkProfile command above.
  See also
  enableDisableNetworkProfile

  #### Declaration

  Swift

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

- `


  ### [supportsGetGuestNetworkPasswordCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV016supportsGetGuestD15PasswordCommandSbvp)


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

  #### Declaration

  Swift

      var supportsGetGuestNetworkPasswordCommand: Bool { get }

- `


  ### [getGuestNetworkPassword()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV08getGuestD8PasswordAE03GethdI7CommandV8ResponseVyYaKF)


  ` Gets the password of the guest network.

  #### Declaration

  Swift

      func getGuestNetworkPassword() async throws -> https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.NetworkControlTrait.GetGuestNetworkPasswordCommandResponse

- `


  ### [getGuestNetworkPasswordBatchable()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV08getGuestD17PasswordBatchable0aB3SDK0J7CommandVyAE03GethdiL0V8ResponseVGyKF)


  ` The batchable version of getGuestNetworkPassword command above.
  See also
  getGuestNetworkPassword

  #### Declaration

  Swift

      func getGuestNetworkPasswordBatchable() throws -> BatchableCommand<https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.NetworkControlTrait.GetGuestNetworkPasswordCommandResponse>

- `


  ### [supportsTestNetworkSpeedCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV012supportsTestD12SpeedCommandSbvp)


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

  #### Declaration

  Swift

      var supportsTestNetworkSpeedCommand: Bool { get }

- `


  ### [testNetworkSpeed(testUploadSpeed:testDownloadSpeed:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV04testD5Speed0g6UploadH00g8DownloadH0ySb_SbtYaKF)


  ` 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. |

- `


  ### [testNetworkSpeedBatchable(testUploadSpeed:testDownloadSpeed:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait#/s:15GoogleHomeTypes0A0O19NetworkControlTraitV04testD14SpeedBatchable0g6UploadH00g8DownloadH00aB3SDK0I7CommandVyytGSb_SbtKF)


  ` The batchable version of testNetworkSpeed command above.
  See also
  testNetworkSpeed

  #### Declaration

  Swift

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

- `


  ### [SpeedTestStatus](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/SpeedTestStatus.html)


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

  #### Declaration

  Swift

      enum SpeedTestStatus

- `


  ### [NetworkControlFeature](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/NetworkControlTrait/NetworkControlFeature.html)


  ` NetworkControl trait FeatureMap.

  #### Declaration

  Swift

      struct NetworkControlFeature