phoenix6.controls.modulate_v_bat_out

Module Contents

class phoenix6.controls.modulate_v_bat_out.ModulateVBatOut(output: float)

Modulates the CANdle VBat output to the specified duty cycle. This can be used to control a single-color LED strip.

Note that CANdleFeaturesConfigs.VBatOutputMode must be set to VBatOutputModeValue.Modulated.

Parameters:

output (float) – Proportion of VBat to output in fractional units between 0.0 and 1.0.

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

update_freq_hz: phoenix6.units.hertz = 50

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.

output

Proportion of VBat to output in fractional units between 0.0 and 1.0.

• Units: fractional

with_output(new_output: float) → ModulateVBatOut

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

Proportion of VBat to output in fractional units between 0.0 and 1.0.

• Units: fractional

Parameters:

new_output (float) – Parameter to modify

Returns:

Itself

Return type:

ModulateVBatOut

with_update_freq_hz(new_update_freq_hz: phoenix6.units.hertz) → ModulateVBatOut

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:

ModulateVBatOut