Package com.ctre.phoenixpro.controls

Class TorqueCurrentFOC

java.lang.Object
com.ctre.phoenixpro.controls.ControlRequest
com.ctre.phoenixpro.controls.TorqueCurrentFOC
@Deprecated(forRemoval=true)
public class TorqueCurrentFOC
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.
Request a specified motor current (field oriented control).

This control request will drive the motor to the requested motor (stator) current value. This leverages field oriented control (FOC), which means greater peak power than what is documented. This scales to torque based on Motor's kT constant.

  • 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
    double Deadband
    Deprecated, for removal: This API element is subject to removal in a future version.
    Deadband in Amperes.
    double MaxAbsDutyCycle
    Deprecated, for removal: This API element is subject to removal in a future version.
    The maximum absolute motor output that can be applied, which effectively limits the velocity.
    double Output
    Deprecated, for removal: This API element is subject to removal in a future version.
    Amount of motor current in Amperes
    boolean OverrideCoastDurNeutral
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set to true to coast the rotor when output is zero (or within deadband).
    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
    TorqueCurrentFOC​(double Output)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Classes in the phoenixpro package will be removed in 2024.
    TorqueCurrentFOC​(double Output, double MaxAbsDutyCycle, double Deadband, boolean OverrideCoastDurNeutral)
    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.
     
    TorqueCurrentFOC withDeadband​(double newDeadband)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's Deadband parameter and returns itself for method-chaining and easier to use request API.
    TorqueCurrentFOC withMaxAbsDutyCycle​(double newMaxAbsDutyCycle)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's MaxAbsDutyCycle parameter and returns itself for method-chaining and easier to use request API.
    TorqueCurrentFOC withOutput​(double newOutput)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's Output parameter and returns itself for method-chaining and easier to use request API.
    TorqueCurrentFOC withOverrideCoastDurNeutral​(boolean newOverrideCoastDurNeutral)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Modifies this Control Request's OverrideCoastDurNeutral parameter and returns itself for method-chaining and easier to use request API.
    TorqueCurrentFOC 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

    • Output

      public double Output
      Deprecated, for removal: This API element is subject to removal in a future version.
      Amount of motor current in Amperes

    • MaxAbsDutyCycle

      public double MaxAbsDutyCycle
      Deprecated, for removal: This API element is subject to removal in a future version.
      The maximum absolute motor output that can be applied, which effectively limits the velocity. For example, 0.50 means no more than 50% output in either direction. This is useful for preventing the motor from spinning to its terminal velocity when there is no external torque applied unto the rotor. Note this is absolute maximum, so the value should be between zero and one.

    • Deadband

      public double Deadband
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deadband in Amperes. If torque request is within deadband, the bridge output is neutral. If deadband is set to zero then there is effectively no deadband. Note if deadband is zero, a free spinning motor will spin for quite a while as the firmware attempts to hold the motor's bemf. If user expects motor to cease spinning quickly with a demand of zero, we recommend a deadband of one Ampere. This value will be converted to an integral value of amps.

    • OverrideCoastDurNeutral

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

    • 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

    • TorqueCurrentFOC

      @Deprecated(forRemoval=true) public TorqueCurrentFOC​(double Output, double MaxAbsDutyCycle, double Deadband, boolean OverrideCoastDurNeutral)
      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.
      Request a specified motor current (field oriented control).

      This control request will drive the motor to the requested motor (stator) current value. This leverages field oriented control (FOC), which means greater peak power than what is documented. This scales to torque based on Motor's kT constant.

      Parameters:
      Output - Amount of motor current in Amperes
      MaxAbsDutyCycle - The maximum absolute motor output that can be applied, which effectively limits the velocity. For example, 0.50 means no more than 50% output in either direction. This is useful for preventing the motor from spinning to its terminal velocity when there is no external torque applied unto the rotor. Note this is absolute maximum, so the value should be between zero and one.
      Deadband - Deadband in Amperes. If torque request is within deadband, the bridge output is neutral. If deadband is set to zero then there is effectively no deadband. Note if deadband is zero, a free spinning motor will spin for quite a while as the firmware attempts to hold the motor's bemf. If user expects motor to cease spinning quickly with a demand of zero, we recommend a deadband of one Ampere. This value will be converted to an integral value of amps.
      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).

    • TorqueCurrentFOC

      @Deprecated(forRemoval=true) public TorqueCurrentFOC​(double Output)
      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.
      Request a specified motor current (field oriented control).

      This control request will drive the motor to the requested motor (stator) current value. This leverages field oriented control (FOC), which means greater peak power than what is documented. This scales to torque based on Motor's kT constant.

      Parameters:
      Output - Amount of motor current in Amperes

  • 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

    • withOutput

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

    • withMaxAbsDutyCycle

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

    • withDeadband

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

    • withOverrideCoastDurNeutral

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

    • withUpdateFreqHz

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