Class DynamicMotionMagicDutyCycle

Namespace

CTRE.Phoenix6.Controls

Assembly

Phoenix6.Hardware.dll

Requires Phoenix Pro and CANivore; Requests Motion Magic® to target a final position using a motion profile. This dynamic request allows runtime changes to Cruise Velocity, Acceleration, and (optional) Jerk. Users can optionally provide a duty cycle feedforward.

Motion Magic® produces a motion profile in real-time while attempting to honor the specified Cruise Velocity, Acceleration, and (optional) Jerk. This control mode does not use the Expo_kV or Expo_kA configs.

Target position can be changed on-the-fly and Motion Magic® will do its best to adjust the profile. This control mode is duty cycle based, so relevant closed-loop gains will use fractional duty cycle for the numerator: +1.0 represents full forward output.

public sealed class DynamicMotionMagicDutyCycle : ControlRequest, ICloneable

Inheritance

object

DynamicMotionMagicDutyCycle

Implements

ControlRequest

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DynamicMotionMagicDutyCycle(double, double, double)

Requires Phoenix Pro and CANivore; Requests Motion Magic® to target a final position using a motion profile. This dynamic request allows runtime changes to Cruise Velocity, Acceleration, and (optional) Jerk. Users can optionally provide a duty cycle feedforward.

Motion Magic® produces a motion profile in real-time while attempting to honor the specified Cruise Velocity, Acceleration, and (optional) Jerk. This control mode does not use the Expo_kV or Expo_kA configs.

Target position can be changed on-the-fly and Motion Magic® will do its best to adjust the profile. This control mode is duty cycle based, so relevant closed-loop gains will use fractional duty cycle for the numerator: +1.0 represents full forward output. Position to drive toward in rotations. Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation. Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation

public DynamicMotionMagicDutyCycle(double Position, double Velocity, double Acceleration)

Parameters

Position double

Velocity double

Acceleration double

Fields

Acceleration

Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation

• Units: rotations per second²

public double Acceleration

Field Value

double

EnableFOC

Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15% on supported devices (see 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.

public bool EnableFOC

Field Value

bool

FeedForward

Feedforward to apply in fractional units between -1 and +1. This is added to the output of the onboard feedforward terms.

• Units: fractional

public double FeedForward

Field Value

double

IgnoreHardwareLimits

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.

public bool IgnoreHardwareLimits

Field Value

bool

IgnoreSoftwareLimits

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.

public bool IgnoreSoftwareLimits

Field Value

bool

Jerk

Jerk for profiling. The signage does not matter as the device will use the absolute value for profile generation.

Jerk is optional; if this is set to zero, then Motion Magic® will not apply a Jerk limit.

• Units: rotations per second³

public double Jerk

Field Value

double

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.

public bool LimitForwardMotion

Field Value

bool

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.

public bool LimitReverseMotion

Field Value

bool

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.

public bool OverrideBrakeDurNeutral

Field Value

bool

Position

Position to drive toward in rotations.

• Units: rotations

public double Position

Field Value

double

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

public int Slot

Field Value

int

UpdateFreqHz

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.

public double UpdateFreqHz

Field Value

double

UseTimesync

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.

public bool UseTimesync

Field Value

bool

Velocity

Cruise velocity for profiling. The signage does not matter as the device will use the absolute value for profile generation.

• Units: rotations per second

public double Velocity

Field Value

double

Properties

Name

Name of this control request.

public string Name { get; }

Property Value

string

Methods

Clone()

Creates a copy of this control request.

public DynamicMotionMagicDutyCycle Clone()

Returns

DynamicMotionMagicDutyCycle

GetControlInfo()

Gets information about this control request.

public Dictionary<string, string> GetControlInfo()

Returns

Dictionary<string, string>

Dictionary of control parameter names and corresponding applied values

SendRequest(string, uint)

Sends this request out over CAN bus to the device for the device to apply.

public StatusCode SendRequest(string network, uint deviceHash)

Parameters

network string

Network to send request over

deviceHash uint

Device to send request to

Returns

StatusCode

Status of the send operation

ToString()

Provides the string representation of this object.

public override string ToString()

Returns

string

WithAcceleration(double)

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

Acceleration for profiling. The signage does not matter as the device will use the absolute value for profile generation

• Units: rotations per second²

public DynamicMotionMagicDutyCycle WithAcceleration(double newAcceleration)

Parameters

newAcceleration double

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithEnableFOC(bool)

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

public DynamicMotionMagicDutyCycle WithEnableFOC(bool newEnableFOC)

Parameters

newEnableFOC bool

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithFeedForward(double)

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

Feedforward to apply in fractional units between -1 and +1. This is added to the output of the onboard feedforward terms.

• Units: fractional

public DynamicMotionMagicDutyCycle WithFeedForward(double newFeedForward)

Parameters

newFeedForward double

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithIgnoreHardwareLimits(bool)

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.

public DynamicMotionMagicDutyCycle WithIgnoreHardwareLimits(bool newIgnoreHardwareLimits)

Parameters

newIgnoreHardwareLimits bool

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithIgnoreSoftwareLimits(bool)

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.

public DynamicMotionMagicDutyCycle WithIgnoreSoftwareLimits(bool newIgnoreSoftwareLimits)

Parameters

newIgnoreSoftwareLimits bool

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithJerk(double)

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

Jerk for profiling. The signage does not matter as the device will use the absolute value for profile generation.

Jerk is optional; if this is set to zero, then Motion Magic® will not apply a Jerk limit.

• Units: rotations per second³

public DynamicMotionMagicDutyCycle WithJerk(double newJerk)

Parameters

newJerk double

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithLimitForwardMotion(bool)

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.

public DynamicMotionMagicDutyCycle WithLimitForwardMotion(bool newLimitForwardMotion)

Parameters

newLimitForwardMotion bool

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithLimitReverseMotion(bool)

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.

public DynamicMotionMagicDutyCycle WithLimitReverseMotion(bool newLimitReverseMotion)

Parameters

newLimitReverseMotion bool

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithOverrideBrakeDurNeutral(bool)

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.

public DynamicMotionMagicDutyCycle WithOverrideBrakeDurNeutral(bool newOverrideBrakeDurNeutral)

Parameters

newOverrideBrakeDurNeutral bool

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithPosition(double)

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

public DynamicMotionMagicDutyCycle WithPosition(double newPosition)

Parameters

newPosition double

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithSlot(int)

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

public DynamicMotionMagicDutyCycle WithSlot(int newSlot)

Parameters

newSlot int

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithUpdateFreqHz(double)

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.

public DynamicMotionMagicDutyCycle WithUpdateFreqHz(double newUpdateFreqHz)

Parameters

newUpdateFreqHz double

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithUseTimesync(bool)

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.

public DynamicMotionMagicDutyCycle WithUseTimesync(bool newUseTimesync)

Parameters

newUseTimesync bool

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself

WithVelocity(double)

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.

• Units: rotations per second

public DynamicMotionMagicDutyCycle WithVelocity(double newVelocity)

Parameters

newVelocity double

Parameter to modify

Returns

DynamicMotionMagicDutyCycle

Itself