Functions that control the timing board.
More...
Functions that control the timing board.
◆ ProfisharkAPITimeSource
Time source for the timestamps.
Enumerator |
---|
ProfisharkAPITimeSource_System | System clock
|
ProfisharkAPITimeSource_RTC | Internal RTC
|
ProfisharkAPITimeSource_GPS | GPS time
|
ProfisharkAPITimeSource_None | Not initialized
|
ProfisharkAPITimeSource_Manual | Manual timestamp
|
ProfisharkAPITimeSource_SNTP | From SNTP
|
◆ ProfisharkAPITimingBoardState
State of device timing board.
Enumerator |
---|
ProfisharkAPITimingBoardState_Available | Timing board connected and available
|
ProfisharkAPITimingBoardState_Absent | Timing board not connected
|
ProfisharkAPITimingBoardState_Locked | Timing board connected but not available
|
◆ ProfisharkAPITimingFixState
State of the gps chip.
Enumerator |
---|
ProfisharkAPITimingFixState_NoFix | No GPS fix
|
ProfisharkAPITimingFixState_2DFix | GPS 2D fix
|
ProfisharkAPITimingFixState_3DFix | GPS 3D fix
|
◆ ProfisharkAPIGetTimingStatus()
Get timing board status.
- Parameters
-
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
◆ ProfisharkAPIGPSOutputFlush()
Flush GPS UART output interface.
- Parameters
-
handle | a handle to the device |
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
ProfisharkAPIRet_Unsupported | if the device does not support this operation |
◆ ProfisharkAPIGPSOutputRead()
Fetch data from the GPS UART output interface.
- Parameters
-
| handle | a handle to the device |
| data | a buffer to be filled with data from the gps uart interface |
| the | size of the buffer |
[out] | the | number of bytes transferred from the interface |
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |
ProfisharkAPIRet_Unsupported | if the device does not support this operation |
◆ ProfisharkAPISetTimingTime()
Set timestamp time information.
- Parameters
-
- Return values
-
ProfisharkAPIRet_Success | on success |
ProfisharkAPIRet_NoDev | if the device does not exist |