CTRE Phoenix 6 C++ 26.3.0
Loading...
Searching...
No Matches
ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage Class Referencefinal

Requires Phoenix Pro and CANivore; Requests Motion Magic® Expo to target a final position using an exponential motion profile. More...

#include <ctre/phoenix6/controls/DynamicMotionMagicExpoVoltage.hpp>

Inheritance diagram for ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage:
ctre::phoenix6::controls::ControlRequest

Public Member Functions

constexpr DynamicMotionMagicExpoVoltage (units::angle::turn_t Position, ctre::unit::volts_per_turn_per_second_t kV, ctre::unit::volts_per_turn_per_second_squared_t kA)
 Requires Phoenix Pro and CANivore; Requests Motion Magic® Expo to target a final position using an exponential motion profile.
 
constexpr ~DynamicMotionMagicExpoVoltage () override
 
constexpr std::string_view GetName () const override
 Gets the name of this control request.
 
constexpr DynamicMotionMagicExpoVoltageWithPosition (units::angle::turn_t newPosition)
 Modifies this Control Request's Position parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithKV (ctre::unit::volts_per_turn_per_second_t newKV)
 Modifies this Control Request's kV parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithKA (ctre::unit::volts_per_turn_per_second_squared_t newKA)
 Modifies this Control Request's kA parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithVelocity (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.
 
constexpr DynamicMotionMagicExpoVoltageWithEnableFOC (bool newEnableFOC)
 Modifies this Control Request's EnableFOC parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithFeedForward (units::voltage::volt_t newFeedForward)
 Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithSlot (int newSlot)
 Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithOverrideBrakeDurNeutral (bool newOverrideBrakeDurNeutral)
 Modifies this Control Request's OverrideBrakeDurNeutral parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithLimitForwardMotion (bool newLimitForwardMotion)
 Modifies this Control Request's LimitForwardMotion parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithLimitReverseMotion (bool newLimitReverseMotion)
 Modifies this Control Request's LimitReverseMotion parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithIgnoreHardwareLimits (bool newIgnoreHardwareLimits)
 Modifies this Control Request's IgnoreHardwareLimits parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithIgnoreSoftwareLimits (bool newIgnoreSoftwareLimits)
 Modifies this Control Request's IgnoreSoftwareLimits parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithUseTimesync (bool newUseTimesync)
 Modifies this Control Request's UseTimesync parameter and returns itself for method-chaining and easier to use request API.
 
constexpr DynamicMotionMagicExpoVoltageWithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz)
 Sets the frequency at which this control will update.
 
std::string ToString () const override
 Returns a string representation of the object.
 
std::map< std::string, std::string > GetControlInfo () const override
 Gets information about this control request.
 
- Public Member Functions inherited from ctre::phoenix6::controls::ControlRequest
constexpr ControlRequest ()=default
 Constructs a new Control Request.
 
virtual constexpr ~ControlRequest ()
 

Public Attributes

units::angle::turn_t Position
 Position to drive toward in rotations.
 
ctre::unit::volts_per_turn_per_second_t kV
 Mechanism kV for profiling.
 
ctre::unit::volts_per_turn_per_second_squared_t kA
 Mechanism kA for profiling.
 
units::angular_velocity::turns_per_second_t Velocity = 0_tps
 Cruise velocity for profiling.
 
bool EnableFOC = true
 Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15% on supported devices (see hardware::traits::SupportsFOC).
 
units::voltage::volt_t FeedForward = 0.0_V
 Feedforward to apply in volts.
 
int Slot = 0
 Select which gains are applied by selecting the slot.
 
bool OverrideBrakeDurNeutral = false
 Set to true to static-brake the rotor when output is zero (or within deadband).
 
bool LimitForwardMotion = false
 Set to true to force forward limiting.
 
bool LimitReverseMotion = false
 Set to true to force reverse limiting.
 
bool IgnoreHardwareLimits = false
 Set to true to ignore hardware limit switches and the LimitForwardMotion and LimitReverseMotion parameters, instead allowing motion.
 
bool IgnoreSoftwareLimits = false
 Set to true to ignore software limits, instead allowing motion.
 
bool UseTimesync = false
 Set to true to delay applying this control request until a timesync boundary (requires Phoenix Pro and CANivore).
 
units::frequency::hertz_t UpdateFreqHz {100_Hz}
 The frequency at which this control will update.
 

Additional Inherited Members

- Protected Member Functions inherited from ctre::phoenix6::controls::ControlRequest
constexpr ControlRequest (ControlRequest const &)=default
 
constexpr ControlRequest (ControlRequest &&)=default
 
constexpr ControlRequestoperator= (ControlRequest const &)=default
 
constexpr ControlRequestoperator= (ControlRequest &&)=default
 

Detailed Description

Requires Phoenix Pro and CANivore; Requests Motion Magic® Expo to target a final position using an exponential motion profile.

This dynamic request allows runtime changes to the profile kV, kA, and (optional) Cruise Velocity. Users can optionally provide a voltage feedforward.

Motion Magic® Expo produces a motion profile in real-time while attempting to honor the specified Cruise Velocity (optional) and the mechanism kV and kA. Note that unlike the slot gains, the Expo_kV and Expo_kA parameters are always in output units of Volts.

Setting the Cruise Velocity to 0 will allow the profile to run to the max possible velocity based on Expo_kV. This control mode does not use the Acceleration or Jerk configs.

Target position can be changed on-the-fly and Motion Magic® will do its best to adjust the profile. This control mode is voltage-based, so relevant closed-loop gains will use Volts for the numerator.

Constructor & Destructor Documentation

◆ DynamicMotionMagicExpoVoltage()

ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::DynamicMotionMagicExpoVoltage ( units::angle::turn_t Position,
ctre::unit::volts_per_turn_per_second_t kV,
ctre::unit::volts_per_turn_per_second_squared_t kA )
inlineconstexpr

Requires Phoenix Pro and CANivore; Requests Motion Magic® Expo to target a final position using an exponential motion profile.

This dynamic request allows runtime changes to the profile kV, kA, and (optional) Cruise Velocity. Users can optionally provide a voltage feedforward.

Motion Magic® Expo produces a motion profile in real-time while attempting to honor the specified Cruise Velocity (optional) and the mechanism kV and kA. Note that unlike the slot gains, the Expo_kV and Expo_kA parameters are always in output units of Volts.

Setting the Cruise Velocity to 0 will allow the profile to run to the max possible velocity based on Expo_kV. This control mode does not use the Acceleration or Jerk configs.

Target position can be changed on-the-fly and Motion Magic® will do its best to adjust the profile. This control mode is voltage-based, so relevant closed-loop gains will use Volts for the numerator.

Parameters
PositionPosition to drive toward in rotations.
kVMechanism kV for profiling. Unlike the kV slot gain, this is always in units of V/rps.

This represents the amount of voltage necessary to hold a velocity. In terms of the Motion Magic® Expo profile, a higher kV results in a slower maximum velocity.

Parameters
kAMechanism kA for profiling. Unlike the kA slot gain, this is always in units of V/rps².

This represents the amount of voltage necessary to achieve an acceleration. In terms of the Motion Magic® Expo profile, a higher kA results in a slower acceleration.

◆ ~DynamicMotionMagicExpoVoltage()

ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::~DynamicMotionMagicExpoVoltage ( )
inlineconstexproverride

Member Function Documentation

◆ GetControlInfo()

std::map< std::string, std::string > ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::GetControlInfo ( ) const
overridevirtual

Gets information about this control request.

Returns
Map of control parameter names and corresponding applied values

Implements ctre::phoenix6::controls::ControlRequest.

◆ GetName()

std::string_view ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::GetName ( ) const
inlineconstexproverridevirtual

Gets the name of this control request.

Returns
Name of the control request

Implements ctre::phoenix6::controls::ControlRequest.

◆ ToString()

std::string ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::ToString ( ) const
overridevirtual

Returns a string representation of the object.

Returns
a string representation of the object.

Implements ctre::phoenix6::controls::ControlRequest.

◆ WithEnableFOC()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithEnableFOC ( bool newEnableFOC)
inlineconstexpr

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% on supported devices (see hardware::traits::SupportsFOC). 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.

Parameters
newEnableFOCParameter to modify
Returns
Itself

◆ WithFeedForward()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithFeedForward ( units::voltage::volt_t newFeedForward)
inlineconstexpr

Modifies this Control Request's FeedForward parameter and returns itself for method-chaining and easier to use request API.

Feedforward to apply in volts. This is added to the output of the onboard feedforward terms.

  • Units: Volts
Parameters
newFeedForwardParameter to modify
Returns
Itself

◆ WithIgnoreHardwareLimits()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithIgnoreHardwareLimits ( bool newIgnoreHardwareLimits)
inlineconstexpr

Modifies this Control Request's IgnoreHardwareLimits parameter and returns itself for method-chaining and easier to use request API.

Set to true to ignore hardware limit switches and the LimitForwardMotion and LimitReverseMotion parameters, instead allowing motion.

This can be useful on mechanisms such as an intake/feeder, where a limit switch stops motion while intaking but should be ignored when feeding to a shooter.

The hardware limit faults and Forward/ReverseLimit signals will still report the values of the limit switches regardless of this parameter.

Parameters
newIgnoreHardwareLimitsParameter to modify
Returns
Itself

◆ WithIgnoreSoftwareLimits()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithIgnoreSoftwareLimits ( bool newIgnoreSoftwareLimits)
inlineconstexpr

Modifies this Control Request's IgnoreSoftwareLimits parameter and returns itself for method-chaining and easier to use request API.

Set to true to ignore software limits, instead allowing motion.

This can be useful when calibrating the zero point of a mechanism such as an elevator.

The software limit faults will still report the values of the software limits regardless of this parameter.

Parameters
newIgnoreSoftwareLimitsParameter to modify
Returns
Itself

◆ WithKA()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithKA ( ctre::unit::volts_per_turn_per_second_squared_t newKA)
inlineconstexpr

Modifies this Control Request's kA parameter and returns itself for method-chaining and easier to use request API.

Mechanism kA for profiling. Unlike the kA slot gain, this is always in units of V/rps².

This represents the amount of voltage necessary to achieve an acceleration. In terms of the Motion Magic® Expo profile, a higher kA results in a slower acceleration.

  • Units: V/rps²
Parameters
newKAParameter to modify
Returns
Itself

◆ WithKV()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithKV ( ctre::unit::volts_per_turn_per_second_t newKV)
inlineconstexpr

Modifies this Control Request's kV parameter and returns itself for method-chaining and easier to use request API.

Mechanism kV for profiling. Unlike the kV slot gain, this is always in units of V/rps.

This represents the amount of voltage necessary to hold a velocity. In terms of the Motion Magic® Expo profile, a higher kV results in a slower maximum velocity.

  • Units: V/rps
Parameters
newKVParameter to modify
Returns
Itself

◆ WithLimitForwardMotion()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithLimitForwardMotion ( bool newLimitForwardMotion)
inlineconstexpr

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.

Parameters
newLimitForwardMotionParameter to modify
Returns
Itself

◆ WithLimitReverseMotion()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithLimitReverseMotion ( bool newLimitReverseMotion)
inlineconstexpr

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.

Parameters
newLimitReverseMotionParameter to modify
Returns
Itself

◆ WithOverrideBrakeDurNeutral()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithOverrideBrakeDurNeutral ( bool newOverrideBrakeDurNeutral)
inlineconstexpr

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.

Parameters
newOverrideBrakeDurNeutralParameter to modify
Returns
Itself

◆ WithPosition()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithPosition ( units::angle::turn_t newPosition)
inlineconstexpr

Modifies this Control Request's Position parameter and returns itself for method-chaining and easier to use request API.

Position to drive toward in rotations.

  • Units: rotations
Parameters
newPositionParameter to modify
Returns
Itself

◆ WithSlot()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithSlot ( int newSlot)
inlineconstexpr

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].

Parameters
newSlotParameter to modify
Returns
Itself

◆ WithUpdateFreqHz()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithUpdateFreqHz ( units::frequency::hertz_t newUpdateFreqHz)
inlineconstexpr

Sets the frequency at which this control will update.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

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
newUpdateFreqHzParameter to modify
Returns
Itself

