Commit a04b085d authored by Nathaniel Wesley Filardo's avatar Nathaniel Wesley Filardo Committed by Marcel Stör
Browse files

ws2812_effects deprecation warning

parent 98e428f1
...@@ -156,6 +156,10 @@ static uint8_t get_random_wheel_index(uint8_t pos) ...@@ -156,6 +156,10 @@ static uint8_t get_random_wheel_index(uint8_t pos)
* initialized ws2812_effects with the buffer to use * initialized ws2812_effects with the buffer to use
*/ */
static int ws2812_effects_init(lua_State *L) { 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"); ws2812_buffer * buffer = (ws2812_buffer*)luaL_checkudata(L, 1, "ws2812.buffer");
luaL_argcheck(L, buffer != NULL, 1, "no valid buffer provided"); luaL_argcheck(L, buffer != NULL, 1, "no valid buffer provided");
// get rid of old state // get rid of old state
......
...@@ -7,6 +7,12 @@ This module provides effects based on the [WS2812 library](ws2812.md). Some effe ...@@ -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. 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 !!! caution
This module depends on the [color utils module](color-utils.md). Things **will** fail if that module is missing in the firmware! This module depends on the [color utils module](color-utils.md). Things **will** fail if that module is missing in the firmware!
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment