Package com.ctre.phoenix6.controls

Class MotionMagicVoltage

java.lang.Object
com.ctre.phoenix6.controls.MotionMagicVoltage
All Implemented Interfaces:
ControlRequest, Cloneable
public final class MotionMagicVoltage extends Object implements ControlRequest, Cloneable
Requests Motion Magic® to target a final position using a motion profile. Users can optionally provide a voltage feedforward.

Motion Magic® produces a motion profile in real-time while attempting to honor the Cruise Velocity, Acceleration, and (optional) Jerk specified via the Motion Magic® configuration values. 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 voltage-based, so relevant closed-loop gains will use Volts for the numerator.

  • Field Details

    • Position

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

    • EnableFOC

      public boolean EnableFOC
      Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15% on supported devices (see SupportsFOC). Set to false to use trapezoidal commutation.

      FOC improves motor performance by leveraging torque (current) control. However, this may be inconvenient for applications that require specifying duty cycle or voltage. CTR-Electronics has developed a hybrid method that combines the performances gains of FOC while still allowing applications to provide duty cycle or voltage demand. This not to be confused with simple sinusoidal control or phase voltage control which lacks the performance gains.

    • FeedForward

      public double FeedForward
      Feedforward to apply in volts. This is added to the output of the onboard feedforward terms.
      • Units: Volts

    • 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].

    • OverrideBrakeDurNeutral

      public boolean OverrideBrakeDurNeutral
      Set to true to static-brake 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 0V to the motor.

    • 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

    • MotionMagicVoltage

      public MotionMagicVoltage(double Position)
      Requests Motion Magic® to target a final position using a motion profile. Users can optionally provide a voltage feedforward.

      Motion Magic® produces a motion profile in real-time while attempting to honor the Cruise Velocity, Acceleration, and (optional) Jerk specified via the Motion Magic® configuration values. 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 voltage-based, so relevant closed-loop gains will use Volts for the numerator.

      Parameters:
      Position - Position to drive toward in rotations.

    • MotionMagicVoltage

      public MotionMagicVoltage(Angle Position)
      Requests Motion Magic® to target a final position using a motion profile. Users can optionally provide a voltage feedforward.

      Motion Magic® produces a motion profile in real-time while attempting to honor the Cruise Velocity, Acceleration, and (optional) Jerk specified via the Motion Magic® configuration values. 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 voltage-based, so relevant closed-loop gains will use Volts for the numerator.

      Parameters:
      Position - Position to drive toward in rotations.

  • 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(CANBus 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 MotionMagicVoltage 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 MotionMagicVoltage 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

    • withEnableFOC

      public MotionMagicVoltage withEnableFOC(boolean newEnableFOC)
      Modifies this Control Request's EnableFOC parameter and returns itself for method-chaining and easier to use request API.

      Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15% on supported devices (see SupportsFOC). Set to false to use trapezoidal commutation.

      FOC improves motor performance by leveraging torque (current) control. However, this may be inconvenient for applications that require specifying duty cycle or voltage. CTR-Electronics has developed a hybrid method that combines the performances gains of FOC while still allowing applications to provide duty cycle or voltage demand. This not to be confused with simple sinusoidal control or phase voltage control which lacks the performance gains.

      Parameters:
      newEnableFOC - Parameter to modify
      Returns:
      Itself

    • withFeedForward

      public MotionMagicVoltage 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 volts. This is added to the output of the onboard feedforward terms.

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

    • withFeedForward

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

      Feedforward to apply in volts. This is added to the output of the onboard feedforward terms.

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

    • getFeedForwardMeasure

      public Voltage 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 volts. This is added to the output of the onboard feedforward terms.

      • Units: Volts
      Returns:
      FeedForward

    • withSlot

      public MotionMagicVoltage 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

    • withOverrideBrakeDurNeutral

      public MotionMagicVoltage withOverrideBrakeDurNeutral(boolean newOverrideBrakeDurNeutral)
      Modifies this Control Request's OverrideBrakeDurNeutral parameter and returns itself for method-chaining and easier to use request API.

      Set to true to static-brake 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 0V to the motor.

      Parameters:
      newOverrideBrakeDurNeutral - Parameter to modify
      Returns:
      Itself

    • withLimitForwardMotion

      public MotionMagicVoltage 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 MotionMagicVoltage 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 MotionMagicVoltage 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 MotionMagicVoltage 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 MotionMagicVoltage 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 MotionMagicVoltage 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 MotionMagicVoltage 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 MotionMagicVoltage clone()
      Overrides:
      clone in class Object