xf_wifi 包含 STA、AP 接口。更多...

xf_wifi 的协作图:

模块
	ap
	xf_wifi ap.

	sta
	xf_wifi sta.

结构体
struct	_xf_wifi_country_t
	WiFi 国家码。更多...

struct	_xf_wifi_static_ip_configuration_t
	wifi 静态 IP。更多...

struct	_xf_wifi_softap_configuration_extended_t
	Soft-AP 扩展配置结构体。谨慎使用，不同平台对这些配置的处理不一定相同。更多...

struct	_xf_wifi_softap_configuration_t
	Soft-AP 基础配置结构体. 更多...

struct	_xf_wifi_station_configuration_extended_t
	STA 扩展配置结构体。更多...

struct	_xf_wifi_station_configuration_t
	STA 基础配置结构体。更多...

struct	_xf_wifi_station_information_t
	连接到当前 AP 的 STA 的信息。更多...

struct	_xf_wifi_scan_cfg_t
	Parameters for an SSID scan. 更多...

struct	_xf_wifi_ap_info_t
	AP 信息。扫描结果中使用。更多...

struct	_xf_wifi_event_sta_connected_t
	STA 事件消息类型: 已连接到 AP。事件 id 见 XF_WIFI_EVENT_STA_CONNECTED. 更多...

struct	_xf_wifi_event_sta_disconnected_t
	STA 事件消息类型: 已从 AP 断开连接。事件 id 见 XF_WIFI_EVENT_STA_DISCONNECTED. 更多...

struct	_xf_wifi_event_ap_sta_connected_t
	AP 事件消息类型: STA 连接。事件 id 见 XF_WIFI_EVENT_AP_STA_CONNECTED. 更多...

struct	_xf_wifi_event_ap_sta_disconnected_t
	AP 事件消息类型: STA 断开连接。事件 id 见 XF_WIFI_EVENT_AP_STA_DISCONNECTED. 更多...

宏定义
#define	XF_WIFI_SSID_LEN_MAX (33)
	wifi ssid 最大长度。 32 字节有效字符 + 一个 '\0'。

#define	XF_WIFI_PASSWORD_LEN_MAX (65)
	wifi 密码最大长度。 64 字节有效字符 + 一个 '\0'。

类型定义
typedef enum _xf_wifi_interface_t	xf_wifi_interface_t
	wifi 接口类型枚举。

typedef enum _xf_wifi_authenticate_mode_t	xf_wifi_auth_mode_t
	授权模式的强度。 OPEN < WEP < WPA_PSK < OWE < WPA2_PSK = WPA_WPA2_PSK < WAPI_PSK < WPA3_PSK = WPA2_WPA3_PSK

typedef struct _xf_wifi_country_t	xf_wifi_country_t
	WiFi 国家码。

typedef struct _xf_wifi_static_ip_configuration_t	xf_wifi_static_ip_cfg_t
	wifi 静态 IP。

typedef struct _xf_wifi_softap_configuration_extended_t	xf_wifi_ap_cfg_ext_t
	Soft-AP 扩展配置结构体。谨慎使用，不同平台对这些配置的处理不一定相同。

typedef struct _xf_wifi_softap_configuration_t	xf_wifi_ap_cfg_t
	Soft-AP 基础配置结构体.

typedef struct _xf_wifi_station_configuration_extended_t	xf_wifi_sta_cfg_ext_t
	STA 扩展配置结构体。

typedef struct _xf_wifi_station_configuration_t	xf_wifi_sta_cfg_t
	STA 基础配置结构体。

typedef struct _xf_wifi_station_information_t	xf_wifi_sta_info_t
	连接到当前 AP 的 STA 的信息。

typedef struct _xf_wifi_scan_cfg_t	xf_wifi_scan_cfg_t
	Parameters for an SSID scan.

typedef struct _xf_wifi_ap_info_t	xf_wifi_ap_info_t
	AP 信息。扫描结果中使用。

