groundsdk 7.7.2 API/com.parrot.drone.groundsdk.device.peripheral/WifiScanner

WifiScanner

interface WifiScanner : Peripheral

WIFI network scanner peripheral interface for drones.

Allowsscanning the device's WIFI environment and retrieve information such as:

  • current occupation of WIFI channels

This peripheral can be obtained from a drone using: drone.getPeripheral(WifiStation::class.java)

See also

Drone.getPeripheral

Properties

Link copied to clipboard
@get:JvmName(name = "isScanning")
abstract val scanning: Boolean

Tells whether the component is currently scanning WIFI networks environment.

Link copied to clipboard
abstract val scanResults: List<ScanResult>

Latest scan results. Empty if no results were obtained yet or when scanning is not ongoing.

Functions

Link copied to clipboard
open fun getChannelOccupationRate(channel: Channel): Int

Computes the amount of WIFI networks that are currently using a given WIFI channel.

Link copied to clipboard
abstract fun startScan()

Requests the WIFI environment scanning process to start.

Link copied to clipboard
abstract fun stopScan()

Requests an ongoing scan operation to stop.