WLED 项目安装与使用指南
1. 项目目录结构及介绍
WLED 项目的目录结构如下:
WLED/
├── devcontainer/
├── github/
├── vscode/
├── images/
├── include/
├── lib/
├── pio-scripts/
├── test/
├── tools/
├── usermods/
├── wled00/
├── .envrc
├── .gitignore
├── .gitpod.Dockerfile
├── .gitpod.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── package-lock.json
├── package.json
├── platformio.ini
├── readme.md
├── requirements.in
└── requirements.txt
目录介绍
- devcontainer/: 包含开发容器配置文件。
- github/: 包含 GitHub 相关的配置文件。
- vscode/: 包含 Visual Studio Code 的配置文件。
- images/: 包含项目相关的图片资源。
- include/: 包含项目的头文件。
- lib/: 包含项目的库文件。
- pio-scripts/: 包含 PlatformIO 脚本。
- test/: 包含项目的测试文件。
- tools/: 包含项目的工具脚本。
- usermods/: 包含用户自定义模块。
- wled00/: 包含项目的主要源代码文件。
- .envrc: 环境变量配置文件。
- .gitignore: Git 忽略文件配置。
- .gitpod.Dockerfile: Gitpod 的 Dockerfile。
- .gitpod.yml: Gitpod 的配置文件。
- CHANGELOG.md: 项目更新日志。
- CODE_OF_CONDUCT.md: 项目行为准则。
- CONTRIBUTING.md: 项目贡献指南。
- LICENSE: 项目许可证。
- package-lock.json: npm 包锁定文件。
- package.json: npm 包配置文件。
- platformio.ini: PlatformIO 配置文件。
- readme.md: 项目自述文件。
- requirements.in: Python 依赖文件。
- requirements.txt: Python 依赖文件。
2. 项目启动文件介绍
WLED 项目的主要启动文件位于 wled00/
目录下。以下是一些关键的启动文件:
- wled00/wled.cpp: 这是 WLED 项目的主程序文件,包含了项目的初始化和主要逻辑。
- wled00/wled.h: 这是 WLED 项目的主头文件,包含了项目的全局定义和声明。
- wled00/wled_ethernet.cpp: 这是 WLED 项目的以太网支持文件,用于配置和启动以太网功能。
- wled00/wled_http.cpp: 这是 WLED 项目的 HTTP 服务器文件,用于处理 HTTP 请求和响应。
- wled00/wled_json.cpp: 这是 WLED 项目的 JSON 处理文件,用于解析和生成 JSON 数据。
3. 项目的配置文件介绍
WLED 项目的主要配置文件包括:
- platformio.ini: 这是 PlatformIO 的配置文件,用于定义项目的构建和上传设置。
- wled00/wled_defaults.h: 这是 WLED 项目的默认配置文件,包含了项目的默认参数和设置。
- wled00/wled_config.h: 这是 WLED 项目的用户配置文件,用户可以在这里自定义项目的参数和设置。
配置文件示例
platformio.ini
[env:esp32dev]
platform = espressif32
board = esp32dev
framework = arduino
upload_port = /dev/ttyUSB0
monitor_speed = 115200
wled00/wled_defaults.h
#define DEFAULT_LED_COUNT 300
#define DEFAULT_BRIGHTNESS 128
#define DEFAULT_COLOR_ORDER GRB
wled00/wled_config.h
#define LED_COUNT 500
#define BRIGHTNESS 200
#define COLOR_ORDER RGB
通过这些配置文件,用户可以轻松地自定义 WLED 项目的行为和功能。