Package com.ctre.phoenixpro.controls

Class MotionMagicVoltage

java.lang.Object
com.ctre.phoenixpro.controls.ControlRequest
com.ctre.phoenixpro.controls.MotionMagicVoltage
@Deprecated(forRemoval=true)
public class MotionMagicVoltage
extends ControlRequest
Deprecated, for removal: This API element is subject to removal in a future version.
Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.
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 Jerk value specified via the Motion Magic® configuration values. 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 Summary

    Fields 
    Modifier and Type Field Description
    double configTimeout
    Deprecated, for removal: This API element is subject to removal in a future version.
    The timeout when sending configs associated with this control
    boolean EnableFOC
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set to true to use FOC commutation, which increases peak power by ~15%.
    double FeedForward
    Deprecated, for removal: This API element is subject to removal in a future version.
    Feedforward to apply in volts
    boolean OverrideBrakeDurNeutral
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set to true to static-brake the rotor when output is zero (or within deadband).
    double Position
    Deprecated, for removal: This API element is subject to removal in a future version.
    Position to drive toward in rotations.
    int Slot
    Deprecated, for removal: This API element is subject to removal in a future version.
    Select which gains are applied by selecting the slot.
    double UpdateFreqHz
    Deprecated, for removal: This API element is subject to removal in a future version.
    The period at which this control will update at.

    Fields inherited from class com.ctre.phoenixpro.controls.ControlRequest

    requestReference

  • Constructor Summary

    Constructors 
    Constructor Description
    MotionMagicVoltage​(double Position)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Classes in the phoenixpro package will be removed in 2024.
    MotionMagicVoltage​(double Position, boolean EnableFOC, double FeedForward, int Slot, boolean OverrideBrakeDurNeutral)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Classes in the phoenixpro package will be removed in 2024.

  • Method Summary

    Modifier and Type Method Description
    void forceApplyConfigs()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Forces configs to be applied the next time this is used in a setControl.
    StatusCode sendRequest​(String network, int deviceHash, boolean cancelOtherRequests)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    MotionMagicVoltage withEnableFOC​(boolean newEnableFOC)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's EnableFOC parameter and returns itself for method-chaining and easier to use request API.
    MotionMagicVoltage withFeedForward​(double newFeedForward)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API.
    MotionMagicVoltage withOverrideBrakeDurNeutral​(boolean newOverrideBrakeDurNeutral)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's OverrideBrakeDurNeutral parameter and returns itself for method-chaining and easier to use request API.
    MotionMagicVoltage withPosition​(double newPosition)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's Position parameter and returns itself for method-chaining and easier to use request API.
    MotionMagicVoltage withSlot​(int newSlot)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.
    MotionMagicVoltage withUpdateFreqHz​(double newUpdateFreqHz)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the period at which this control will update at.

    Methods inherited from class com.ctre.phoenixpro.controls.ControlRequest

    getControlInfo

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • Position

      public double Position
      Deprecated, for removal: This API element is subject to removal in a future version.
      Position to drive toward in rotations.

    • EnableFOC

      public boolean EnableFOC
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set to true to use FOC commutation, which increases peak power by ~15%. 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      Feedforward to apply in volts

    • Slot

      public int Slot
      Deprecated, for removal: This API element is subject to removal in a future version.
      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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

    • UpdateFreqHz

      public double UpdateFreqHz
      Deprecated, for removal: This API element is subject to removal in a future version.
      The period at which this control will update at. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

      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.

    • configTimeout

      public double configTimeout
      Deprecated, for removal: This API element is subject to removal in a future version.
      The timeout when sending configs associated with this control

  • Constructor Details

    • MotionMagicVoltage

      @Deprecated(forRemoval=true) public MotionMagicVoltage​(double Position, boolean EnableFOC, double FeedForward, int Slot, boolean OverrideBrakeDurNeutral)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.
      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 Jerk value specified via the Motion Magic® configuration values. 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.
      EnableFOC - Set to true to use FOC commutation, which increases peak power by ~15%. 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 - Feedforward to apply in volts
      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 - 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.

    • MotionMagicVoltage

      @Deprecated(forRemoval=true) public MotionMagicVoltage​(double Position)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.
      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 Jerk value specified via the Motion Magic® configuration values. 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

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object

    • sendRequest

      public StatusCode sendRequest​(String network, int deviceHash, boolean cancelOtherRequests)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      sendRequest in class ControlRequest

    • withPosition

      public MotionMagicVoltage withPosition​(double newPosition)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Modifies this Control Request's Position parameter and returns itself for method-chaining and easier to use request API.
      Parameters:
      newPosition - Parameter to modify
      Returns:
      Itself

    • withEnableFOC

      public MotionMagicVoltage withEnableFOC​(boolean newEnableFOC)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Modifies this Control Request's EnableFOC parameter and returns itself for method-chaining and easier to use request API.
      Parameters:
      newEnableFOC - Parameter to modify
      Returns:
      Itself

    • withFeedForward

      public MotionMagicVoltage withFeedForward​(double newFeedForward)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API.
      Parameters:
      newFeedForward - Parameter to modify
      Returns:
      Itself

    • withSlot

      public MotionMagicVoltage withSlot​(int newSlot)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.
      Parameters:
      newSlot - Parameter to modify
      Returns:
      Itself

    • withOverrideBrakeDurNeutral

      public MotionMagicVoltage withOverrideBrakeDurNeutral​(boolean newOverrideBrakeDurNeutral)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Modifies this Control Request's OverrideBrakeDurNeutral parameter and returns itself for method-chaining and easier to use request API.
      Parameters:
      newOverrideBrakeDurNeutral - Parameter to modify
      Returns:
      Itself

    • withUpdateFreqHz

      public MotionMagicVoltage withUpdateFreqHz​(double newUpdateFreqHz)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the period at which this control will update at. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

      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.

      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • forceApplyConfigs

      public void forceApplyConfigs()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Forces configs to be applied the next time this is used in a setControl.

      This is not necessary in the majority of cases, because Phoenix will make sure configs are properly set when they are not already set