ParentDeviceOptimizeBusUtilization Method

Optimizes the device's bus utilization by reducing the update frequencies of its status signals.

All status signals that have not been explicitly given an update frequency will be disabled. Note that if other status signals in the same status frame have been given an update frequency, the update frequency will be honored for the entire frame.

This function only needs to be called once on this device in the robot program. Additionally, this method does not necessarily need to be called after setting the update frequencies of other signals.

To restore the default status update frequencies, remove this method call, redeploy the robot application, and power-cycle the devices on the bus. Alternatively, the user can override individual status update frequencies using {@link BaseStatusSignal#setUpdateFrequency}.

Definition

Namespace: CTRE.Phoenix6.Hardware
Assembly: Phoenix6 (in Phoenix6.dll) Version: 1.0.0
C#
public StatusCode OptimizeBusUtilization(
	double timeoutSeconds = 0.05
)

Parameters

timeoutSeconds  Double  (Optional)
Maximum amount of time to wait for each status frame when performing the action

Return Value

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

See Also