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

116 lines
3.4 KiB
Markdown
Raw Normal View History

2024-05-07 10:09:20 +00:00
# SmartConfig示例工程
> SmartConfig示例工程展示了XRadio SDK中SmartConfig配网接口的使用方法。
>
> 本工程中提供以下示例:
>
> 1. SmartConfig配网接口示例
> 2. XRadio SDK配网助手使用示例
------
## 适用平台
> 本工程适用以下芯片类型:
>
> 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. libsmartlink.aSmartConfig库
> 2. libsc_assistant.aXRadio SDK配网助手库该库可以提高配网的成功率。
> 可选项
>
>
## 工程说明
> 本工程主要目的是为了展示XRadio SDK中SmartConfig配网接口的使用方法及使用流程SmartConfig配网接口中有较多阻塞接口故在实际开发过程中建议单独建立配网线程来运行SmartConfig配网接口。
### 操作说明
> 1. 编译工程,烧录镜像,启动即可
> 2. 打开串口调试工具,并连接串口
> 3. 系统启动后会自动进入SmartConfig配网
> 4. 安装Xconfig.apk软件并打开软件该软件可咨询FAE获取
> 5. 手机连接到某个用于SmartConfig配网测试的wifi
> 6. 在Xconfig.apk软件中填入要配网的wifi名、wifi密码及AESKey点击开始
> 7. 等待串口打印配网结果
> XRadio SDK的编译、烧写等操作方式的说明可在以下地址获取
> https://github.com/XradioTech/xradiotech-wiki
### 代码结构
```
#本工程
.
├── gcc
│   ├── defconfig # 本工程的配置选项,主要用于覆盖默认全局配置
│   └── Makefile # 本工程的编译规则如ld文件、image.cfg、board_config.h等文件指定可覆盖默认配置
├── main.c # 本工程的入口,工程示例
├── 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. 初始化配网助手
> 2. 启动SmartConfig配网XRadio SDK封装的SmartConfig配网接口内部会使用配网助手
> 3. 等待配网结果(阻塞等待)
> 4. 配网完成后,获取配网结果
> 5. 用配网结果连接wifi并发送connect ack信号告诉手机设备已经连接上wifi了
## 常见问题
> SmartConfig连接不上或连接超时
1.检查aes_key是否设置正确2.检查路由器是否是2.4G3.检查路由器是否设置为支持20M或20M/40M4.检查路由器是否支持转发组播包。
## 参考文档
>