xt-sdk 文档 v1.0.3
xt-sdk 嵌入式 SDK API 参考
载入中...
搜索中...
未找到
xt_wifiscan(Wi-Fi 扫描)

XTINY Wi-Fi 扫描模块接口 更多...

结构体

struct  xt_wifiscan_cell_info_t
 Wi-Fi 扫描单元信息结构体 更多...
struct  xt_wifiscan_info_t
 Wi-Fi 扫描结果结构体 更多...

宏定义

#define XT_WIFISCAN_AP_NUM_MAX   20
#define XT_WIFISCAN_MAC_SIZE   6
#define XT_WIFISCAN_SSID_SIZE   32

类型定义

typedef void(* xt_wifiscan_cb_t) (xt_wifiscan_info_t *info)
 Wi-Fi 扫描完成回调函数类型

函数

xt_err_t xt_wifiscan_set_cb (xt_wifiscan_cb_t cb)
 设置 Wi-Fi 扫描完成回调
xt_err_t xt_wifiscan_start (uint32_t channel_mask, uint32_t scannum, uint32_t timeout_ms)
 启动 Wi-Fi 扫描
xt_err_t xt_wifiscan_stop (void)
 停止 Wi-Fi 扫描

详细描述

XTINY Wi-Fi 扫描模块接口

宏定义说明

◆ XT_WIFISCAN_AP_NUM_MAX

#define XT_WIFISCAN_AP_NUM_MAX   20

扫描信息单元最大数量

在文件 xt_wifiscan.h 第 34 行定义.

◆ XT_WIFISCAN_MAC_SIZE

#define XT_WIFISCAN_MAC_SIZE   6

MAC 地址缓存区长度

在文件 xt_wifiscan.h 第 37 行定义.

◆ XT_WIFISCAN_SSID_SIZE

#define XT_WIFISCAN_SSID_SIZE   32

无线网络名称长度

在文件 xt_wifiscan.h 第 40 行定义.

类型定义说明

◆ xt_wifiscan_cb_t

typedef void(* xt_wifiscan_cb_t) (xt_wifiscan_info_t *info)

Wi-Fi 扫描完成回调函数类型

参数
info扫描结果,见 xt_wifiscan_info_t

在文件 xt_wifiscan.h 第 69 行定义.

函数说明

◆ xt_wifiscan_set_cb()

xt_err_t xt_wifiscan_set_cb ( xt_wifiscan_cb_t cb)

设置 Wi-Fi 扫描完成回调

参数
cb回调函数,见 xt_wifiscan_cb_t
返回
xt_err_t XT_EOK 成功,其他失败

◆ xt_wifiscan_start()

xt_err_t xt_wifiscan_start ( uint32_t channel_mask,
uint32_t scannum,
uint32_t timeout_ms )

启动 Wi-Fi 扫描

参数
channel_mask要扫描的通道掩码,可以指定 bit1 ~ bit13
scannum所有 channel 总上报 AP 最大个数
timeout_ms一次 WIFISCAN 所有 channel 总的最长时间(单位:ms)。 实际精度由平台决定,lm620 为 1s,最小值为 2000ms,最大值为 255s。
返回
xt_err_t XT_EOK 成功,其他失败

◆ xt_wifiscan_stop()

xt_err_t xt_wifiscan_stop ( void )

停止 Wi-Fi 扫描

返回
xt_err_t XT_EOK 成功,其他失败