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::TalonFXConfigurator:

Public Member Functions
	TalonFXConfigurator (const TalonFXConfigurator &)=delete
	Delete the copy constructor, we can only pass by reference. More...

ctre::phoenix::StatusCode	Refresh (TalonFXConfiguration &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (TalonFXConfiguration &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const TalonFXConfiguration &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const TalonFXConfiguration &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (Slot0Configs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (Slot0Configs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const Slot0Configs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const Slot0Configs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (Slot1Configs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (Slot1Configs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const Slot1Configs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const Slot1Configs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (Slot2Configs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (Slot2Configs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const Slot2Configs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const Slot2Configs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (MotorOutputConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (MotorOutputConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const MotorOutputConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const MotorOutputConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (CurrentLimitsConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (CurrentLimitsConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const CurrentLimitsConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const CurrentLimitsConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (VoltageConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (VoltageConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const VoltageConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const VoltageConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (TorqueCurrentConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (TorqueCurrentConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const TorqueCurrentConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const TorqueCurrentConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (FeedbackConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (FeedbackConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const FeedbackConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const FeedbackConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (OpenLoopRampsConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (OpenLoopRampsConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const OpenLoopRampsConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const OpenLoopRampsConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (ClosedLoopRampsConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (ClosedLoopRampsConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const ClosedLoopRampsConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const ClosedLoopRampsConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (HardwareLimitSwitchConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (HardwareLimitSwitchConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const HardwareLimitSwitchConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const HardwareLimitSwitchConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (AudioConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (AudioConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const AudioConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const AudioConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (SoftwareLimitSwitchConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (SoftwareLimitSwitchConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const SoftwareLimitSwitchConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const SoftwareLimitSwitchConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (MotionMagicConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (MotionMagicConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const MotionMagicConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const MotionMagicConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (CustomParamsConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (CustomParamsConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const CustomParamsConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const CustomParamsConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Refresh (ClosedLoopGeneralConfigs &configs) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Refresh (ClosedLoopGeneralConfigs &configs, units::time::second_t timeoutSeconds) const
	Refreshes the values of the specified config group. More...

ctre::phoenix::StatusCode	Apply (const ClosedLoopGeneralConfigs &configs)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	Apply (const ClosedLoopGeneralConfigs &configs, units::time::second_t timeoutSeconds)
	Applies the contents of the specified config to the device. More...

ctre::phoenix::StatusCode	SetRotorPosition (units::angle::turn_t newValue)
	The position to set the rotor position to right now. More...

ctre::phoenix::StatusCode	SetRotorPosition (units::angle::turn_t newValue, units::time::second_t timeoutSeconds)
	The position to set the rotor position to right now. More...

ctre::phoenix::StatusCode	ClearStickyFaults ()
	Clear the sticky faults in the device. More...

ctre::phoenix::StatusCode	ClearStickyFaults (units::time::second_t timeoutSeconds)
	Clear the sticky faults in the device. More...

Additional Inherited Members
Public Attributes inherited from ctre::phoenixpro::configs::ParentConfigurator
units::time::second_t	defaultTimeoutSeconds {0.050_s}
	The default amount of time to wait for a config. More...

Protected Member Functions inherited from ctre::phoenixpro::configs::ParentConfigurator
	ParentConfigurator (hardware::DeviceIdentifier deviceIdentifier)

ctre::phoenix::StatusCode	SetConfigsPrivate (const std::string &serializedString, units::time::second_t timeoutSeconds, bool futureProofConfigs, bool overrideIfDuplicate)

ctre::phoenix::StatusCode	GetConfigsPrivate (std::string &serializedString, units::time::second_t timeoutSeconds) const

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

Constructor & Destructor Documentation

◆ TalonFXConfigurator()

ctre::phoenixpro::configs::TalonFXConfigurator::TalonFXConfigurator ( const TalonFXConfigurator & )

delete

Delete the copy constructor, we can only pass by reference.

Member Function Documentation

◆ Apply() [1/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const AudioConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [2/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const AudioConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [3/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const ClosedLoopGeneralConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [4/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const ClosedLoopGeneralConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [5/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const ClosedLoopRampsConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [6/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const ClosedLoopRampsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [7/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const CurrentLimitsConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [8/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const CurrentLimitsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [9/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const CustomParamsConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [10/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const CustomParamsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [11/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const FeedbackConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [12/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const FeedbackConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [13/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const HardwareLimitSwitchConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [14/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const HardwareLimitSwitchConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [15/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const MotionMagicConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [16/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const MotionMagicConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [17/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const MotorOutputConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [18/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const MotorOutputConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [19/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const OpenLoopRampsConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [20/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const OpenLoopRampsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [21/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const Slot0Configs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [22/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const Slot0Configs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [23/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const Slot1Configs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [24/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const Slot1Configs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [25/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const Slot2Configs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [26/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const Slot2Configs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [27/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const SoftwareLimitSwitchConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [28/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const SoftwareLimitSwitchConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [29/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const TalonFXConfiguration & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [30/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const TalonFXConfiguration &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [31/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const TorqueCurrentConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [32/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const TorqueCurrentConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ Apply() [33/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply ( const VoltageConfigs & configs )

inline

Applies the contents of the specified config to the device.

This will wait up to defaultTimeoutSeconds.

Call to apply the selected configs.

Parameters

configs Configs to apply against.

Returns: StatusCode of the set command

◆ Apply() [34/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Apply	(	const VoltageConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)

inline

Applies the contents of the specified config to the device.

Call to apply the selected configs.

Parameters

configs	Configs to apply against.
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of the set command

◆ ClearStickyFaults() [1/2]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::ClearStickyFaults ( )

inline

Clear the sticky faults in the device.

This typically has no impact on the device functionality. Instead, it just clears telemetry faults that are accessible via API and Tuner Self-Test.

This will wait up to defaultTimeoutSeconds.

This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

Returns: StatusCode of the set command

◆ ClearStickyFaults() [2/2]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::ClearStickyFaults ( units::time::second_t timeoutSeconds )

inline

Clear the sticky faults in the device.

This typically has no impact on the device functionality. Instead, it just clears telemetry faults that are accessible via API and Tuner Self-Test.

This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

Parameters

timeoutSeconds Maximum time to wait up to in seconds.

Returns: StatusCode of the set command

◆ Refresh() [1/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( AudioConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [2/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	AudioConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [3/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( ClosedLoopGeneralConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [4/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	ClosedLoopGeneralConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [5/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( ClosedLoopRampsConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [6/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	ClosedLoopRampsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [7/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( CurrentLimitsConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [8/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	CurrentLimitsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [9/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( CustomParamsConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [10/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	CustomParamsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [11/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( FeedbackConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [12/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	FeedbackConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [13/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( HardwareLimitSwitchConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [14/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	HardwareLimitSwitchConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [15/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( MotionMagicConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [16/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	MotionMagicConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [17/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( MotorOutputConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [18/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	MotorOutputConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [19/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( OpenLoopRampsConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [20/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	OpenLoopRampsConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [21/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( Slot0Configs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [22/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	Slot0Configs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [23/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( Slot1Configs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [24/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	Slot1Configs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [25/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( Slot2Configs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [26/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	Slot2Configs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [27/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( SoftwareLimitSwitchConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [28/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	SoftwareLimitSwitchConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [29/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( TalonFXConfiguration & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [30/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	TalonFXConfiguration &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [31/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( TorqueCurrentConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [32/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	TorqueCurrentConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ Refresh() [33/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh ( VoltageConfigs & configs ) const

inline

Refreshes the values of the specified config group.

This will wait up to defaultTimeoutSeconds.

Call to refresh the selected configs from the device.

Parameters

configs The configs to refresh

Returns: StatusCode of refreshing the configs

◆ Refresh() [34/34]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::Refresh	(	VoltageConfigs &	configs,
		units::time::second_t	timeoutSeconds
	)		const

inline

Refreshes the values of the specified config group.

Call to refresh the selected configs from the device.

Parameters

configs	The configs to refresh
timeoutSeconds	Maximum amount of time to wait when performing configuration

Returns: StatusCode of refreshing the configs

◆ SetRotorPosition() [1/2]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::SetRotorPosition ( units::angle::turn_t newValue )

inline

The position to set the rotor position to right now.

This will wait up to defaultTimeoutSeconds.

This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

Parameters

newValue Value to set to.

Returns: StatusCode of the set command

◆ SetRotorPosition() [2/2]

ctre::phoenix::StatusCode ctre::phoenixpro::configs::TalonFXConfigurator::SetRotorPosition	(	units::angle::turn_t	newValue,
		units::time::second_t	timeoutSeconds
	)

inline

The position to set the rotor position to right now.

This is available in the configurator in case the user wants to initialize their device entirely without passing a device reference down to the code that performs the initialization. In this case, the user passes down the configurator object and performs all the initialization code on the object.

Parameters

newValue	Value to set to.
timeoutSeconds	Maximum time to wait up to in seconds.

Returns: StatusCode of the set command

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

ctre/phoenixpro/core/CoreTalonFX.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TalonFXConfigurator()

Member Function Documentation

◆ Apply() [1/34]

◆ Apply() [2/34]

◆ Apply() [3/34]

◆ Apply() [4/34]

◆ Apply() [5/34]

◆ Apply() [6/34]

◆ Apply() [7/34]

◆ Apply() [8/34]

◆ Apply() [9/34]

◆ Apply() [10/34]

◆ Apply() [11/34]

◆ Apply() [12/34]

◆ Apply() [13/34]

◆ Apply() [14/34]

◆ Apply() [15/34]

◆ Apply() [16/34]

◆ Apply() [17/34]

◆ Apply() [18/34]

◆ Apply() [19/34]

◆ Apply() [20/34]

◆ Apply() [21/34]

◆ Apply() [22/34]

◆ Apply() [23/34]

◆ Apply() [24/34]

◆ Apply() [25/34]

◆ Apply() [26/34]

◆ Apply() [27/34]

◆ Apply() [28/34]

◆ Apply() [29/34]

◆ Apply() [30/34]

◆ Apply() [31/34]

◆ Apply() [32/34]

◆ Apply() [33/34]

◆ Apply() [34/34]

◆ ClearStickyFaults() [1/2]

◆ ClearStickyFaults() [2/2]

◆ Refresh() [1/34]

◆ Refresh() [2/34]

◆ Refresh() [3/34]

◆ Refresh() [4/34]

◆ Refresh() [5/34]

◆ Refresh() [6/34]

◆ Refresh() [7/34]

◆ Refresh() [8/34]

◆ Refresh() [9/34]

◆ Refresh() [10/34]

◆ Refresh() [11/34]

◆ Refresh() [12/34]

◆ Refresh() [13/34]

◆ Refresh() [14/34]

◆ Refresh() [15/34]

◆ Refresh() [16/34]

◆ Refresh() [17/34]

◆ Refresh() [18/34]

◆ Refresh() [19/34]

◆ Refresh() [20/34]

◆ Refresh() [21/34]

◆ Refresh() [22/34]

◆ Refresh() [23/34]

◆ Refresh() [24/34]

◆ Refresh() [25/34]

◆ Refresh() [26/34]

◆ Refresh() [27/34]

◆ Refresh() [28/34]

◆ Refresh() [29/34]

◆ Refresh() [30/34]

◆ Refresh() [31/34]

◆ Refresh() [32/34]

◆ Refresh() [33/34]

◆ Refresh() [34/34]

◆ SetRotorPosition() [1/2]

◆ SetRotorPosition() [2/2]