typedef enum _xf_wifi_event_code_t	xf_wifi_event_code_t
	WiFi 事件声明。

typedef int32_t	xf_wifi_event_id_t
	wifi 事件 id。见 xf_wifi_event_code_t.

typedef struct _xf_wifi_event_sta_connected_t	xf_wifi_event_sta_conn_t
	STA 事件消息类型: 已连接到 AP。事件 id 见 XF_WIFI_EVENT_STA_CONNECTED.

typedef struct _xf_wifi_event_sta_disconnected_t	xf_wifi_event_sta_disconn_t
	STA 事件消息类型: 已从 AP 断开连接。事件 id 见 XF_WIFI_EVENT_STA_DISCONNECTED.

typedef struct _xf_wifi_event_ap_sta_connected_t	xf_wifi_event_ap_sta_conn_t
	AP 事件消息类型: STA 连接。事件 id 见 XF_WIFI_EVENT_AP_STA_CONNECTED.

typedef struct _xf_wifi_event_ap_sta_disconnected_t	xf_wifi_event_ap_sta_disconn_t
	AP 事件消息类型: STA 断开连接。事件 id 见 XF_WIFI_EVENT_AP_STA_DISCONNECTED.

typedef void(*	xf_wifi_cb_t) (xf_wifi_event_id_t event_id, void event_data, void user_args)
	wifi 回调函数原型。

枚举
enum	_xf_wifi_interface_t { XF_WIFI_IF_STA = 0 , XF_WIFI_IF_AP , XF_WIFI_IF_MAX }
	wifi 接口类型枚举。更多...

enum	_xf_wifi_authenticate_mode_t { XF_WIFI_AUTH_OPEN = 0 , XF_WIFI_AUTH_WEP , XF_WIFI_AUTH_WPA_PSK , XF_WIFI_AUTH_WPA2_PSK , XF_WIFI_AUTH_WPA_WPA2_PSK , XF_WIFI_AUTH_ENTERPRISE , XF_WIFI_AUTH_WPA2_ENTERPRISE = XF_WIFI_AUTH_ENTERPRISE , XF_WIFI_AUTH_WPA3_PSK , XF_WIFI_AUTH_WPA2_WPA3_PSK , XF_WIFI_AUTH_WAPI_PSK , XF_WIFI_AUTH_OWE , XF_WIFI_AUTH_WPA3_ENT_192 , XF_WIFI_AUTH_MAX }
	授权模式的强度。 OPEN < WEP < WPA_PSK < OWE < WPA2_PSK = WPA_WPA2_PSK < WAPI_PSK < WPA3_PSK = WPA2_WPA3_PSK 更多...

enum	_xf_wifi_event_code_t { XF_WIFI_EVENT_BASE = 0 , XF_WIFI_EVENT_SCAN_DONE = XF_WIFI_EVENT_BASE , XF_WIFI_EVENT_STA_START , XF_WIFI_EVENT_STA_STOP , XF_WIFI_EVENT_STA_CONNECTED , XF_WIFI_EVENT_STA_DISCONNECTED , XF_WIFI_EVENT_AP_START , XF_WIFI_EVENT_AP_STOP , XF_WIFI_EVENT_AP_STA_CONNECTED , XF_WIFI_EVENT_AP_STA_DISCONNECTED , XF_WIFI_EVENT_MAX }
	WiFi 事件声明。更多...

函数
xf_err_t	xf_wifi_enable (void)
	启用 wifi 协议栈.

xf_err_t	xf_wifi_disable (void)
	禁用 wifi 协议栈.

xf_err_t	xf_wifi_set_mac (xf_wifi_interface_t ifx, const uint8_t mac[XF_MAC_LEN_MAX])
	wifi 设置 mac 地址。

xf_err_t	xf_wifi_get_mac (xf_wifi_interface_t ifx, uint8_t mac[XF_MAC_LEN_MAX])
	wifi 获取 mac 地址。

