|
WPILibC++
2020.3.2
|
Functions | |
| HAL_NotifierHandle | HAL_InitializeNotifier (int32_t *status) |
| Initializes a notifier. More... | |
| void | HAL_SetNotifierName (HAL_NotifierHandle notifierHandle, const char *name, int32_t *status) |
| Sets the name of a notifier. More... | |
| void | HAL_StopNotifier (HAL_NotifierHandle notifierHandle, int32_t *status) |
| Stops a notifier from running. More... | |
| void | HAL_CleanNotifier (HAL_NotifierHandle notifierHandle, int32_t *status) |
| Cleans a notifier. More... | |
| void | HAL_UpdateNotifierAlarm (HAL_NotifierHandle notifierHandle, uint64_t triggerTime, int32_t *status) |
| Updates the trigger time for a notifier. More... | |
| void | HAL_CancelNotifierAlarm (HAL_NotifierHandle notifierHandle, int32_t *status) |
| Cancels the next notifier alarm. More... | |
| uint64_t | HAL_WaitForNotifierAlarm (HAL_NotifierHandle notifierHandle, int32_t *status) |
| Waits for the next alarm for the specific notifier. More... | |
| void HAL_CancelNotifierAlarm | ( | HAL_NotifierHandle | notifierHandle, |
| int32_t * | status | ||
| ) |
Cancels the next notifier alarm.
This does not cause HAL_WaitForNotifierAlarm to return.
| notifierHandle | the notifier handle |
| void HAL_CleanNotifier | ( | HAL_NotifierHandle | notifierHandle, |
| int32_t * | status | ||
| ) |
Cleans a notifier.
Note this also stops a notifier if it is already running.
| notifierHandle | the notifier handle |
| HAL_NotifierHandle HAL_InitializeNotifier | ( | int32_t * | status | ) |
Initializes a notifier.
A notifier is an FPGA controller timer that triggers at requested intervals based on the FPGA time. This can be used to make precise control loops.
| void HAL_SetNotifierName | ( | HAL_NotifierHandle | notifierHandle, |
| const char * | name, | ||
| int32_t * | status | ||
| ) |
Sets the name of a notifier.
| notifierHandle | the notifier handle |
| name | name |
| void HAL_StopNotifier | ( | HAL_NotifierHandle | notifierHandle, |
| int32_t * | status | ||
| ) |
Stops a notifier from running.
This will cause any call into HAL_WaitForNotifierAlarm to return.
| notifierHandle | the notifier handle |
| void HAL_UpdateNotifierAlarm | ( | HAL_NotifierHandle | notifierHandle, |
| uint64_t | triggerTime, | ||
| int32_t * | status | ||
| ) |
Updates the trigger time for a notifier.
Note that this time is an absolute time relative to HAL_GetFPGATime()
| notifierHandle | the notifier handle |
| triggerTime | the updated trigger time |
| uint64_t HAL_WaitForNotifierAlarm | ( | HAL_NotifierHandle | notifierHandle, |
| int32_t * | status | ||
| ) |
Waits for the next alarm for the specific notifier.
This is a blocking call until either the time elapses or HAL_StopNotifier gets called.
| notifierHandle | the notifier handle |