CTRE Phoenix Pro C++ 23.0.12
|
Class for CANcoder, a CAN based magnetic encoder that provides absolute and relative position along with filtered velocity. More...
#include <ctre/phoenixpro/core/CoreCANcoder.hpp>
Public Member Functions | |
CANcoderConfigurator (const CANcoderConfigurator &)=delete | |
Delete the copy constructor, we can only pass by reference. More... | |
ctre::phoenix::StatusCode | Refresh (CANcoderConfiguration &configs) const |
Refreshes the values of the specified config group. More... | |
ctre::phoenix::StatusCode | Refresh (CANcoderConfiguration &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. More... | |
ctre::phoenix::StatusCode | Apply (const CANcoderConfiguration &configs) |
Applies the contents of the specified config to the device. More... | |
ctre::phoenix::StatusCode | Apply (const CANcoderConfiguration &configs, units::time::second_t timeoutSeconds) |
Applies the contents of the specified config to the device. More... | |
ctre::phoenix::StatusCode | Refresh (MagnetSensorConfigs &configs) const |
Refreshes the values of the specified config group. More... | |
ctre::phoenix::StatusCode | Refresh (MagnetSensorConfigs &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. More... | |
ctre::phoenix::StatusCode | Apply (const MagnetSensorConfigs &configs) |
Applies the contents of the specified config to the device. More... | |
ctre::phoenix::StatusCode | Apply (const MagnetSensorConfigs &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) |
The position to set the sensor position to right now. More... | |
ctre::phoenix::StatusCode | SetPosition (units::angle::turn_t newValue, units::time::second_t timeoutSeconds) |
The position to set the sensor 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 |
Class for CANcoder, a CAN based magnetic encoder that provides absolute and relative position along with filtered velocity.
This handles the configurations for the hardware::CANcoder
|
delete |
Delete the copy constructor, we can only pass by reference.
|
inline |
Applies the contents of the specified config to the device.
This will wait up to defaultTimeoutSeconds.
Call to apply the selected configs.
configs | Configs to apply against. |
|
inline |
Applies the contents of the specified config to the device.
Call to apply the selected configs.
configs | Configs to apply against. |
timeoutSeconds | Maximum amount of time to wait when performing configuration |
|
inline |
Applies the contents of the specified config to the device.
This will wait up to defaultTimeoutSeconds.
Call to apply the selected configs.
configs | Configs to apply against. |
|
inline |
Applies the contents of the specified config to the device.
Call to apply the selected configs.
configs | Configs to apply against. |
timeoutSeconds | Maximum amount of time to wait when performing configuration |
|
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.
|
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.
timeoutSeconds | Maximum time to wait up to in seconds. |
|
inline |
Refreshes the values of the specified config group.
This will wait up to defaultTimeoutSeconds.
Call to refresh the selected configs from the device.
configs | The configs to refresh |
|
inline |
Refreshes the values of the specified config group.
Call to refresh the selected configs from the device.
configs | The configs to refresh |
timeoutSeconds | Maximum amount of time to wait when performing configuration |
|
inline |
Refreshes the values of the specified config group.
This will wait up to defaultTimeoutSeconds.
Call to refresh the selected configs from the device.
configs | The configs to refresh |
|
inline |
Refreshes the values of the specified config group.
Call to refresh the selected configs from the device.
configs | The configs to refresh |
timeoutSeconds | Maximum amount of time to wait when performing configuration |
|
inline |
The position to set the sensor 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.
newValue | Value to set to. |
|
inline |
The position to set the sensor 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.
newValue | Value to set to. |
timeoutSeconds | Maximum time to wait up to in seconds. |