Enum Class SwerveDriveTelemetry.BooleanTelemetryField

java.lang.Object

java.lang.Enum<SwerveDriveTelemetry.BooleanTelemetryField>

yams.core.telemetry.SwerveDriveTelemetry.BooleanTelemetryField

All Implemented Interfaces:

Serializable, Comparable<SwerveDriveTelemetry.BooleanTelemetryField>, Constable

Enclosing class:

SwerveDriveTelemetry

public static enum SwerveDriveTelemetry.BooleanTelemetryField
extends Enum<SwerveDriveTelemetry.BooleanTelemetryField>

Boolean telemetry field for SwerveDrives.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AutoAlignEnabled	Enables or disables driving to the auto-align target pose.
ModulesAzimuthTuningEnabled	Enables or disables live tuning of every module's azimuth motor PID gains and angle setpoint.
ModulesAzimuthVoltageEnabled	While azimuth tuning is on, turn every module's azimuth motor at SwerveDriveTelemetry.DoubleTelemetryField.ModulesAzimuthVoltage instead of the angle setpoint, without its closed loop controller, as for characterizing it.
ModulesDriveInPlace	When enabled ensure drive testing is done with all modules are oriented to the swerve drive will drive counter clockwise positive.
ModulesDriveTuningEnabled	Enables or disables live tuning of every module's drive motor PID gains and velocity setpoint.
ModulesDriveVoltageEnabled	While drive tuning is on, drive every module's drive motor at SwerveDriveTelemetry.DoubleTelemetryField.ModulesDriveVoltage instead of the velocity setpoint, without its closed loop controller, as for characterizing it.

Method Summary

Modifier and Type	Method	Description
BooleanTelemetry<SwerveDriveTelemetry.BooleanTelemetryField>	create()	Create a BooleanTelemetry object for non-static usage.
static SwerveDriveTelemetry.BooleanTelemetryField	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SwerveDriveTelemetry.BooleanTelemetryField[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AutoAlignEnabled

public static final SwerveDriveTelemetry.BooleanTelemetryField AutoAlignEnabled

Enables or disables driving to the auto-align target pose.

ModulesDriveTuningEnabled

public static final SwerveDriveTelemetry.BooleanTelemetryField ModulesDriveTuningEnabled

Enables or disables live tuning of every module's drive motor PID gains and velocity setpoint.

ModulesDriveInPlace

public static final SwerveDriveTelemetry.BooleanTelemetryField ModulesDriveInPlace

When enabled ensure drive testing is done with all modules are oriented to the swerve drive will drive counter clockwise positive.

ModulesDriveVoltageEnabled

public static final SwerveDriveTelemetry.BooleanTelemetryField ModulesDriveVoltageEnabled

While drive tuning is on, drive every module's drive motor at SwerveDriveTelemetry.DoubleTelemetryField.ModulesDriveVoltage instead of the velocity setpoint, without its closed loop controller, as for characterizing it.

ModulesAzimuthTuningEnabled

public static final SwerveDriveTelemetry.BooleanTelemetryField ModulesAzimuthTuningEnabled

Enables or disables live tuning of every module's azimuth motor PID gains and angle setpoint.

ModulesAzimuthVoltageEnabled

public static final SwerveDriveTelemetry.BooleanTelemetryField ModulesAzimuthVoltageEnabled

While azimuth tuning is on, turn every module's azimuth motor at SwerveDriveTelemetry.DoubleTelemetryField.ModulesAzimuthVoltage instead of the angle setpoint, without its closed loop controller, as for characterizing it.

Method Details

values

public static SwerveDriveTelemetry.BooleanTelemetryField[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SwerveDriveTelemetry.BooleanTelemetryField valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

create

public BooleanTelemetry<SwerveDriveTelemetry.BooleanTelemetryField> create()

Create a BooleanTelemetry object for non-static usage.

Returns:

BooleanTelemetry