io.github.thunderbots.lightning.utility

Class Telemetry

java.lang.Object

io.github.thunderbots.lightning.utility.Telemetry

public final class Telemetry
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private static com.qualcomm.robotcore.robocol.Telemetry	robotTelemetry The telemetry link between the robot controller and the driver station.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Telemetry() Telemetry should not be instantiable.

Method Summary

Modifier and Type	Method and Description
static void	sendData(java.lang.Object data) Deprecated. Since this method is a delegate that substitutes an empty string for the tag, all objects that are sent with this method will have an identical tag. The telemetry system assumes that multiple objects sent with the same tag are just different versions of the same information, and that only the most recent version of the object is the 'correct' version. If multiple objects are sent with the same tag, only the most recently sent object will be displayed, and all others will be discarded. This makes it very impractical to send data with an empty tag, because the telemetry system will discard potentially important data.
static void	sendData(java.lang.String tag, java.lang.Object data) Sends given data from the robot controller to the driver station.
static void	sendMotor(Motor m) Sends motor data from the robot controller to the driver station.
static void	sendMotorPosition(Motor m) Sends motor data from the robot controller to the driver station.
static void	sendMotorPower(Motor m) Sends motor data from the robot controller to the driver station.
static void	sendServoPosition(Servo s) Sends servo data from the robot controller to the driver station.
static void	setTelemetry(com.qualcomm.robotcore.robocol.Telemetry telemetry)

Methods inherited from class java.lang.Object

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

Field Detail

robotTelemetry

private static com.qualcomm.robotcore.robocol.Telemetry robotTelemetry

The telemetry link between the robot controller and the driver station. It is used, among other things, to send debug information from the robot controller to the driver station.

See Also:

Telemetry

Constructor Detail

Telemetry

private Telemetry()

Telemetry should not be instantiable.

Method Detail

setTelemetry

public static void setTelemetry(com.qualcomm.robotcore.robocol.Telemetry telemetry)

sendData

public static void sendData(java.lang.String tag,
                            java.lang.Object data)

Sends given data from the robot controller to the driver station. Any object can be sent, but the object's toString() method will be called and the string representation of the object is what will actually be sent. The data will be displayed in the bottom portion of the driver station's screen.

Parameters:

tag - a very short description of the data that is being sent. Ideally this string should be around 1-8 characters long, but an upper limit on characters is currently not known.

data - the object to be sent.

sendData

public static void sendData(java.lang.Object data)

Deprecated. Since this method is a delegate that substitutes an empty string for the tag, all objects that are sent with this method will have an identical tag. The telemetry system assumes that multiple objects sent with the same tag are just different versions of the same information, and that only the most recent version of the object is the 'correct' version. If multiple objects are sent with the same tag, only the most recently sent object will be displayed, and all others will be discarded. This makes it very impractical to send data with an empty tag, because the telemetry system will discard potentially important data.

Sends given data from the robot controller to the driver station. This method acts as a delegate to sendData(String, Object), but replaces the tag argument with an empty string.

Parameters:

data - the object to be sent.

See Also:

sendData(String, Object)

sendMotor

public static void sendMotor(Motor m)

Sends motor data from the robot controller to the driver station. Two entries are sent for the data, with the first being the power, and the second being the current encoder reading.

This method works by calling sendMotorPower(Motor) followed by sendMotorPosition(Motor). Refer to the documentation for both of these methods for more information.

Parameters:

m - the motor to be sent.

See Also:

sendMotorPower(Motor), sendMotorPosition(Motor)

sendMotorPower

public static void sendMotorPower(Motor m)

Sends motor data from the robot controller to the driver station. The name of the motor is used as the tag for the data, and the power of the motor is sent as the data.

Parameters:

m - the motor to be sent.

See Also:

sendData(String, Object)

sendMotorPosition

public static void sendMotorPosition(Motor m)

Sends motor data from the robot controller to the driver station. The name of the motor is used as the tag for the data, and the reading of the encoder is sent as the data.

Parameters:

m - the motor to be sent.

See Also:

sendData(String, Object)

sendServoPosition

public static void sendServoPosition(Servo s)

Sends servo data from the robot controller to the driver station. The name of the servo is used as the tag for the data, and the position of the servo is sent as the data.

Parameters:

s - the servo to be sent.

See Also:

sendData(String, Object)