sdk-hwV1.3/lichee/xr806/appos/project/example/wlan/readme.md

127 lines
3.2 KiB
Markdown
Executable File
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# wlan示例工程
> wlan示例工程展示了wlan模块接口使用方法。
>
> 本工程中提供以下模块接口使用的示例:
> 1. wlan的启动STA模式的使用
> 2. wlan的启动AP模式的使用
> 3. wlan的启动monitor模式的使用
---
## 适用平台
> 本工程适用以下芯片类型:
>
> 1. XR806系列芯片
> 本工程适用以下评估板类型:
> 1. 底板XR806_EVB
> 2. 模组XR806_MD01
> 本工程在基于"XR806_MD01"的“XR806_EVB”板上测试通过。
> 若需要在其他适用芯片和评估板上运行本工程请根据快速指南《XRadio_Quick_Start_Guide-CN》的提示进行相关配置修改。
> XRadio Wireless MCU芯片和评估板的更多信息可在以下地址获取
> https://docs.xradiotech.com
## 工程配置
> defconfig
> * N/A
>
> Makefile
> * N/A
>
> board_config.h
> * N/A
>
> board_config.c
> * N/A
>
> prj_config.h
>
> * N/A
## 模块依赖
> 必选项
> 1.libxrwireless.a
> 2.libwlan.a
---
## 工程说明
> 本工程的实现为逐个启动 STA、AP、monitor 模式每个模式保持1分钟时间后会自动切换到下一个模式
### 操作说明:
> 1. 修改工程中的 sta_ssid 和 sta_psk 字符串为实际需要连接的AP的字符串
> 2. 编译工程,烧录镜像,启动即可
> 3. 系统启动后,可以通过串口软件看到示例的打印信息
> XRadio SDK的编译、烧写等操作方式的说明可在以下地址获取
> https://github.com/XradioTech/xradiotech-wiki
### 控制命令
> * N/A
### 代码结构
```
.
├── gcc
│ ├── defconfig # 本工程的配置规则,用于覆盖默认配置
│ └── Makefile # 本工程的编译规则可指定src、lib、ld、image.cfg、board_config等文件
├── image
│ └── xr806
│ └── image.cfg # 本工程的镜像分区配置
├── main.c # 本工程的入口进行wdg三种工作模式的选择和执行
├── prj_config.h # 本工程的配置选项,主要用于功能的选择。
└── readme.md # 本工程的说明文档
#本程用到XRadio SDK的其他配置文件
.
└── project
   └── common
      └── board
         └── xr806_dig_ver #在project/Kconfig默认指定使用xr806_dig_ver的板级配置
            ├── board_config.h #本工程的板级配置,
            └── board_config.c #本工程的板级pin mux的配置。
```
### 代码流程
> 1. main()入口:
> A初始化系统
> B执行sta_test()
> C执行ap_test()
> D执行monitor_test()
> 2. 执行sta_test()函数流程:
> A切换到sta模式
> B设置SSID和PSK然后启动STA连接
> C持续60秒
> D断开STA的连接
> 3. 执行ap_test()函数流程:
> A切换到ap模式
> B先关闭ap功能
> C设置SSID和PSK然后再次使能ap功能
> D持续60秒
> E断开AP的连接
> 4. 执行monitor_test()函数流程:
> A注册收到包时候的回调处理函数rx_cb()
> B切换到monitor模式
> C持续60秒
> D清除回调函数
> E切换回正常的STA模式
---
## 常见问题
> * N/A
## 参考文档
> * N/A