From 1884b4c999a58b77e4805bc345cde185a7bd843a Mon Sep 17 00:00:00 2001 From: crnbaker Date: Wed, 24 Jan 2024 13:52:45 +0000 Subject: [PATCH] #50 hotfix API doc fixes --- src/spectrumdevice/__init__.py | 16 ++++++++++------ src/spectrumdevice/devices/awg/awg_card.py | 1 + .../features/pulse_generator/pulse_generator.py | 1 + 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/src/spectrumdevice/__init__.py b/src/spectrumdevice/__init__.py index d7886e9..ab6f3e5 100644 --- a/src/spectrumdevice/__init__.py +++ b/src/spectrumdevice/__init__.py @@ -7,12 +7,16 @@ for controlling devices: ### Hardware Classes -| Name | Purpose | -|----------------------------|---------------------------------------------------------| -| `SpectrumDigitiserCard` | Controlling individual digitiser cards | -| `SpectrumDigitiserStarHub` | Controlling digitiser cards aggregated with a StarHub | -| `SpectrumAWGCard` | Controlling individual AWG cards | -| `SpectrumAWGStarHub` | Controlling AWG cards aggregated with a StarHub | +| Name | Purpose | +|----------------------------------|---------------------------------------------------------| +| `SpectrumDigitiserCard` | Controlling individual digitiser cards | +| `SpectrumDigitiserStarHub` | Controlling digitiser cards aggregated with a StarHub | +| `SpectrumDigitiserAnalogChannel` | Controlling analog channels of a digitiser | +| `SpectrumDigitiserIOLine` | Controlling multipurpose IO channels of a digitiser | +| `SpectrumAWGCard` | Controlling individual AWG cards | +| `SpectrumAWGStarHub` | (not yet implemented) | +| `SpectrumAWGAnalogChannel` | Controlling analog channels of an AWG | +| `SpectrumAWGIOLine` | Controlling multipurpose IO channels of an AWG | ### Mock Classes `spectrumdevice` also includes mock classes for testing software without drivers installed or hardware connected: diff --git a/src/spectrumdevice/devices/awg/awg_card.py b/src/spectrumdevice/devices/awg/awg_card.py index a1fa238..bf2c31e 100644 --- a/src/spectrumdevice/devices/awg/awg_card.py +++ b/src/spectrumdevice/devices/awg/awg_card.py @@ -30,6 +30,7 @@ class SpectrumAWGCard( AbstractSpectrumCard[SpectrumAWGAnalogChannelInterface, SpectrumAWGIOLineInterface], AbstractSpectrumAWG ): + """Class for controlling individual Spectrum AWG cards.""" def _init_analog_channels(self) -> Sequence[SpectrumAWGAnalogChannelInterface]: num_modules = self.read_spectrum_device_register(SPC_MIINST_MODULES) num_channels_per_module = self.read_spectrum_device_register(SPC_MIINST_CHPERMODULE) diff --git a/src/spectrumdevice/features/pulse_generator/pulse_generator.py b/src/spectrumdevice/features/pulse_generator/pulse_generator.py index d2fe5b6..a4b237e 100644 --- a/src/spectrumdevice/features/pulse_generator/pulse_generator.py +++ b/src/spectrumdevice/features/pulse_generator/pulse_generator.py @@ -52,6 +52,7 @@ class PulseGenerator(PulseGeneratorInterface): + """Class for controlling pulse generators associated with IO lines (requires firmware option be enabled).""" def __init__(self, parent: SpectrumIOLineInterface): self._parent_io_line = parent # last char of IO line name is IO line chanel number, which is used to set pulse generator number