rt-thread/bsp/ESP32_C3/README.md

101 lines
3.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

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.

# ESP32-C3 BSP 说明
## 简介
本文档为基于RT-THREAD的乐鑫ESP32-C3的[ESP32C3](http://luatos.com/t/esp32c3) BSP (板级支持包) 说明。
主要内容如下:
- 开发板资源介绍
- BSP 快速上手
通过阅读快速上手章节开发者可以快速地上手该 BSP将 RT-Thread 运行在开发板上。
## 开发板介绍
目前测试了两款开发板运行都正常由于两款开发板LED小灯引脚不同请在menuconfig中选择自己手上的开发板。已测开发板外观如下图所示
- [LUATOS_ESP32C3](https://wiki.luatos.com/chips/esp32c3/board.html)
![LUATOS_ESP32C3](images/luatos_esp32c3.png)
- [HX-DK-商](https://docs.wireless-tech.cn/doc/7/)
![hongxu](images/hx_shang.png)
该LUATOS_ESP32C3开发板常用 **板载资源** 如下:
- MCU[esp32-c3](https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf),主频 160MHz 407.22 CoreMark; 2.55 CoreMark/MHz
- 芯片内置384KB ROM, 400KB SRAM,
- 常用外设
- 红色LED2个LED: D4 (IO12), D5IO13
- 按键2个K1BOOT K2(RST)
- SPI FLASH: 4M
- 常用接口USB UART等
开发板更多详细信息请参考 [ESP32-C3开发板介绍](https://wiki.luatos.com/chips/esp32c3/board.html)。
## 外设支持
本 BSP 目前对外设的支持情况如下:
| **片上外设** | **支持情况** | **备注** |
| :----------------- | :----------: | :------------------------------------- |
| GPIO | 支持 | |
| UART | 支持 | 使用LUATOS_ESP32C3开发板需要在UART0_TX和UART0_RX连接串口转USB芯片如CP2102|
| JTAG调试 | 支持 | ESP32C3采用USB方式和PC链接的开发板可以调试 |
## 使用说明
### 快速上手
先要搭建IDE开发环境乐鑫官方推荐使用IDF开发这边建议使用vscode插件。
IDF的搭建方法有很多种尝试了很多种方法之后总结了一个比较好用的方法并且可以使用vscode跨平台安装非常简单方便具体方法见链接[ESP-IDF 一键式搭建环境基于VSCODE](https://blog.csdn.net/lt6210925/article/details/123699249)。 安装的时候IDF版本请选择IDF 4.4版本。如果你对官方IDF命令行的方式熟悉的话你也可以使用命令行的方式直接在`bsp/esp32_c3`中执行`idf.py build`即可,这边已经测试过,是可以使用的。
### ESP-IDF 添加RT-THREAD patch
由于IDF使用的是FREERTOS如果需要使用rt-thread就需要修改一些文件。将`rtt.patch` 这个文件拷贝到IDF的代码目录下面然后在`git bash`命令行内执行命令下面几条命令就可以打上patch
```
cd esp/esp-idf
git checkout v4.4
git am rtt.patch
```
如果不想用patch文件已经将代码上传到github上面可以进入[tangzz98/esp-idf](https://github.com/tangzz98/esp-idf/tree/freertos_wrapper) 下载最新的freertos_wrapper分支代码即可。修改之后的IDF原来的IDF的example还是正常使用互不干扰可以放心使用。
#### 编译下载
在`bsp/ESP32_C3`中右击然后使用vscode打开工程
编译选择最下面的按钮即可:
![build](images/build.png)
这边通常采用串口下载需要根据你自己开发板选择对应的串口如果有JTAG的也可以用JTAG下载和调试
![burn](images/burn.png)
#### 运行结果
下载程序成功之后,系统会运行,红色的 LED灯以 1S 周期闪烁。
感兴趣的可以通过公众号`Thomas的小火车`来联系
## 注意事项
- 目前RTTHREAD支持起来了后续会需要继续完善一些其他功能刚开始使用ESP32欢迎小伙伴一起来讨论和贡献。
## 联系人信息
维护人:
- [supperthomas](https://github.com/supperthomas) 邮箱:<78900636@qq.com>
## 特别感谢
- 感谢[chenyingchun0312](https://github.com/chenyingchun0312) 提供了RISCV的强力支持