ctre::phoenix6::controls::NeutralOut Class Reference

Request neutral output of actuator. More...

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

Inheritance diagram for ctre::phoenix6::controls::NeutralOut:

Public Member Functions
constexpr	NeutralOut ()
	Request neutral output of actuator.
constexpr	~NeutralOut () override
constexpr std::string_view	GetName () const override
	Gets the name of this control request.
constexpr NeutralOut &	WithUseTimesync (bool newUseTimesync)
	Modifies this Control Request's UseTimesync parameter and returns itself for method-chaining and easier to use request API.
constexpr NeutralOut &	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
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 {20_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 neutral output of actuator.

The applied brake type is determined by the NeutralMode configuration.

Constructor & Destructor Documentation

NeutralOut()

ctre::phoenix6::controls::NeutralOut::NeutralOut ( )

inlineconstexpr

Request neutral output of actuator.

The applied brake type is determined by the NeutralMode configuration.

~NeutralOut()

ctre::phoenix6::controls::NeutralOut::~NeutralOut ( )

inlineconstexproverride

Member Function Documentation

GetControlInfo()

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

overridevirtual

Returns a string representation of the object.

Returns

a string representation of the object.

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

WithUpdateFreqHz()

NeutralOut & ctre::phoenix6::controls::NeutralOut::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()

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

UpdateFreqHz

units::frequency::hertz_t ctre::phoenix6::controls::NeutralOut::UpdateFreqHz {20_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::NeutralOut::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/NeutralOut.hpp