CTRE Phoenix 6 C++ 24.3.0
|
Request PID to target velocity with voltage feedforward. More...
#include <ctre/phoenix6/controls/VelocityVoltage.hpp>
Public Member Functions | |
VelocityVoltage (units::angular_velocity::turns_per_second_t Velocity, units::angular_acceleration::turns_per_second_squared_t Acceleration=0.0_tr_per_s_sq, bool EnableFOC=true, units::voltage::volt_t FeedForward=0.0_V, int Slot=0, bool OverrideBrakeDurNeutral=false, bool LimitForwardMotion=false, bool LimitReverseMotion=false) | |
Request PID to target velocity with voltage feedforward. More... | |
VelocityVoltage & | WithVelocity (units::angular_velocity::turns_per_second_t newVelocity) |
Modifies this Control Request's Velocity parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithAcceleration (units::angular_acceleration::turns_per_second_squared_t newAcceleration) |
Modifies this Control Request's Acceleration parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithEnableFOC (bool newEnableFOC) |
Modifies this Control Request's EnableFOC parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithFeedForward (units::voltage::volt_t newFeedForward) |
Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithSlot (int newSlot) |
Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithOverrideBrakeDurNeutral (bool newOverrideBrakeDurNeutral) |
Modifies this Control Request's OverrideBrakeDurNeutral parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithLimitForwardMotion (bool newLimitForwardMotion) |
Modifies this Control Request's LimitForwardMotion parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithLimitReverseMotion (bool newLimitReverseMotion) |
Modifies this Control Request's LimitReverseMotion parameter and returns itself for method-chaining and easier to use request API. More... | |
VelocityVoltage & | WithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz) |
Sets the period at which this control will update at. More... | |
std::string | ToString () const override |
Returns a string representation of the object. More... | |
std::map< std::string, std::string > | GetControlInfo () const override |
Gets information about this control request. More... | |
Public Member Functions inherited from ctre::phoenix6::controls::ControlRequest | |
ControlRequest (std::string name) | |
Constructs a new Control Request with the given name. More... | |
std::string const & | GetName () const |
virtual std::map< std::string, std::string > | GetControlInfo () const =0 |
Gets information about this control request. More... | |
virtual | ~ControlRequest ()=default |
virtual std::string | ToString () const =0 |
Public Attributes | |
units::angular_velocity::turns_per_second_t | Velocity |
Velocity to drive toward in rotations per second. More... | |
units::angular_acceleration::turns_per_second_squared_t | Acceleration |
Acceleration to drive toward in rotations per second squared. More... | |
bool | EnableFOC |
Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15%. More... | |
units::voltage::volt_t | FeedForward |
Feedforward to apply in volts. More... | |
int | Slot |
Select which gains are applied by selecting the slot. More... | |
bool | OverrideBrakeDurNeutral |
Set to true to static-brake the rotor when output is zero (or within deadband). More... | |
bool | LimitForwardMotion |
Set to true to force forward limiting. More... | |
bool | LimitReverseMotion |
Set to true to force reverse limiting. More... | |
units::frequency::hertz_t | UpdateFreqHz {100_Hz} |
The period at which this control will update at. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ctre::phoenix6::controls::ControlRequest | |
ControlRequest (ControlRequest const &)=default | |
ControlRequest (ControlRequest &&)=default | |
ControlRequest & | operator= (ControlRequest const &)=default |
ControlRequest & | operator= (ControlRequest &&)=default |
Protected Attributes inherited from ctre::phoenix6::controls::ControlRequest | |
std::string | name |
Request PID to target velocity with voltage feedforward.
This control mode will set the motor's velocity setpoint to the velocity specified by the user. In addition, it will apply an additional voltage as an arbitrary feedforward value.
|
inline |
Request PID to target velocity with voltage feedforward.
This control mode will set the motor's velocity setpoint to the velocity specified by the user. In addition, it will apply an additional voltage as an arbitrary feedforward value.
Velocity | Velocity to drive toward in rotations per second. |
Acceleration | Acceleration to drive toward in rotations per second squared. This is typically used for motion profiles generated by the robot program. |
EnableFOC | Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15%. Set to false to use trapezoidal commutation. |
FOC improves motor performance by leveraging torque (current) control. However, this may be inconvenient for applications that require specifying duty cycle or voltage. CTR-Electronics has developed a hybrid method that combines the performances gains of FOC while still allowing applications to provide duty cycle or voltage demand. This not to be confused with simple sinusoidal control or phase voltage control which lacks the performance gains.
FeedForward | Feedforward to apply in volts |
Slot | Select which gains are applied by selecting the slot. Use the configuration api to set the gain values for the selected slot before enabling this feature. Slot must be within [0,2]. |
OverrideBrakeDurNeutral | Set to true to static-brake the rotor when output is zero (or within deadband). Set to false to use the NeutralMode configuration setting (default). This flag exists to provide the fundamental behavior of this control when output is zero, which is to provide 0V to the motor. |
LimitForwardMotion | Set to true to force forward limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power. |
LimitReverseMotion | Set to true to force reverse limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power. |
|
inlineoverridevirtual |
Gets information about this control request.
Implements ctre::phoenix6::controls::ControlRequest.
|
inlineoverridevirtual |
Returns a string representation of the object.
Implements ctre::phoenix6::controls::ControlRequest.
|
inline |
Modifies this Control Request's Acceleration parameter and returns itself for method-chaining and easier to use request API.
Acceleration to drive toward in rotations per second squared. This is typically used for motion profiles generated by the robot program.
newAcceleration | Parameter to modify |
|
inline |
Modifies this Control Request's EnableFOC parameter and returns itself for method-chaining and easier to use request API.
Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15%. Set to false to use trapezoidal commutation.
FOC improves motor performance by leveraging torque (current) control. However, this may be inconvenient for applications that require specifying duty cycle or voltage. CTR-Electronics has developed a hybrid method that combines the performances gains of FOC while still allowing applications to provide duty cycle or voltage demand. This not to be confused with simple sinusoidal control or phase voltage control which lacks the performance gains.
newEnableFOC | Parameter to modify |
|
inline |
Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API.
Feedforward to apply in volts
newFeedForward | Parameter to modify |
|
inline |
Modifies this Control Request's LimitForwardMotion parameter and returns itself for method-chaining and easier to use request API.
Set to true to force forward limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.
newLimitForwardMotion | Parameter to modify |
|
inline |
Modifies this Control Request's LimitReverseMotion parameter and returns itself for method-chaining and easier to use request API.
Set to true to force reverse limiting. This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.
newLimitReverseMotion | Parameter to modify |
|
inline |
Modifies this Control Request's OverrideBrakeDurNeutral parameter and returns itself for method-chaining and easier to use request API.
Set to true to static-brake the rotor when output is zero (or within deadband). Set to false to use the NeutralMode configuration setting (default). This flag exists to provide the fundamental behavior of this control when output is zero, which is to provide 0V to the motor.
newOverrideBrakeDurNeutral | Parameter to modify |
|
inline |
Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.
Select which gains are applied by selecting the slot. Use the configuration api to set the gain values for the selected slot before enabling this feature. Slot must be within [0,2].
newSlot | Parameter to modify |
|
inline |
Sets the period at which this control will update at.
This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).
If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.
newUpdateFreqHz | Parameter to modify |
|
inline |
Modifies this Control Request's Velocity parameter and returns itself for method-chaining and easier to use request API.
Velocity to drive toward in rotations per second.
newVelocity | Parameter to modify |
units::angular_acceleration::turns_per_second_squared_t ctre::phoenix6::controls::VelocityVoltage::Acceleration |
Acceleration to drive toward in rotations per second squared.
This is typically used for motion profiles generated by the robot program.
bool ctre::phoenix6::controls::VelocityVoltage::EnableFOC |
Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15%.
Set to false to use trapezoidal commutation.
FOC improves motor performance by leveraging torque (current) control. However, this may be inconvenient for applications that require specifying duty cycle or voltage. CTR-Electronics has developed a hybrid method that combines the performances gains of FOC while still allowing applications to provide duty cycle or voltage demand. This not to be confused with simple sinusoidal control or phase voltage control which lacks the performance gains.
units::voltage::volt_t ctre::phoenix6::controls::VelocityVoltage::FeedForward |
Feedforward to apply in volts.
bool ctre::phoenix6::controls::VelocityVoltage::LimitForwardMotion |
Set to true to force forward limiting.
This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.
bool ctre::phoenix6::controls::VelocityVoltage::LimitReverseMotion |
Set to true to force reverse limiting.
This allows users to use other limit switch sensors connected to robot controller. This also allows use of active sensors that require external power.
bool ctre::phoenix6::controls::VelocityVoltage::OverrideBrakeDurNeutral |
Set to true to static-brake the rotor when output is zero (or within deadband).
Set to false to use the NeutralMode configuration setting (default). This flag exists to provide the fundamental behavior of this control when output is zero, which is to provide 0V to the motor.
int ctre::phoenix6::controls::VelocityVoltage::Slot |
Select which gains are applied by selecting the slot.
Use the configuration api to set the gain values for the selected slot before enabling this feature. Slot must be within [0,2].
units::frequency::hertz_t ctre::phoenix6::controls::VelocityVoltage::UpdateFreqHz {100_Hz} |
The period at which this control will update at.
This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).
If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.
units::angular_velocity::turns_per_second_t ctre::phoenix6::controls::VelocityVoltage::Velocity |
Velocity to drive toward in rotations per second.