Class VelocityDutyCycle

Namespace

CTRE.Phoenix6.Controls

Assembly

Phoenix6.Hardware.dll

Request PID to target velocity with duty cycle 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.

public sealed class VelocityDutyCycle : ControlRequest, ICloneable

Inheritance

object

VelocityDutyCycle

Implements

ControlRequest

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

VelocityDutyCycle(double)

Request PID to target velocity with duty cycle 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 to drive toward in rotations per second.

public VelocityDutyCycle(double Velocity)

Parameters

Velocity double

Fields

Acceleration

Acceleration to drive toward in rotations per second squared. This is typically used for motion profiles generated by the robot program.

• 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

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

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

Velocity to drive toward in rotations per second.

• 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 VelocityDutyCycle Clone()

Returns

VelocityDutyCycle

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 to drive toward in rotations per second squared. This is typically used for motion profiles generated by the robot program.

• Units: rotations per second²

public VelocityDutyCycle WithAcceleration(double newAcceleration)

Parameters

newAcceleration double

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithEnableFOC(bool newEnableFOC)

Parameters

newEnableFOC bool

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithFeedForward(double newFeedForward)

Parameters

newFeedForward double

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithIgnoreHardwareLimits(bool newIgnoreHardwareLimits)

Parameters

newIgnoreHardwareLimits bool

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithIgnoreSoftwareLimits(bool newIgnoreSoftwareLimits)

Parameters

newIgnoreSoftwareLimits bool

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithLimitForwardMotion(bool newLimitForwardMotion)

Parameters

newLimitForwardMotion bool

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithLimitReverseMotion(bool newLimitReverseMotion)

Parameters

newLimitReverseMotion bool

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithOverrideBrakeDurNeutral(bool newOverrideBrakeDurNeutral)

Parameters

newOverrideBrakeDurNeutral bool

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithSlot(int newSlot)

Parameters

newSlot int

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithUpdateFreqHz(double newUpdateFreqHz)

Parameters

newUpdateFreqHz double

Parameter to modify

Returns

VelocityDutyCycle

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 VelocityDutyCycle WithUseTimesync(bool newUseTimesync)

Parameters

newUseTimesync bool

Parameter to modify

Returns

VelocityDutyCycle

Itself

WithVelocity(double)

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.

• Units: rotations per second

public VelocityDutyCycle WithVelocity(double newVelocity)

Parameters

newVelocity double

Parameter to modify

Returns

VelocityDutyCycle

Itself