From a04b085d71d918a430c77c6736861be18ab7b608 Mon Sep 17 00:00:00 2001
From: Nathaniel Wesley Filardo <nwfilardo@gmail.com>
Date: Tue, 26 May 2020 12:42:42 +0100
Subject: [PATCH] ws2812_effects deprecation warning

---
 app/modules/ws2812_effects.c   | 4 ++++
 docs/modules/ws2812-effects.md | 6 ++++++
 2 files changed, 10 insertions(+)

diff --git a/app/modules/ws2812_effects.c b/app/modules/ws2812_effects.c
index 6bcbcb21..6333ab5e 100644
--- a/app/modules/ws2812_effects.c
+++ b/app/modules/ws2812_effects.c
@@ -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
diff --git a/docs/modules/ws2812-effects.md b/docs/modules/ws2812-effects.md
index e459a5f8..b83a7ab2 100644
--- a/docs/modules/ws2812-effects.md
+++ b/docs/modules/ws2812-effects.md
@@ -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!