Package com.ctre.phoenix.motorcontrol
Class StatorCurrentLimitConfiguration
java.lang.Object
com.ctre.phoenix.motorcontrol.StatorCurrentLimitConfiguration
@Deprecated(since="2024", forRemoval=true) public class StatorCurrentLimitConfiguration extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
This device's Phoenix 5 API is deprecated for removal in the
2025 season. Users should update to Phoenix 6 firmware and migrate to the
Phoenix 6 API. A migration guide is available at
https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.
If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.
Stator-side current limiting. This is typically used to limit acceleration/torque and heat generation.
-
Field Summary
Fields Modifier and Type Field Description double
currentLimit
Deprecated, for removal: This API element is subject to removal in a future version.The "holding" current (amperes) to limit to when feature is activated.boolean
enable
Deprecated, for removal: This API element is subject to removal in a future version.True/False to enable/disable limit feature.double
triggerThresholdCurrent
Deprecated, for removal: This API element is subject to removal in a future version.Current must exceed this threshold (amperes) before limiting occurs.double
triggerThresholdTime
Deprecated, for removal: This API element is subject to removal in a future version.How long current must exceed threshold (seconds) before limiting occurs. -
Constructor Summary
Constructors Constructor Description StatorCurrentLimitConfiguration()
Deprecated, for removal: This API element is subject to removal in a future version.StatorCurrentLimitConfiguration(boolean enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime)
Deprecated, for removal: This API element is subject to removal in a future version.StatorCurrentLimitConfiguration(double[] doubleArray)
Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and Type Method Description void
deserialize(double[] doubles)
Deprecated, for removal: This API element is subject to removal in a future version.boolean
equals(StatorCurrentLimitConfiguration rhs)
Deprecated, for removal: This API element is subject to removal in a future version.double[]
toArray()
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.
-
Field Details
-
enable
Deprecated, for removal: This API element is subject to removal in a future version.True/False to enable/disable limit feature. -
currentLimit
Deprecated, for removal: This API element is subject to removal in a future version.The "holding" current (amperes) to limit to when feature is activated. -
triggerThresholdCurrent
Deprecated, for removal: This API element is subject to removal in a future version.Current must exceed this threshold (amperes) before limiting occurs. If this value is less than currentLimit, then currentLimit is used as the threshold. -
triggerThresholdTime
Deprecated, for removal: This API element is subject to removal in a future version.How long current must exceed threshold (seconds) before limiting occurs.
-
-
Constructor Details
-
StatorCurrentLimitConfiguration
public StatorCurrentLimitConfiguration()Deprecated, for removal: This API element is subject to removal in a future version. -
StatorCurrentLimitConfiguration
public StatorCurrentLimitConfiguration(boolean enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime)Deprecated, for removal: This API element is subject to removal in a future version. -
StatorCurrentLimitConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
toString
Deprecated, for removal: This API element is subject to removal in a future version. -
toArray
Deprecated, for removal: This API element is subject to removal in a future version. -
deserialize
Deprecated, for removal: This API element is subject to removal in a future version. -
equals
Deprecated, for removal: This API element is subject to removal in a future version.
-