AHP® XC Correlators API
AHP XC Correlators
Loading...
Searching...
No Matches

Functions

DLL_EXPORT int32_t ahp_xc_connect (const char *port)
 Connect to a serial port.
 
DLL_EXPORT int32_t ahp_xc_connect_fd (int32_t fd)
 Connect to a serial port or other stream associated to the given file descriptor.
 
DLL_EXPORT int32_t ahp_xc_get_fd ()
 Obtain the serial port file descriptor.
 
DLL_EXPORT void ahp_xc_disconnect (void)
 Disconnect from the serial port or descriptor opened with ahp_xc_connect.
 
DLL_EXPORT uint32_t ahp_xc_is_connected (void)
 Report connection status.
 
DLL_EXPORT uint32_t ahp_xc_is_detected (void)
 Report if a correlator was detected.
 
DLL_EXPORT int32_t ahp_xc_get_baudrate (void)
 Obtain the current baud rate.
 
DLL_EXPORT void ahp_xc_set_baudrate (baud_rate rate)
 Obtain the current baud rate.
 
DLL_EXPORT void ahp_xc_set_correlation_order (uint32_t order)
 Set the crosscorrelation order.
 
DLL_EXPORT int32_t ahp_xc_get_correlation_order ()
 Get the crosscorrelation order.
 

Detailed Description

Function Documentation

◆ ahp_xc_connect()

DLL_EXPORT int32_t ahp_xc_connect ( const char * port)
Parameters
portThe serial port name or filename
Returns
Returns non-zero on failure
See also
ahp_xc_disconnect

◆ ahp_xc_connect_fd()

DLL_EXPORT int32_t ahp_xc_connect_fd ( int32_t fd)
Parameters
fdThe file descriptor of the stream
Returns
Returns non-zero on failure

◆ ahp_xc_disconnect()

DLL_EXPORT void ahp_xc_disconnect ( void )
See also
ahp_xc_connect

◆ ahp_xc_get_baudrate()

DLL_EXPORT int32_t ahp_xc_get_baudrate ( void )
Returns
Returns the baud rate

◆ ahp_xc_get_correlation_order()

DLL_EXPORT int32_t ahp_xc_get_correlation_order ( )
Returns
The crosscorrelation order

◆ ahp_xc_get_fd()

DLL_EXPORT int32_t ahp_xc_get_fd ( )
Returns
The file descriptor of the stream

◆ ahp_xc_is_connected()

DLL_EXPORT uint32_t ahp_xc_is_connected ( void )
See also
ahp_xc_connect
ahp_xc_connect_fd
ahp_xc_disconnect
Returns
Returns non-zero if connected

◆ ahp_xc_is_detected()

DLL_EXPORT uint32_t ahp_xc_is_detected ( void )
See also
ahp_xc_connect
ahp_xc_connect_fd
ahp_xc_disconnect
Returns
Returns non-zero if a correlator was detected

◆ ahp_xc_set_baudrate()

DLL_EXPORT void ahp_xc_set_baudrate ( baud_rate rate)
Parameters
rateThe new baud rate index

◆ ahp_xc_set_correlation_order()

DLL_EXPORT void ahp_xc_set_correlation_order ( uint32_t order)
Parameters
orderThe new crosscorrelation order