Interface Netif

ReadonlyapiModuleName

Readonlydevice

getScanInfo

• getScanInfo(
      refresh?: boolean,
      timeoutInSeconds?: number,
      sendOptions?: SendOptions,
  ): Promise<unknown>

  Requests netif.get_scaninfo (list of WiFi networks).

  Note that timeoutInSeconds is sent in the request and is not the actual network timeout. The network timeout for the request is calculated by adding the default network timeout to timeoutInSeconds.

  Parameters

  • refresh: boolean = false

    request device's cached results

  • timeoutInSeconds: number = 10

    timeout for scan in seconds

  • OptionalsendOptions: SendOptions

    additional options for the request

  Returns Promise<unknown>

  parsed JSON response

  Throws

  ResponseError