WifiAccessPoint

public protocol WifiAccessPoint : Peripheral

Wifi access point peripheral interface for drones.

Allows to configure various parameters of the device’s Wifi access point, such as:

  • Environment (indoor/outdoor) setup
  • Country
  • Channel
  • SSID
  • Security

This peripheral can be retrieved by:

drone.getPeripheral(Peripherals.wifiAccessPoint)
  • Access point activation setting.

    Note

    Activating the access point may deactivate other components, such as the WifiStation component.

    Declaration

    Swift

    var active: BoolSetting { get }
  • Access point indoor/outdoor environment setting.

    Note

    Altering this setting may change the set of available channels, and even result in a device disconnection since the channel currently in use might not be allowed with the new environment setup.

    Declaration

    Swift

    var environment: EnvironmentSetting { get }
  • Access point country setting.

    Note

    Altering this setting may change the set of available channels, and even result in a device disconnection since the channel currently in use might not be allowed with the new country setup.

    Declaration

    Swift

    var country: EnumSetting<Country> { get }
  • Legacy access point country setting.

    The country can only be configured to one of the availableCountries. The country is a two-letter string, as ISO 3166-1-alpha-2 code.

    Note

    Altering this setting may change the set of available channels, and even result in a device disconnection since the channel currently in use might not be allowed with the new country setup.

    Declaration

    Swift

    @available(*, deprecated, message: "Use `country` instead")
    var isoCountryCode: StringSetting { get }
  • true if a country has been automatically selected by the drone AND can be modified, false otherwise.

    Declaration

    Swift

    @available(*, deprecated, message: "Do not use; will be retired in next release")
    var defaultCountryUsed: Bool { get }
  • Set of countries to which the access point may be configured.

    Declaration

    Swift

    @available(*, deprecated, message: "Use `country` instead")
    var availableCountries: Set<String> { get }
  • Access point channel setting.

    Note

    Changing the channel (either manually or through auto-selection) may result in a device disconnection.

    Declaration

    Swift

    var channel: ChannelSetting { get }
  • Access point Service Set IDentifier (SSID) setting.

    Declaration

    Swift

    var ssid: StringSetting { get }
  • Access point SSID broadcast (hidden network) setting.

    Declaration

    Swift

    var ssidBroadcast: BoolSetting { get }
  • Access point security setting.

    Note

    The device needs to be rebooted for the access point security to effectively change.

    Declaration

    Swift

    var security: SecurityModeSetting { get }