AHP® XC Correlators API
AHP XC Correlators
Loading...
Searching...
No Matches
Functions
Commands and setup of the correlator

Functions

DLL_EXPORT int32_t ahp_xc_set_capture_flags (xc_capture_flags flags)
 Set integration flags.
 
DLL_EXPORT xc_capture_flags ahp_xc_get_capture_flags ()
 Get integration flags.
 
DLL_EXPORT void ahp_xc_set_leds (uint32_t index, int32_t leds)
 Switch on or off the led lines of the correlator.
 
DLL_EXPORT void ahp_xc_set_channel_cross (uint32_t index, off_t value, size_t size, size_t step)
 Set the channel of the selected input (for cross-correlation)
 
DLL_EXPORT void ahp_xc_set_channel_auto (uint32_t index, off_t value, size_t size, size_t step)
 Set the channel of the selected input (for auto-correlation)
 
DLL_EXPORT void ahp_xc_set_frequency_divider (unsigned char value)
 Set the clock divider for autocorrelation and crosscorrelation.
 
DLL_EXPORT void ahp_xc_set_voltage (uint32_t index, unsigned char value)
 Set the supply voltage on the current line.
 
DLL_EXPORT void ahp_xc_set_test_flags (uint32_t index, int32_t test)
 Enable tests on the current line.
 
DLL_EXPORT unsigned char ahp_xc_get_test_flags (uint32_t index)
 Get the current status of the test features.
 
DLL_EXPORT unsigned char ahp_xc_get_leds (uint32_t index)
 Get the current status of the leds on line.
 
DLL_EXPORT void ahp_xc_select_input (uint32_t index)
 Select the input on which to issue next command.
 
DLL_EXPORT uint32_t ahp_xc_current_input ()
 Returns the currently selected input on which next command will be issued.
 
DLL_EXPORT int32_t ahp_xc_send_command (xc_cmd cmd, unsigned char value)
 Send an arbitrary command to the AHP XC device.
 
DLL_EXPORT uint32_t ahp_xc_get_version (void)
 Obtain the current libahp-xc version.
 

Detailed Description

Function Documentation

◆ ahp_xc_current_input()

DLL_EXPORT uint32_t ahp_xc_current_input ( )
Returns
The input index

◆ ahp_xc_get_capture_flags()

DLL_EXPORT xc_capture_flags ahp_xc_get_capture_flags ( )
Returns
current capture flags.

◆ ahp_xc_get_leds()

DLL_EXPORT unsigned char ahp_xc_get_leds ( uint32_t index)
Parameters
indexThe line index starting from 0
Returns
The current led configuration on index input

◆ ahp_xc_get_test_flags()

DLL_EXPORT unsigned char ahp_xc_get_test_flags ( uint32_t index)
Parameters
indexThe line index starting from 0
Returns
The current tests on index input

◆ ahp_xc_get_version()

DLL_EXPORT uint32_t ahp_xc_get_version ( void )
inline
Returns
The current version code

◆ ahp_xc_select_input()

DLL_EXPORT void ahp_xc_select_input ( uint32_t index)
Parameters
indexThe input index

◆ ahp_xc_send_command()

DLL_EXPORT int32_t ahp_xc_send_command ( xc_cmd cmd,
unsigned char value )
Parameters
cmdThe command
valueThe command parameter
Returns
non-zero on failure

◆ ahp_xc_set_capture_flags()

DLL_EXPORT int32_t ahp_xc_set_capture_flags ( xc_capture_flags flags)
Parameters
flagsNew capture flags mask.

◆ ahp_xc_set_channel_auto()

DLL_EXPORT void ahp_xc_set_channel_auto ( uint32_t index,
off_t value,
size_t size,
size_t step )
Parameters
indexThe input line index starting from 0
valueThe starting channel
sizeThe number of channels to scan
stepThe scan stepping in channels

◆ ahp_xc_set_channel_cross()

DLL_EXPORT void ahp_xc_set_channel_cross ( uint32_t index,
off_t value,
size_t size,
size_t step )
Parameters
indexThe input line index starting from 0
valueThe starting channel
sizeThe number of channels to scan
stepThe scan stepping in channels

◆ ahp_xc_set_frequency_divider()

DLL_EXPORT void ahp_xc_set_frequency_divider ( unsigned char value)
Parameters
valueThe clock divider power of 2

◆ ahp_xc_set_leds()

DLL_EXPORT void ahp_xc_set_leds ( uint32_t index,
int32_t leds )
Parameters
indexThe input line index starting from 0
ledsThe enable mask of the leds

◆ ahp_xc_set_test_flags()

DLL_EXPORT void ahp_xc_set_test_flags ( uint32_t index,
int32_t test )
Parameters
indexThe input line index starting from 0
testThe test flags

◆ ahp_xc_set_voltage()

DLL_EXPORT void ahp_xc_set_voltage ( uint32_t index,
unsigned char value )
Parameters
indexThe input line index starting from 0
valueThe voltage level