Class description for the Talon FX integrated motor controller. More...
#include <ctre/phoenix6/core/CoreTalonFX.hpp>
Public Member Functions | |
| 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 (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 (DifferentialSensorsConfigs &configs) const |
| Refreshes the values of the specified config group. More... | |
| ctre::phoenix::StatusCode | Refresh (DifferentialSensorsConfigs &configs, units::time::second_t timeoutSeconds) const |
| Refreshes the values of the specified config group. More... | |
| ctre::phoenix::StatusCode | Apply (const DifferentialSensorsConfigs &configs) |
| Applies the contents of the specified config to the device. More... | |
| ctre::phoenix::StatusCode | Apply (const DifferentialSensorsConfigs &configs, units::time::second_t timeoutSeconds) |
| Applies the contents of the specified config to the device. More... | |
| ctre::phoenix::StatusCode | Refresh (DifferentialConstantsConfigs &configs) const |
| Refreshes the values of the specified config group. More... | |
| ctre::phoenix::StatusCode | Refresh (DifferentialConstantsConfigs &configs, units::time::second_t timeoutSeconds) const |
| Refreshes the values of the specified config group. More... | |
| ctre::phoenix::StatusCode | Apply (const DifferentialConstantsConfigs &configs) |
| Applies the contents of the specified config to the device. More... | |
| ctre::phoenix::StatusCode | Apply (const DifferentialConstantsConfigs &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 | 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 (SlotConfigs &configs) const |
| Refreshes the values of the specified config group. More... | |
| ctre::phoenix::StatusCode | Refresh (SlotConfigs &configs, units::time::second_t timeoutSeconds) const |
| Refreshes the values of the specified config group. More... | |
| ctre::phoenix::StatusCode | Apply (const SlotConfigs &configs) |
| Applies the contents of the specified config to the device. More... | |
| ctre::phoenix::StatusCode | Apply (const SlotConfigs &configs, units::time::second_t timeoutSeconds) |
| Applies the contents of the specified config to the device. More... | |
| ctre::phoenix::StatusCode | SetPosition (units::angle::turn_t newValue) |
| Sets the mechanism position of the device in mechanism rotations. More... | |
| ctre::phoenix::StatusCode | SetPosition (units::angle::turn_t newValue, units::time::second_t timeoutSeconds) |
| Sets the mechanism position of the device in mechanism rotations. 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... | |
| ctre::phoenix::StatusCode | ClearStickyFault_Hardware () |
| Clear sticky fault: Hardware fault occurred. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_Hardware (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Hardware fault occurred. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ProcTemp () |
| Clear sticky fault: Processor temperature exceeded limit. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ProcTemp (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Processor temperature exceeded limit. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_DeviceTemp () |
| Clear sticky fault: Device temperature exceeded limit. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_DeviceTemp (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Device temperature exceeded limit. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_Undervoltage () |
| Clear sticky fault: Device supply voltage dropped to near brownout levels. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_Undervoltage (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Device supply voltage dropped to near brownout levels. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_BootDuringEnable () |
| Clear sticky fault: Device boot while detecting the enable signal. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_BootDuringEnable (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Device boot while detecting the enable signal. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_BridgeBrownout () |
| Clear sticky fault: Bridge was disabled most likely due to supply voltage dropping too low. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_BridgeBrownout (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Bridge was disabled most likely due to supply voltage dropping too low. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_RemoteSensorReset () |
| Clear sticky fault: The remote sensor has reset. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_RemoteSensorReset (units::time::second_t timeoutSeconds) |
| Clear sticky fault: The remote sensor has reset. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_MissingDifferentialFX () |
| Clear sticky fault: The remote Talon FX used for differential control is not present on CAN Bus. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_MissingDifferentialFX (units::time::second_t timeoutSeconds) |
| Clear sticky fault: The remote Talon FX used for differential control is not present on CAN Bus. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_RemoteSensorPosOverflow () |
| Clear sticky fault: The remote sensor position has overflowed. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_RemoteSensorPosOverflow (units::time::second_t timeoutSeconds) |
| Clear sticky fault: The remote sensor position has overflowed. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_OverSupplyV () |
| Clear sticky fault: Supply Voltage has exceeded the maximum voltage rating of device. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_OverSupplyV (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Supply Voltage has exceeded the maximum voltage rating of device. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_UnstableSupplyV () |
| Clear sticky fault: Supply Voltage is unstable. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_UnstableSupplyV (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Supply Voltage is unstable. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ReverseHardLimit () |
| Clear sticky fault: Reverse limit switch has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ReverseHardLimit (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Reverse limit switch has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ForwardHardLimit () |
| Clear sticky fault: Forward limit switch has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ForwardHardLimit (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Forward limit switch has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ReverseSoftLimit () |
| Clear sticky fault: Reverse soft limit has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ReverseSoftLimit (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Reverse soft limit has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ForwardSoftLimit () |
| Clear sticky fault: Forward soft limit has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_ForwardSoftLimit (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Forward soft limit has been asserted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_RemoteSensorDataInvalid () |
| Clear sticky fault: The remote sensor's data is no longer trusted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_RemoteSensorDataInvalid (units::time::second_t timeoutSeconds) |
| Clear sticky fault: The remote sensor's data is no longer trusted. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_FusedSensorOutOfSync () |
| Clear sticky fault: The remote sensor used for fusion has fallen out of sync to the local sensor. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_FusedSensorOutOfSync (units::time::second_t timeoutSeconds) |
| Clear sticky fault: The remote sensor used for fusion has fallen out of sync to the local sensor. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_StatorCurrLimit () |
| Clear sticky fault: Stator current limit occured. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_StatorCurrLimit (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Stator current limit occured. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_SupplyCurrLimit () |
| Clear sticky fault: Supply current limit occured. More... | |
| ctre::phoenix::StatusCode | ClearStickyFault_SupplyCurrLimit (units::time::second_t timeoutSeconds) |
| Clear sticky fault: Supply current limit occured. More... | |
Additional Inherited Members | |
 Public Attributes inherited from ctre::phoenix6::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::phoenix6::configs::ParentConfigurator | |
| ParentConfigurator (hardware::DeviceIdentifier deviceIdentifier) | |
| ParentConfigurator (ParentConfigurator &&)=default | |
| ParentConfigurator & | operator= (ParentConfigurator &&)=default |
| 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.
This handles the configurations for the hardware::TalonFX
Member Function Documentation
◆ Apply() [1/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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() [35/40]
|
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() [36/40]
|
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() [37/40]
|
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() [38/40]
|
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() [39/40]
|
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() [40/40]
|
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
◆ ClearStickyFault_BootDuringEnable() [1/2]
|
inline |
Clear sticky fault: Device boot while detecting the enable signal.
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
◆ ClearStickyFault_BootDuringEnable() [2/2]
|
inline |
Clear sticky fault: Device boot while detecting the enable signal.
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
◆ ClearStickyFault_BridgeBrownout() [1/2]
|
inline |
Clear sticky fault: Bridge was disabled most likely due to supply voltage dropping too low.
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
◆ ClearStickyFault_BridgeBrownout() [2/2]
|
inline |
Clear sticky fault: Bridge was disabled most likely due to supply voltage dropping too low.
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
◆ ClearStickyFault_DeviceTemp() [1/2]
|
inline |
Clear sticky fault: Device temperature exceeded limit.
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
◆ ClearStickyFault_DeviceTemp() [2/2]
|
inline |
Clear sticky fault: Device temperature exceeded limit.
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
◆ ClearStickyFault_ForwardHardLimit() [1/2]
|
inline |
Clear sticky fault: Forward limit switch has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_ForwardHardLimit() [2/2]
|
inline |
Clear sticky fault: Forward limit switch has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_ForwardSoftLimit() [1/2]
|
inline |
Clear sticky fault: Forward soft limit has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_ForwardSoftLimit() [2/2]
|
inline |
Clear sticky fault: Forward soft limit has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_FusedSensorOutOfSync() [1/2]
|
inline |
Clear sticky fault: The remote sensor used for fusion has fallen out of sync to the local sensor.
A re-synchronization has occurred, which may cause a discontinuity. This typically happens if there is significant slop in the mechanism, or if the RotorToSensorRatio configuration parameter is incorrect.
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
◆ ClearStickyFault_FusedSensorOutOfSync() [2/2]
|
inline |
Clear sticky fault: The remote sensor used for fusion has fallen out of sync to the local sensor.
A re-synchronization has occurred, which may cause a discontinuity. This typically happens if there is significant slop in the mechanism, or if the RotorToSensorRatio configuration parameter is incorrect.
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
◆ ClearStickyFault_Hardware() [1/2]
|
inline |
Clear sticky fault: Hardware fault occurred.
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
◆ ClearStickyFault_Hardware() [2/2]
|
inline |
Clear sticky fault: Hardware fault occurred.
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
◆ ClearStickyFault_MissingDifferentialFX() [1/2]
|
inline |
Clear sticky fault: The remote Talon FX used for differential control is not present on CAN Bus.
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
◆ ClearStickyFault_MissingDifferentialFX() [2/2]
|
inline |
Clear sticky fault: The remote Talon FX used for differential control is not present on CAN Bus.
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
◆ ClearStickyFault_OverSupplyV() [1/2]
|
inline |
Clear sticky fault: Supply Voltage has exceeded the maximum voltage rating of device.
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
◆ ClearStickyFault_OverSupplyV() [2/2]
|
inline |
Clear sticky fault: Supply Voltage has exceeded the maximum voltage rating of device.
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
◆ ClearStickyFault_ProcTemp() [1/2]
|
inline |
Clear sticky fault: Processor temperature exceeded limit.
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
◆ ClearStickyFault_ProcTemp() [2/2]
|
inline |
Clear sticky fault: Processor temperature exceeded limit.
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
◆ ClearStickyFault_RemoteSensorDataInvalid() [1/2]
|
inline |
Clear sticky fault: The remote sensor's data is no longer trusted.
This can happen if the remote sensor disappears from the CAN bus or if the remote sensor indicates its data is no longer valid, such as when a CANcoder's magnet strength falls into the "red" range.
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
◆ ClearStickyFault_RemoteSensorDataInvalid() [2/2]
|
inline |
Clear sticky fault: The remote sensor's data is no longer trusted.
This can happen if the remote sensor disappears from the CAN bus or if the remote sensor indicates its data is no longer valid, such as when a CANcoder's magnet strength falls into the "red" range.
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
◆ ClearStickyFault_RemoteSensorPosOverflow() [1/2]
|
inline |
Clear sticky fault: The remote sensor position has overflowed.
Because of the nature of remote sensors, it is possible for the remote sensor position to overflow beyond what is supported by the status signal frame. However, this is rare and cannot occur over the course of an FRC match under normal use.
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
◆ ClearStickyFault_RemoteSensorPosOverflow() [2/2]
|
inline |
Clear sticky fault: The remote sensor position has overflowed.
Because of the nature of remote sensors, it is possible for the remote sensor position to overflow beyond what is supported by the status signal frame. However, this is rare and cannot occur over the course of an FRC match under normal use.
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
◆ ClearStickyFault_RemoteSensorReset() [1/2]
|
inline |
Clear sticky fault: The remote sensor has reset.
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
◆ ClearStickyFault_RemoteSensorReset() [2/2]
|
inline |
Clear sticky fault: The remote sensor has reset.
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
◆ ClearStickyFault_ReverseHardLimit() [1/2]
|
inline |
Clear sticky fault: Reverse limit switch has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_ReverseHardLimit() [2/2]
|
inline |
Clear sticky fault: Reverse limit switch has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_ReverseSoftLimit() [1/2]
|
inline |
Clear sticky fault: Reverse soft limit has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_ReverseSoftLimit() [2/2]
|
inline |
Clear sticky fault: Reverse soft limit has been asserted.
Output is set to neutral.
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
◆ ClearStickyFault_StatorCurrLimit() [1/2]
|
inline |
Clear sticky fault: Stator current limit occured.
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
◆ ClearStickyFault_StatorCurrLimit() [2/2]
|
inline |
Clear sticky fault: Stator current limit occured.
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
◆ ClearStickyFault_SupplyCurrLimit() [1/2]
|
inline |
Clear sticky fault: Supply current limit occured.
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
◆ ClearStickyFault_SupplyCurrLimit() [2/2]
|
inline |
Clear sticky fault: Supply current limit occured.
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
◆ ClearStickyFault_Undervoltage() [1/2]
|
inline |
Clear sticky fault: Device supply voltage dropped to near brownout levels.
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
◆ ClearStickyFault_Undervoltage() [2/2]
|
inline |
Clear sticky fault: Device supply voltage dropped to near brownout levels.
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
◆ ClearStickyFault_UnstableSupplyV() [1/2]
|
inline |
Clear sticky fault: Supply Voltage is unstable.
Ensure you are using a battery and current limited power supply.
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
◆ ClearStickyFault_UnstableSupplyV() [2/2]
|
inline |
Clear sticky fault: Supply Voltage is unstable.
Ensure you are using a battery and current limited power supply.
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
◆ ClearStickyFaults() [1/2]
|
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]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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/40]
|
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() [35/40]
|
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() [36/40]
|
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() [37/40]
|
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() [38/40]
|
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() [39/40]
|
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() [40/40]
|
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
◆ SetPosition() [1/2]
|
inline |
Sets the mechanism position of the device in mechanism rotations.
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. Units are in rotations.
- Returns
- StatusCode of the set command
◆ SetPosition() [2/2]
|
inline |
Sets the mechanism position of the device in mechanism rotations.
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. Units are in rotations. 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/phoenix6/core/CoreTalonFX.hpp
