Interface WifiHandle

Wifi操控句柄

Description

通过 Wifi.open() 开启设备，以获得句柄对象，用于操控 Wifi。 WifiHandle 继承 IEventSource，可用on/off/once方法监听消息事件。

Hierarchy

Properties

active apConfig apMac staConfig staIp staMac staStarted staStatus

Methods

config connect disconnect emit off on once scan start stop

Properties

active

active: boolean

此句柄对象是否有效?

Description

如果用Wifi.close()关闭了Wifi设备，而之前打开时返回的句柄对象仍被引用，则此对象的active属性将变为false。 false 表示句柄对象虽然还在，但是其对应Wifi设备已经被关闭过了。 失效的句柄，不能用来对Wifi进行操控，会抛出异常。

Readonly apConfig

apConfig: null | {
    authMethod: null | AuthMethodType;
    ssid: string;
}

AP模式配置。null表示未启用AP模式。

Readonly apMac

apMac: string

AP模式的MAC地址

Readonly staConfig

staConfig: null | {
    authMethod: null | AuthMethodType;
    ssid: string;
}

STA模式配置。null表示未启用STA模式。

Readonly staIp

staIp: null | IpInfo

STA模式下获取的IP地址信息

Readonly staMac

staMac: string

STA模式的MAC地址

Readonly staStarted

staStarted: boolean

Readonly staStatus

staStatus: WifiStatus

STA模式状态

Methods

config

  • 配置WIFI工作模式

    Parameters

    • sta: null | {
          authMethod?: null | AuthMethodType;
          password: string;
          ssid: string;
      }

      配置STA模式。null表示不启用STA模式

    • ap: null | {
          authMethod?: null | AuthMethodType;
          password?: string;
          ssid: string;
      }

      配置AP模式。null表示不启用AP模式

    Returns WifiHandle

connect

disconnect

emit

  • 触发事件

    Type Parameters

    • T extends "state-change" | "ip-assigned"

    Parameters

    • type: T

      事件类型

    • Rest ...args: {
          ip-assigned: [null | string];
          state-change: [WifiStatus];
      }[T]

      事件参数

    Returns WifiHandle

off

  • 取消监听

    Type Parameters

    • T extends "state-change" | "ip-assigned"

    Parameters

    • type: T
    • handler: ((...args: {
          ip-assigned: [null | string];
          state-change: [WifiStatus];
      }[T]) => void)
        • (...args: {
              ip-assigned: [null | string];
              state-change: [WifiStatus];
          }[T]): void

        • Parameters

          • Rest ...args: {
                ip-assigned: [null | string];
                state-change: [WifiStatus];
            }[T]

          Returns void

    Returns WifiHandle

on

  • 添加监听

    Type Parameters

    • T extends "state-change" | "ip-assigned"

    Parameters

    • type: T

      Event type

    • handler: ((...args: {
          ip-assigned: [null | string];
          state-change: [WifiStatus];
      }[T]) => void)

      A callback function to process the incomming event

        • (...args: {
              ip-assigned: [null | string];
              state-change: [WifiStatus];
          }[T]): void

        • Parameters

          • Rest ...args: {
                ip-assigned: [null | string];
                state-change: [WifiStatus];
            }[T]

          Returns void

    Returns WifiHandle

once

  • 添加一次性监听

    Type Parameters

    • T extends "state-change" | "ip-assigned"

    Parameters

    • type: T

      Event type

    • handler: ((...args: {
          ip-assigned: [null | string];
          state-change: [WifiStatus];
      }[T]) => void)

      A callback function to process the incomming event

        • (...args: {
              ip-assigned: [null | string];
              state-change: [WifiStatus];
          }[T]): void

        • Parameters

          • Rest ...args: {
                ip-assigned: [null | string];
                state-change: [WifiStatus];
            }[T]

          Returns void

    Returns WifiHandle

scan

  • 扫描AP

    Returns Promise<ApInfo[]>

start

stop

Settings

Member Visibility

Theme