Package com.ctre.phoenixpro.configs

Class CurrentLimitsConfigs

java.lang.Object
com.ctre.phoenixpro.configs.CurrentLimitsConfigs
All Implemented Interfaces:
ParentConfiguration, ISerializable
@Deprecated(forRemoval=true)
public class CurrentLimitsConfigs
extends Object
implements ParentConfiguration
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.
Configs that directly affect current limiting features.

Includes Motor Invert and various limit features.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    double StatorCurrentLimit
    Deprecated, for removal: This API element is subject to removal in a future version.
    The amount of current allowed in the motor (motoring and regen current).
    boolean StatorCurrentLimitEnable
    Deprecated, for removal: This API element is subject to removal in a future version.
    Enable motor stator current limiting.
    double SupplyCurrentLimit
    Deprecated, for removal: This API element is subject to removal in a future version.
    The amount of supply current allowed.
    boolean SupplyCurrentLimitEnable
    Deprecated, for removal: This API element is subject to removal in a future version.
    Enable motor supply current limiting.
    double SupplyCurrentThreshold
    Deprecated, for removal: This API element is subject to removal in a future version.
    Delay supply current limiting until current exceeds this threshold for longer than SupplyTimeThreshold.
    double SupplyTimeThreshold
    Deprecated, for removal: This API element is subject to removal in a future version.
    Allows unlimited current for a period of time before current limiting occurs.

  • Constructor Summary

    Constructors 
    Constructor Description
    CurrentLimitsConfigs()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type Method Description
    StatusCode deserialize​(String string)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String serialize()
    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.
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • StatorCurrentLimit

      public double StatorCurrentLimit
      Deprecated, for removal: This API element is subject to removal in a future version.
      The amount of current allowed in the motor (motoring and regen current). This is only applicable for non-torque current control modes. Note this requires the corresponding enable to be true.
      • Minimum Value: 0.0
      • Maximum Value: 800.0
      • Default Value: 0
      • Units: A

    • StatorCurrentLimitEnable

      public boolean StatorCurrentLimitEnable
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enable motor stator current limiting.
      • Default Value: False

    • SupplyCurrentLimit

      public double SupplyCurrentLimit
      Deprecated, for removal: This API element is subject to removal in a future version.
      The amount of supply current allowed. This is only applicable for non-torque current control modes. Note this requires the corresponding enable to be true. Use SupplyCurrentThreshold and SupplyTimeThreshold to allow brief periods of high-current before limiting occurs.
      • Minimum Value: 0.0
      • Maximum Value: 800.0
      • Default Value: 0
      • Units: A

    • SupplyCurrentLimitEnable

      public boolean SupplyCurrentLimitEnable
      Deprecated, for removal: This API element is subject to removal in a future version.
      Enable motor supply current limiting.
      • Default Value: False

    • SupplyCurrentThreshold

      public double SupplyCurrentThreshold
      Deprecated, for removal: This API element is subject to removal in a future version.
      Delay supply current limiting until current exceeds this threshold for longer than SupplyTimeThreshold. This allows current draws above SupplyCurrentLimit for a fixed period of time. This has no effect if SupplyCurrentLimit is greater than this value.
      • Minimum Value: 0.0
      • Maximum Value: 511
      • Default Value: 0
      • Units: A

    • SupplyTimeThreshold

      public double SupplyTimeThreshold
      Deprecated, for removal: This API element is subject to removal in a future version.
      Allows unlimited current for a period of time before current limiting occurs. Current threshold is the maximum of SupplyCurrentThreshold and SupplyCurrentLimit.
      • Minimum Value: 0.0
      • Maximum Value: 1.275
      • Default Value: 0
      • Units: sec

  • Constructor Details

  • Method Details