Profishark API  2.3.12.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Timing

Functions that control the timing board. More...

Data Structures

struct  ProfisharkAPITimingTime
 Timing configuration. More...
 
struct  ProfisharkAPITimingDataTime
 Represents a date and time. More...
 
struct  ProfisharkAPITimingStatus
 Status of the device timing board. More...
 

Enumerations

enum  ProfisharkAPITimeSource {
  ProfisharkAPITimeSource_System, ProfisharkAPITimeSource_RTC, ProfisharkAPITimeSource_GPS, ProfisharkAPITimeSource_None,
  ProfisharkAPITimeSource_Manual, ProfisharkAPITimeSource_SNTP
}
 Time source for the timestamps. More...
 
enum  ProfisharkAPITimingBoardState { ProfisharkAPITimingBoardState_Available, ProfisharkAPITimingBoardState_Absent, ProfisharkAPITimingBoardState_Locked }
 State of device timing board. More...
 
enum  ProfisharkAPITimingFixState { ProfisharkAPITimingFixState_NoFix, ProfisharkAPITimingFixState_2DFix, ProfisharkAPITimingFixState_3DFix }
 State of the gps chip. More...
 

Functions

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetTimingTime (ProfisharkApiDeviceHandle handle, ProfisharkAPITimingTime time)
 Set timestamp time information. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetTimingStatus (ProfisharkApiDeviceHandle handle, ProfisharkAPITimingStatus &status)
 Get timing board status. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGPSOutputFlush (ProfisharkApiDeviceHandle handle)
 Flush GPS UART output interface. More...
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGPSOutputRead (ProfisharkApiDeviceHandle handle, char *data, int len, int *transferred)
 Fetch data from the GPS UART output interface. More...
 

Detailed Description

Functions that control the timing board.

Enumeration Type Documentation

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

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

State of the gps chip.

Enumerator
ProfisharkAPITimingFixState_NoFix 

No GPS fix

ProfisharkAPITimingFixState_2DFix 

GPS 2D fix

ProfisharkAPITimingFixState_3DFix 

GPS 3D fix

Function Documentation

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetTimingStatus ( ProfisharkApiDeviceHandle  handle,
ProfisharkAPITimingStatus status 
)

Get timing board status.

Parameters
handlea handle to the device
[out]statusa ProfisharkAPITimingStatus that will contain the timing board status
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGPSOutputFlush ( ProfisharkApiDeviceHandle  handle)

Flush GPS UART output interface.

Parameters
handlea handle to the device
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
ProfisharkAPIRet_Unsupportedif the device does not support this operation
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGPSOutputRead ( ProfisharkApiDeviceHandle  handle,
char *  data,
int  len,
int *  transferred 
)

Fetch data from the GPS UART output interface.

Parameters
handlea handle to the device
dataa buffer to be filled with data from the gps uart interface
thesize of the buffer
[out]thenumber of bytes transferred from the interface
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
ProfisharkAPIRet_Unsupportedif the device does not support this operation
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetTimingTime ( ProfisharkApiDeviceHandle  handle,
ProfisharkAPITimingTime  time 
)

Set timestamp time information.

Parameters
handlea handle to the device
timea ProfisharkAPITimingTime that contains the time information
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist