# LuatOS-ESP32

**Repository Path**: chenxuuu/LuatOS-ESP32

## Basic Information

- **Project Name**: LuatOS-ESP32
- **Description**: LuatOS For ESP32
- **Primary Language**: C
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 103
- **Created**: 2021-09-16
- **Last Updated**: 2024-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ESP32 固件源码库

ESP32C3/ESP32S3是乐鑫基于riscv/xtensa内核设计的wifi芯片

> 本仓库由[梦程的项目](https://gitee.com/dreamcmi/LuatOS-ESP32)fork而来

## 编译说明

见编译教程[【LuatOS】全系列固件编译教程](https://www.bilibili.com/video/BV1D3411p7MK)

wiki文字版教程等待更新中

## 相关资料

* ESP32C3: [https://wiki.luatos.com/chips/esp32c3/index.html](https://wiki.luatos.com/chips/esp32c3/index.html)
* [ESP32C3解锁GPIO11](./doc/VDD_SPI_AS_GPIO.md)
* LuatOS主库: [https://gitee.com/openLuat/LuatOS](https://gitee.com/openLuat/LuatOS)

## 如需帮助

LuatOS/ESP32C3/ESP32S3问题请加QQ群: 827963649 或提交issue

## 授权协议

> fork分支前的部分遵循Apache License 2.0协议（参考git提交记录），版权属于[梦程](https://gitee.com/dreamcmi)

除上述部分与源码中特殊声明的文件，其余部分均使用MIT协议

欢迎提交issue或pull request.

## 项目目录结构

```cmd
├─components		(组件库)
│  ├─lua			(lua核心代码)
│  ├─luat			(luat移植层)
│  │  ├─freertos	(freertos移植层)
│  │  ├─include		(用户头文件目录)
│  │  └─port		(接口移植目录)
│  ├─led_strip		(ws2812库)
│  ├─libhelix-mp3	(mp3解码库)
│  ├─miniz			(压缩库)
├─demo				(lua示例)
├─doc				(开发相关文档)
├─img				(介绍用相关图片)
├─main				(c程序主入口)
├─patches			(补丁目录)
├─soc_tools			(用于打包luatos-soc的相关文件)
├─test				(测试部测试代码)
├─tools				(工具目录，包括下载打包脚本)
└─userdoc			(用户文档)
```