MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix WS2812 effects documentation

This commit is contained in:
Marcel Stör 2018-02-13 12:33:55 +01:00
parent 6027d86ec7
commit 8d2c523aab
2 changed files with 25 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/en/modules/color-utils.md
View File

@ -1,10 +1,9 @@
# COLOR_UTILS Module
# color utils Module
| Since | Origin / Contributor | Maintainer | Source |
| :----- | :-------------------- | :---------- | :------ |
| 2017-12-30 | [Konrad Huebner](https://github.com/skycoders) | [Konrad Huebner](https://github.com/skycoders) | [color_utils.c](../../../app/modules/color_utils.c)|
The color_utils module provides some basic color transformations useful for color LEDs. It is used by the WS2812_EFFECTS module.
This module provides basic color transformations useful for color LEDs.
## color_utils.hsv2grb()
Convert HSV color to GRB color.
@ -13,9 +12,9 @@ Convert HSV color to GRB color.
`color_utils.hsv2grb(hue, saturation, value)`
#### Parameters
- `hue` is the hue value, between 0 and 360.
- `saturation` is the saturation value, between 0 and 255.
- `value` is the value value, between 0 and 255.
- `hue` is the hue value, between 0 and 360
- `saturation` is the saturation value, between 0 and 255
- `value` is the value value, between 0 and 255
#### Returns
`green`, `red`, `blue` as values between 0 and 255
@ -27,9 +26,9 @@ Convert HSV color to GRB color and explicitly return a white value. This can be
`color_utils.hsv2grbw(hue, saturation, value)`
#### Parameters
- `hue` is the hue value, between 0 and 360.
- `saturation` is the saturation value, between 0 and 255.
- `value` is the value value, between 0 and 255.
- `hue` is the hue value, between 0 and 360
- `saturation` is the saturation value, between 0 and 255
- `value` is the value value, between 0 and 255
#### Returns
`green`, `red`, `blue`, `white` as values between 0 and 255
@ -41,9 +40,9 @@ Convert GRB color to HSV color.
`color_utils.grb2hsv(green, red, blue)`
#### Parameters
- `green` is the green value, between 0 and 255.
- `red` is the red value, between 0 and 255.
- `blue` is the blue value, between 0 and 255.
- `green` is the green value, between 0 and 255
- `red` is the red value, between 0 and 255
- `blue` is the blue value, between 0 and 255
#### Returns
`hue`, `saturation`, `value` as values between 0 and 360, respective 0 and 255
@ -58,4 +57,4 @@ The color wheel function makes use of the HSV color space and calculates colors
- `angle` is the angle on the color circle, between 0 and 359
#### Returns
`green`, `red`, `blue` as values between 0 and 255.
`green`, `red`, `blue` as values between 0 and 255

22
docs/en/modules/ws2812-effects.md
View File

@ -1,11 +1,15 @@
# WS2812_EFFECTS Module
# WS2812 effects Module
| Since | Origin / Contributor | Maintainer | Source |
| :----- | :-------------------- | :---------- | :------ |
| 2017-11-01 | [Konrad Huebner](https://github.com/skycoders) | [ws2812_effects.c](../../../app/modules/ws2812_effects.c)|
| 2017-11-01 | [Konrad Huebner](https://github.com/skycoders) | [Konrad Huebner](https://github.com/skycoders) | [ws2812_effects.c](../../../app/modules/ws2812_effects.c)|
The ws2812_effects module provides effects based on the ws2812 library. Some effects are inspired by / based on the [WS2812FX Library](https://github.com/kitesurfer1404/WS2812FX) but have been adopted to the specifics of the ws2812 library. The effects library works based on a buffer created through the ws2812 library and performs the operations on this buffer.
This module provides effects based on the [WS2812 library](ws2812.md). Some effects are inspired by / based on the [WS2812FX Library](https://github.com/kitesurfer1404/WS2812FX) but have been adopted to the specifics of the ws2812 library. The effects library works based on a buffer created through the ws2812 library and performs the operations on this buffer.
ATTENTION: Dual mode is currently not supported for effects.
Note that dual mode is currently not supported for effects.
!!! caution
This module depends on the [color utils module](color-utils.md). Things **will** fail if that module is missing in the firmware!
#### Example usage
```lua
@ -60,7 +64,7 @@ Stop the animation effect.
## ws2812_effects.set_brightness()
Set the brightness
Set the brightness.
#### Syntax
`ws2812_effects.set_brightness(brightness)`
@ -72,7 +76,7 @@ Set the brightness
`nil`
## ws2812_effects.set_color()
Set the color
Set the color.
#### Syntax
`ws2812_effects.set_color(g, r, b, [w])`
@ -87,7 +91,7 @@ Set the color
`nil`
## ws2812_effects.set_speed()
Set the speed
Set the speed.
#### Syntax
`ws2812_effects.set_speed(speed)`
@ -100,7 +104,7 @@ Set the speed
## ws2812_effects.get_speed()
Get current speed
Get current speed.
#### Syntax
`ws2812_effects.get_speed()`
@ -125,7 +129,7 @@ Set the delay between two effect steps in milliseconds.
`nil`
## ws2812_effects.get_delay()
Get current delay
Get current delay.
#### Syntax
`ws2812_effects.get_delay()`