Request a specified motor duty cycle with a differential position closed-loop. More...

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

Inheritance diagram for ctre::phoenix6::controls::DifferentialDutyCycle:

Public Member Functions
	DifferentialDutyCycle (units::dimensionless::scalar_t TargetOutput, units::angle::turn_t DifferentialPosition)
	Request a specified motor duty cycle with a differential position closed-loop.

DifferentialDutyCycle &	WithTargetOutput (units::dimensionless::scalar_t newTargetOutput)
	Modifies this Control Request's TargetOutput parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithDifferentialPosition (units::angle::turn_t newDifferentialPosition)
	Modifies this Control Request's DifferentialPosition parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithEnableFOC (bool newEnableFOC)
	Modifies this Control Request's EnableFOC parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithDifferentialSlot (int newDifferentialSlot)
	Modifies this Control Request's DifferentialSlot parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithOverrideBrakeDurNeutral (bool newOverrideBrakeDurNeutral)
	Modifies this Control Request's OverrideBrakeDurNeutral parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithLimitForwardMotion (bool newLimitForwardMotion)
	Modifies this Control Request's LimitForwardMotion parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithLimitReverseMotion (bool newLimitReverseMotion)
	Modifies this Control Request's LimitReverseMotion parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithIgnoreHardwareLimits (bool newIgnoreHardwareLimits)
	Modifies this Control Request's IgnoreHardwareLimits parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithUseTimesync (bool newUseTimesync)
	Modifies this Control Request's UseTimesync parameter and returns itself for method-chaining and easier to use request API.

DifferentialDutyCycle &	WithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz)
	Sets the period at which this control will update at.

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
	ControlRequest (std::string name)
	Constructs a new Control Request with the given name.

std::string const &	GetName () const

virtual	~ControlRequest ()=default

Public Attributes
units::dimensionless::scalar_t	TargetOutput
	Proportion of supply voltage to apply in fractional units between -1 and +1.

units::angle::turn_t	DifferentialPosition
	Differential position to drive towards in rotations.

bool	EnableFOC = true
	Set to true to use FOC commutation (requires Phoenix Pro), which increases peak power by ~15%.

int	DifferentialSlot = 1
	Select which gains are applied to the differential controller 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	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 period at which this control will update at.

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

Detailed Description

Request a specified motor duty cycle with a differential position closed-loop.

This control mode will output a proportion of the supplied voltage which is supplied by the user. It will also set the motor's differential position setpoint to the specified position.

Constructor & Destructor Documentation

◆ DifferentialDutyCycle()

ctre::phoenix6::controls::DifferentialDutyCycle::DifferentialDutyCycle	(	units::dimensionless::scalar_t	TargetOutput,
		units::angle::turn_t	DifferentialPosition )

inline

Request a specified motor duty cycle with a differential position closed-loop.

This control mode will output a proportion of the supplied voltage which is supplied by the user. It will also set the motor's differential position setpoint to the specified position.

Parameters

TargetOutput	Proportion of supply voltage to apply in fractional units between -1 and +1
DifferentialPosition	Differential position to drive towards in rotations

Member Function Documentation

◆ GetControlInfo()

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

inlineoverridevirtual

Gets information about this control request.

Returns: Map of control parameter names and corresponding applied values

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

◆ ToString()

std::string ctre::phoenix6::controls::DifferentialDutyCycle::ToString ( ) const

inlineoverridevirtual

Returns a string representation of the object.

Returns: a string representation of the object.

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

◆ WithDifferentialPosition()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithDifferentialPosition ( units::angle::turn_t newDifferentialPosition )

inline

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

Differential position to drive towards in rotations

Parameters

newDifferentialPosition Parameter to modify

Returns: Itself

◆ WithDifferentialSlot()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithDifferentialSlot ( int newDifferentialSlot )

inline

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

Select which gains are applied to the differential controller 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

newDifferentialSlot Parameter to modify

Returns: Itself

◆ WithEnableFOC()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithEnableFOC ( bool newEnableFOC )

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.

Parameters

newEnableFOC Parameter to modify

Returns: Itself

◆ WithIgnoreHardwareLimits()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithIgnoreHardwareLimits ( bool newIgnoreHardwareLimits )

inline

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

newIgnoreHardwareLimits Parameter to modify

Returns: Itself

◆ WithLimitForwardMotion()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithLimitForwardMotion ( bool newLimitForwardMotion )

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.

Parameters

newLimitForwardMotion Parameter to modify

Returns: Itself

◆ WithLimitReverseMotion()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithLimitReverseMotion ( bool newLimitReverseMotion )

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.

Parameters

newLimitReverseMotion Parameter to modify

Returns: Itself

◆ WithOverrideBrakeDurNeutral()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithOverrideBrakeDurNeutral ( bool newOverrideBrakeDurNeutral )

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.

Parameters

newOverrideBrakeDurNeutral Parameter to modify

Returns: Itself

◆ WithTargetOutput()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithTargetOutput ( units::dimensionless::scalar_t newTargetOutput )

inline

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

Proportion of supply voltage to apply in fractional units between -1 and +1

Parameters

newTargetOutput Parameter to modify

Returns: Itself

◆ WithUpdateFreqHz()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::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

◆ WithUseTimesync()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithUseTimesync ( bool newUseTimesync )

inline

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

newUseTimesync Parameter to modify

Returns: Itself

Member Data Documentation

◆ DifferentialPosition

units::angle::turn_t ctre::phoenix6::controls::DifferentialDutyCycle::DifferentialPosition

Differential position to drive towards in rotations.

◆ DifferentialSlot

int ctre::phoenix6::controls::DifferentialDutyCycle::DifferentialSlot = 1

Select which gains are applied to the differential controller 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].

◆ EnableFOC

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

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.

◆ IgnoreHardwareLimits

bool ctre::phoenix6::controls::DifferentialDutyCycle::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.

◆ LimitForwardMotion

bool ctre::phoenix6::controls::DifferentialDutyCycle::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::DifferentialDutyCycle::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::DifferentialDutyCycle::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.

◆ TargetOutput

units::dimensionless::scalar_t ctre::phoenix6::controls::DifferentialDutyCycle::TargetOutput

Proportion of supply voltage to apply in fractional units between -1 and +1.

◆ UpdateFreqHz

units::frequency::hertz_t ctre::phoenix6::controls::DifferentialDutyCycle::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.

◆ UseTimesync

bool ctre::phoenix6::controls::DifferentialDutyCycle::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.

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

ctre/phoenix6/controls/DifferentialDutyCycle.hpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DifferentialDutyCycle()

Member Function Documentation

◆ GetControlInfo()

◆ ToString()

◆ WithDifferentialPosition()

◆ WithDifferentialSlot()

◆ WithEnableFOC()

◆ WithIgnoreHardwareLimits()

◆ WithLimitForwardMotion()

◆ WithLimitReverseMotion()

◆ WithOverrideBrakeDurNeutral()

◆ WithTargetOutput()

◆ WithUpdateFreqHz()

◆ WithUseTimesync()

Member Data Documentation

◆ DifferentialPosition

◆ DifferentialSlot

◆ EnableFOC

◆ IgnoreHardwareLimits

◆ LimitForwardMotion

◆ LimitReverseMotion

◆ OverrideBrakeDurNeutral

◆ TargetOutput

◆ UpdateFreqHz

◆ UseTimesync