Package com.ctre.phoenix.motorcontrol

Enum TalonFXControlMode

java.lang.Object
java.lang.Enum<TalonFXControlMode>
com.ctre.phoenix.motorcontrol.TalonFXControlMode
All Implemented Interfaces:
Serializable, Comparable<TalonFXControlMode>, java.lang.constant.Constable
@Deprecated(since="2024",
            forRemoval=true)
public enum TalonFXControlMode
extends Enum<TalonFXControlMode>
Deprecated, for removal: This API element is subject to removal in a future version.
This device's Phoenix 5 API is deprecated for removal in the 2025 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

Choose the control mode for a TalonFX / Falcon 500.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    Current
    Deprecated, for removal: This API element is subject to removal in a future version.
    Input current closed loop
    Disabled
    Deprecated, for removal: This API element is subject to removal in a future version.
    Disable Motor Controller
    Follower
    Deprecated, for removal: This API element is subject to removal in a future version.
    Follow other motor controller
    MotionMagic
    Deprecated, for removal: This API element is subject to removal in a future version.
    Motion Magic
    MotionProfile
    Deprecated, for removal: This API element is subject to removal in a future version.
    Motion Profile
    MotionProfileArc
    Deprecated, for removal: This API element is subject to removal in a future version.
    Motion Profile with auxiliary output
    MusicTone
    Deprecated, for removal: This API element is subject to removal in a future version.
    Plays a single tone.
    PercentOutput
    Deprecated, for removal: This API element is subject to removal in a future version.
    Percent output [-1,1]
    Position
    Deprecated, for removal: This API element is subject to removal in a future version.
    Position closed loop
    Velocity
    Deprecated, for removal: This API element is subject to removal in a future version.
    Velocity closed loop

  • Field Summary

    Fields 
    Modifier and Type Field Description
    int value
    Deprecated, for removal: This API element is subject to removal in a future version.
    Value of control mode

  • Method Summary

    Modifier and Type Method Description
    ControlMode toControlMode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Helper method to convert to generic ControlMode enum.
    static TalonFXControlMode valueOf​(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this type with the specified name.
    static TalonFXControlMode[] values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Field Details

    • value

      public final int value
      Deprecated, for removal: This API element is subject to removal in a future version.
      Value of control mode

  • Method Details

    • values

      public static TalonFXControlMode[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static TalonFXControlMode valueOf​(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • toControlMode

      public ControlMode toControlMode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Helper method to convert to generic ControlMode enum.
      Returns:
      value cast as ControlMode