XFusion API v1.3.0
载入中...
搜索中...
未找到
xf_wifi.h
浏览该文件的文档.
1
20#ifndef __XF_WIFI_H__
21#define __XF_WIFI_H__
22
23/* ==================== [Includes] ========================================== */
24
25#include "xf_utils.h"
26#include "xf_netif_types.h"
27#include "xf_wifi_types.h"
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/* ==================== [Defines] =========================================== */
34
35/* ==================== [Typedefs] ========================================== */
36
37/* ==================== [Global Prototypes] ================================= */
38
54
63
77 xf_wifi_interface_t ifx, const uint8_t mac[XF_MAC_LEN_MAX]);
78
89 xf_wifi_interface_t ifx, uint8_t mac[XF_MAC_LEN_MAX]);
90
133
146
156
168xf_err_t xf_wifi_ap_set_cb(xf_wifi_cb_t cb_func, void *user_args);
169
181xf_err_t xf_wifi_ap_set_ip_cb(xf_ip_cb_t cb_func, void *user_args);
182
197 xf_wifi_sta_info_t sta_array[], uint32_t sta_array_size,
198 uint32_t *p_sta_num);
199
208xf_err_t xf_wifi_ap_deauth_sta(const uint8_t mac[]);
209
251
260
270
282xf_err_t xf_wifi_sta_set_cb(xf_wifi_cb_t cb_func, void *user_args);
283
295xf_err_t xf_wifi_sta_set_ip_cb(xf_ip_cb_t cb_func, void *user_args);
296
307
315
324
334
347
356
374 xf_wifi_ap_info_t result_array[], uint32_t result_array_size,
375 uint32_t *p_result_num);
376
392
398/* ==================== [Macros] ============================================ */
399
400#ifdef __cplusplus
401} /* extern "C" */
402#endif
403
404#endif /* __XF_WIFI_H__ */
void(* xf_ip_cb_t)(xf_ip_event_id_t event_id, void *event_data, void *user_args)
ip 回调函数原型。
void * xf_netif_t
xfusion netif 句柄。
#define XF_MAC_LEN_MAX
mac 地址最大长度。
Definition xf_mac.h:35
int32_t xf_err_t
整形错误类型。 错误码具体值见 xf_err_code_t.
Definition xf_err.h:69
xf_err_t xf_wifi_ap_init(const xf_wifi_ap_cfg_t *p_cfg)
启用 wifi AP 模式.
xf_err_t xf_wifi_ap_set_cb(xf_wifi_cb_t cb_func, void *user_args)
AP 设置 wifi 事件回调函数.
xf_err_t xf_wifi_ap_get_netif(xf_netif_t *p_netif_hdl)
获取 AP 的 netif 句柄.
xf_err_t xf_wifi_ap_set_ip_cb(xf_ip_cb_t cb_func, void *user_args)
AP 设置 ip 事件回调函数.
xf_err_t xf_wifi_ap_get_sta_list(xf_wifi_sta_info_t sta_array[], uint32_t sta_array_size, uint32_t *p_sta_num)
获取 AP 已连接的 STA 列表.
xf_err_t xf_wifi_ap_deauth_sta(const uint8_t mac[])
断开已连接到 AP 的指定 STA.
xf_err_t xf_wifi_ap_deinit(void)
反初始化 wifi AP 模式, 并且释放相关资源.
xf_err_t xf_wifi_sta_set_ip_cb(xf_ip_cb_t cb_func, void *user_args)
STA 设置 ip 事件回调函数.
xf_err_t xf_wifi_scan_get_result(xf_wifi_ap_info_t result_array[], uint32_t result_array_size, uint32_t *p_result_num)
wifi 获取扫描结果。
xf_err_t xf_wifi_sta_get_netif(xf_netif_t *p_netif_hdl)
获取 STA 的 netif 句柄.
xf_err_t xf_wifi_sta_connect(xf_wifi_sta_cfg_t *p_cfg)
STA 连接到指定 AP.
xf_err_t xf_wifi_sta_deinit(void)
反初始化 wifi STA 模式, 并且释放相关资源.
xf_err_t xf_wifi_scan_start(const xf_wifi_scan_cfg_t *p_cfg, bool block)
wifi 启动 AP 扫描。
xf_err_t xf_wifi_sta_get_ap_info(xf_wifi_ap_info_t *p_info)
STA 获取当前连接到的 AP 的信息。
xf_err_t xf_wifi_scan_stop(void)
wifi 停止 AP 扫描。
bool xf_wifi_sta_is_connected(void)
STA 检查是否已经连接到 AP.
xf_err_t xf_wifi_scan_clear_result(void)
wifi 清除扫描结果。
xf_err_t xf_wifi_sta_set_cb(xf_wifi_cb_t cb_func, void *user_args)
wifi STA 设置回调函数.
xf_err_t xf_wifi_sta_disconnect(void)
STA 主动断开 AP 连接。
xf_err_t xf_wifi_sta_init(const xf_wifi_sta_cfg_t *p_cfg)
启用 wifi STA 模式.
xf_err_t xf_wifi_get_mac(xf_wifi_interface_t ifx, uint8_t mac[XF_MAC_LEN_MAX])
wifi 获取 mac 地址。
void(* xf_wifi_cb_t)(xf_wifi_event_id_t event_id, void *event_data, void *user_args)
wifi 回调函数原型。
xf_err_t xf_wifi_enable(void)
启用 wifi 协议栈.
xf_err_t xf_wifi_disable(void)
禁用 wifi 协议栈.
enum _xf_wifi_interface_t xf_wifi_interface_t
wifi 接口类型枚举。
xf_err_t xf_wifi_set_mac(xf_wifi_interface_t ifx, const uint8_t mac[XF_MAC_LEN_MAX])
wifi 设置 mac 地址。
AP 信息。 扫描结果中使用。
Parameters for an SSID scan.
Soft-AP 基础配置结构体.
STA 基础配置结构体。
连接到当前 AP 的 STA 的信息。