CTRE_Phoenix 5.20.2
com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration Class Reference

Public Member Functions

 SupplyCurrentLimitConfiguration (boolean enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime)
 
 SupplyCurrentLimitConfiguration (double[] doubleArray)
 
String toString ()
 
double[] toArray ()
 
void deserialize (double[] doubles)
 
boolean equals (SupplyCurrentLimitConfiguration rhs)
 

Public Attributes

boolean enable = false
 
double currentLimit = 0
 
double triggerThresholdCurrent = 0
 
double triggerThresholdTime = 0
 

Detailed Description

Supply-side current limiting. This is typically used to prevent breakers from tripping.

Member Function Documentation

◆ toString()

String com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration.toString ( )
inline
Returns
string representation of current faults tripped

Member Data Documentation

◆ currentLimit

double com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration.currentLimit = 0

The "holding" current (amperes) to limit to when feature is activated.

◆ enable

boolean com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration.enable = false

True/False to enable/disable limit feature.

◆ triggerThresholdCurrent

double com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration.triggerThresholdCurrent = 0

Current must exceed this threshold (amperes) before limiting occurs. If this value is less than currentLimit, then currentLimit is used as the threshold.

◆ triggerThresholdTime

double com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration.triggerThresholdTime = 0

How long current must exceed threshold (seconds) before limiting occurs.


The documentation for this class was generated from the following file: