phoenix6.controls.neutral_out#

Module Contents#

class phoenix6.controls.neutral_out.NeutralOut#

Request neutral output of actuator. The applied brake type is determined by the NeutralMode configuration.

property name: str#

Gets the name of this control request.

Returns:

Name of the control request

Return type:

str

property control_info: dict#

Gets information about this control request.

Returns:

Dictonary of control parameter names and corresponding applied values

Return type:

dict

with_update_freq_hz(new_update_freq_hz: phoenix6.units.hertz) NeutralOut#

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:

new_update_freq_hz (hertz) – Parameter to modify

Returns:

Itself

Return type:

NeutralOut