Package com.ctre.phoenix6.controls

Class DynamicMotionMagicTorqueCurrentFOC

java.lang.Object
com.ctre.phoenix6.controls.DynamicMotionMagicTorqueCurrentFOC
All Implemented Interfaces:
ControlRequest, Cloneable
public final class DynamicMotionMagicTorqueCurrentFOC extends Object implements ControlRequest, Cloneable
Requires Phoenix Pro and CANivore; Requests Motion Magic® to target a final position using a motion profile. This dynamic request allows runtime changes to Cruise Velocity, Acceleration, and (optional) Jerk. Users can optionally provide a torque current feedforward.

Motion Magic® produces a motion profile in real-time while attempting to honor the specified Cruise Velocity, Acceleration, and (optional) Jerk. This control mode does not use the Expo_kV or Expo_kA configs.

Target position can be changed on-the-fly and Motion Magic® will do its best to adjust the profile. This control mode is based on torque current, so relevant closed-loop gains will use Amperes for the numerator.

  • Field Details

    • Position

      public double Position
      Position to drive toward in rotations.
      • Units: rotations

    • Velocity

      public double Velocity
      Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation.
      • Units: rotations per second

    • Acceleration

      public double Acceleration
      Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation.
      • Units: rotations per second²

    • Jerk

      public double Jerk
      Jerk for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      Jerk is optional; if this is set to zero, then Motion Magic® will not apply a Jerk limit.

      • Units: rotations per second³

    • FeedForward

      public double FeedForward
      Feedforward to apply in torque current in Amperes. This is added to the output of the onboard feedforward terms.

      User can use motor's kT to scale Newton-meter to Amperes.

      • Units: A

    • Slot

      public int Slot
      Select which gains are applied by selecting the slot. Use the configuration api to set the gain values for the selected slot before enabling this feature. Slot must be within [0,2].

    • OverrideCoastDurNeutral

      public boolean OverrideCoastDurNeutral
      Set to true to coast the rotor when output is zero (or within deadband). Set to false to use the NeutralMode configuration setting (default). This flag exists to provide the fundamental behavior of this control when output is zero, which is to provide 0A (zero torque).

    • LimitForwardMotion

      public boolean LimitForwardMotion
      Set to true to force forward limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.

    • LimitReverseMotion

      public boolean LimitReverseMotion
      Set to true to force reverse limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.

    • IgnoreHardwareLimits

      public boolean IgnoreHardwareLimits
      Set to true to ignore hardware limit switches and the LimitForwardMotion and LimitReverseMotion parameters, instead allowing motion.

      This can be useful on mechanisms such as an intake/feeder, where a limit switch stops motion while intaking but should be ignored when feeding to a shooter.

      The hardware limit faults and Forward/ReverseLimit signals will still report the values of the limit switches regardless of this parameter.

    • IgnoreSoftwareLimits

      public boolean IgnoreSoftwareLimits
      Set to true to ignore software limits, instead allowing motion.

      This can be useful when calibrating the zero point of a mechanism such as an elevator.

      The software limit faults will still report the values of the software limits regardless of this parameter.

    • UseTimesync

      public boolean UseTimesync
      Set to true to delay applying this control request until a timesync boundary (requires Phoenix Pro and CANivore). This eliminates the impact of nondeterministic network delays in exchange for a larger but deterministic control latency.

      This requires setting the ControlTimesyncFreqHz config in MotorOutputConfigs. Additionally, when this is enabled, the UpdateFreqHz of this request should be set to 0 Hz.

    • UpdateFreqHz

      public double UpdateFreqHz
      The frequency at which this control will update. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

  • Constructor Details

    • DynamicMotionMagicTorqueCurrentFOC

      public DynamicMotionMagicTorqueCurrentFOC(double Position, double Velocity, double Acceleration)
      Requires Phoenix Pro and CANivore; Requests Motion Magic® to target a final position using a motion profile. This dynamic request allows runtime changes to Cruise Velocity, Acceleration, and (optional) Jerk. Users can optionally provide a torque current feedforward.

      Motion Magic® produces a motion profile in real-time while attempting to honor the specified Cruise Velocity, Acceleration, and (optional) Jerk. This control mode does not use the Expo_kV or Expo_kA configs.

      Target position can be changed on-the-fly and Motion Magic® will do its best to adjust the profile. This control mode is based on torque current, so relevant closed-loop gains will use Amperes for the numerator.

      Parameters:
      Position - Position to drive toward in rotations.
      Velocity - Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation.
      Acceleration - Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation.

    • DynamicMotionMagicTorqueCurrentFOC

      public DynamicMotionMagicTorqueCurrentFOC(Angle Position, AngularVelocity Velocity, AngularAcceleration Acceleration)
      Requires Phoenix Pro and CANivore; Requests Motion Magic® to target a final position using a motion profile. This dynamic request allows runtime changes to Cruise Velocity, Acceleration, and (optional) Jerk. Users can optionally provide a torque current feedforward.

      Motion Magic® produces a motion profile in real-time while attempting to honor the specified Cruise Velocity, Acceleration, and (optional) Jerk. This control mode does not use the Expo_kV or Expo_kA configs.

      Target position can be changed on-the-fly and Motion Magic® will do its best to adjust the profile. This control mode is based on torque current, so relevant closed-loop gains will use Amperes for the numerator.

      Parameters:
      Position - Position to drive toward in rotations.
      Velocity - Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation.
      Acceleration - Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation.

  • Method Details

    • getName

      public String getName()
      Description copied from interface: ControlRequest
      Gets the name of this control request.
      Specified by:
      getName in interface ControlRequest
      Returns:
      Name of the control request

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • sendRequest

      public StatusCode sendRequest(String network, int deviceHash)
      Specified by:
      sendRequest in interface ControlRequest

    • getControlInfo

      public Map<String,String> getControlInfo()
      Gets information about this control request.
      Specified by:
      getControlInfo in interface ControlRequest
      Returns:
      Map of control parameter names and corresponding applied values

    • withPosition

      public DynamicMotionMagicTorqueCurrentFOC withPosition(double newPosition)
      Modifies this Control Request's Position parameter and returns itself for method-chaining and easier to use request API.

      Position to drive toward in rotations.

      • Units: rotations
      Parameters:
      newPosition - Parameter to modify
      Returns:
      Itself

    • withPosition

      public DynamicMotionMagicTorqueCurrentFOC withPosition(Angle newPosition)
      Modifies this Control Request's Position parameter and returns itself for method-chaining and easier to use request API.

      Position to drive toward in rotations.

      • Units: rotations
      Parameters:
      newPosition - Parameter to modify
      Returns:
      Itself

    • getPositionMeasure

      public Angle getPositionMeasure()
      Helper method to get this Control Request's Position parameter converted to a unit type. If not using the Java units library, Position can be accessed directly instead.

      Position to drive toward in rotations.

      • Units: rotations
      Returns:
      Position

    • withVelocity

      public DynamicMotionMagicTorqueCurrentFOC withVelocity(double newVelocity)
      Modifies this Control Request's Velocity parameter and returns itself for method-chaining and easier to use request API.

      Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      • Units: rotations per second
      Parameters:
      newVelocity - Parameter to modify
      Returns:
      Itself

    • withVelocity

      public DynamicMotionMagicTorqueCurrentFOC withVelocity(AngularVelocity newVelocity)
      Modifies this Control Request's Velocity parameter and returns itself for method-chaining and easier to use request API.

      Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      • Units: rotations per second
      Parameters:
      newVelocity - Parameter to modify
      Returns:
      Itself

    • getVelocityMeasure

      public AngularVelocity getVelocityMeasure()
      Helper method to get this Control Request's Velocity parameter converted to a unit type. If not using the Java units library, Velocity can be accessed directly instead.

      Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      • Units: rotations per second
      Returns:
      Velocity

    • withAcceleration

      public DynamicMotionMagicTorqueCurrentFOC withAcceleration(double newAcceleration)
      Modifies this Control Request's Acceleration parameter and returns itself for method-chaining and easier to use request API.

      Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      • Units: rotations per second²
      Parameters:
      newAcceleration - Parameter to modify
      Returns:
      Itself

    • withAcceleration

      public DynamicMotionMagicTorqueCurrentFOC withAcceleration(AngularAcceleration newAcceleration)
      Modifies this Control Request's Acceleration parameter and returns itself for method-chaining and easier to use request API.

      Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      • Units: rotations per second²
      Parameters:
      newAcceleration - Parameter to modify
      Returns:
      Itself

    • getAccelerationMeasure

      public AngularAcceleration getAccelerationMeasure()
      Helper method to get this Control Request's Acceleration parameter converted to a unit type. If not using the Java units library, Acceleration can be accessed directly instead.

      Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      • Units: rotations per second²
      Returns:
      Acceleration

    • withJerk

      public DynamicMotionMagicTorqueCurrentFOC withJerk(double newJerk)
      Modifies this Control Request's Jerk parameter and returns itself for method-chaining and easier to use request API.

      Jerk for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      Jerk is optional; if this is set to zero, then Motion Magic® will not apply a Jerk limit.

      • Units: rotations per second³
      Parameters:
      newJerk - Parameter to modify
      Returns:
      Itself

    • withJerk

      public DynamicMotionMagicTorqueCurrentFOC withJerk(Velocity<AngularAccelerationUnit> newJerk)
      Modifies this Control Request's Jerk parameter and returns itself for method-chaining and easier to use request API.

      Jerk for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      Jerk is optional; if this is set to zero, then Motion Magic® will not apply a Jerk limit.

      • Units: rotations per second³
      Parameters:
      newJerk - Parameter to modify
      Returns:
      Itself

    • getJerkMeasure

      public Velocity<AngularAccelerationUnit> getJerkMeasure()
      Helper method to get this Control Request's Jerk parameter converted to a unit type. If not using the Java units library, Jerk can be accessed directly instead.

      Jerk for profiling. The signage does not matter as the device will use the absolute value for profile generation.

      Jerk is optional; if this is set to zero, then Motion Magic® will not apply a Jerk limit.

      • Units: rotations per second³
      Returns:
      Jerk

    • withFeedForward

      public DynamicMotionMagicTorqueCurrentFOC withFeedForward(double newFeedForward)
      Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API.

      Feedforward to apply in torque current in Amperes. This is added to the output of the onboard feedforward terms.

      User can use motor's kT to scale Newton-meter to Amperes.

      • Units: A
      Parameters:
      newFeedForward - Parameter to modify
      Returns:
      Itself

    • withFeedForward

      public DynamicMotionMagicTorqueCurrentFOC withFeedForward(Current newFeedForward)
      Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API.

      Feedforward to apply in torque current in Amperes. This is added to the output of the onboard feedforward terms.

      User can use motor's kT to scale Newton-meter to Amperes.

      • Units: A
      Parameters:
      newFeedForward - Parameter to modify
      Returns:
      Itself

    • getFeedForwardMeasure

      public Current getFeedForwardMeasure()
      Helper method to get this Control Request's FeedForward parameter converted to a unit type. If not using the Java units library, FeedForward can be accessed directly instead.

      Feedforward to apply in torque current in Amperes. This is added to the output of the onboard feedforward terms.

      User can use motor's kT to scale Newton-meter to Amperes.

      • Units: A
      Returns:
      FeedForward

    • withSlot

      public DynamicMotionMagicTorqueCurrentFOC withSlot(int newSlot)
      Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.

      Select which gains are applied by selecting the slot. Use the configuration api to set the gain values for the selected slot before enabling this feature. Slot must be within [0,2].

      Parameters:
      newSlot - Parameter to modify
      Returns:
      Itself

    • withOverrideCoastDurNeutral

      public DynamicMotionMagicTorqueCurrentFOC withOverrideCoastDurNeutral(boolean newOverrideCoastDurNeutral)
      Modifies this Control Request's OverrideCoastDurNeutral parameter and returns itself for method-chaining and easier to use request API.

      Set to true to coast the rotor when output is zero (or within deadband). Set to false to use the NeutralMode configuration setting (default). This flag exists to provide the fundamental behavior of this control when output is zero, which is to provide 0A (zero torque).

      Parameters:
      newOverrideCoastDurNeutral - Parameter to modify
      Returns:
      Itself

    • withLimitForwardMotion

      public DynamicMotionMagicTorqueCurrentFOC withLimitForwardMotion(boolean newLimitForwardMotion)
      Modifies this Control Request's LimitForwardMotion parameter and returns itself for method-chaining and easier to use request API.

      Set to true to force forward limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.

      Parameters:
      newLimitForwardMotion - Parameter to modify
      Returns:
      Itself

    • withLimitReverseMotion

      public DynamicMotionMagicTorqueCurrentFOC withLimitReverseMotion(boolean newLimitReverseMotion)
      Modifies this Control Request's LimitReverseMotion parameter and returns itself for method-chaining and easier to use request API.

      Set to true to force reverse limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.

      Parameters:
      newLimitReverseMotion - Parameter to modify
      Returns:
      Itself

    • withIgnoreHardwareLimits

      public DynamicMotionMagicTorqueCurrentFOC withIgnoreHardwareLimits(boolean newIgnoreHardwareLimits)
      Modifies this Control Request's IgnoreHardwareLimits parameter and returns itself for method-chaining and easier to use request API.

      Set to true to ignore hardware limit switches and the LimitForwardMotion and LimitReverseMotion parameters, instead allowing motion.

      This can be useful on mechanisms such as an intake/feeder, where a limit switch stops motion while intaking but should be ignored when feeding to a shooter.

      The hardware limit faults and Forward/ReverseLimit signals will still report the values of the limit switches regardless of this parameter.

      Parameters:
      newIgnoreHardwareLimits - Parameter to modify
      Returns:
      Itself

    • withIgnoreSoftwareLimits

      public DynamicMotionMagicTorqueCurrentFOC withIgnoreSoftwareLimits(boolean newIgnoreSoftwareLimits)
      Modifies this Control Request's IgnoreSoftwareLimits parameter and returns itself for method-chaining and easier to use request API.

      Set to true to ignore software limits, instead allowing motion.

      This can be useful when calibrating the zero point of a mechanism such as an elevator.

      The software limit faults will still report the values of the software limits regardless of this parameter.

      Parameters:
      newIgnoreSoftwareLimits - Parameter to modify
      Returns:
      Itself

    • withUseTimesync

      public DynamicMotionMagicTorqueCurrentFOC withUseTimesync(boolean newUseTimesync)
      Modifies this Control Request's UseTimesync parameter and returns itself for method-chaining and easier to use request API.

      Set to true to delay applying this control request until a timesync boundary (requires Phoenix Pro and CANivore). This eliminates the impact of nondeterministic network delays in exchange for a larger but deterministic control latency.

      This requires setting the ControlTimesyncFreqHz config in MotorOutputConfigs. Additionally, when this is enabled, the UpdateFreqHz of this request should be set to 0 Hz.

      Parameters:
      newUseTimesync - Parameter to modify
      Returns:
      Itself

    • withUpdateFreqHz

      public DynamicMotionMagicTorqueCurrentFOC withUpdateFreqHz(double newUpdateFreqHz)
      Sets the frequency at which this control will update. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

      Specified by:
      withUpdateFreqHz in interface ControlRequest
      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • withUpdateFreqHz

      public DynamicMotionMagicTorqueCurrentFOC withUpdateFreqHz(Frequency newUpdateFreqHz)
      Sets the frequency at which this control will update. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

      Specified by:
      withUpdateFreqHz in interface ControlRequest
      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • clone

      public DynamicMotionMagicTorqueCurrentFOC clone()
      Overrides:
      clone in class Object