Change "neopixel" references to use RGB LED naming (#10225)

* fix(rgbled): fixes core rgbledWrite()

* fix(rgbled): fixes examples - rgbledWrite()

* fix(rgbled): fixes variants commetaries - rgbledWrite()

* fix(rgbled): examples and doc - use RGB_LED naming

* fix(rgbled): variants - use RGB_LED naming

* fix(rgbled): other places for RGB LED naming

* fix(typo): cores - rgbLed instead of rgbled

* fix(typo): examples - rgbLed instead of rgbled

* fix(typo): variants commentaties - rgbLed instead of rgbled

* fix(rgbled): bad file name

* fix(typo): typo and commentaries

Co-authored-by: Lucas Saavedra Vaz <[email protected]>

* fix(rgbled): deprecating neopixelWrite()

* fix(rgbled): use RGB LED naming

* fix(rgbled): document formatting

* fix(rgbled): neopixelWrite() is now deprecated

* fix(rgbled): removed attribute in wrong place

* just a git push test

* restart git bash test

* ci(pre-commit): Apply automatic fixes

* removed wrong test file

* fix(rgbled): new Arduino style depreacted attribute

---------

Co-authored-by: Lucas Saavedra Vaz <[email protected]>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: 3 people

cores/esp32/esp32-hal-gpio.c

@@ -166,7 +166,7 @@ extern void ARDUINO_ISR_ATTR __digitalWrite(uint8_t pin, uint8_t val) {
     //use RMT to set all channels on/off
     RGB_BUILTIN_storage = val;
     const uint8_t comm_val = val != 0 ? RGB_BRIGHTNESS : 0;
-    neopixelWrite(RGB_BUILTIN, comm_val, comm_val, comm_val);
+    rgbLedWrite(RGB_BUILTIN, comm_val, comm_val, comm_val);
     return;
   }
 #endif  // RGB_BUILTIN

cores/esp32/esp32-hal-rgb-led.c

@@ -16,6 +16,12 @@
 
 #include "esp32-hal-rgb-led.h"
 
+// Backward compatibility - Deprecated. It will be removed in future releases.
+void neopixelWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val) {
+  log_w("neopixelWrite() is deprecated. Use rgbLedWrite().");
+  rgbLedWrite(pin, red_val, green_val, blue_val);
+}
+
 void rgbLedWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val) {
   rgbLedWriteOrdered(pin, RGB_BUILTIN_LED_COLOR_ORDER, red_val, green_val, blue_val);
 }

cores/esp32/esp32-hal-rgb-led.h

@@ -29,8 +29,9 @@ void rgbLedWriteOrdered(uint8_t pin, rgb_led_color_order_t order, uint8_t red_va
 // Will use RGB_BUILTIN_LED_COLOR_ORDER
 void rgbLedWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val);
 
-// Backward compatibility
-#define neopixelWrite(p, r, g, b) rgbLedWrite(p, r, g, b)
+// Backward compatibility - Deprecated. It will be removed in future releases.
+[[deprecated("Use rgbLedWrite() instead.")]]
+void neopixelWrite(uint8_t p, uint8_t r, uint8_t g, uint8_t b);
 
 #ifdef __cplusplus
 }

cores/esp32/io_pin_remap.h

@@ -77,7 +77,7 @@ int8_t gpioNumberToDigitalPin(int8_t gpioNumber);
 #define pinMatrixOutDetach(pin, invertOut, invertEnable)           pinMatrixOutDetach(digitalPinToGPIONumber(pin), invertOut, invertEnable)
 
 // cores/esp32/esp32-hal-rgb-led.h
-#define neopixelWrite(pin, red_val, green_val, blue_val) neopixelWrite(digitalPinToGPIONumber(pin), red_val, green_val, blue_val)
+#define rgbLedWrite(pin, red_val, green_val, blue_val) rgbLedWrite(digitalPinToGPIONumber(pin), red_val, green_val, blue_val)
 
 // cores/esp32/esp32-hal-rmt.h
 #define rmtInit(pin, channel_direction, memsize, frequency_Hz) rmtInit(digitalPinToGPIONumber(pin), channel_direction, memsize, frequency_Hz)