详细描述

xf_wifi 包含 STA、AP 接口。

宏定义说明

◆ XF_WIFI_SSID_LEN_MAX

#define XF_WIFI_SSID_LEN_MAX (33)

wifi ssid 最大长度。 32 字节有效字符 + 一个 '\0'。

在文件 xf_wifi_types.h 第 39 行定义.

◆ XF_WIFI_PASSWORD_LEN_MAX

#define XF_WIFI_PASSWORD_LEN_MAX (65)

wifi 密码最大长度。 64 字节有效字符 + 一个 '\0'。

在文件 xf_wifi_types.h 第 45 行定义.

类型定义说明

◆ xf_wifi_interface_t

typedef enum _xf_wifi_interface_t xf_wifi_interface_t

wifi 接口类型枚举。

◆ xf_wifi_auth_mode_t

typedef enum _xf_wifi_authenticate_mode_t xf_wifi_auth_mode_t

授权模式的强度。 OPEN < WEP < WPA_PSK < OWE < WPA2_PSK = WPA_WPA2_PSK < WAPI_PSK < WPA3_PSK = WPA2_WPA3_PSK

◆ xf_wifi_country_t

typedef struct _xf_wifi_country_t xf_wifi_country_t

WiFi 国家码。

◆ xf_wifi_static_ip_cfg_t

typedef struct _xf_wifi_static_ip_configuration_t xf_wifi_static_ip_cfg_t

wifi 静态 IP。

◆ xf_wifi_ap_cfg_ext_t

typedef struct _xf_wifi_softap_configuration_extended_t xf_wifi_ap_cfg_ext_t

Soft-AP 扩展配置结构体。谨慎使用，不同平台对这些配置的处理不一定相同。

◆ xf_wifi_ap_cfg_t

typedef struct _xf_wifi_softap_configuration_t xf_wifi_ap_cfg_t

Soft-AP 基础配置结构体.

◆ xf_wifi_sta_cfg_ext_t

typedef struct _xf_wifi_station_configuration_extended_t xf_wifi_sta_cfg_ext_t

STA 扩展配置结构体。

◆ xf_wifi_sta_cfg_t

typedef struct _xf_wifi_station_configuration_t xf_wifi_sta_cfg_t

STA 基础配置结构体。

◆ xf_wifi_sta_info_t

typedef struct _xf_wifi_station_information_t xf_wifi_sta_info_t

连接到当前 AP 的 STA 的信息。

◆ xf_wifi_scan_cfg_t

typedef struct _xf_wifi_scan_cfg_t xf_wifi_scan_cfg_t

Parameters for an SSID scan.

wifi 扫描参数。

目前只支持指定通道扫描。

◆ xf_wifi_ap_info_t

typedef struct _xf_wifi_ap_info_t xf_wifi_ap_info_t

AP 信息。扫描结果中使用。

◆ xf_wifi_event_code_t

typedef enum _xf_wifi_event_code_t xf_wifi_event_code_t

WiFi 事件声明。

◆ xf_wifi_event_id_t

typedef int32_t xf_wifi_event_id_t

wifi 事件 id。见 xf_wifi_event_code_t.

在文件 xf_wifi_types.h 第 227 行定义.

◆ xf_wifi_event_sta_conn_t

typedef struct _xf_wifi_event_sta_connected_t xf_wifi_event_sta_conn_t

STA 事件消息类型: 已连接到 AP。事件 id 见 XF_WIFI_EVENT_STA_CONNECTED.

◆ xf_wifi_event_sta_disconn_t

typedef struct _xf_wifi_event_sta_disconnected_t xf_wifi_event_sta_disconn_t

STA 事件消息类型: 已从 AP 断开连接。事件 id 见 XF_WIFI_EVENT_STA_DISCONNECTED.

◆ xf_wifi_event_ap_sta_conn_t

