Package xbot.common.controls.actuators

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	XCANLightController.AnimationType	Types of animations supported by the light controller.
static interface	XCANLightController.XCANLightControllerFactory	Factory interface for creating instances of XCANLightController.

Field Summary

Fields

Modifier and Type	Field	Description
protected final CANBusId	busId
protected final CANLightControllerOutputConfig	config
protected final int	deviceId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XCANLightController(CANLightControllerInfo info, DevicePolice police)	Constructor for XCANLightController.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

busId

protected final CANBusId busId

deviceId

protected final int deviceId

config

protected final CANLightControllerOutputConfig config

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,
 Frequency frameRate,
 Color color)

fire

public abstract void fire(int slot,
 Frequency frameRate,
 double brightness,
 double cooling,
 double sparking)

larson

public abstract void larson(int slot,
 Frequency frameRate,
 Color color,
 LarsonBounceValue bounceValue)

rainbow

public abstract void rainbow(int slot,
 Frequency frameRate,
 double brightness,
 AnimationDirectionValue animationDirection)

rgbFade

public abstract void rgbFade(int slot,
 Frequency frameRate,
 double brightness)

singleFade

public abstract void singleFade(int slot,
 Frequency frameRate,
 Color color)

strobe

public abstract void strobe(int slot,
 Frequency frameRate,
 Color color)

twinkleOff

public abstract void twinkleOff(int slot,
 Frequency frameRate,
 double density,
 Color color)

twinkle

public abstract void twinkle(int slot,
 Frequency frameRate,
 Color color)