◆ WithUseTimesync()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithUseTimesync ( bool newUseTimesync)
inlineconstexpr

Modifies this Control Request's UseTimesync parameter and returns itself for method-chaining and easier to use request API.

Set to true to delay applying this control request until a timesync boundary (requires Phoenix Pro and CANivore). This eliminates the impact of nondeterministic network delays in exchange for a larger but deterministic control latency.

This requires setting the ControlTimesyncFreqHz config in MotorOutputConfigs. Additionally, when this is enabled, the UpdateFreqHz of this request should be set to 0 Hz.

Parameters
newUseTimesyncParameter to modify
Returns
Itself

◆ WithVelocity()

DynamicMotionMagicExpoVoltage & ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::WithVelocity ( units::angular_velocity::turns_per_second_t newVelocity)
inlineconstexpr

Modifies this Control Request's Velocity parameter and returns itself for method-chaining and easier to use request API.

Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation. Setting this to 0 will allow the profile to run to the max possible velocity based on Expo_kV.

  • Units: rotations per second
Parameters
newVelocityParameter to modify
Returns
Itself

Member Data Documentation

◆ EnableFOC

bool ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::EnableFOC = true

Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15% on supported devices (see hardware::traits::SupportsFOC).

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

units::voltage::volt_t ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::FeedForward = 0.0_V

Feedforward to apply in volts.

This is added to the output of the onboard feedforward terms.

  • Units: Volts

◆ IgnoreHardwareLimits

bool ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::IgnoreHardwareLimits = false

Set to true to ignore hardware limit switches and the LimitForwardMotion and LimitReverseMotion parameters, instead allowing motion.

This can be useful on mechanisms such as an intake/feeder, where a limit switch stops motion while intaking but should be ignored when feeding to a shooter.

The hardware limit faults and Forward/ReverseLimit signals will still report the values of the limit switches regardless of this parameter.

◆ IgnoreSoftwareLimits

bool ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::IgnoreSoftwareLimits = false

Set to true to ignore software limits, instead allowing motion.

This can be useful when calibrating the zero point of a mechanism such as an elevator.

The software limit faults will still report the values of the software limits regardless of this parameter.

◆ kA

ctre::unit::volts_per_turn_per_second_squared_t ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::kA

Mechanism kA for profiling.

Unlike the kA slot gain, this is always in units of V/rps².

This represents the amount of voltage necessary to achieve an acceleration. In terms of the Motion Magic® Expo profile, a higher kA results in a slower acceleration.

  • Units: V/rps²

◆ kV

ctre::unit::volts_per_turn_per_second_t ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::kV

Mechanism kV for profiling.

Unlike the kV slot gain, this is always in units of V/rps.

This represents the amount of voltage necessary to hold a velocity. In terms of the Motion Magic® Expo profile, a higher kV results in a slower maximum velocity.

  • Units: V/rps

◆ LimitForwardMotion

bool ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::LimitForwardMotion = false

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

bool ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::LimitReverseMotion = false

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.

◆ OverrideBrakeDurNeutral

bool ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::OverrideBrakeDurNeutral = false

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.

◆ Position

units::angle::turn_t ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::Position

Position to drive toward in rotations.

  • Units: rotations

◆ Slot

int ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::Slot = 0

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].

◆ UpdateFreqHz

units::frequency::hertz_t ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::UpdateFreqHz {100_Hz}

The frequency at which this control will update.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

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.

◆ UseTimesync

bool ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::UseTimesync = false

Set to true to delay applying this control request until a timesync boundary (requires Phoenix Pro and CANivore).

This eliminates the impact of nondeterministic network delays in exchange for a larger but deterministic control latency.

This requires setting the ControlTimesyncFreqHz config in MotorOutputConfigs. Additionally, when this is enabled, the UpdateFreqHz of this request should be set to 0 Hz.

◆ Velocity

units::angular_velocity::turns_per_second_t ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage::Velocity = 0_tps

Cruise velocity for profiling.

The signage does not matter as the device will use the absolute value for profile generation. Setting this to 0 will allow the profile to run to the max possible velocity based on Expo_kV.

  • Units: rotations per second

The documentation for this class was generated from the following file: