StatusSignalNative Class

Static class holding the methods for interfacing to the native StatusSignal API

Definition

Namespace: CTRE.Phoenix6.Native
Assembly: Phoenix6 (in Phoenix6.dll) Version: 1.0.0
C#
public static class StatusSignalNative
Inheritance
Object    StatusSignalNative

Methods

GetAppliedUpdateFrequency Gets the applied update frequency for the specified signal
GetUnits Gets the units of the specified SPN index
OptimizeUpdateFrequencies 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 SetUpdateFrequency(Double, Double).

RefreshSignal Gets the signal in a non-blocking manner and updates the StatusSignalNativeStatusSignalInfo struct with the updated information.
SetUpdateFrequency Sets the update frequency of the specified signal to the specified frequency.
SetUpdateFrequencyForAll Sets the update frequency for all specified signals.
WaitForAll Gets all the signals in a blocking manner and updates the StatusSignalNativeStatusSignalInfo structs with the updated information.
WaitForSignal Gets the signal in a blocking manner and updates the StatusSignalNativeStatusSignalInfo struct with the updated information.

See Also