AlazarGetParameter¶

Function Syntax¶

RETURN_CODE AlazarGetParameter(HANDLE handle, U8 channel, U32 parameter, long *retValue)¶

Get a device parameter as a signed long value.

Parameters:

handle – [in] Board handle
channel – [in] The channel to control. See ALAZAR_CHANNELS for a list of possible values. This parameter only takes unsigned 8-bit values.
parameter – [in] The Parameter to modify. This can be one of ALAZAR_PARAMETERS.
retValue – [in] Parameter’s value

Returns:

ApiSuccess upon success, or an error code. See RETURN_CODE for more detailed information.

LabVIEW Block Diagram¶

Related Enumerations¶

enum ALAZAR_PARAMETERS¶

Parameters suitable to be used with AlazarSetParameter() and/or AlazarGetParameter()

Values:

enumerator DATA_WIDTH¶: 0x10000009UL The number of bits per sample

enumerator SETGET_ASYNC_BUFFSIZE_BYTES¶: 0x10000039UL The size of API-allocated DMA buffers in bytes

enumerator SETGET_ASYNC_BUFFCOUNT¶: 0x10000040UL The number of API-allocated DMA buffers

enumerator GET_ASYNC_BUFFERS_PENDING¶: 0x10000050UL DMA buffers currently posted to the board

enumerator GET_ASYNC_BUFFERS_PENDING_FULL¶: 0x10000051UL DMA buffers waiting to be processed by the application

enumerator GET_ASYNC_BUFFERS_PENDING_EMPTY¶: 0x10000052UL DMA buffers waiting to be filled by the board

enumerator SET_DATA_FORMAT¶: 0x10000041UL 0 if the data format is unsigned, and 1 otherwise

enumerator GET_DATA_FORMAT¶: 0x10000042UL 0 if the data format is unsigned, and 1 otherwise

enumerator GET_SAMPLES_PER_TIMESTAMP_CLOCK¶: 0x10000044UL Number of samples per timestamp clock

enumerator GET_RECORDS_CAPTURED¶: 0x10000045UL Records captured since the start of the acquisition (single-port) or buffer (dual-port)

enumerator ECC_MODE¶: 0x10000048UL ECC mode. Member of ALAZAR_ECC_MODES

enumerator GET_AUX_INPUT_LEVEL¶: 0x10000049UL Read the TTL level of the AUX connector. Member of ALAZAR_AUX_INPUT_LEVELS

enumerator GET_CHANNELS_PER_BOARD¶: 0x10000070UL Number of analog channels supported by this digitizer

enumerator GET_FPGA_TEMPERATURE¶

0x10000080UL Current FPGA temperature in degrees Celcius. Only supported by PCIe digitizers. Please note that the returned value is encoded in a 32-bit floating point number. The following code sample demonstrates how to get the temperature value.

float temperature_c;
RETURN_CODE rc = AlazarGetParameter(board, 0, GET_FPGA_TEMPERATURE, (long*)&temperature_c);
if (rc != ApiSuccess) {
  // Handle error
}

enumerator PACK_MODE¶: 0x10000072UL Get/Set the pack mode as a member of ALAZAR_PACK_MODES

enumerator SET_SINGLE_CHANNEL_MODE¶: 0x10000043UL Reserve all the on-board memory to the channel passed as argument. Single-port only.

enumerator API_FLAGS¶: 0x10000090UL Get/Set the state of the API logging as a member of ALAZAR_API_TRACE_STATES

enumerator SET_SOFTWARE_CAL_MECHANISM¶: 0x10000100UL Use software calibration mechanism if set to 1, else use standard hardware calibration.

enumerator API_LOG_CLEAR¶: 0x10000102UL Clear the log file of the API logging mechanism

enumerator SETGET_TRIGGER_SKIPPING¶: 0x10000103UL Sets of gets the current value of trigger skipping. Please refer to the trigger skipping section of the documentation for more information.

enumerator GET_ADC_TEMPERATURE¶

0x10000104UL Current ADC temperature in degrees Celcius. Only supported by PCIe digitizers. Please note that the returned value is encoded in a 32-bit floating point number. The following code sample demonstrates how to get the temperature value.

float temperature_c;
RETURN_CODE rc = AlazarGetParameter(board, 0, GET_ADC_TEMPERATURE, (long*)&temperature_c);
if (rc != ApiSuccess) {
  // Handle error
}

enumerator GET_ONBOARD_MEMORY_USED¶: 0x10000105UL Get the percentage of on-board memory used. Feature only supported for certain board types.

enum ALAZAR_ECC_MODES¶

ECC Modes.

Values:

enumerator ECC_DISABLE¶: 0 Disable

enumerator ECC_ENABLE¶: 1 Enable

enum ALAZAR_AUX_INPUT_LEVELS¶

Auxiliary input levels.

Values:

enumerator AUX_INPUT_LOW¶: 0 Low level

enumerator AUX_INPUT_HIGH¶: 1 High level

enum ALAZAR_PACK_MODES¶

Data pack modes.

Values:

enumerator PACK_DEFAULT¶: 0 Default pack mode of the board

enumerator PACK_8_BITS_PER_SAMPLE¶: 1 8 bits per sample

enumerator PACK_12_BITS_PER_SAMPLE¶: 2 12 bits per sample

enum ALAZAR_API_TRACE_STATES¶

API trace states.

Values:

enumerator API_DISABLE_TRACE¶: 0 Trace disabled

enumerator API_ENABLE_TRACE¶: 1 Trace enabled