docs/en/api/rmt.rst

@@ -14,10 +14,10 @@ Example
 
 To get started with RMT, you can try:
 
-RMT Write Neo Pixel
-*******************
+RMT Write RGB LED
+*****************
 
-.. literalinclude:: ../../../libraries/ESP32/examples/RMT/RMTWriteNeoPixel/RMTWriteNeoPixel.ino
+.. literalinclude:: ../../../libraries/ESP32/examples/RMT/RMTWrite_RGB_LED/RMTWrite_RGB_LED.ino
     :language: arduino
 
 

libraries/ESP32/examples/GPIO/BlinkRGB/BlinkRGB.ino

@@ -6,7 +6,7 @@
   Calling digitalWrite(RGB_BUILTIN, HIGH) will use hidden RGB driver.
 
   RGBLedWrite demonstrates control of each channel:
-  void neopixelWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val)
+  void rgbLedWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val)
 
   WARNING: After using digitalWrite to drive RGB LED it will be impossible to drive the same pin
     with normal HIGH/LOW level
@@ -27,13 +27,13 @@ void loop() {
   digitalWrite(RGB_BUILTIN, LOW);  // Turn the RGB LED off
   delay(1000);
 
-  neopixelWrite(RGB_BUILTIN, RGB_BRIGHTNESS, 0, 0);  // Red
+  rgbLedWrite(RGB_BUILTIN, RGB_BRIGHTNESS, 0, 0);  // Red
   delay(1000);
-  neopixelWrite(RGB_BUILTIN, 0, RGB_BRIGHTNESS, 0);  // Green
+  rgbLedWrite(RGB_BUILTIN, 0, RGB_BRIGHTNESS, 0);  // Green
   delay(1000);
-  neopixelWrite(RGB_BUILTIN, 0, 0, RGB_BRIGHTNESS);  // Blue
+  rgbLedWrite(RGB_BUILTIN, 0, 0, RGB_BRIGHTNESS);  // Blue
   delay(1000);
-  neopixelWrite(RGB_BUILTIN, 0, 0, 0);  // Off / black
+  rgbLedWrite(RGB_BUILTIN, 0, 0, 0);  // Off / black
   delay(1000);
 #endif
 }

libraries/ESP32/examples/RMT/Legacy_RMT_Driver_Compatible/Legacy_RMT_Driver_Compatible.ino

@@ -17,7 +17,7 @@
 #else
 
 // add the file "build_opt.h" to your Arduino project folder with "-DESP32_ARDUINO_NO_RGB_BUILTIN" to use the RMT Legacy driver
-// neoPixelWrite() is a function that writes to the RGB LED and it won't be available here
+// rgbLedWrite() is a function that writes to the RGB LED and it won't be available here
 #include "driver/rmt.h"
 
 bool installed = false;

libraries/ESP32/examples/RMT/RMTWriteNeoPixel/RMTWriteNeoPixel.ino renamed to libraries/ESP32/examples/RMT/RMTWrite_RGB_LED/RMTWrite_RGB_LED.ino

@@ -1,4 +1,4 @@
-// Copyright 2023 Espressif Systems (Shanghai) PTE LTD
+// Copyright 2024 Espressif Systems (Shanghai) PTE LTD
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -20,17 +20,17 @@
  */
 
 // The effect seen in (Espressif devkits) ESP32C6, ESP32H2, ESP32C3, ESP32S2 and ESP32S3 is like a Blink of RGB LED
-#ifdef PIN_NEOPIXEL
-#define BUILTIN_RGBLED_PIN PIN_NEOPIXEL
+#ifdef PIN_LED_RGB
+#define BUILTIN_RGBLED_PIN PIN_LED_RGB
 #else
-#define BUILTIN_RGBLED_PIN 21  // ESP32 has no builtin RGB LED (PIN_NEOPIXEL)
+#define BUILTIN_RGBLED_PIN 21  // ESP32 has no builtin RGB LED (PIN_LED_RGB)
 #endif
 
 #define NR_OF_LEDS     8 * 4
 #define NR_OF_ALL_BITS 24 * NR_OF_LEDS
 
 //
