xf_main.c 文件参考

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

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

浏览源代码.

结构体
struct	example_scan_context_s
	扫描任务无栈协程上下文。 更多...
struct	example_authenticate_mode_message_s
	认证模式与字符串消息。 更多...

宏定义
#define	EXAMPLE_SCAN_CHANNEL_START   1
#define	EXAMPLE_SCAN_CHANNEL_END   13
#define	EXAMPLE_SCAN_RESULT_SIZE   32
#define	EXAMPLE_SCAN_BLOCK_IS_ENABLE   1
#define	EXAMPLE_SCAN_BLOCK   true
#define	EXAMPLE_WIFI_NTASK_PRIORITY   15
#define	EXAMPLE_WIFI_NTASK_PERIOD_MS   10
#define	TBL_IT(v)   {v, XSTR(v)}
	用于创建枚举值与枚举名称的对应关系。
#define	EXAMPLE_WIFI_SSID   "myssid"
#define	EXAMPLE_WIFI_PASS   "mypassword"
#define	ERROR_CHECK(expression)

类型定义
typedef struct example_scan_context_s	ex_scan_ctx_t
	扫描任务无栈协程上下文。
typedef struct example_authenticate_mode_message_s	ex_auth_mode_msg_t
	认证模式与字符串消息。

函数
static void	_error_check_failed (void)
static void	_wifi_sta_event_handler (xf_wifi_event_id_t event_id, void *event_data, void *user_args)
static void	_ip_event_handler (xf_ip_event_id_t event_id, void *event_data, void *user_args)
static const char *	ex_auth_mode_to_name (xf_wifi_auth_mode_t code)
	将 xf_wifi_auth_mode_t 的枚举值转为字符串消息。
static void	_wifi_ntask (xf_task_t task)
	扫描任务。
void	xf_main (void)
	全局函数定义: [Global Functions].

变量
static const char *	TAG = "scan"
static ex_scan_ctx_t	ctx = {0}
	扫描无栈任务上下文。
static ex_scan_ctx_t *	sp_ctx = &ctx
static uint8_t	s_is_connected = false
static xf_wifi_sta_cfg_t	s_sta_cfg
	STA 配置。

详细描述

作者

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

版本

1.0

日期

2024-09-14

Copyright (c) 2024, CorAL. All rights reserved.

在文件 xf_main.c 中定义.

宏定义说明

EXAMPLE_SCAN_CHANNEL_START

#define EXAMPLE_SCAN_CHANNEL_START   1

开始通道

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

EXAMPLE_SCAN_CHANNEL_END

#define EXAMPLE_SCAN_CHANNEL_END   13

结束通道（含）

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

EXAMPLE_SCAN_RESULT_SIZE

#define EXAMPLE_SCAN_RESULT_SIZE   32

AP 结果数组大小

示例

examples/wireless/wifi/scan/base_scan/main/xf_main.c , 以及 examples/wireless/wifi/scan/scan_and_connect/main/xf_main.c.

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

EXAMPLE_SCAN_BLOCK_IS_ENABLE

#define EXAMPLE_SCAN_BLOCK_IS_ENABLE   1

是否阻塞扫描

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

EXAMPLE_SCAN_BLOCK

#define EXAMPLE_SCAN_BLOCK   true

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

EXAMPLE_WIFI_NTASK_PRIORITY

#define EXAMPLE_WIFI_NTASK_PRIORITY   15

扫描无栈任务优先级

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

EXAMPLE_WIFI_NTASK_PERIOD_MS

#define EXAMPLE_WIFI_NTASK_PERIOD_MS   10

扫描无栈任务周期

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

TBL_IT

#define TBL_IT

(

v

)

{v, XSTR(v)}

用于创建枚举值与枚举名称的对应关系。

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

EXAMPLE_WIFI_SSID

#define EXAMPLE_WIFI_SSID   "myssid"

目标 AP 名称

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

EXAMPLE_WIFI_PASS

#define EXAMPLE_WIFI_PASS   "mypassword"

目标 AP 密码

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

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 第 122 行定义.

类型定义说明

ex_scan_ctx_t

typedef struct example_scan_context_s ex_scan_ctx_t

扫描任务无栈协程上下文。

ex_auth_mode_msg_t

typedef struct example_authenticate_mode_message_s ex_auth_mode_msg_t

认证模式与字符串消息。

函数说明

_error_check_failed()

static void _error_check_failed ( void  )

static

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

_wifi_sta_event_handler()

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

static

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

_ip_event_handler()

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

static

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

ex_auth_mode_to_name()

static const char * ex_auth_mode_to_name ( xf_wifi_auth_mode_t  code )

static

将 xf_wifi_auth_mode_t 的枚举值转为字符串消息。

参数

code

认证模式。

返回

const char* 字符串消息。

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

_wifi_ntask()

static void _wifi_ntask ( xf_task_t  task )

static

扫描任务。

该任务中逐通道扫描，扫描完毕后，如果找到目标 AP，则尝试连接，如果没有扫描到则重试。

注意

无栈协程内所有临时变量都不安全。 delay 后均会重置。

参数

task

本任务句柄。

注意

为了保持最大兼容性， 此处不调用 xf_wifi_scan_clear_result() 清除扫描结果列表。

对于 esp32 清除扫描结果列表后不影响连接； 而在 ws63 上，清除清除扫描结果列表后无法直接连接，扫描后不清除才能连接。

因此只在连接成功后，或者没有找到目标 AP 时清除列表。

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

xf_main()

void xf_main

(

void

)

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

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

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

< 用于接收 _xf_template_func 的传出

< 防止警告

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

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

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

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

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

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

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

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

< 打开过滤器

< 设置过滤器为黑名单

< 不用彩色打印

< 启用彩色打印

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

变量说明

TAG

const char* TAG = "scan"

static

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

ctx

ex_scan_ctx_t ctx = {0}

static

扫描无栈任务上下文。

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

sp_ctx

ex_scan_ctx_t* sp_ctx = &ctx

static

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

s_is_connected

uint8_t s_is_connected = false

static

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

s_sta_cfg

xf_wifi_sta_cfg_t s_sta_cfg

static

初始值:

= {
    .ssid           = EXAMPLE_WIFI_SSID,
    .password       = EXAMPLE_WIFI_PASS,
    .bssid_set      = false,                
    .bssid          = {0},
    .authmode       = XF_WIFI_AUTH_OPEN,    
    .channel        = 0,                    
    .p_cfg_ext      = NULL,                 
    .p_static_ip    = NULL,                 
}

STA 配置。

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