add note about support for WS2815

wpilibsuite · Jan 10, 2025 · 30fe332 · 30fe332
1 parent 638d265
commit 30fe332
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/hal/src/main/java/edu/wpi/first/hal/AddressableLEDJNI.java b/hal/src/main/java/edu/wpi/first/hal/AddressableLEDJNI.java
@@ -53,7 +53,7 @@ public class AddressableLEDJNI extends JNIWrapper {
   /**
    * Sets the bit timing.
    *
-   * <p>By default, the driver is set up to drive WS2812Bs, so nothing needs to be set for those.
+   * <p>By default, the driver is set up to drive WS2812B and WS2815, so nothing needs to be set for those.
    *
    * @param handle the Addressable LED handle
    * @param highTime0NanoSeconds high time for 0 bit (default 400ns)
@@ -72,7 +72,7 @@ public static native void setBitTiming(
   /**
    * Sets the sync time.
    *
-   * <p>The sync time is the time to hold output so LEDs enable. Default set for WS2812B.
+   * <p>The sync time is the time to hold output so LEDs enable. Default set for WS2812B and WS2815.
    *
    * @param handle the Addressable LED handle
    * @param syncTimeMicroSeconds the sync time (default 280us)

diff --git a/hal/src/main/native/include/hal/AddressableLED.h b/hal/src/main/native/include/hal/AddressableLED.h
@@ -77,7 +77,7 @@ void HAL_WriteAddressableLEDData(HAL_AddressableLEDHandle handle,
 /**
  * Sets the bit timing.
  *
- * <p>By default, the driver is set up to drive WS2812Bs, so nothing needs to
+ * <p>By default, the driver is set up to drive WS2812B and WS2815, so nothing needs to
  * be set for those.
  *
  * @param[in] handle the Addressable LED handle
@@ -98,7 +98,7 @@ void HAL_SetAddressableLEDBitTiming(HAL_AddressableLEDHandle handle,
  * Sets the sync time.
  *
  * <p>The sync time is the time to hold output so LEDs enable. Default set for
- * WS2812B.
+ * WS2812B and WS2815.
  *
  * @param[in] handle the Addressable LED handle
  * @param[in] syncTimeMicroSeconds the sync time (default 280us)

diff --git a/wpilibc/src/main/native/include/frc/AddressableLED.h b/wpilibc/src/main/native/include/frc/AddressableLED.h
@@ -19,9 +19,9 @@
 namespace frc {
 
 /**
- * A class for driving addressable LEDs, such as WS2812Bs and NeoPixels.
+ * A class for driving addressable LEDs, such as WS2812B, WS2815, and NeoPixels.
  *
- * By default, the timing supports WS2812B LEDs, but is configurable using
+ * By default, the timing supports WS2812B and WS2815 LEDs, but is configurable using
  * SetBitTiming()
  *
  * <p>Only 1 LED driver is currently supported by the roboRIO. However,
@@ -130,7 +130,7 @@ class AddressableLED {
   /**
    * Sets the bit timing.
    *
-   * <p>By default, the driver is set up to drive WS2812Bs, so nothing needs to
+   * <p>By default, the driver is set up to drive WS2812B and WS2815, so nothing needs to
    * be set for those.
    *
    * @param highTime0 high time for 0 bit (default 400ns)
@@ -146,7 +146,7 @@ class AddressableLED {
    * Sets the sync time.
    *
    * <p>The sync time is the time to hold output so LEDs enable. Default set for
-   * WS2812B.
+   * WS2812B and WS2815.
    *
    * @param syncTime the sync time (default 280us)
    */

diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/AddressableLED.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/AddressableLED.java
@@ -10,9 +10,9 @@
 import edu.wpi.first.hal.PWMJNI;
 
 /**
- * A class for driving addressable LEDs, such as WS2812Bs and NeoPixels.
+ * A class for driving addressable LEDs, such as WS2812B, WS2815, and NeoPixels.
  *
- * <p>By default, the timing supports WS2812B LEDs, but is configurable using setBitTiming()
+ * <p>By default, the timing supports WS2812B and WS2815 LEDs, but is configurable using setBitTiming()
  *
  * <p>Only 1 LED driver is currently supported by the roboRIO. However, multiple LED strips can be
  * connected in series and controlled from the single driver.
@@ -70,7 +70,7 @@ public void setData(AddressableLEDBuffer buffer) {
   /**
    * Sets the bit timing.
    *
-   * <p>By default, the driver is set up to drive WS2812Bs, so nothing needs to be set for those.
+   * <p>By default, the driver is set up to drive WS2812B and WS2815, so nothing needs to be set for those.
    *
    * @param highTime0NanoSeconds high time for 0 bit (default 400ns)
    * @param lowTime0NanoSeconds low time for 0 bit (default 900ns)
@@ -93,7 +93,7 @@ public void setBitTiming(
   /**
    * Sets the sync time.
    *
-   * <p>The sync time is the time to hold output so LEDs enable. Default set for WS2812B.
+   * <p>The sync time is the time to hold output so LEDs enable. Default set for WS2812B and WS2815.
    *
    * @param syncTimeMicroSeconds the sync time (default 280us)
    */