Skip to content

Commit 0463f1c

Browse files
authored
Merge pull request #265 from suda-morris/docs/rmt_api_reference
docs(led_strip): add api reference
2 parents 2f34308 + 3afd573 commit 0463f1c

File tree

9 files changed

+531
-47
lines changed

9 files changed

+531
-47
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ sdkconfig.old
66
dependencies.lock
77
**/managed_components/**
88
.vscode/
9+
doxygen/

led_strip/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## 2.5.0
22

33
- Enabled support for IDF4.4 and above
4-
- only with RMT backend
4+
- with RMT backend only
55
- Added API `led_strip_set_pixel_hsv`
66

77
## 2.4.0
88

99
- Support configurable SPI mode to control leds
1010
- recommend enabling DMA when using SPI mode
11-
11+
1212
## 2.3.0
1313

1414
- Support configurable RMT channel size by setting `mem_block_symbols`

led_strip/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,7 @@ The number of LED strip objects can be created depends on how many free SPI buse
9191
F --> |No| H[RMT backend] --> D
9292
```
9393
94+
* How to set the brightness of the LED strip?
95+
* You can tune the brightness by scaling the value of each R-G-B element with a **same** factor. But pay attention to the overflow of the value.
96+
9497
[^1]: The RMT DMA feature is not available on all ESP chips. Please check the data sheet before using it.

0 commit comments

Comments
 (0)