Class XCANLightController

java.lang.Object
xbot.common.controls.actuators.XCANLightController
Direct Known Subclasses:
CANdleWpiAdapter, MockCANLightController

public abstract class XCANLightController extends Object
Abstract base class for CAN-based light controllers.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Types of animations supported by the light controller.
    static interface 
    Factory interface for creating instances of XCANLightController.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final CANBusId
     
     
    protected final int
     
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Constructor for XCANLightController.
  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    clearAnimation(int slot)
     
    abstract void
    colorFlow(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color)
     
    abstract void
    fire(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness, double cooling, double sparking)
     
    abstract DeviceHealth
     
    protected int
    getSlotEndIndex(int slot)
     
    protected int
     
    abstract void
    larson(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color, LarsonBounceValue bounceValue)
     
    abstract void
    rainbow(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness, AnimationDirectionValue animationDirection)
     
    abstract void
    rgbFade(int slot, org.wpilib.units.measure.Frequency frameRate, double brightness)
     
    abstract void
    singleFade(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color)
     
    abstract void
    strobe(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color)
     
    abstract void
    twinkle(int slot, org.wpilib.units.measure.Frequency frameRate, org.wpilib.util.Color color)
     
    abstract void
    twinkleOff(int slot, org.wpilib.units.measure.Frequency frameRate, double density, org.wpilib.util.Color color)
     

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • XCANLightController

      protected XCANLightController(CANLightControllerInfo info, DevicePolice police)
      Constructor for XCANLightController.
      Parameters:
      info - The CAN light controller information.
      police - The device police for registering the device.
  • Method Details

    • getHealth

      public abstract DeviceHealth 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)