Enum Class ReverseLimitSourceValue

java.lang.Object
java.lang.Enum<ReverseLimitSourceValue>
com.ctre.phoenix6.signals.ReverseLimitSourceValue
All Implemented Interfaces:
Serializable, Comparable<ReverseLimitSourceValue>, Constable
public enum ReverseLimitSourceValue extends Enum<ReverseLimitSourceValue>
Determines where to poll the reverse limit switch. This defaults to the reverse limit switch pin on the limit switch connector.

Choose RemoteTalonFX to use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANifier to use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Disabled
    Disable the reverse limit switch.
    LimitSwitchPin
    Use the reverse limit switch pin on the limit switch connector.
    RemoteCANcoder
    Use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).
    RemoteCANdiS1
    Use another CTR Electronics' CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).
    RemoteCANdiS2
    Use another CTR Electronics' CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID).
    RemoteCANifier
    Use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).
    RemoteCANrange
    Use another CANrange on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).
    RemoteTalonFX
    Use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final int
    value
    Unique integer value of this ReverseLimitSourceValue.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ReverseLimitSourceValue
    valueOf(int value)
    Gets ReverseLimitSourceValue from specified value
    static ReverseLimitSourceValue
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ReverseLimitSourceValue[]
    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

    • LimitSwitchPin

      public static final ReverseLimitSourceValue LimitSwitchPin
      Use the reverse limit switch pin on the limit switch connector.

    • RemoteTalonFX

      public static final ReverseLimitSourceValue RemoteTalonFX
      Use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

    • RemoteCANifier

      public static final ReverseLimitSourceValue RemoteCANifier
      Use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

    • RemoteCANcoder

      public static final ReverseLimitSourceValue RemoteCANcoder
      Use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

    • RemoteCANrange

      public static final ReverseLimitSourceValue RemoteCANrange
      Use another CANrange on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANrange proximity detect is tripped.

    • RemoteCANdiS1

      public static final ReverseLimitSourceValue RemoteCANdiS1
      Use another CTR Electronics' CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when the CTR Electronics' CANdi™ Signal 1 Input (S1IN) pin matches the configured closed state.

    • RemoteCANdiS2

      public static final ReverseLimitSourceValue RemoteCANdiS2
      Use another CTR Electronics' CANdi™ on the same CAN bus (this also requires setting ForwardLimitRemoteSensorID). The forward limit will assert when CANdi™ Signal 2 Input (S2IN) pin matches the configured closed state.

    • Disabled

      public static final ReverseLimitSourceValue Disabled
      Disable the reverse limit switch.

  • Field Details

    • value

      public final int value
      Unique integer value of this ReverseLimitSourceValue.

  • Method Details

    • values

      public static ReverseLimitSourceValue[] 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 ReverseLimitSourceValue 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

    • valueOf

      public static ReverseLimitSourceValue valueOf(int value)
      Gets ReverseLimitSourceValue from specified value
      Parameters:
      value - Value of ReverseLimitSourceValue
      Returns:
      ReverseLimitSourceValue of specified value