#include "xf_utils.h"
#include "xf_wifi.h"

xf_main.c 的引用(Include)关系图:

宏定义
#define	EXAMPLE_WIFI_SSID "myssid"

#define	EXAMPLE_WIFI_PASS "mypassword"

#define	EXAMPLE_WIFI_AUTHMODE XF_WIFI_AUTH_WPA_WPA2_PSK

#define	EXAMPLE_WIFI_CHANNEL 6

#define	EXAMPLE_WIFI_SSID_HIDDEN_FLAG 0

#define	ERROR_CHECK(expression)

函数
static void	_error_check_failed (void)

static void	_wifi_ap_event_handler (xf_wifi_event_id_t event_id, void event_data, void user_args)

static void	_wifi_ip_event_handler (xf_ip_event_id_t event_id, void event_data, void user_args)

void	xf_main (void)
	全局函数定义: [Global Functions].

变量
static const char *	TAG = "ap"

static xf_wifi_ap_cfg_t	s_ap_cfg

详细描述

作者: catcatBlue (catca.nosp@m.tblu.nosp@m.e@qq..nosp@m.com)

版本: 1.0

日期: 2024-06-06

在文件 xf_main.c 中定义.

宏定义说明

◆ EXAMPLE_WIFI_SSID

#define EXAMPLE_WIFI_SSID "myssid"

示例: examples/wireless/wifi/get_started/softap/main/xf_main.c, examples/wireless/wifi/get_started/station/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_main.c 第 24 行定义.

◆ EXAMPLE_WIFI_PASS

#define EXAMPLE_WIFI_PASS "mypassword"

示例: examples/wireless/wifi/get_started/softap/main/xf_main.c, examples/wireless/wifi/get_started/station/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_main.c 第 25 行定义.

◆ EXAMPLE_WIFI_AUTHMODE

#define EXAMPLE_WIFI_AUTHMODE XF_WIFI_AUTH_WPA_WPA2_PSK

在文件 xf_main.c 第 26 行定义.

◆ EXAMPLE_WIFI_CHANNEL

#define EXAMPLE_WIFI_CHANNEL 6

wifi 信道

在文件 xf_main.c 第 27 行定义.

◆ EXAMPLE_WIFI_SSID_HIDDEN_FLAG

#define EXAMPLE_WIFI_SSID_HIDDEN_FLAG 0

不隐藏

在文件 xf_main.c 第 28 行定义.

◆ ERROR_CHECK

#define ERROR_CHECK ( expression )

值:

    do { \
        if (unlikely((expression) != XF_OK)) { \
            XF_LOGE(TAG, "An error occurred: %s", XSTR(expression != XF_OK)); \
            _error_check_failed(); \
        } \
    } while (0)

在文件 xf_main.c 第 55 行定义.

函数说明

◆ _error_check_failed()

static void _error_check_failed ( void )

static

示例: 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_main.c 第 119 行定义.

◆ _wifi_ap_event_handler()

static void _wifi_ap_event_handler	(	xf_wifi_event_id_t	event_id,
		void *	event_data,
		void *	user_args
	)

static

在文件 xf_main.c 第 80 行定义.

◆ _wifi_ip_event_handler()

static void _wifi_ip_event_handler	(	xf_ip_event_id_t	event_id,
		void *	event_data,
		void *	user_args
	)

static

在文件 xf_main.c 第 104 行定义.

◆ xf_main()

void xf_main ( void )

全局函数定义: [Global Functions].

全局函数原型在**头文件**中声明并编写注释，此处可以不加 brief。

主函数。正常情况下此行空白：函数之间需要有一个空行作为分隔

< 用于接收 _xf_template_func 的传出

< 防止警告

分支语句哪怕只有一句也必须加花括号。

判断语句中，如果一行不足以放下判断语句，分行时需要将逻辑符号放在新行的开头。此时最好还是用变量表达判断语句。

常量在前可以避免不必要的逻辑错误。如 if (XF_TEMPL_FAIL = ret) 时编译会报错。

对于返回值为 void 的函数， return;可有可无，文件风格统一即可。

注意！ xf_init() 会在 xf_main() 前运行，此处不需要重复调用 xf_init()！

此示例仅用于演示自动初始化的使用方法。

< 所有等级打印都带有全部信息

< 过滤文件名为 "file1.c" 的打印

< 打开过滤器

< 设置过滤器为黑名单

< 不用彩色打印

< 启用彩色打印

在文件 xf_main.c 第 65 行定义.

变量说明

◆ TAG

const char* TAG = "ap"

static

在文件 xf_main.c 第 42 行定义.

◆ s_ap_cfg

xf_wifi_ap_cfg_t s_ap_cfg

static

初始值:

= {
    .ssid           = EXAMPLE_WIFI_SSID,
    .password       = EXAMPLE_WIFI_PASS,
    .authmode       = EXAMPLE_WIFI_AUTHMODE,
    .channel        = EXAMPLE_WIFI_CHANNEL,
    .ssid_hidden    = EXAMPLE_WIFI_SSID_HIDDEN_FLAG,
    .p_cfg_ext      = NULL,             
    .p_static_ip    = NULL,             
}

在文件 xf_main.c 第 43 行定义.