更新README

This commit is contained in:
2023-11-26 00:37:38 +08:00
parent 7b33d5a45e
commit dcc547b630
2 changed files with 11 additions and 3 deletions

View File

@@ -23,12 +23,20 @@
### 包含头文件 ### 包含头文件
在你的项目中包含`rgb_effect.h`文件 在你的项目中包含`rgb_effect.h`文件它是较高等级的灯效头文件用于实现各种灯效以及向RGB输出灯效
```c ```c
#include "rgb_effect.h" #include "rgb_effect.h"
``` ```
或者直接包含`visualize_volume.h`它是最高等级的应用头文件用于实现可视化的响度。你需要为它创建一个线程并向它的缓存中写入音频样本以驱动RGB。
```c
#include "visualize_volume.h"
```
//TODO: 后续我们会创建一个例程,帮助你快速构建一个线程安全的应用。
### 快速开始 ### 快速开始
如果你想要尝试开箱即用的持续的颜色渐变效果,可以使用`examples/app_hsv_cycle_example/src/hsv_cycle_example.c`中的`hsv_cycle_example`函数,具体的用法可以参考该示例。 如果你想要尝试开箱即用的持续的颜色渐变效果,可以使用`examples/app_hsv_cycle_example/src/hsv_cycle_example.c`中的`hsv_cycle_example`函数,具体的用法可以参考该示例。
@@ -100,9 +108,9 @@ output_rgb_array(rgb_array, 3);
- [x] RGB渐变 - [x] RGB渐变
- [x] HSV渐变 - [x] HSV渐变
- [ ] 每个灯珠独立的HSV渐变 - [ ] 每个灯珠独立的HSV渐变
- [x] 音频响度响应 - [x] 音频响度响应
- [ ] 使用fp/s32以增加`HSV_to_RGB`的计算效率 - [ ] 使用fp/s32以增加`HSV_to_RGB`的计算效率
- [ ] 提供音频响度响应的例程与说明
## 贡献 ## 贡献
如果你有任何改进意见或者发现了bug请通过issues或pull requests来提交或贡献。 如果你有任何改进意见或者发现了bug请通过issues或pull requests来提交或贡献。

View File

@@ -45,7 +45,7 @@ uint32_t current_hue = 0; // 从红色开始的当前色相值
uint32_t current_color[NUM_RGB_GROUPS] = {0x000000, 0x000000}; uint32_t current_color[NUM_RGB_GROUPS] = {0x000000, 0x000000};
// 根据音频的响度点亮不同数量的rgb灯 // 根据音频的响度点亮不同数量的rgb灯,实现响度可视化
void visualize_loudness_driver() void visualize_loudness_driver()
{ {
// 响度对应的RGB灯等级 // 响度对应的RGB灯等级