CTRE Phoenix 6 C++ 25.2.1
|
Class for CANdi, a CAN digital input device that detects when a digital signal is asserted or deasserted. More...
#include <ctre/phoenix6/core/CoreCANdi.hpp>
Public Member Functions | |
ctre::phoenix::StatusCode | Refresh (CANdiConfiguration &configs) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Refresh (CANdiConfiguration &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Apply (const CANdiConfiguration &configs) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Apply (const CANdiConfiguration &configs, units::time::second_t timeoutSeconds) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Refresh (CustomParamsConfigs &configs) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Refresh (CustomParamsConfigs &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Apply (const CustomParamsConfigs &configs) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Apply (const CustomParamsConfigs &configs, units::time::second_t timeoutSeconds) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Refresh (DigitalInputsConfigs &configs) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Refresh (DigitalInputsConfigs &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Apply (const DigitalInputsConfigs &configs) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Apply (const DigitalInputsConfigs &configs, units::time::second_t timeoutSeconds) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Refresh (QuadratureConfigs &configs) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Refresh (QuadratureConfigs &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Apply (const QuadratureConfigs &configs) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Apply (const QuadratureConfigs &configs, units::time::second_t timeoutSeconds) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Refresh (PWM1Configs &configs) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Refresh (PWM1Configs &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Apply (const PWM1Configs &configs) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Apply (const PWM1Configs &configs, units::time::second_t timeoutSeconds) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Refresh (PWM2Configs &configs) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Refresh (PWM2Configs &configs, units::time::second_t timeoutSeconds) const |
Refreshes the values of the specified config group. | |
ctre::phoenix::StatusCode | Apply (const PWM2Configs &configs) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | Apply (const PWM2Configs &configs, units::time::second_t timeoutSeconds) |
Applies the contents of the specified config to the device. | |
ctre::phoenix::StatusCode | SetQuadraturePosition (units::angle::turn_t newValue) |
Sets the position of the quadrature input. | |
ctre::phoenix::StatusCode | SetQuadraturePosition (units::angle::turn_t newValue, units::time::second_t timeoutSeconds) |
Sets the position of the quadrature input. | |
ctre::phoenix::StatusCode | ClearStickyFaults () |
Clear the sticky faults in the device. | |
ctre::phoenix::StatusCode | ClearStickyFaults (units::time::second_t timeoutSeconds) |
Clear the sticky faults in the device. | |
ctre::phoenix::StatusCode | ClearStickyFault_Hardware () |
Clear sticky fault: Hardware fault occurred. | |
ctre::phoenix::StatusCode | ClearStickyFault_Hardware (units::time::second_t timeoutSeconds) |
Clear sticky fault: Hardware fault occurred. | |
ctre::phoenix::StatusCode | ClearStickyFault_Undervoltage () |
Clear sticky fault: Device supply voltage dropped to near brownout levels. | |
ctre::phoenix::StatusCode | ClearStickyFault_Undervoltage (units::time::second_t timeoutSeconds) |
Clear sticky fault: Device supply voltage dropped to near brownout levels. | |
ctre::phoenix::StatusCode | ClearStickyFault_BootDuringEnable () |
Clear sticky fault: Device boot while detecting the enable signal. | |
ctre::phoenix::StatusCode | ClearStickyFault_BootDuringEnable (units::time::second_t timeoutSeconds) |
Clear sticky fault: Device boot while detecting the enable signal. | |
ctre::phoenix::StatusCode | ClearStickyFault_UnlicensedFeatureInUse () |
Clear sticky fault: An unlicensed feature is in use, device may not behave as expected. | |
ctre::phoenix::StatusCode | ClearStickyFault_UnlicensedFeatureInUse (units::time::second_t timeoutSeconds) |
Clear sticky fault: An unlicensed feature is in use, device may not behave as expected. | |
ctre::phoenix::StatusCode | ClearStickyFault_5V () |
Clear sticky fault: CANdi has detected a 5V fault. | |
ctre::phoenix::StatusCode | ClearStickyFault_5V (units::time::second_t timeoutSeconds) |
Clear sticky fault: CANdi has detected a 5V fault. | |
Additional Inherited Members | |
![]() | |
units::time::second_t | DefaultTimeoutSeconds {0.100_s} |
The default maximum amount of time to wait for a config. | |
![]() | |
ParentConfigurator (hardware::DeviceIdentifier deviceIdentifier) | |
ParentConfigurator (ParentConfigurator const &)=delete | |
ParentConfigurator & | operator= (ParentConfigurator const &)=delete |
void | ReportIfFrequent () const |
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 CANdi, a CAN digital input device that detects when a digital signal is asserted or deasserted.
This handles the configurations for the hardware::CANdi
|
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 |
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 |
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 sticky fault: CANdi has detected a 5V fault.
This may be due to overcurrent or a short-circuit.
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 sticky fault: CANdi has detected a 5V fault.
This may be due to overcurrent or a short-circuit.
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 |
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.
|
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.
timeoutSeconds | Maximum time to wait up to in seconds. |
|
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.
|
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.
timeoutSeconds | Maximum time to wait up to in seconds. |
|
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.
|
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.
timeoutSeconds | Maximum time to wait up to in seconds. |
|
inline |
Clear sticky fault: An unlicensed feature is in use, device may not behave as expected.
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 sticky fault: An unlicensed feature is in use, device may not behave as expected.
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 |
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 |
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 |
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 |
Sets the position of the quadrature input.
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. Units are in rotations. |
|
inline |
Sets the position of the quadrature input.
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. Units are in rotations. |
timeoutSeconds | Maximum time to wait up to in seconds. |