sdk-hwV1.3/lichee/xr806/appos/project/demo/hello_demo/readme.md

102 lines
3.0 KiB
Markdown
Raw Normal View History

2024-05-07 10:09:20 +00:00
# hello_demo演示工程
> hello_demo演示工程展示了XRadio SDK常用工程配置和系统初始化流程。
>
> 本工程中提供以下常用工程配置和系统初始化流程的演示:
> 1. 常用工程配置启用XIP、OTA、网络功能
> 2. 支持常用的控制台命令可用于常用网络功能演示、OTA升级、系统调试等
> 3. 在main()函数入口完成平台初始化后每隔10秒打印“Hello world! @ xxx sec”
---
## 适用平台
> 本工程适用以下芯片类型:
>
> 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:
>
> Makefile
>
> prj_config.h
>
> * PRJCONF_NET_EN可选项配置是否开启网络功能
## 模块依赖
> 可选项
> 1. liblwip.a开启网络功能需要依赖的库
> 2. wlan模块开启网络功能需要依赖的库
---
## 工程说明
> 本工程完成系统初始化后每隔10秒打印“Hello world! @ xxx sec”。
### 操作说明:
> 1. 使用串口线连接UART0连接至PC
> 2. 编译工程,烧录镜像,复位启动
> 3. 系统启动10秒后每隔10秒打印“Hello world! @ xxx sec”
> XRadio SDK的编译、烧写等操作方式的说明可参考《XRADIO_Quick_Start_Guide-CN》
### 控制命令
> 1. 连网操作(可选操作)
```
$ net sta config <your_ssid> [your_password]
$ net sta enable
```
### 代码结构
```
#本工程
.
├── command.c # 本工程的控制台命令入口和命令定义
├── command.h
├── gcc
│   ├── defconfig # 本工程的配置选项,可覆盖全局默认配置
│   └── Makefile # 本工程的Makefile可指定src、board config、ld、image cfg
├── main.c # 本工程的入口完成平台初始化后每隔10秒打印“Hello world! @ xxx sec”
├── 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) 调用platform_init()完成平台初始化
> B) 执行while循环每隔10秒打印“Hello world! @ xxx sec”
---
## 常见问题
> * N/A
## 参考文档
> 《XRADIO_Quick_Start_Guide-CN》