com.mach.LightDrive

Class LightDriveSerial

java.lang.Object

com.mach.LightDrive.LightDriveSerial

public final class LightDriveSerial
extends java.lang.Object

Class for controlling LightDrive-12 via CANbus.

Constructor Summary

Constructors

Constructor and Description
LightDriveSerial() Creates an instance of LightDriveSerial to control the LightDrive12 via MXP Serial Port.
LightDriveSerial(edu.wpi.first.wpilibj.SerialPort.Port port) Creates an instance of LightDriveSerial to control the LightDrive12 via the specified port.

Method Summary

Modifier and Type	Method and Description
float	GetCurrent(int ch) Return the approximate current from the specified channel bank
int	GetFWVersion() Returns the attached LightDrive's firmware version
Status	GetStatus() Returns a Status class for the LightDrive
float	GetTotalCurrent() Returns the total approximate LightDrive current.
float	GetVoltage() Returns the LightDrive input voltage
void	SetColor(int ch, java.awt.Color color) Set the given channel's Color
void	SetColor(int ch, java.awt.Color color, double brightness) Set the given channel's Color with a brightness scalar
void	SetLevel(int ch, byte level) Sets the raw pwm output value for a desired channel
void	Update() Send new data to LightDrive.

Methods inherited from class java.lang.Object

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

Constructor Detail

LightDriveSerial

public LightDriveSerial()

Creates an instance of LightDriveSerial to control the LightDrive12 via MXP Serial Port. Note - You may specify another port using the other constructor, but this is the only built-in port directly compatible with the LightDrive inputs.

LightDriveSerial

public LightDriveSerial(edu.wpi.first.wpilibj.SerialPort.Port port)

Creates an instance of LightDriveSerial to control the LightDrive12 via the specified port. Note - You may specify a port using this constructor, but the MXP port is the only built-in port directly compatible with the LightDrive inputs.

Method Detail

Update

public void Update()

Send new data to LightDrive. Call this each time the display should update

SetColor

public void SetColor(int ch,
                     java.awt.Color color)

Set the given channel's Color

Parameters:

ch - Int (1-4) representing the desired bank of channels to set

color - Color class representing the desired Color

SetColor

public void SetColor(int ch,
                     java.awt.Color color,
                     double brightness)

Set the given channel's Color with a brightness scalar

Parameters:

ch - Int (1-4) representing the desired bank of channels to set

color - Color class representing the desired Color

brightness - Double representing the desired brightness scaled 0.0 to 1.0

SetLevel

public void SetLevel(int ch,
                     byte level)

Sets the raw pwm output value for a desired channel

Parameters:

ch - Int (1-12) representing the desired channel

level - Byte (0-255) representing the desired duty cycle scaled 0 to 255

GetCurrent

public float GetCurrent(int ch)

Return the approximate current from the specified channel bank

Parameters:

ch - Int (1-4) indicating the desired bank to read from

Returns:

Float representing the bank's current in A. -1.0 if invalid channel given

GetTotalCurrent

public float GetTotalCurrent()

Returns the total approximate LightDrive current.

Returns:

Float representing total current in A.

GetVoltage

public float GetVoltage()

Returns the LightDrive input voltage

Returns:

Float representing input voltage in V.

GetFWVersion

public int GetFWVersion()

Returns the attached LightDrive's firmware version

Returns:

Int representing firmware version

GetStatus

public Status GetStatus()

Returns a Status class for the LightDrive

Returns:

Status Class representing LightDrive's status