ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration Struct Reference

Describes the desired stator current limiting behavior. More...

#include <ctre/phoenix/motorcontrol/StatorCurrentLimitConfiguration.h>

Public Member Functions
	StatorCurrentLimitConfiguration ()
	Default c'tor. More...
	StatorCurrentLimitConfiguration (const double *doubleArray, int doubleArraySz)
	StatorCurrentLimitConfiguration (bool enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime)
std::string	ToString () const
std::vector< double >	ToArray () const
void	Deserialize (const double *doubles, int doubleCnt)
bool	Equals (const StatorCurrentLimitConfiguration &rhs) const

Public Attributes
bool	enable = false
	True/False to enable/disable limit feature. More...
double	currentLimit = 0
	The "holding" current (amperes) to limit to when feature is activated. More...
double	triggerThresholdCurrent = 0
	Current must exceed this threshold (amperes) before limiting occurs. More...
double	triggerThresholdTime = 0
	How long current must exceed threshold (seconds) before limiting occurs. More...

Detailed Description

Describes the desired stator current limiting behavior.

Deprecated:

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.

Constructor & Destructor Documentation

StatorCurrentLimitConfiguration() [1/3]

ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::StatorCurrentLimitConfiguration ( )

inline

Default c'tor.

Because currentLimit is zero, limiting id disabled.

StatorCurrentLimitConfiguration() [2/3]

ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::StatorCurrentLimitConfiguration ( const double *  doubleArray, int  doubleArraySz  )

inline

StatorCurrentLimitConfiguration() [3/3]

ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::StatorCurrentLimitConfiguration ( bool  enable, double  currentLimit, double  triggerThresholdCurrent, double  triggerThresholdTime  )

inline

Member Function Documentation

Deserialize()

void ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::Deserialize ( const double *  doubles, int  doubleCnt  )

inline

Equals()

bool ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::Equals ( const StatorCurrentLimitConfiguration &  rhs ) const

inline

ToArray()

std::vector< double > ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::ToArray ( ) const

inline

ToString()

std::string ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::ToString ( ) const

inline

Returns

string representation of current faults tripped

Member Data Documentation

currentLimit

double ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::currentLimit = 0

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

enable

bool ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::enable = false

True/False to enable/disable limit feature.

triggerThresholdCurrent

double ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::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 ctre::phoenix::motorcontrol::StatorCurrentLimitConfiguration::triggerThresholdTime = 0

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

---

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

• ctre/phoenix/motorcontrol/StatorCurrentLimitConfiguration.h