This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works
Implement open, close, and the category-required methods.
6 rules from this sentence
BK9115 has an open method
Holds
BK9115 has a close method
Holds
RigolDP800 has an open method
Holds
RigolDP800 has a close method
Holds
Keithley2400 has an open method
Holds
Keithley2400 has a close method
Holds
DMMDriverBase is the clearest example, with 8 required (open, close, set_measurement_function, plus 5 primary measurements) and ~15 optional (per-function range/NPLC setters, set_digits, measure_four_wire_resistance) for capabilities that aren't universal across vendors.
5 rules from this sentence
DMMDriverBase has an open method
Holds
DMMDriverBase has a close method
Holds
DMMDriverBase has a set_measurement_function method
Holds
DMMDriverBase has a set_digits method
Holds
DMMDriverBase has a measure_four_wire_resistance method
Holds
DAQDriverBase is the one exception: it has a default __init__ that initializes the channel/timing dicts the driver is required to populate (see DAQ driver state tracking).
DAQDriverBase has __init__
Holds
Shared JSON-config blocks live in instro/lib/config.py.TimingConfig, the publisher config models (NominalCorePublisherConfig, FilePublisherConfig, PublisherConfigType), build_publisher, and the generic load_config(config, model_cls) loader are identical across category configs,
6 rules from this sentence
NominalCorePublisherConfig, FilePublisherConfig, PublisherConfigType and 3 more are in instro/lib
Holdsall 6
daq.ai_channels, daq.relay_channels, daq.ai_hw_timing_config, the aggregate daq.channels, and friends delegate straight to the driver's read-only accessors.
4 rules from this sentence
InstroDAQ has ai_channels
checks “daq.ai_channels”
Holds
InstroDAQ has relay_channels
checks “daq.relay_channels”
Holds
InstroDAQ has ai_hw_timing_config
checks “daq.ai_hw_timing_config”
Holds
InstroDAQ has channels
checks “the aggregate daq.channels”
Holds
DAQDriverBase is the single source of truth for configured channels and AI/AO/DI/DO timing config, held in private dicts/slots (_ai_channels, _ao_channels, _di_channels, _do_channels, _relay_channels, the four _*_hw_timing_config slots).
9 rules from this sentence
DAQDriverBase has _ai_channels, _ao_channels, _di_channels and 6 more
Holdsall 9
The base initializes _ai_channels, _ao_channels, _di_channels, _do_channels, _relay_channels, all four _*_hw_timing_config slots, and points_in_buffer.
DAQDriverBase has points_in_buffer
Holds
The default DAQDriverBase.define_relay_channel already records on self._relay_channels;
DAQDriverBase has define_relay_channel
Holds
This class is initialized with a vendor-specific driver (RigolDG1022Z, Keysight33521B, …), and provides the vendor-agnostic API (set_waveform, set_amplitude, set_offset, set_modulation, set_sweep, …).
5 rules from this sentence
InstroAWG has set_waveform
Holds
InstroAWG has set_amplitude
Holds
InstroAWG has set_offset
Holds
InstroAWG has set_modulation
Holds
InstroAWG has set_sweep
Holds
InstroAWG supports programming a channel with the following waveforms: Sine, Square, Sawtooth, Triangle, Pulse, Arbitrary, or StaticValue. These are all frozen dataclasses in instro.awg.
7 rules from this sentence
Sine, Square, Sawtooth and 4 more are in instro.awg
Holdsall 7
Arbitrary requires a sample rate field (sample_rate_sas, in samples per second) to specify the number of samples that the internal DAC outputs per second.
Arbitrary has a sample_rate_sas field
Holds
Unlike the other DAQ drivers, it owns its own VisaDriver and connects over SCPI/VISA rather than a vendor SDK.
Keysight34980A depends on VisaDriver
Holdsdaq → lib
This class is initialized with a vendor-specific driver (Agilent34401A, Keysight34461A, Keithley2400, …), and provides the vendor-agnostic API (set_measurement_function, read, set_range, …).
3 rules from this sentence
InstroDMM has set_measurement_function
Holds
InstroDMM has read
Holds
InstroDMM has set_range
Holds
The read_<function>() shorthands (e.g. read_dc_voltage()) fold steps 3 and 4 into one call.
InstroDMM has a read_dc_voltage method
Holds
Optionally, you can use background fetching via start() / stop(), but it is an atypical use case for a DMM.
2 rules from this sentence
InstroDMM has a start method
Holds
InstroDMM has a stop method
Holds
read_dc_voltage(), read_ac_voltage(), read_dc_current(), read_ac_current(), read_resistance() (2-wire), and read_four_wire_resistance().
5 rules from this sentence
InstroDMM has a read_ac_voltage method
checks “read_ac_voltage()”
Holds
InstroDMM has a read_dc_current method
checks “read_dc_current()”
Holds
InstroDMM has a read_ac_current method
checks “read_ac_current()”
Holds
InstroDMM has a read_resistance method
checks “read_resistance()”
Holds
InstroDMM has a read_four_wire_resistance method
checks “read_four_wire_resistance()”
Holds
The 8845A's default 8845 command set is compatible with the Agilent 34401A, so this driver runs the {py:obj}Agilent34401A <instro.dmm.drivers.agilent_a34401a.Agilent34401A> driver's commands, with its own error messages.
Fluke8845A depends on Agilent34401A
Holdspackages → instro
This class is initialized with a vendor-specific driver (BK85XXB, …), and provides the vendor-agnostic API (set_mode, set_level, get_voltage, …).
3 rules from this sentence
InstroELoad has set_mode
Holds
InstroELoad has set_level
Holds
InstroELoad has get_voltage
Holds
This class is initialized with a vendor-specific driver (AlicatMC, …), and provides the vendor-agnostic API (get_flow_data, set_setpoint, select_gas, tare_flow, …).
3 rules from this sentence
InstroFlowController has get_flow_data
Holds
InstroFlowController has set_setpoint
Holds
InstroFlowController has tare_flow
Holds
This class is initialized with a vendor-specific driver (RigolDG1022Z, Keysight33521B, …), and provides the vendor-agnostic API (set_waveform, set_amplitude, set_offset, set_modulation, set_sweep, …).
5 rules from this sentence
InstroAWG has set_waveform
Holds
InstroAWG has set_amplitude
Holds
InstroAWG has set_offset
Holds
InstroAWG has set_modulation
Holds
InstroAWG has set_sweep
Holds
Arbitrary requires a sample rate field (sample_rate_sas, in samples per second) to specify the number of samples that the internal DAC outputs per second.
Arbitrary has a sample_rate_sas field
Holds
import FlowControllers from "/snippets/drivers/flowcontroller.mdx"; InstroFlowController provides a unified interface for gas flow controllers.
InstroFlowController is in packages/instro-unstable/instro/unstable/flowcontroller
Holds
This class is initialized with a vendor-specific driver (AlicatMC, …), and provides the vendor-agnostic API (get_flow_data, set_setpoint, select_gas, tare_flow, …).
3 rules from this sentence
InstroFlowController has get_flow_data
Holds
InstroFlowController has set_setpoint
Holds
InstroFlowController has tare_flow
Holds
The category-level class (InstroPSU, InstroDMM, etc.) is always imported from core instro.
2 rules from this sentence
InstroPSU is in instro/psu
Holds
InstroDMM is in instro/dmm
Holds
Only the concrete driver lives in instro.contrib.
InstroPSU may not be in packages/instro-contrib/instro/contrib/psu/drivers
Holds
For example, the BK9115 power supply has no overcurrent protection or remote sense, so its driver raises FeatureNotSupportedError for those methods.
BK9115 depends on FeatureNotSupportedError
Holdspsu → lib
FeatureNotSupportedError (a subclass of InstroError) is raised by a concrete driver to declare that the connected instrument genuinely lacks a capability.
FeatureNotSupportedError extends InstroError
Holds
InstrumentNotOpenError (a subclass of InstroError) is raised when a device-touching method is called before open().
InstrumentNotOpenError extends InstroError
Holds
When controlling an Instrument gets and sets return Measurement and Command objects.
2 rules from this sentence
Instrument depends on Measurement
Holds
Instrument depends on Command
Holds
Every Measurement and Command is now recorded by each Publisher in publishers.
2 rules from this sentence
Publisher depends on Measurement
Holdspublishers → types.py
Publisher depends on Command
Holdspublishers → types.py
Every Measurement and Command is now recorded by each Publisher in publishers. An Instrument will close() all publishers when it closes.
Instrument depends on Publisher
Holdsinstrument.py → publishers
It is the concrete implementation of the abstract BufferedPublisher base, so instantiate BasicBufferedPublisher.
BasicBufferedPublisher extends BufferedPublisher
Holds
Every transport inherits TransportBase, so the lifecycle, locking, and shared-ownership behavior on this page is identical no matter which one a driver holds.
2 rules from this sentence
ModbusTCPTransport extends TransportBase
Holds
ModbusRTUTransport extends TransportBase
Holds
Member open(holder=None), What the base provides Opens the connection through _open_session() Idempotent With a holder, registers shared ownership and returns True only for the first owner
TransportBase has an open method
Holds
Member lock(), What the base provides The reentrant lock guarding this connection, for callers that need a multi-step sequence to stay atomic
TransportBase has a lock method
Holds
Member del, What the base provides Best-effort teardown on garbage collection, bypassing the ownership guard and swallowing errors A backstop against a stranded socket, not something to rely on
TransportBase has __del__
Holds
This class is initialized with a vender-specfic driver (Keysight1200X, Tektronix2SeriesMSO,...), and provides the vendor-agnostic API (set_vertical_scale, fetch_waveform, measure, set_trigger_level, …).
4 rules from this sentence
InstroScope has set_vertical_scale
Holds
InstroScope has fetch_waveform
Holds
InstroScope has measure
Holds
InstroScope has set_trigger_level
Holds
InstroScope tracks vertical, horizontal, acquisition, and trigger state locally as you issue commands, in a ScopeState dataclass.
InstroScope depends on ScopeState
Holds
When controlling an {py:obj}Instrument <instro.lib.instrument.Instrument> gets and sets return {py:obj}Measurement <instro.lib.types.Measurement> and {py:obj}Command <instro.lib.types.Command> objects.
2 rules from this sentence
Instrument depends on Measurement
Holds
Instrument depends on Command
Holds
Every Measurement and Command is now recorded by each {py:obj}Publisher <instro.lib.publishers.publisher.Publisher> in publishers.
2 rules from this sentence
Publisher depends on Measurement
Holdspublishers → types.py
Publisher depends on Command
Holdspublishers → types.py
Every Measurement and Command is now recorded by each {py:obj}Publisher <instro.lib.publishers.publisher.Publisher> in publishers. An Instrument will close() all publishers when it closes.
Instrument depends on Publisher
Holdsinstrument.py → publishers
Every transport inherits TransportBase, so the lifecycle, locking, and shared-ownership behavior on this page is identical no matter which one a driver holds.
2 rules from this sentence
ModbusTCPTransport extends TransportBase
Holds
ModbusRTUTransport extends TransportBase
Holds
Member open(holder=None), What the base provides Opens the connection through _open_session() Idempotent With a holder, registers shared ownership and returns True only for the first owner
TransportBase has an open method
Holds
Member lock(), What the base provides The reentrant lock guarding this connection, for callers that need a multi-step sequence to stay atomic
TransportBase has a lock method
Holds
Member del, What the base provides Best-effort teardown on garbage collection, bypassing the ownership guard and swallowing errors A backstop against a stranded socket, not something to rely on
TransportBase has __del__
Holds
get_overvoltage_protection_tripped() and get_overcurrent_protection_tripped() report the latch as a bool Measurement (ch<n>.ovp.tripped, ch<n>.ocp.tripped).
2 rules from this sentence
RigolDP800 has a get_overvoltage_protection_tripped method
Holds
RigolDP800 has a get_overcurrent_protection_tripped method
Holds
clear_protection() clears every latched trip on the channel and publishes a Command (ch<n>.protection.clear.cmd).
RigolDP800 has a clear_protection method
Holds
It uses the SCPI interface of the TDK Lambda Genesys driver.
KeysightN5700 depends on TDKLambdaGenesys
Holds
get_operating_mode reads the channel's questionable-status condition register (:STAT:QUES:INST:ISUM<n>:COND?) in a single query.
RigolDP800 has get_operating_mode
Holds
Parameters and methods specific to {py:obj}RigolDP800 <instro.psu.drivers.rigol_dp800.RigolDP800> can be found in the Reference.
RigolDP800 depends on OperatingMode
Holdsdrivers → types.py
_open_session, _teardown_session, and is_open are the required contract, and the base itself provides the open/close lifecycle with shared ownership, so more than one driver can share a single connection.
5 rules from this sentence
TransportBase has _open_session
checks “_open_session, _teardown_session, and is_open are the required contract”
Holds
TransportBase has _teardown_session
checks “_open_session, _teardown_session, and is_open are the required contract”
Holds
TransportBase has is_open
checks “_open_session, _teardown_session, and is_open are the required contract”
Holds
TransportBase has open
checks “the base itself provides the open/close lifecycle”
Holds
TransportBase has close
checks “the base itself provides the open/close lifecycle”
Holds
This class is initialized with a vender-specfic driver (Keysight1200X, Tektronix2SeriesMSO,...), and provides the vendor-agnostic API (set_vertical_scale, fetch_waveform, measure, set_trigger_level, …).
4 rules from this sentence
InstroScope has set_vertical_scale
Holds
InstroScope has fetch_waveform
Holds
InstroScope has measure
Holds
InstroScope has set_trigger_level
Holds
run(), single(), and stop_acquisition().
3 rules from this sentence
InstroScope has a run method
checks “run()”
Holds
InstroScope has a single method
checks “single()”
Holds
InstroScope has a stop_acquisition method
checks “stop_acquisition()”
Holds
start() and stop() (inherited from Instrument) periodically call the methods you register and stream their results to publishers.
2 rules from this sentence
InstroScope has a start method
checks “start()”
Holds
InstroScope has a stop method
checks “stop()”
Holds
InstroScope has two independent start/stop concepts: … start() and stop() (inherited from Instrument) periodically call the methods you register and stream their results to publishers.
InstroScope extends Instrument
Holdsscope → lib
InstroScope tracks vertical, horizontal, acquisition, and trigger state locally as you issue commands, in a ScopeState dataclass.
InstroScope depends on ScopeState
Holds
This package contributes LabJackTSeriesDriver under instro.daq.drivers.labjack, with model definitions for the T4, T7, and T8.
LabJackTSeriesDriver is in packages/instro-daq-labjack/instro/daq/drivers/labjack
Holds
This package contributes MCCDriver under instro.daq.drivers.mcc.
MCCDriver is in packages/instro-daq-mcc/instro/daq/drivers/mcc
Holds
This package contributes NIDAQDriver under instro.daq.drivers.ni.
NIDAQDriver is in packages/instro-daq-ni/instro/daq/drivers/ni
Holds
This package contributes Aardvark under instro.i2c.drivers.totalphase.
Aardvark is in packages/instro-i2c-aardvark/instro/i2c/drivers/totalphase