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
constexpr	DifferentialDutyCycle (units::dimensionless::scalar_t AverageOutput, units::angle::turn_t DifferentialPosition)
	Request a specified motor duty cycle with a differential position closed-loop.

constexpr	~DifferentialDutyCycle () override

constexpr std::string_view	GetName () const override
	Gets the name of this control request.

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

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

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

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

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

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

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

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

constexpr DifferentialDutyCycle &	WithIgnoreSoftwareLimits (bool newIgnoreSoftwareLimits)
	Modifies this Control Request's IgnoreSoftwareLimits parameter and returns itself for method-chaining and easier to use request API.

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

constexpr DifferentialDutyCycle &	WithUpdateFreqHz (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::dimensionless::scalar_t	AverageOutput
	Proportion of supply voltage to apply on the Average axis 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% on supported devices (see hardware::traits::SupportsFOC).

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	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 ControlRequest &	operator= (ControlRequest const &)=default

constexpr ControlRequest &	operator= (ControlRequest &&)=default

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	AverageOutput,
		units::angle::turn_t	DifferentialPosition )

inlineconstexpr

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

AverageOutput	Proportion of supply voltage to apply on the Average axis in fractional units between -1 and +1.
DifferentialPosition	Differential position to drive towards in rotations.

◆ ~DifferentialDutyCycle()

ctre::phoenix6::controls::DifferentialDutyCycle::~DifferentialDutyCycle ( )

inlineconstexproverride

Member Function Documentation

◆ GetControlInfo()

std::map< std::string, std::string > ctre::phoenix6::controls::DifferentialDutyCycle::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::DifferentialDutyCycle::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::DifferentialDutyCycle::ToString ( ) const

overridevirtual

Returns a string representation of the object.

Returns: a string representation of the object.

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

◆ WithAverageOutput()

DifferentialDutyCycle & ctre::phoenix6::controls::DifferentialDutyCycle::WithAverageOutput ( units::dimensionless::scalar_t newAverageOutput )

inlineconstexpr

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

Proportion of supply voltage to apply on the Average axis in fractional units between -1 and +1.

Units: fractional

Parameters

newAverageOutput Parameter to modify

Returns: Itself

◆ WithDifferentialPosition()

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

inlineconstexpr

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.

Units: rotations

Parameters

newDifferentialPosition Parameter to modify

Returns: Itself

◆ WithDifferentialSlot()

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

inlineconstexpr

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 )

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

newEnableFOC Parameter to modify

Returns: Itself

◆ WithIgnoreHardwareLimits()

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

newIgnoreHardwareLimits Parameter to modify

Returns: Itself

◆ WithIgnoreSoftwareLimits()

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

newIgnoreSoftwareLimits Parameter to modify

Returns: Itself

◆ WithLimitForwardMotion()

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

newLimitForwardMotion Parameter to modify

Returns: Itself

◆ WithLimitReverseMotion()

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

newLimitReverseMotion Parameter to modify

Returns: Itself

◆ WithOverrideBrakeDurNeutral()

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

newOverrideBrakeDurNeutral Parameter to modify

Returns: Itself

◆ WithUpdateFreqHz()

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

newUpdateFreqHz Parameter to modify

Returns: Itself

◆ WithUseTimesync()

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

newUseTimesync Parameter to modify

Returns: Itself

Member Data Documentation

◆ AverageOutput

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

Proportion of supply voltage to apply on the Average axis in fractional units between -1 and +1.

Units: fractional

◆ DifferentialPosition

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

Differential position to drive towards in rotations.

Units: 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% 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.

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

◆ IgnoreSoftwareLimits

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

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

◆ UpdateFreqHz

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

◆ ~DifferentialDutyCycle()

Member Function Documentation

◆ GetControlInfo()

◆ GetName()

◆ ToString()

◆ WithAverageOutput()

◆ WithDifferentialPosition()

◆ WithDifferentialSlot()

◆ WithEnableFOC()

◆ WithIgnoreHardwareLimits()

◆ WithIgnoreSoftwareLimits()

◆ WithLimitForwardMotion()

◆ WithLimitReverseMotion()

◆ WithOverrideBrakeDurNeutral()

◆ WithUpdateFreqHz()

◆ WithUseTimesync()

Member Data Documentation

◆ AverageOutput

◆ DifferentialPosition

◆ DifferentialSlot

◆ EnableFOC

◆ IgnoreHardwareLimits

◆ IgnoreSoftwareLimits

◆ LimitForwardMotion

◆ LimitReverseMotion

◆ OverrideBrakeDurNeutral

◆ UpdateFreqHz

◆ UseTimesync