CTRE Phoenix 6 C++ 24.3.0
|
Applies full neutral-brake by shorting motor leads together. More...
#include <ctre/phoenix6/controls/StaticBrake.hpp>
Public Member Functions | |
StaticBrake () | |
Applies full neutral-brake by shorting motor leads together. More... | |
StaticBrake & | WithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz) |
Sets the period at which this control will update at. More... | |
std::string | ToString () const override |
Returns a string representation of the object. More... | |
std::map< std::string, std::string > | GetControlInfo () const override |
Gets information about this control request. More... | |
![]() | |
ControlRequest (std::string name) | |
Constructs a new Control Request with the given name. More... | |
std::string const & | GetName () const |
virtual std::map< std::string, std::string > | GetControlInfo () const =0 |
Gets information about this control request. More... | |
virtual | ~ControlRequest ()=default |
virtual std::string | ToString () const =0 |
Public Attributes | |
units::frequency::hertz_t | UpdateFreqHz {20_Hz} |
The period at which this control will update at. More... | |
Additional Inherited Members | |
![]() | |
ControlRequest (ControlRequest const &)=default | |
ControlRequest (ControlRequest &&)=default | |
ControlRequest & | operator= (ControlRequest const &)=default |
ControlRequest & | operator= (ControlRequest &&)=default |
![]() | |
std::string | name |
Applies full neutral-brake by shorting motor leads together.
|
inline |
Applies full neutral-brake by shorting motor leads together.
|
inlineoverridevirtual |
Gets information about this control request.
Implements ctre::phoenix6::controls::ControlRequest.
|
inlineoverridevirtual |
Returns a string representation of the object.
Implements ctre::phoenix6::controls::ControlRequest.
|
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.
newUpdateFreqHz | Parameter to modify |
units::frequency::hertz_t ctre::phoenix6::controls::StaticBrake::UpdateFreqHz {20_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.