-// Note: This example uses Neopixel LED board, 32 LEDs chained one
+// Note: This example uses a board with 32 WS2812b LEDs chained one
 //      after another, each RGB LED has its 24 bit value
 //      for color configuration (8b for each color)
 //

libraries/ESP32/examples/RMT/RMT_CPUFreq_Test/RMT_CPUFreq_Test.ino

@@ -17,7 +17,7 @@
  * that RMT works on any CPU/APB Frequency.
  *
  * It uses an ESP32 Arduino builtin RGB NeoLED function based on RMT:
- * void neopixelWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val)
+ * void rgbLedWrite(uint8_t pin, uint8_t red_val, uint8_t green_val, uint8_t blue_val)
  *
  * The output is a visual WS2812 RGB LED color change routine using each time a
  * different CPU Frequency, just to illustrate how it works. Serial output indicates
@@ -26,10 +26,10 @@
 
 // Default DevKit RGB LED GPIOs:
 // The effect seen in (Espressif devkits) ESP32C6, ESP32H2, ESP32C3, ESP32S2 and ESP32S3 is like a Blink of RGB LED
-#ifdef PIN_NEOPIXEL
-#define MY_LED_GPIO PIN_NEOPIXEL
+#ifdef PIN_RGB_LED
+#define MY_LED_GPIO PIN_RGB_LED
 #else
-#define MY_LED_GPIO 21  // ESP32 has no builtin RGB LED (PIN_NEOPIXEL)
+#define MY_LED_GPIO 21  // ESP32 has no builtin RGB LED (PIN_RGB_LED)
 #endif
 
 // Set the correct GPIO to any necessary by changing RGB_LED_GPIO value
@@ -65,22 +65,22 @@ void loop() {
   Serial.updateBaudRate(115200);
   Serial.printf("\n--changed CPU Frequency to %lu MHz\n", getCpuFrequencyMhz());
 
-  neopixelWrite(RGB_LED_GPIO, BRIGHTNESS, BRIGHTNESS, BRIGHTNESS);  // White
+  rgbLedWrite(RGB_LED_GPIO, BRIGHTNESS, BRIGHTNESS, BRIGHTNESS);  // White
   Serial.println("White");
   delay(1000);
-  neopixelWrite(RGB_LED_GPIO, 0, 0, 0);  // Off
+  rgbLedWrite(RGB_LED_GPIO, 0, 0, 0);  // Off
   Serial.println("Off");
   delay(1000);
-  neopixelWrite(RGB_LED_GPIO, BRIGHTNESS, 0, 0);  // Red
+  rgbLedWrite(RGB_LED_GPIO, BRIGHTNESS, 0, 0);  // Red
   Serial.println("Red");
   delay(1000);
-  neopixelWrite(RGB_LED_GPIO, 0, BRIGHTNESS, 0);  // Green
+  rgbLedWrite(RGB_LED_GPIO, 0, BRIGHTNESS, 0);  // Green
   Serial.println("Green");
   delay(1000);
-  neopixelWrite(RGB_LED_GPIO, 0, 0, BRIGHTNESS);  // Blue
+  rgbLedWrite(RGB_LED_GPIO, 0, 0, BRIGHTNESS);  // Blue
   Serial.println("Blue");
   delay(1000);
-  neopixelWrite(RGB_LED_GPIO, 0, 0, 0);  // Off
+  rgbLedWrite(RGB_LED_GPIO, 0, 0, 0);  // Off
   Serial.println("Off");
   delay(1000);
 }

libraries/ESP32/examples/Zigbee/Zigbee_Light_Bulb/README.md

@@ -20,7 +20,7 @@ Currently, this example supports the following targets.
 ### Configure the Project
 
 Set the LED GPIO by changing the `LED_PIN` definition. By default, the LED_PIN is `RGB_BUILTIN`.
-By default, the `neoPixelWrite` function is used to control the LED. You can change it to digitalWrite to control a simple LED.
+By default, the `rgbLedWrite` function is used to control the LED. You can change it to digitalWrite to control a simple LED.
 
 #### Using Arduino IDE