Skip to content

API reference

This section renders the public dtollib surface from source docstrings (Google-style, via mkdocstrings). Everything below is re-exported from the top-level dtollib package unless noted — from dtollib import ....

By topic

Page Covers
Sessions DtolSession, open_device — the central acquisition object and its lifecycle.
Task specs TaskSpec, TaskBuilder, Timing, BufferPlan, data-flow / subsystem enums.
Channels Every analog-input, analog-output, digital, and counter/timer channel spec + enums.
Triggers TriggerSpec hierarchy and RetriggerSpec.
Continuous & playback record, record_polled, play, Recording, AcquisitionSummary, policies, DaqBlock.
Sinks CSV / JSONL / Parquet / SQLite / Postgres / memory / raw-counts sinks + the sink Protocol.
Discovery & capabilities find_devices, find_subsystems, CapabilitySet, board/subsystem info models.
Manager DtolManager, DeviceResult.
Configuration DtolConfig, config_from_env.
TEDS IEEE-1451.4 strain-gage / bridge-sensor readers.
Strain & rosette math strain_from_volts, bridge_value_from_volts, rosette helpers.
Units to_pint and the temperature/thermocouple conversions.
Sync facade Dtol, SyncDtolSession, the blocking-portal wrappers.
Testing helpers FakeDtolBackend and the make_fake_* fixtures.
Errors The DtolError hierarchy and ErrorContext.
capi The hand-rolled ctypes binding (contributor-facing).
backend Session orchestration above capi (contributor-facing).