typedef struct _xf_wifi_event_ap_sta_connected_t xf_wifi_event_ap_sta_conn_t

AP 事件消息类型: STA 连接。事件 id 见 XF_WIFI_EVENT_AP_STA_CONNECTED.

◆ xf_wifi_event_ap_sta_disconn_t

typedef struct _xf_wifi_event_ap_sta_disconnected_t xf_wifi_event_ap_sta_disconn_t

AP 事件消息类型: STA 断开连接。事件 id 见 XF_WIFI_EVENT_AP_STA_DISCONNECTED.

◆ xf_wifi_cb_t

typedef void(* xf_wifi_cb_t) (xf_wifi_event_id_t event_id, void *event_data, void *user_args)

wifi 回调函数原型。

参数

event_id	事件 id. 根据事件类型, 见 xf_wifi_event_code_t.
event_data	事件数据. 需要根据事件 id 强转为对应的类型.
user_args	用户数据. `xf_wifi_ap/sta_set_cb(..., user_args);`时传入.

在文件 xf_wifi_types.h 第 274 行定义.

枚举类型说明

◆ _xf_wifi_interface_t

enum _xf_wifi_interface_t

wifi 接口类型枚举。

枚举值
XF_WIFI_IF_STA
XF_WIFI_IF_AP
XF_WIFI_IF_MAX

在文件 xf_wifi_types.h 第 52 行定义.

◆ _xf_wifi_authenticate_mode_t

enum _xf_wifi_authenticate_mode_t

授权模式的强度。 OPEN < WEP < WPA_PSK < OWE < WPA2_PSK = WPA_WPA2_PSK < WAPI_PSK < WPA3_PSK = WPA2_WPA3_PSK

枚举值
XF_WIFI_AUTH_OPEN	authenticate mode : open
XF_WIFI_AUTH_WEP	authenticate mode : WEP
XF_WIFI_AUTH_WPA_PSK	authenticate mode : WPA_PSK
XF_WIFI_AUTH_WPA2_PSK	authenticate mode : WPA2_PSK
XF_WIFI_AUTH_WPA_WPA2_PSK	authenticate mode : WPA_WPA2_PSK
XF_WIFI_AUTH_ENTERPRISE	authenticate mode : WiFi EAP security
XF_WIFI_AUTH_WPA2_ENTERPRISE	authenticate mode : WiFi EAP security
XF_WIFI_AUTH_WPA3_PSK	authenticate mode : WPA3_PSK
XF_WIFI_AUTH_WPA2_WPA3_PSK	authenticate mode : WPA2_WPA3_PSK
XF_WIFI_AUTH_WAPI_PSK	authenticate mode : WAPI_PSK
XF_WIFI_AUTH_OWE	authenticate mode : OWE
XF_WIFI_AUTH_WPA3_ENT_192	authenticate mode : WPA3_ENT_SUITE_B_192_BIT
XF_WIFI_AUTH_MAX

在文件 xf_wifi_types.h 第 62 行定义.

◆ _xf_wifi_event_code_t

enum _xf_wifi_event_code_t

WiFi 事件声明。

枚举值
XF_WIFI_EVENT_BASE	WiFi 事件 ID 起始。
XF_WIFI_EVENT_SCAN_DONE	扫描 AP 完毕。该事件无数据。扫描结果通过 xf_wifi_get_scan_result() 获取。
XF_WIFI_EVENT_STA_START	STA 启动。该事件无数据。
XF_WIFI_EVENT_STA_STOP	STA 停止。该事件无数据。
XF_WIFI_EVENT_STA_CONNECTED	STA 已连接到 AP。事件数据类型见 xf_wifi_event_sta_conn_t.
XF_WIFI_EVENT_STA_DISCONNECTED	STA 与 AP 断开连接。事件数据类型见 xf_wifi_event_sta_disconn_t.
XF_WIFI_EVENT_AP_START	soft-AP 启动。该事件无数据。
XF_WIFI_EVENT_AP_STOP	soft-AP 停止。该事件无数据。
XF_WIFI_EVENT_AP_STA_CONNECTED	有 STA 连接到 soft-AP. 事件数据类型见 xf_wifi_event_ap_sta_conn_t.
XF_WIFI_EVENT_AP_STA_DISCONNECTED	有 STA 与 soft-AP 断开连接。事件数据类型见 xf_wifi_event_ap_sta_disconn_t.
XF_WIFI_EVENT_MAX	WiFi 事件 ID 最大值，无效的 WiFi 事件 ID.

