DAQ (Data Acquisition)¤
Errors raised by these methods are documented in Exceptions.
Interface¤
Bases: Instrument
Parameters:
-
(name¤str) –Channel-name prefix for published data.
-
(driver¤DAQDriverBase) –Concrete DAQ driver; owns its own transport::
daq = InstroDAQ( "myDAQ", driver=Keysight34980A("USB0::0x0957::0x0507::MY44001757::INSTR"), )
-
(publishers¤list[Publisher] | None, default:None) –Publishers that receive emitted Measurement/Command data.
-
–**kwargs¤Default tags applied to every emitted Measurement/Command. Pass
dataset_rid="<rid>"to auto-create a NominalCorePublisher (uses the on-disk 'default' Nominal credential).
property
¤
Return an insertion-ordered snapshot of all published channel names.
Names are complete after one full daemon iteration: {name}.loop_time publishes every iteration, so call get_channel("loop_time", wait_for_new_samples=True) then read channel_names to ensure the complete set has arrived.
Raises:
-
RuntimeError–No background buffer;
start()was not called.
property
¤
driver: DAQDriverBase
The underlying vendor driver. Source of truth for all channel/timing state.
property
¤
channels: tuple[DAQChannel, ...]
Frozen snapshot of all configured AI/AO/DI/DO channels (excludes relays).
property
¤
ai_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AI channels, keyed by alias.
property
¤
ao_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AO channels, keyed by alias.
property
¤
di_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DI channels, keyed by alias.
property
¤
do_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DO channels, keyed by alias.
property
¤
relay_channels: Mapping[str, RelayChannel]
Frozen snapshot of configured relay channels, keyed by alias.
property
¤
is_hw_timing_configured: bool
True once configure_ai_hw_sample_rate() has programmed the AI sample clock.
property
¤
is_sw_timing_configured: bool
True once configure_ai_sw_sample_rate() has set a software-timed polling rate.
property
writable
¤
background_interval: float
Daemon loop period (s); 0 unless configure_ai_sw_sample_rate() set a software-timed rate.
add_publisher(publisher: Publisher)
Register a publisher to receive this instrument's Measurement/Command data.
publish(data: Measurement | Command, **kwargs)
Fan data out to every configured publisher; kwargs pass through.
add_background_daemon_function(method: Callable, *args, **kwargs)
Append method to the daemon's call list. Use define_background_daemon to replace instead.
get_channel(
channel_name: str,
length: int = 1,
wait_for_new_samples: bool = False,
timeout: float = 10.0,
) -> Measurement
Return the most recent length samples for channel_name from the in-memory buffer.
If the channel does not exist yet, or no sample is available, the code will always block until timeout expires.
Parameters:
-
(channel_name¤str) –Name of the channel to retrieve.
-
(length¤int, default:1) –Number of trailing samples to return.
-
(wait_for_new_samples¤bool, default:False) –Block until at least
lengthnew values arrive. -
(timeout¤float, default:10.0) –Seconds to wait when insufficient data exists or
wait_for_new_samples=True.
Raises:
-
RuntimeError–No background buffer;
start()was not called. -
ChannelNotFoundError–channel had no values and no data appeared before
timeout.wait_for_new_samples=Trueand channel did not appear withintimeout. -
ChannelValueTimeoutError–wait_for_new_samples=Trueand values did not arrive withintimeout.
get_single_channel_value(channel_name: str) -> float | None
Return the most recent sample for channel_name from the in-memory buffer.
This will not wait, if data is not available then None is returned.
Parameters:
Raises:
-
RuntimeError–No background buffer;
start()was not called.
define_background_daemon(method: Callable, *args, **kwargs)
Replace all daemon functions with a single method (called with the given args).
close()
Run full teardown unconditionally: daemon, then publishers, then the driver, which owns its idempotency.
configure_voltage_input(
physical_channel: str,
*,
alias: str | None = None,
range_min: float = -10.0,
range_max: float = 10.0,
scaler: Scaler | None = None,
terminal_config: str | TerminalConfig | None = None,
)
Configure an analog voltage input channel.
Parameters:
-
(physical_channel¤str) –Vendor-specific channel id (e.g.
"ai0"or"Dev1/ai0"). -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel. -
(range_min¤float, default:-10.0) –Lower voltage range (volts).
-
(range_max¤float, default:10.0) –Upper voltage range (volts).
-
(scaler¤Scaler | None, default:None) –Optional
Scalerapplied to AI samples after read. -
(terminal_config¤str | TerminalConfig | None, default:None) –Terminal wiring (RSE / NRSE / DIFF) for the channel.
configure_voltage_output(
physical_channel: str,
*,
alias: str | None = None,
range_min: float = -10.0,
range_max: float = 10.0,
scaler: Scaler | None = None,
)
Configure an analog voltage output channel.
Parameters:
-
(physical_channel¤str) –Vendor-specific channel id (e.g.
"ao0"or"Dev1/ao0"). -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel. -
(range_min¤float, default:-10.0) –Lower voltage range (volts).
-
(range_max¤float, default:10.0) –Upper voltage range (volts).
-
(scaler¤Scaler | None, default:None) –Optional
Scalerfor the channel.
configure_current_input(
physical_channel: str,
*,
alias: str | None = None,
range_min: float = 0.0,
range_max: float = 0.02,
scaler: Scaler | None = None,
)
Configure an analog current input channel.
Parameters:
-
(physical_channel¤str) –Vendor-specific channel id (e.g.
"ai0"or"Dev1/ai0"). -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel. -
(range_min¤float, default:0.0) –Lower current range (amps).
-
(range_max¤float, default:0.02) –Upper current range (amps).
-
(scaler¤Scaler | None, default:None) –Optional
Scalerapplied to AI samples after read.
configure_current_output(
physical_channel: str,
*,
alias: str | None = None,
range_min: float = 0.0,
range_max: float = 0.02,
scaler: Scaler | None = None,
)
Configure an analog current output channel.
Parameters:
-
(physical_channel¤str) –Vendor-specific channel id (e.g.
"ao0"or"Dev1/ao0"). -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel. -
(range_min¤float, default:0.0) –Lower current range (amps).
-
(range_max¤float, default:0.02) –Upper current range (amps).
-
(scaler¤Scaler | None, default:None) –Optional
Scalerfor the channel.
configure_thermocouple_input(
physical_channel: str,
tc_type: str | TC_TYPE,
*,
unit: str | TC_UNIT,
alias: str | None = None,
range_min: float = 0.0,
range_max: float = 100.0,
scaler: Scaler | None = None,
cjc_source: str | CJCSource = INTERNAL,
cjc_temp: float | None = None,
cjc_channel: str | None = None,
tc_input_scaler: Scaler | None = None,
)
Configure a thermocouple input channel.
Parameters:
-
(physical_channel¤str) –Vendor-specific channel id (e.g.
"ai0"or"Dev1/ai0"). -
(tc_type¤str | TC_TYPE) –Thermocouple type — one of B, E, J, K, N, R, S, T.
-
(unit¤str | TC_UNIT) –Temperature unit for
range_min/range_max,cjc_temp, and returned readings. -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel. -
(range_min¤float, default:0.0) –Lower temperature range (in
unit). -
(range_max¤float, default:100.0) –Upper temperature range (in
unit). -
(scaler¤Scaler | None, default:None) –Optional
Scalerapplied to AI samples after read. -
(cjc_source¤str | CJCSource, default:INTERNAL) –Cold-junction compensation source (internal / constant / channel).
-
(cjc_temp¤float | None, default:None) –Cold-junction temperature when
cjc_sourceisCONSTANT, expressed inunit. -
(cjc_channel¤str | None, default:None) –Channel supplying cold-junction temperature when
cjc_sourceisCHANNEL. -
(tc_input_scaler¤Scaler | None, default:None) –Volts-domain scaler applied before temperature conversion if amplifier was used (LabJack only).
configure_digital_input(
physical_channel: str,
*,
logic: str | Logic = HIGH,
logic_level: float | None = None,
alias: str | None = None,
)
Configure a digital input line channel.
Parameters:
-
(physical_channel¤str) –Vendor-specific line id (e.g.
"port0/line3"on NI,"FIO0"on LabJack). -
(logic¤str | Logic, default:HIGH) –Active-
HIGHor active-LOW. -
(logic_level¤float | None, default:None) –Voltage threshold (volts); the driver default is used when
None. -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel.
configure_digital_output(
physical_channel: str,
*,
logic: str | Logic = HIGH,
logic_level: float | None = None,
alias: str | None = None,
)
Configure a digital output line channel.
Parameters:
-
(physical_channel¤str) –Vendor-specific line id (e.g.
"port0/line3"on NI,"FIO0"on LabJack). -
(logic¤str | Logic, default:HIGH) –Active-
HIGHor active-LOW. -
(logic_level¤float | None, default:None) –Voltage threshold (volts); the driver default is used when
None. -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel.
configure_analog_channel(
direction: Direction,
physical_channel: str,
alias: str | None = None,
range_min: float = -10.0,
range_max: float = 10.0,
scaler: Scaler | None = None,
terminal_config: TerminalConfig | None = None,
)
Configure an analog channel.
Parameters:
-
(direction¤Direction) –INPUTorOUTPUT. -
(physical_channel¤str) –Vendor-specific channel id (e.g.
"ai0"or"Dev1/ai0"). -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel. -
(range_min¤float, default:-10.0) –Lower voltage range (volts).
-
(range_max¤float, default:10.0) –Upper voltage range (volts).
-
(scaler¤Scaler | None, default:None) –Optional
Scalerapplied to AI samples after read. -
(terminal_config¤TerminalConfig | None, default:None) –Terminal wiring (RSE / NRSE / DIFF) for the channel.
configure_ai_sample_rate(
sample_rate: float, samples_per_channel: int | None = None, **kwargs
)
configure_ai_hw_sample_rate(
sample_rate: float, samples_per_channel: int | None = None
)
configure_ai_sw_sample_rate(sample_rate: float)
start(background: bool = True, **kwargs)
Start acquisition: hardware-timed, or the software-timed daemon when SW timing is configured.
With no AI timing configured, background=True falls back to software timing at
1 Hz.
Parameters:
-
(background¤bool, default:True) –When True (default), spin the daemon thread to continuously fetch the buffer. When False, begin hardware acquisition only and fetch the buffer yourself by calling
read_analog(). Software-timed acquisition requires True — the daemon is what does the timing — so False logs an error and starts nothing. -
–**kwargs¤channel_type(NI only) selects which DAQmx task to start.
stop(**kwargs)
Stop hardware acquisition and the background daemon; tolerant teardown when not open.
read_analog(**kwargs) -> Measurement | list[Measurement]
Dispatch a hardware-timed buffer fetch or a software-timed conversion based on configuration.
Each branch publishes its own Measurements; this dispatcher does not. Either timing mode with the background daemon running raises — the daemon owns the reads. Returns a single Measurement when channels share a timebase, otherwise one Measurement per timebase cluster.
read(channel: str, **kwargs) -> Measurement
Read one AI/DI channel by alias; returns its Measurement.
read_batch(
channels: list[str] | None = None, **kwargs
) -> dict[str, Measurement]
Read AI/DI channels by alias (None = all inputs); returns {alias: Measurement}, analog via read_analog (or the daemon buffer while it runs), digital per line/port.
Write value to one AO/DO channel by alias; returns its Command.
write_batch(
channels: list[str],
values: list[float | int | bool],
continue_on_failed_write: bool = False,
**kwargs,
) -> list[Command]
Write values[i] to output channels[i] (alias); continue_on_failed_write logs and skips failed writes instead of raising.
Write value (volts) to AO channel (alias). Raises KeyError if channel isn't configured.
configure_digital_line(
direction: Direction,
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Configure a digital line channel.
Parameters:
-
(direction¤Direction) –INPUTorOUTPUT. -
(physical_channel¤str) –Vendor-specific line id (e.g.
"port0/line3"on NI,"5101/3"on Keysight,"FIO0"on LabJack). -
(logic¤Logic) –Active-
HIGHor active-LOW. -
(logic_level¤float | None, default:None) –Voltage threshold (volts); the driver default is used when
None. -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel.
configure_digital_port(
direction: Direction,
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Configure a digital port channel.
Parameters:
-
(direction¤Direction) –INPUTorOUTPUT. -
(physical_channel¤str) –Vendor-specific port id (e.g.
"port0"on NI,"5101"on Keysight,"AUXPORT0"on MCC). -
(logic¤Logic) –Active-
HIGHor active-LOW. -
(port_width¤DigitalPortWidth) –Port width in bits (8/16/32/64).
-
(logic_level¤float | None, default:None) –Voltage threshold (volts); the driver default is used when
None. -
(alias¤str | None, default:None) –Friendly name; defaults to
physical_channel.
Write 0/1 to DO line channel (alias). Raises KeyError if channel isn't configured.
read_digital_line(channel: str, **kwargs) -> Measurement
Read DI line channel (alias). Raises KeyError if channel isn't configured.
Write data to DO port channel (alias). Raises KeyError if channel isn't configured.
read_digital_port(channel: str, **kwargs) -> Measurement
Read DI port channel (alias). Raises KeyError if channel isn't configured.
Configure a relay channel (physical_channel e.g. "3101" = slot 3 / channel 101).
Close relay channel (alias) — connects the circuit.
Open relay channel (alias) — disconnects the circuit.
get_actual_sample_rate() -> float | None
Hardware's actual sample rate after start(); None if unsupported or not started.
get_points_in_buffer(**kwargs) -> Measurement
Publish the current DAQ buffer depth on channel {name}.buffer.
Types & Configuration¤
DAQ shared types: vendors, channel types, terminal configs, hardware-timing config.
module-attribute
¤
AnalogChannelUnion = (
AnalogChannel
| AnalogVoltageChannel
| AnalogCurrentChannel
| AnalogThermocoupleChannel
)
dataclass
¤
dataclass
¤
dataclass
¤
AnalogChannel(
range_max: float,
range_min: float,
scaler: Scaler | None,
terminal_config: TerminalConfig | None = None,
*,
physical_channel: str,
alias: str,
direction: Direction,
)
Bases: DAQChannel
dataclass
¤
AnalogVoltageChannel(
range_max: float,
range_min: float,
scaler: Scaler | None,
terminal_config: TerminalConfig | None = None,
*,
physical_channel: str,
alias: str,
direction: Direction,
)
Bases: DAQChannel
dataclass
¤
AnalogCurrentChannel(
range_max: float,
range_min: float,
scaler: Scaler | None,
*,
physical_channel: str,
alias: str,
direction: Direction,
)
Bases: DAQChannel
dataclass
¤
AnalogThermocoupleChannel(
range_max: float,
range_min: float,
scaler: Scaler | None,
tc_type: TC_TYPE,
cjc_source: CJCSource | None,
cjc_temp: float | None,
cjc_channel: str | None,
unit: TC_UNIT,
tc_input_scaler: Scaler | None = None,
*,
physical_channel: str,
alias: str,
direction: Direction,
)
Bases: DAQChannel
dataclass
¤
dataclass
¤
DigitalPortChannel(
logic_level: float | None,
logic: Logic,
width: DigitalPortWidth,
*,
physical_channel: str,
alias: str,
direction: Direction,
)
Bases: DigitalChannel
dataclass
¤
DigitalLineChannel(
logic_level: float | None,
logic: Logic,
bit_position: int | None = None,
*,
physical_channel: str,
alias: str,
direction: Direction,
)
Bases: DigitalChannel
dataclass
¤
Scaling¤
Thermocouple Scaling¤
Thermocouple scaling for DAQ: voltage → °C with cold-junction compensation.
Bases: Scaler
Thermocouple voltage → °C with cold-junction compensation.
ThermocoupleSensor(TC_TYPE.K, cjc_temp=25.0) # Type K, 25 °C reference junction
Parameters:
Bases: Scaler
Temperature (°C) → voltage with cold-junction compensation — inverse of ThermocoupleSensor.
InverseThermocoupleSensor(TC_TYPE.K, cjc_temp=25.0) # Type K, 25 °C reference junction
Parameters:
Convert a Kelvin temperature to unit.
Driver Interface¤
Bases: ABC
Vendor DAQ driver contract.
The driver is the single source of truth for configured channels and
timing config, held in private dicts/slots that __init__ initializes so
every concrete driver has the same shape; subclasses call
super().__init__() and then populate those privates inside their own
configure_* methods (self._ai_channels[channel.alias] = channel,
self._ai_hw_timing_config = hw_timing_config, etc.). Read-only
@property accessors hand back frozen snapshots so the state can't be
mutated from outside the configure_* path; InstroDAQ exposes the
same snapshots for user introspection — it does not keep its own copies.
property
¤
channels: tuple[DAQChannel, ...]
Frozen snapshot of all configured AI/AO/DI/DO channels (excludes relays).
property
¤
ai_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AI channels, keyed by alias.
property
¤
ao_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AO channels, keyed by alias.
property
¤
di_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DI channels, keyed by alias.
property
¤
do_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DO channels, keyed by alias.
property
¤
relay_channels: Mapping[str, RelayChannel]
Frozen snapshot of configured relay channels, keyed by alias.
abstractmethod
¤
open()
Open the underlying transport (or verify the device is present, for handle-less SDKs).
abstractmethod
¤
configure_ai_channel(channel: AnalogChannel)
Register an AI channel with the underlying driver (range, terminal mode, scaler — vendor-specific).
configure_ao_channel(channel: AnalogChannel)
Register an AO channel. Override if the driver supports analog output.
configure_ai_voltage_channel(channel: AnalogVoltageChannel)
Register an AI voltage channel. Override if the driver supports analog voltage input.
configure_ao_voltage_channel(channel: AnalogVoltageChannel)
Register an AO voltage channel. Override if the driver supports analog voltage output.
configure_ai_current_channel(channel: AnalogCurrentChannel)
Register an AI current channel. Override if the driver supports analog current input.
configure_ao_current_channel(channel: AnalogCurrentChannel)
Register an AO current channel. Override if the driver supports analog current output.
configure_ai_thermocouple_channel(channel: AnalogThermocoupleChannel)
Register an AI thermocouple channel. Override if the driver supports thermocouple input.
abstractmethod
¤
configure_ai_hw_timing(hw_timing_config: HWTimingConfig)
Configure hardware-timed AI sampling at hw_timing_config.sample_rate.
Called before start() whenever InstroDAQ.configure_ai_sample_rate()
is invoked. The driver should program the sample clock and any
samples_per_channel buffer sizing the underlying SDK requires.
abstractmethod
¤
configure_di_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse, program, and register a DI line channel.
abstractmethod
¤
configure_do_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse, program, and register a DO line channel.
configure_di_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse, program, and register a DI port channel. Override if the driver supports port-mode digital input.
configure_do_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse, program, and register a DO port channel. Override if the driver supports port-mode digital output.
configure_di_channel(channel: DigitalLineChannel)
Register a DI line channel. Override if the driver supports digital input.
configure_do_channel(channel: DigitalLineChannel)
Register a DO line channel. Override if the driver supports digital output.
abstractmethod
¤
start(**kwargs)
Start hardware-timed acquisition.
InstroDAQ passes channel_type=<ChannelType> when the user
targets a specific task (e.g. on NI, where AI/AO/DI/DO each have their
own DAQmx task). Drivers without that distinction can ignore it.
abstractmethod
¤
stop(**kwargs)
Stop a running acquisition and release any scan buffers. channel_type mirrors :meth:start.
abstractmethod
¤
read_analog() -> Any
Software-timed read of every configured AI channel.
Returns a vendor-specific payload that _read_to_measurements then
unpacks into Measurements. response.dt should be None so
the wrapper timestamps with wall-clock time.
abstractmethod
¤
fetch_analog() -> Any
Block until samples_per_channel new AI samples are available, then return them.
Drivers should set self.points_in_buffer for buffer-depth
telemetry and return dt (ns per sample) so the wrapper can
build contiguous timestamps via HWTimestamper.
get_actual_sample_rate() -> float | None
Actual hardware sample rate achieved after start().
Default returns None (driver doesn't know or hasn't started).
Override on drivers whose SDK reports the effective rate (NI, MCC,
LabJack T-series all do).
write_analog_value(channel: AnalogChannelUnion, value: float)
Write value to AO channel. Override if the driver supports analog output.
abstractmethod
¤
write_digital_line(channel: DigitalChannel, data: int)
Drive a single DO line. data is 0 or 1 (active-low channel.logic is handled in the driver).
abstractmethod
¤
read_digital_line(channel: DigitalChannel) -> int
Sample a single DI line. Returns 0 or 1 after applying channel.logic.
abstractmethod
¤
write_digital_port(channel: DigitalChannel, data: int)
Drive a multi-line DO port. data is an N-bit integer; bit i controls line i.
abstractmethod
¤
read_digital_port(channel: DigitalChannel) -> int
Sample a multi-line DI port. Returns an N-bit integer; bit i reflects line i.
define_relay_channel(
physical_channel: str, alias: str | None = None
) -> RelayChannel
Build a RelayChannel for physical_channel (e.g. "3101" = slot 3 / channel 101).
Default implementation suits the Keysight 34980A's slot/channel
addressing; override if the driver needs different parsing. Overrides
must also record the resulting channel on self._relay_channels.
close_relay(channel: RelayChannel)
Close the relay (connect the circuit). Override if the driver supports relays.
open_relay(channel: RelayChannel)
Open the relay (disconnect the circuit). Override if the driver supports relays.
Contiguous nanosecond timestamps for hardware-timed DAQ batches.
Anchors to the wall clock exactly once via seed(), then advances by
sample period on every next_batch() call — eliminates timestamp overlap
when consecutive reads return in rapid succession.
classmethod
¤
Anchor the timeline at t_wall ns (read-return time of the first batch).
Vendor Drivers¤
Keysight 34980A¤
Keysight 34980A Multifunction Switch/Measure Unit DAQ driver.
dataclass
¤
Keysight34980A(
visa_resource: str | VisaConfig, *, sync_system_clock: bool = True
)
Bases: DAQDriverBase
Keysight 34980A Multifunction Switch/Measure Unit.
Parameters:
-
(visa_resource¤str | VisaConfig) –VISA resource string or full
VisaConfig. -
(sync_system_clock¤bool, default:True) –Sync the instrument clock to host UTC on
open()so returned timestamps align with the host. Enabled by default.
property
¤
channels: tuple[DAQChannel, ...]
Frozen snapshot of all configured AI/AO/DI/DO channels (excludes relays).
property
¤
ai_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AI channels, keyed by alias.
property
¤
ao_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AO channels, keyed by alias.
property
¤
di_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DI channels, keyed by alias.
property
¤
do_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DO channels, keyed by alias.
property
¤
relay_channels: Mapping[str, RelayChannel]
Frozen snapshot of configured relay channels, keyed by alias.
configure_ai_channel(channel: AnalogChannel)
Configure an AI channel: CONF:VOLT:DC at computed range, then add to ROUT:SCAN and enable timestamps.
configure_ai_hw_timing(hw_timing_config: HWTimingConfig)
Configure TRIG:SOUR TIMER at the configured sample period and infinite count.
fetch_analog() -> KeysightData
Block until the buffer holds at least one full per-channel batch, then drain a channel-aligned chunk.
configure_di_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse MNNN/B (slot/channel/bit), program the port for DI, and register the line.
configure_do_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse MNNN/B (slot/channel/bit), program the port for DO, and register the line.
configure_di_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse MNNN (slot/channel), program the port for DI, and register the port.
configure_do_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse MNNN (slot/channel), program the port for DO, and register the port.
write_digital_port(channel: DigitalChannel, data: int)
Drive a DO port as one N-bit integer. Active-low is applied in hardware via CONF:DIG:POL.
read_digital_port(channel: DigitalChannel) -> int
Sample a DI port as one N-bit integer. Active-low is applied in hardware via CONF:DIG:POL.
configure_ao_channel(channel: AnalogChannel)
Register an AO channel. Override if the driver supports analog output.
configure_ai_voltage_channel(channel: AnalogVoltageChannel)
Register an AI voltage channel. Override if the driver supports analog voltage input.
configure_ao_voltage_channel(channel: AnalogVoltageChannel)
Register an AO voltage channel. Override if the driver supports analog voltage output.
configure_ai_current_channel(channel: AnalogCurrentChannel)
Register an AI current channel. Override if the driver supports analog current input.
configure_ao_current_channel(channel: AnalogCurrentChannel)
Register an AO current channel. Override if the driver supports analog current output.
configure_ai_thermocouple_channel(channel: AnalogThermocoupleChannel)
Register an AI thermocouple channel. Override if the driver supports thermocouple input.
configure_di_channel(channel: DigitalLineChannel)
Register a DI line channel. Override if the driver supports digital input.
configure_do_channel(channel: DigitalLineChannel)
Register a DO line channel. Override if the driver supports digital output.
get_actual_sample_rate() -> float | None
Actual hardware sample rate achieved after start().
Default returns None (driver doesn't know or hasn't started).
Override on drivers whose SDK reports the effective rate (NI, MCC,
LabJack T-series all do).
write_analog_value(channel: AnalogChannelUnion, value: float)
Write value to AO channel. Override if the driver supports analog output.
define_relay_channel(
physical_channel: str, alias: str | None = None
) -> RelayChannel
Build a RelayChannel for physical_channel (e.g. "3101" = slot 3 / channel 101).
Default implementation suits the Keysight 34980A's slot/channel
addressing; override if the driver needs different parsing. Overrides
must also record the resulting channel on self._relay_channels.
Convert a Keysight "YYYY,MM,DD,HH,MM,SS.sss" timestamp (UTC) to ns since the Unix epoch.
Split a Keysight reading/timestamp data string into (measurements, timestamps_ns).
NI-DAQmx¤
dataclass
¤
NIDAQDriver(device_id: str)
Bases: DAQDriverBase
NI-DAQmx DAQ driver.
property
¤
channels: tuple[DAQChannel, ...]
Frozen snapshot of all configured AI/AO/DI/DO channels (excludes relays).
property
¤
ai_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AI channels, keyed by alias.
property
¤
ao_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AO channels, keyed by alias.
property
¤
di_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DI channels, keyed by alias.
property
¤
do_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DO channels, keyed by alias.
property
¤
relay_channels: Mapping[str, RelayChannel]
Frozen snapshot of configured relay channels, keyed by alias.
open()
NI-DAQmx has no explicit connect — verifies the device is present in niSystem.local().
configure_ai_channel(channel: AnalogChannel)
Configure a channel on the NI device.
configure_ai_hw_timing(hw_timing_config: HWTimingConfig)
Configure hardware timing for the specified channels.
configure_di_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DevN/portM/lineP, add as CHAN_PER_LINE to the shared DI line task, and register the line.
configure_do_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DevN/portM/lineP, add as CHAN_PER_LINE to the shared DO line task, and register the line.
configure_di_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DevN/portM, add as CHAN_FOR_ALL_LINES to a dedicated DI task, and register the port.
configure_do_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DevN/portM, add as CHAN_FOR_ALL_LINES to a dedicated DO task, and register the port.
write_digital_line(channel: DigitalChannel, data: int)
Write to digital output channels.
write_digital_port(channel: DigitalChannel, data: int)
Drive a DO port as one N-bit integer; bit i controls line i.
read_digital_port(channel: DigitalChannel) -> int
Sample a DI port as one N-bit integer; bit i reflects line i.
configure_ai_voltage_channel(channel: AnalogVoltageChannel)
Register an AI voltage channel. Override if the driver supports analog voltage input.
configure_ao_voltage_channel(channel: AnalogVoltageChannel)
Register an AO voltage channel. Override if the driver supports analog voltage output.
configure_ai_current_channel(channel: AnalogCurrentChannel)
Register an AI current channel. Override if the driver supports analog current input.
configure_ao_current_channel(channel: AnalogCurrentChannel)
Register an AO current channel. Override if the driver supports analog current output.
configure_ai_thermocouple_channel(channel: AnalogThermocoupleChannel)
Register an AI thermocouple channel. Override if the driver supports thermocouple input.
configure_di_channel(channel: DigitalLineChannel)
Register a DI line channel. Override if the driver supports digital input.
configure_do_channel(channel: DigitalLineChannel)
Register a DO line channel. Override if the driver supports digital output.
define_relay_channel(
physical_channel: str, alias: str | None = None
) -> RelayChannel
Build a RelayChannel for physical_channel (e.g. "3101" = slot 3 / channel 101).
Default implementation suits the Keysight 34980A's slot/channel
addressing; override if the driver needs different parsing. Overrides
must also record the resulting channel on self._relay_channels.
close_relay(channel: RelayChannel)
Close the relay (connect the circuit). Override if the driver supports relays.
open_relay(channel: RelayChannel)
Open the relay (disconnect the circuit). Override if the driver supports relays.
LabJack T-series¤
dataclass
¤
LabJackTSeriesDriver(device_id: str, stream_buffer_bytes: int = 0)
Bases: DAQDriverBase
LabJack T-series DAQ driver (T4/T7/T8 via the LJM library).
Parameters:
-
(device_id¤str) –Device serial number, or "ANY" for the first device found.
-
(stream_buffer_bytes¤int, default:0) –Device-side stream buffer size, always written when AI hardware timing is configured so no value carries over from an earlier session. 0 selects the device's own default. Must be a power of 2 and the max is 262144. Setting this prevents the device from dropping scans at high sample rates, which LJM reports as -9999 sample values.
property
¤
channels: tuple[DAQChannel, ...]
Frozen snapshot of all configured AI/AO/DI/DO channels (excludes relays).
property
¤
ai_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AI channels, keyed by alias.
property
¤
ao_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AO channels, keyed by alias.
property
¤
di_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DI channels, keyed by alias.
property
¤
do_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DO channels, keyed by alias.
property
¤
relay_channels: Mapping[str, RelayChannel]
Frozen snapshot of configured relay channels, keyed by alias.
configure_ai_channel(channel: AnalogChannel)
Deprecated: use configure_ai_voltage_channel. Configures an ai channel on the LabJack device.
configure_ao_channel(channel: AnalogChannel)
Deprecated: use configure_ao_voltage_channel. Configures an AO channel on the LabJack device.
configure_ai_voltage_channel(channel: AnalogVoltageChannel)
Configure a voltage ai channel on the LabJack device.
configure_ao_voltage_channel(channel: AnalogVoltageChannel)
Configure a voltage AO channel on the LabJack device.
configure_ai_thermocouple_channel(channel: AnalogThermocoupleChannel)
Configure a thermocouple ai channel; volts convert to temperature in the channel's unit on read.
range_min/range_max are ignored: the ADC range is fixed per model (T7 0.1 V, T8 0.075 V, T4 none).
configure_ai_hw_timing(hw_timing_config: HWTimingConfig)
Configure hardware timing for the specified channels.
configure_di_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
configure_do_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
configure_di_channel(channel: DigitalLineChannel)
Register a DI line channel on the LabJack device.
configure_do_channel(channel: DigitalLineChannel)
Register a DO line channel on the LabJack device.
configure_di_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse, program, and register a DI port channel. Override if the driver supports port-mode digital input.
configure_do_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse, program, and register a DO port channel. Override if the driver supports port-mode digital output.
define_relay_channel(
physical_channel: str, alias: str | None = None
) -> RelayChannel
Build a RelayChannel for physical_channel (e.g. "3101" = slot 3 / channel 101).
Default implementation suits the Keysight 34980A's slot/channel
addressing; override if the driver needs different parsing. Overrides
must also record the resulting channel on self._relay_channels.
close_relay(channel: RelayChannel)
Close the relay (connect the circuit). Override if the driver supports relays.
open_relay(channel: RelayChannel)
Open the relay (disconnect the circuit). Override if the driver supports relays.
MCC USB-series¤
dataclass
¤
MCCDriver(device_id: str, buffer_multiplier: int = 2)
Bases: DAQDriverBase
MCC (Universal Library / mcculw) DAQ driver.
Parameters:
-
(device_id¤str) –Device unique ID, optionally with a board number as
"<serial>:<board_number>"(e.g."344371:0"). Defaults to board 0. -
(buffer_multiplier¤int, default:2) –Circular-buffer size relative to per-fetch size. Higher values tolerate more jitter at the cost of memory.
property
¤
channels: tuple[DAQChannel, ...]
Frozen snapshot of all configured AI/AO/DI/DO channels (excludes relays).
property
¤
ai_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AI channels, keyed by alias.
property
¤
ao_channels: Mapping[str, AnalogChannelUnion]
Frozen snapshot of configured AO channels, keyed by alias.
property
¤
di_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DI channels, keyed by alias.
property
¤
do_channels: Mapping[str, DigitalChannel]
Frozen snapshot of configured DO channels, keyed by alias.
property
¤
relay_channels: Mapping[str, RelayChannel]
Frozen snapshot of configured relay channels, keyed by alias.
configure_ai_channel(channel: AnalogChannel)
Configure an analog input channel on the MCC DAQ device.
configure_ao_channel(channel: AnalogChannel)
Configure an analog output channel on the MCC DAQ device.
configure_ai_hw_timing(hw_timing_config: HWTimingConfig)
Configure hardware timing for the specified channels.
fetch_analog() -> MCCDAQData
Block until samples_per_channel new samples are available, then drain the circular buffer.
write_analog_value(channel: AnalogChannel, value: float)
Write an analog value to an analog output channel.
configure_di_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DigitalPortType/#, configure the bit for DI, and register the line.
configure_do_line_channel(
physical_channel: str,
logic: Logic,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DigitalPortType/#, configure the bit for DO, and register the line.
configure_di_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DigitalPortType, configure the port for DI, and register the port.
configure_do_port_channel(
physical_channel: str,
logic: Logic,
port_width: DigitalPortWidth,
logic_level: float | None = None,
alias: str | None = None,
)
Parse DigitalPortType, configure the port for DO, and register the port.
write_digital_line(channel: DigitalChannel, data: int)
Write 0/1 to a single DO line (DigitalLineChannel).
read_digital_line(channel: DigitalChannel) -> int
Read 0/1 from a single DI line (DigitalLineChannel).
write_digital_port(channel: DigitalChannel, data: int)
Write an N-bit value to a DO port (bit i drives line i).
read_digital_port(channel: DigitalChannel) -> int
Read an N-bit value from a DI port (bit i reflects line i).
configure_ai_voltage_channel(channel: AnalogVoltageChannel)
Register an AI voltage channel. Override if the driver supports analog voltage input.
configure_ao_voltage_channel(channel: AnalogVoltageChannel)
Register an AO voltage channel. Override if the driver supports analog voltage output.
configure_ai_current_channel(channel: AnalogCurrentChannel)
Register an AI current channel. Override if the driver supports analog current input.
configure_ao_current_channel(channel: AnalogCurrentChannel)
Register an AO current channel. Override if the driver supports analog current output.
configure_ai_thermocouple_channel(channel: AnalogThermocoupleChannel)
Register an AI thermocouple channel. Override if the driver supports thermocouple input.
configure_di_channel(channel: DigitalLineChannel)
Register a DI line channel. Override if the driver supports digital input.
configure_do_channel(channel: DigitalLineChannel)
Register a DO line channel. Override if the driver supports digital output.
define_relay_channel(
physical_channel: str, alias: str | None = None
) -> RelayChannel
Build a RelayChannel for physical_channel (e.g. "3101" = slot 3 / channel 101).
Default implementation suits the Keysight 34980A's slot/channel
addressing; override if the driver needs different parsing. Overrides
must also record the resulting channel on self._relay_channels.
close_relay(channel: RelayChannel)
Close the relay (connect the circuit). Override if the driver supports relays.
open_relay(channel: RelayChannel)
Open the relay (disconnect the circuit). Override if the driver supports relays.