Class XCANLightController
java.lang.Object
xbot.common.controls.actuators.XCANLightController
- Direct Known Subclasses:
CANdleWpiAdapter, MockCANLightController
Abstract base class for CAN-based light controllers.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumTypes of animations supported by the light controller.static interfaceFactory interface for creating instances of XCANLightController. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final CANBusIdprotected final CANLightControllerOutputConfigprotected final int -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedXCANLightController(CANLightControllerInfo info, DevicePolice police) Constructor for XCANLightController. -
Method Summary
Modifier and TypeMethodDescriptionabstract voidclearAnimation(int slot) abstract voidcolorFlow(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color) abstract voidfire(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness, double cooling, double sparking) abstract DeviceHealthprotected intgetSlotEndIndex(int slot) protected intgetSlotStartIndex(int slot) abstract voidlarson(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color, LarsonBounceValue bounceValue) abstract voidrainbow(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness, AnimationDirectionValue animationDirection) abstract voidrgbFade(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness) abstract voidsingleFade(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color) abstract voidstrobe(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color) abstract voidtwinkle(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color) abstract voidtwinkleOff(int slot, org.wpilib.units.measure.Frequency frameRate, double density, org.wpilib.util.Color color)
-
Field Details
-
busId
-
deviceId
protected final int deviceId -
config
-
-
Constructor Details
-
XCANLightController
Constructor for XCANLightController.- Parameters:
info- The CAN light controller information.police- The device police for registering the device.
-
-
Method Details
-
getHealth
-
getSlotStartIndex
protected int getSlotStartIndex(int slot) -
getSlotEndIndex
protected int getSlotEndIndex(int slot) -
clearAnimation
public abstract void clearAnimation(int slot) -
colorFlow
public abstract void colorFlow(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color) -
fire
public abstract void fire(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness, double cooling, double sparking) -
larson
public abstract void larson(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color, LarsonBounceValue bounceValue) -
rainbow
public abstract void rainbow(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness, AnimationDirectionValue animationDirection) -
rgbFade
public abstract void rgbFade(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness) -
singleFade
public abstract void singleFade(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color) -
strobe
public abstract void strobe(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color) -
twinkleOff
public abstract void twinkleOff(int slot, org.wpilib.units.measure.Frequency frameRate, double density, org.wpilib.util.Color color) -
twinkle
public abstract void twinkle(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color)
-