AcquisitionDriver

class FIREQ_LL_API.AcquisitionDriver(*args: Any, **kwargs: Any)

Bases: _FIREQDriver

Driver class that controls the FIREQ Acquisition IP.

Provides methods to define acquisition behaviour and output type (when applicable).

bindto = ['user.org:user:axisAcquisitionIP:1.0']

fabric_clock_port = 'HS_axi_clock'

reset_state() → None

Reset the cache and payload to the init value.

reset_memory_and_registers() → None

Reset all memory and registers to 0.

set_dac_to_adc_ratio(ratio: int) → None

Set the ratio between the sampling rate of the dac and the adc.

print_description(printer_func: callable) → None

Print a detailed description of the acquisition IP configuration parameters.

Parameters:

printer_func (callable) – Function to use to print the description

init_axi_lite_interface(base_address: int, axi_depth: int) → None

Initialize the AXI Lite interface for register access.

Parameters:

• base_address (int) – Base address of the AXI Lite interface

• axi_depth (int) – Depth of the AXI Lite address space

set_demodulation_frequency(frequency: float) → int

Set acquisition demodulation frequency.

Parameters:

frequency (float) – Frequency of the demodulation signal, normalized to the ADC sampling frequency

Returns:

Error code (0 on success)

Return type:

int

set_demodulation_initial_phase(normalized_phase: float) → int

Set acquisition demodulation frequency.

Parameters:

normalized_phase (float) – Phase offset of the demodulation signal, normalized to 2pi

Returns:

Error code (0 on success)

Return type:

int

trigger_manually() → int

Trigger the acquisition manually.

set_acquisition_duration(duration: int) → int

Set the acquisition duration.

Parameters:

duration (int) – Duration in fabric clock cycles

Returns:

Error code (0 on success)

Return type:

int

set_trigger_channel(channel: int) → int

Set the readout trigger channel.

Parameters:

channel (int) – Channel selection, set to 0 to deactivate external triggers

Returns:

Error code (0 on success)

Return type:

int

set_time_of_flight(time_of_flight: int) → int

Set time of flight.

Parameters:

time_of_flight (int) – Time of flight in fabric clock cycles

Returns:

Error code (0 on success)

Return type:

int

set_output_mode(output_mode: str) → int

Set the type of output data of the decimated stream.

Can be set to output the decimated samples or the accumulated values.

Parameters:

output_type (str) – Selection, allowed values are ‘raw’, ‘decimated’ and ‘accumulated’

Returns:

Error code (0 on success)

Return type:

int