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

ws2812_effects deprecation warning

This commit is contained in:
Nathaniel Wesley Filardo 2020-05-26 12:42:42 +01:00 committed by Marcel Stör
parent 98e428f12e
commit a04b085d71
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
app/modules/ws2812_effects.c
View File

@ -156,6 +156,10 @@ static uint8_t get_random_wheel_index(uint8_t pos)
* initialized ws2812_effects with the buffer to use
*/
static int ws2812_effects_init(lua_State *L) {
platform_print_deprecation_note("ws2812_effects",
"soon; please see https://github.com/nodemcu/nodemcu-firmware/issues/3122");
ws2812_buffer * buffer = (ws2812_buffer*)luaL_checkudata(L, 1, "ws2812.buffer");
luaL_argcheck(L, buffer != NULL, 1, "no valid buffer provided");
// get rid of old state

6
docs/modules/ws2812-effects.md
View File

@ -7,6 +7,12 @@ This module provides effects based on the [WS2812 library](ws2812.md). Some effe
Note that dual mode is currently not supported for effects.
!!! caution
This module is deprecated and will be removed in favor of a generic,
in-Lua implementation soon. (Sooner with help!) Please see
https://github.com/nodemcu/nodemcu-firmware/issues/3122 .
!!! caution
This module depends on the [color utils module](color-utils.md). Things **will** fail if that module is missing in the firmware!