BaseStatusSignalSetUpdateFrequencyForAll Method

Sets the update frequency of all specified status signals to the provided common frequency.

A frequency of 0 Hz will turn off the signal. Otherwise, the minimum supported signal frequency is 4 Hz, and the maximum is 1000 Hz.

If other StatusSignals in the same status frame have been set to an update frequency, the fastest requested update frequency will be applied to each frame.

Definition

Namespace: CTRE.Phoenix6
Assembly: Phoenix6 (in Phoenix6.dll) Version: 1.0.0
C#
public static StatusCode SetUpdateFrequencyForAll(
	double frequencyHz,
	double timeoutSec = 0.05,
	params BaseStatusSignal[] signals
)

Parameters

frequencyHz  Double
Rate to publish the signal in Hz
timeoutSec  Double  (Optional)
Maximum amount of time to wait when performing the action
signals  BaseStatusSignal
Signals to apply the update frequency to

Return Value

StatusCode
Status code of the first failed update frequency call, or OK if all succeeded

See Also