Request a specified motor current (field oriented control).
More...
#include <ctre/phoenixpro/controls/TorqueCurrentFOC.hpp>
|
units::current::ampere_t | Output |
| Amount of motor current in Amperes. More...
|
|
units::dimensionless::scalar_t | MaxAbsDutyCycle |
| The maximum absolute motor output that can be applied, which effectively limits the velocity. More...
|
|
units::current::ampere_t | Deadband |
| Deadband in Amperes. More...
|
|
bool | OverrideCoastDurNeutral |
| Set to true to coast the rotor when output is zero (or within deadband). More...
|
|
units::time::second_t | ConfigTimeout {0.1_s} |
| The timeout when sending configs associated with this control. More...
|
|
units::frequency::hertz_t | UpdateFreqHz {100_Hz} |
| The period at which this control will update at. More...
|
|
Request a specified motor current (field oriented control).
This control request will drive the motor to the requested motor (stator) current value. This leverages field oriented control (FOC), which means greater peak power than what is documented. This scales to torque based on Motor's kT constant.
◆ TorqueCurrentFOC() [1/2]
ctre::phoenixpro::controls::TorqueCurrentFOC::TorqueCurrentFOC |
( |
units::current::ampere_t |
Output, |
|
|
units::dimensionless::scalar_t |
MaxAbsDutyCycle, |
|
|
units::current::ampere_t |
Deadband, |
|
|
bool |
OverrideCoastDurNeutral |
|
) |
| |
|
inline |
Request a specified motor current (field oriented control).
This control request will drive the motor to the requested motor (stator) current value. This leverages field oriented control (FOC), which means greater peak power than what is documented. This scales to torque based on Motor's kT constant.
- Parameters
-
Output | Amount of motor current in Amperes |
MaxAbsDutyCycle | The maximum absolute motor output that can be applied, which effectively limits the velocity. For example, 0.50 means no more than 50% output in either direction. This is useful for preventing the motor from spinning to its terminal velocity when there is no external torque applied unto the rotor. Note this is absolute maximum, so the value should be between zero and one. |
Deadband | Deadband in Amperes. If torque request is within deadband, the bridge output is neutral. If deadband is set to zero then there is effectively no deadband. Note if deadband is zero, a free spinning motor will spin for quite a while as the firmware attempts to hold the motor's bemf. If user expects motor to cease spinning quickly with a demand of zero, we recommend a deadband of one Ampere. This value will be converted to an integral value of amps. |
OverrideCoastDurNeutral | Set to true to coast 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 0A (zero torque). |
◆ TorqueCurrentFOC() [2/2]
ctre::phoenixpro::controls::TorqueCurrentFOC::TorqueCurrentFOC |
( |
units::current::ampere_t |
Output | ) |
|
|
inline |
Request a specified motor current (field oriented control).
This control request will drive the motor to the requested motor (stator) current value. This leverages field oriented control (FOC), which means greater peak power than what is documented. This scales to torque based on Motor's kT constant.
- Parameters
-
Output | Amount of motor current in Amperes |
◆ ForceApplyConfigs()
void ctre::phoenixpro::controls::TorqueCurrentFOC::ForceApplyConfigs |
( |
| ) |
|
|
inline |
Forces configs to be applied the next time this is used in a setControl.
This is not necessary in the majority of cases, because Phoenix will make sure configs are properly set when they are not already set
◆ ToString()
std::string ctre::phoenixpro::controls::TorqueCurrentFOC::ToString |
( |
| ) |
const |
|
inlinevirtual |
◆ WithDeadband()
TorqueCurrentFOC & ctre::phoenixpro::controls::TorqueCurrentFOC::WithDeadband |
( |
units::current::ampere_t |
newDeadband | ) |
|
|
inline |
Modifies this Control Request's Deadband parameter and returns itself for method-chaining and easier to use request API.
- Parameters
-
newDeadband | Parameter to modify |
- Returns
- Itself
◆ WithMaxAbsDutyCycle()
TorqueCurrentFOC & ctre::phoenixpro::controls::TorqueCurrentFOC::WithMaxAbsDutyCycle |
( |
units::dimensionless::scalar_t |
newMaxAbsDutyCycle | ) |
|
|
inline |
Modifies this Control Request's MaxAbsDutyCycle parameter and returns itself for method-chaining and easier to use request API.
- Parameters
-
newMaxAbsDutyCycle | Parameter to modify |
- Returns
- Itself
◆ WithOutput()
TorqueCurrentFOC & ctre::phoenixpro::controls::TorqueCurrentFOC::WithOutput |
( |
units::current::ampere_t |
newOutput | ) |
|
|
inline |
Modifies this Control Request's Output parameter and returns itself for method-chaining and easier to use request API.
- Parameters
-
newOutput | Parameter to modify |
- Returns
- Itself
◆ WithOverrideCoastDurNeutral()
TorqueCurrentFOC & ctre::phoenixpro::controls::TorqueCurrentFOC::WithOverrideCoastDurNeutral |
( |
bool |
newOverrideCoastDurNeutral | ) |
|
|
inline |
Modifies this Control Request's OverrideCoastDurNeutral parameter and returns itself for method-chaining and easier to use request API.
- Parameters
-
newOverrideCoastDurNeutral | Parameter to modify |
- Returns
- Itself
◆ WithUpdateFreqHz()
TorqueCurrentFOC & ctre::phoenixpro::controls::TorqueCurrentFOC::WithUpdateFreqHz |
( |
units::frequency::hertz_t |
newUpdateFreqHz | ) |
|
|
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.
- Parameters
-
newUpdateFreqHz | Parameter to modify |
- Returns
- Itself
◆ ConfigTimeout
units::time::second_t ctre::phoenixpro::controls::TorqueCurrentFOC::ConfigTimeout {0.1_s} |
The timeout when sending configs associated with this control.
◆ Deadband
units::current::ampere_t ctre::phoenixpro::controls::TorqueCurrentFOC::Deadband |
Deadband in Amperes.
If torque request is within deadband, the bridge output is neutral. If deadband is set to zero then there is effectively no deadband. Note if deadband is zero, a free spinning motor will spin for quite a while as the firmware attempts to hold the motor's bemf. If user expects motor to cease spinning quickly with a demand of zero, we recommend a deadband of one Ampere. This value will be converted to an integral value of amps.
◆ MaxAbsDutyCycle
units::dimensionless::scalar_t ctre::phoenixpro::controls::TorqueCurrentFOC::MaxAbsDutyCycle |
The maximum absolute motor output that can be applied, which effectively limits the velocity.
For example, 0.50 means no more than 50% output in either direction. This is useful for preventing the motor from spinning to its terminal velocity when there is no external torque applied unto the rotor. Note this is absolute maximum, so the value should be between zero and one.
◆ Output
units::current::ampere_t ctre::phoenixpro::controls::TorqueCurrentFOC::Output |
Amount of motor current in Amperes.
◆ OverrideCoastDurNeutral
bool ctre::phoenixpro::controls::TorqueCurrentFOC::OverrideCoastDurNeutral |
Set to true to coast 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 0A (zero torque).
◆ UpdateFreqHz
units::frequency::hertz_t ctre::phoenixpro::controls::TorqueCurrentFOC::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.
The documentation for this class was generated from the following file: