diff --git a/wpilibc/src/main/native/include/frc/AddressableLED.h b/wpilibc/src/main/native/include/frc/AddressableLED.h index 5534ae4dd1..1d95ec5920 100644 --- a/wpilibc/src/main/native/include/frc/AddressableLED.h +++ b/wpilibc/src/main/native/include/frc/AddressableLED.h @@ -1,5 +1,5 @@ /*----------------------------------------------------------------------------*/ -/* Copyright (c) 2019 FIRST. All Rights Reserved. */ +/* Copyright (c) 2019-2020 FIRST. All Rights Reserved. */ /* Open Source Software - may be modified and shared by FRC teams. The code */ /* must be accompanied by the FIRST BSD license file in the root directory of */ /* the project. */ @@ -22,6 +22,8 @@ namespace frc { /** * A class for driving addressable LEDs, such as WS2812s and NeoPixels. + * + *
Only 1 LED driver is currently supported by the roboRIO. */ class AddressableLED : public ErrorBase { public: @@ -83,7 +85,7 @@ class AddressableLED : public ErrorBase { /** * Constructs a new driver for a specific port. * - * @param port the output port to use (Must be a PWM port) + * @param port the output port to use (Must be a PWM header) */ explicit AddressableLED(int port); @@ -95,6 +97,8 @@ class AddressableLED : public ErrorBase { *
Calling this is an expensive call, so its best to call it once, then * just update data. * + *
The max length is 5460 LEDs. + * * @param length the strip length */ void SetLength(int length); diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/AddressableLED.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/AddressableLED.java index 223c6f20a7..f2ab81b9fd 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/AddressableLED.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/AddressableLED.java @@ -1,5 +1,5 @@ /*----------------------------------------------------------------------------*/ -/* Copyright (c) 2019 FIRST. All Rights Reserved. */ +/* Copyright (c) 2019-2020 FIRST. All Rights Reserved. */ /* Open Source Software - may be modified and shared by FRC teams. The code */ /* must be accompanied by the FIRST BSD license file in the root directory of */ /* the project. */ @@ -14,6 +14,8 @@ import edu.wpi.first.hal.PWMJNI; /** * A class for driving addressable LEDs, such as WS2812s and NeoPixels. + * + *
Only 1 LED driver is currently supported by the roboRIO. */ public class AddressableLED implements AutoCloseable { private final int m_pwmHandle; @@ -22,7 +24,7 @@ public class AddressableLED implements AutoCloseable { /** * Constructs a new driver for a specific port. * - * @param port the output port to use (Must be a PWM port) + * @param port the output port to use (Must be a PWM header, not on MXP) */ public AddressableLED(int port) { m_pwmHandle = PWMJNI.initializePWMPort(HAL.getPort((byte) port)); @@ -45,6 +47,8 @@ public class AddressableLED implements AutoCloseable { * *
Calling this is an expensive call, so its best to call it once, then just update data. * + *
The max length is 5460 LEDs. + * * @param length the strip length */ public void setLength(int length) {