在文件 xf_wifi_types.h 第 195 行定义.

函数说明

◆ xf_wifi_enable()

xf_err_t xf_wifi_enable ( void )

启用 wifi 协议栈.

返回

xf_err_t

XF_OK 成功
XF_FAIL 失败或重复启用

示例: examples/wireless/wifi/get_started/softap/main/xf_main.c, examples/wireless/wifi/get_started/station/main/xf_main.c, examples/wireless/wifi/scan/base_scan/main/xf_main.c, examples/wireless/wifi/scan/scan_and_connect/main/xf_main.c, examples/wireless/wifi/static_ip/softap/main/xf_main.c , 以及 examples/wireless/wifi/static_ip/station/main/xf_main.c.

◆ xf_wifi_disable()

xf_err_t xf_wifi_disable ( void )

禁用 wifi 协议栈.

返回

xf_err_t

XF_OK 成功
XF_FAIL 失败或者未启用

◆ xf_wifi_set_mac()

xf_err_t xf_wifi_set_mac	(	xf_wifi_interface_t	ifx,
		const uint8_t	mac[XF_MAC_LEN_MAX]
	)

wifi 设置 mac 地址。

该接口只有在 AP 或者 STA 启动前有效。

参数

ifx	接口，选择 STA 或者 AP。
mac	新的 mac 地址。

返回

xf_err_t

XF_OK 成功
XF_FAIL 失败
XF_ERR_NOT_SUPPORTED 不支持

◆ xf_wifi_get_mac()

xf_err_t xf_wifi_get_mac	(	xf_wifi_interface_t	ifx,
		uint8_t	mac[XF_MAC_LEN_MAX]
	)

wifi 获取 mac 地址。

参数

	ifx	接口，选择 STA 或者 AP。
[out]	mac	读取到的 mac 地址。

返回

xf_err_t

XF_OK 成功
XF_FAIL 失败

模块

结构体

宏定义

类型定义

枚举

函数

详细描述

宏定义说明

◆ XF_WIFI_SSID_LEN_MAX

◆ XF_WIFI_PASSWORD_LEN_MAX

类型定义说明

◆ xf_wifi_interface_t

◆ xf_wifi_auth_mode_t

◆ xf_wifi_country_t

◆ xf_wifi_static_ip_cfg_t

◆ xf_wifi_ap_cfg_ext_t

◆ xf_wifi_ap_cfg_t

◆ xf_wifi_sta_cfg_ext_t

◆ xf_wifi_sta_cfg_t

◆ xf_wifi_sta_info_t

◆ xf_wifi_scan_cfg_t

◆ xf_wifi_ap_info_t

◆ xf_wifi_event_code_t

◆ xf_wifi_event_id_t

◆ xf_wifi_event_sta_conn_t

◆ xf_wifi_event_sta_disconn_t

◆ xf_wifi_event_ap_sta_conn_t

◆ xf_wifi_event_ap_sta_disconn_t

◆ xf_wifi_cb_t

枚举类型说明

◆ _xf_wifi_interface_t

◆ _xf_wifi_authenticate_mode_t

◆ _xf_wifi_event_code_t

函数说明

◆ xf_wifi_enable()

◆ xf_wifi_disable()

◆ xf_wifi_set_mac()

◆ xf_wifi_get_mac()