CTRE Phoenix Pro C++ 23.0.12
ctre::phoenixpro::configs::TalonFXConfiguration Class Reference

Class description for the Talon FX integrated motor controller that runs on associated Falcon motors. More...

#include <ctre/phoenixpro/core/CoreTalonFX.hpp>

Inheritance diagram for ctre::phoenixpro::configs::TalonFXConfiguration:
ctre::phoenixpro::configs::ParentConfiguration ctre::phoenixpro::ISerializable

Public Member Functions

std::string ToString () const
 Get the string representation of this configuration. More...
 
std::string Serialize () const
 Get the serialized form of this configuration. More...
 
ctre::phoenix::StatusCode Deserialize (const std::string &string)
 Take a string and deserialize it to this configuration. More...
 
virtual std::string ToString () const =0
 
virtual ctre::phoenix::StatusCode Deserialize (const std::string &string)=0
 
virtual std::string Serialize () const =0
 

Public Attributes

bool FutureProofConfigs {true}
 True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone. More...
 
Slot0Configs Slot0
 What the gains for slot 0 are. More...
 
Slot1Configs Slot1
 What the gains for slot 1 are. More...
 
Slot2Configs Slot2
 What the gains for slot 2 are. More...
 
MotorOutputConfigs MotorOutput
 Configs that directly affect motor-output. More...
 
CurrentLimitsConfigs CurrentLimits
 Configs that directly affect current limiting features. More...
 
VoltageConfigs Voltage
 Voltage-specific configs. More...
 
TorqueCurrentConfigs TorqueCurrent
 Configs that directly affect motor-output. More...
 
FeedbackConfigs Feedback
 Configs that directly affect motor-output. More...
 
OpenLoopRampsConfigs OpenLoopRamps
 Configs that directly affect motor-output. More...
 
ClosedLoopRampsConfigs ClosedLoopRamps
 Configs that directly affect motor-output. More...
 
HardwareLimitSwitchConfigs HardwareLimitSwitch
 Configs that directly affect motor-output. More...
 
AudioConfigs Audio
 Configs that directly affect motor-output. More...
 
SoftwareLimitSwitchConfigs SoftwareLimitSwitch
 Configs that directly affect motor-output. More...
 
MotionMagicConfigs MotionMagic
 Configs that directly affect motor-output. More...
 
CustomParamsConfigs CustomParams
 Configs that directly affect motor-output. More...
 
ClosedLoopGeneralConfigs ClosedLoopGeneral
 Configs that affect general behavior during closed-looping. More...
 

Detailed Description

Class description for the Talon FX integrated motor controller that runs on associated Falcon motors.

This handles the configurations for the hardware::TalonFX

Member Function Documentation

◆ Deserialize()

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfiguration::Deserialize ( const std::string &  string)
inlinevirtual

Take a string and deserialize it to this configuration.

Implements ctre::phoenixpro::configs::ParentConfiguration.

◆ Serialize()

std::string ctre::phoenixpro::configs::TalonFXConfiguration::Serialize ( ) const
inlinevirtual

Get the serialized form of this configuration.

Implements ctre::phoenixpro::ISerializable.

◆ ToString()

std::string ctre::phoenixpro::configs::TalonFXConfiguration::ToString ( ) const
inlinevirtual

Get the string representation of this configuration.

Implements ctre::phoenixpro::configs::ParentConfiguration.

Member Data Documentation

◆ Audio

AudioConfigs ctre::phoenixpro::configs::TalonFXConfiguration::Audio

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ ClosedLoopGeneral

ClosedLoopGeneralConfigs ctre::phoenixpro::configs::TalonFXConfiguration::ClosedLoopGeneral

Configs that affect general behavior during closed-looping.

Includes Continuous Wrap features.

◆ ClosedLoopRamps

ClosedLoopRampsConfigs ctre::phoenixpro::configs::TalonFXConfiguration::ClosedLoopRamps

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ CurrentLimits

CurrentLimitsConfigs ctre::phoenixpro::configs::TalonFXConfiguration::CurrentLimits

Configs that directly affect current limiting features.

Includes Motor Invert and various limit features.

◆ CustomParams

CustomParamsConfigs ctre::phoenixpro::configs::TalonFXConfiguration::CustomParams

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ Feedback

FeedbackConfigs ctre::phoenixpro::configs::TalonFXConfiguration::Feedback

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ FutureProofConfigs

bool ctre::phoenixpro::configs::TalonFXConfiguration::FutureProofConfigs {true}

True if we should factory default newer unsupported configs, false to leave newer unsupported configs alone.

This flag addresses a corner case where the device may have firmware with newer configs that didn't exist when this version of the API was built. If this occurs and this flag is true, unsupported new configs will be factory defaulted to avoid unexpected behavior.

This is also the behavior in Phoenix 5, so this flag is defaulted to true to match.

◆ HardwareLimitSwitch

HardwareLimitSwitchConfigs ctre::phoenixpro::configs::TalonFXConfiguration::HardwareLimitSwitch

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ MotionMagic

MotionMagicConfigs ctre::phoenixpro::configs::TalonFXConfiguration::MotionMagic

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ MotorOutput

MotorOutputConfigs ctre::phoenixpro::configs::TalonFXConfiguration::MotorOutput

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ OpenLoopRamps

OpenLoopRampsConfigs ctre::phoenixpro::configs::TalonFXConfiguration::OpenLoopRamps

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ Slot0

Slot0Configs ctre::phoenixpro::configs::TalonFXConfiguration::Slot0

What the gains for slot 0 are.

If this slot is selected, these gains are used in closed loop control requests.

◆ Slot1

Slot1Configs ctre::phoenixpro::configs::TalonFXConfiguration::Slot1

What the gains for slot 1 are.

If this slot is selected, these gains are used in closed loop control requests.

◆ Slot2

Slot2Configs ctre::phoenixpro::configs::TalonFXConfiguration::Slot2

What the gains for slot 2 are.

If this slot is selected, these gains are used in closed loop control requests.

◆ SoftwareLimitSwitch

SoftwareLimitSwitchConfigs ctre::phoenixpro::configs::TalonFXConfiguration::SoftwareLimitSwitch

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ TorqueCurrent

TorqueCurrentConfigs ctre::phoenixpro::configs::TalonFXConfiguration::TorqueCurrent

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

◆ Voltage

VoltageConfigs ctre::phoenixpro::configs::TalonFXConfiguration::Voltage

Voltage-specific configs.

Voltage-specific configs


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