InstroAWG#

class InstroAWG(
name: str | None = None,
driver: AWGDriverBase | None = None,
num_channels: int | None = None,
publishers: list[Publisher] | None = None,
config: AWGConfig | dict | Path | str | None = None,
autostart: bool = False,
**kwargs,
)[source]#

Bases: Instrument

AWG instrument. Methods return Measurement/Command for publishing.

Initialize an InstroAWG. Provide either config or driver/num_channels together, not both.

Attributes

background_interval

Seconds between background daemon iterations (0 = no wait).

channel_names

Return an insertion-ordered snapshot of all published channel names.

Methods

add_background_daemon_function

Append method to the daemon's call list.

add_publisher

Register a publisher to receive this instrument's Measurement/Command data.

align_phase

Sync the phase of all channels.

burst_enable

Enable or disable burst mode on the given channel.

close

Close the underlying driver.

convert_amplitude

Convert an amplitude value between units using channel's configured waveform.

define_background_daemon

Replace all daemon functions with a single method (called with the given args).

fire_burst_trigger

Fire a burst trigger on channel now; the trigger source must already be MANUAL.

fire_sweep_trigger

Fire a sweep trigger on channel now; the trigger source must already be MANUAL.

get_amplitude

Read back the current amplitude and its measurement unit on channel.

get_burst_delay

Read back the burst trigger delay (seconds) on channel.

get_burst_gate_polarity

Read back the gate polarity for GATED bursts on channel.

get_burst_ncycles

Read back the number of cycles per trigger for NCYCLE bursts on channel.

get_burst_period

Read back the internal burst period (seconds) on channel.

get_burst_state

Read back whether burst mode is enabled on channel.

get_burst_trigger

Read back the burst trigger source on channel.

get_burst_type

Read back the burst type currently active on channel.

get_channel

Return the most recent length samples for channel_name from the in-memory buffer.

get_modulation_state

Read back whether modulation is enabled on channel.

get_modulation_type

Read back the modulation type currently active on channel.

get_offset

Read back the DC offset (volts) on channel.

get_output_load

Read back the output load impedance on channel.

get_output_state

Read back whether the output is enabled on channel.

get_single_channel_value

Return the most recent sample for channel_name from the in-memory buffer.

get_sweep_end_freq

Read back the sweep end frequency (Hz) on channel.

get_sweep_return_time

Read back the sweep return time (seconds) on channel.

get_sweep_start_freq

Read back the sweep start frequency (Hz) on channel.

get_sweep_start_hold_time

Read back the sweep start hold time (seconds) on channel.

get_sweep_state

Read back whether sweep mode is enabled on channel.

get_sweep_stop_hold_time

Read back the sweep stop hold time (seconds) on channel.

get_sweep_time

Read back the sweep time (seconds) on channel.

get_sweep_trigger

Read back the sweep trigger source on channel.

get_sweep_type

Read back the sweep type currently configured on channel.

get_waveform

Read back the current waveform definition on channel.

modulation_enable

Enable or disable modulation on the given channel.

open

Open the underlying driver and apply any configured channel state.

output_enable

Enable or disable the output on channel.

publish

Fan data out to every configured publisher; kwargs pass through.

set_amplitude

Set the output amplitude on channel.

set_burst

Configure channel's burst type.

set_burst_delay

Set the burst trigger delay (seconds) on channel.

set_burst_gate_polarity

Set the gate polarity for GATED bursts on channel.

set_burst_ncycles

Set the number of cycles per trigger for NCYCLE bursts on channel.

set_burst_period

Set the internal burst period (seconds) on channel.

set_burst_trigger

Set the burst trigger source on channel.

set_modulation

Configure channel's carrier modulation with modulator shape.

set_offset

Set the DC offset (volts) on channel.

set_output_load

Set the output load impedance; None means high-Z.

set_sweep

Configure the sweep type on channel.

set_sweep_end_freq

Set the sweep end frequency (Hz) on channel.

set_sweep_return_time

Set the sweep return time (seconds) on channel.

set_sweep_start_freq

Set the sweep start frequency (Hz) on channel.

set_sweep_start_hold_time

Set the sweep start hold time (seconds) on channel.

set_sweep_stop_hold_time

Set the sweep stop hold time (seconds) on channel.

set_sweep_time

Set the sweep time (seconds) on channel.

set_sweep_trigger

Set the sweep trigger source on channel.

set_waveform

Program channel with a waveform.

start

Start the background daemon.

stop

Signal the background daemon to stop and join it.

sweep_enable

Enable or disable sweep mode on channel.