Skip to content

Python Toolkit API Data Streaming Module

zhinst.toolkit.driver.modules.data_streaming_module.DataStreamingModule(data_streaming_module, session)

Bases: BaseModule

Data Streaming Module.

The Data Streaming Module provides functionality for continuous streaming of signals to the the API client and saving of data to file. The streamed signals are resampled onto a common sampling grid corresponding to that with the highest sampling rate. Linear interpolation is used for upsampling. The module provides a minimal interface - the duration of the capture is all that has to be specified, plus some extra parameters if saving to file is required.

Parameters:

Name Type Description Default
data_streaming_module DataStreamingModule

Instance of the core DAQ module.

 required
session Session

Session to the Data Server.

 required

finish()

Stop the module.

finished()

Check if the acquisition has finished.

Returns:

Type Description
bool

Flag if the acquisition has finished.