@@ -496,15 +499,15 @@ own class representation, corresponding to
`set_output_signal_path()` is uniquely defined within the AWG5200 as it has special output signal paths.
-`load_waveform()` inherently has an operation complete check as attempting to run overlapping commands while loading a waveform can lead to
+`load_waveform()` inherently has an operation complete check, as attempting to run overlapping commands while loading a waveform can lead to
unintended behavior.
##### Constraints:
-The AWG5200 does not have a sample rate range dependent on model number. Instead, it refers to
+The AWG5200 does not have a sample rate range dependent on the model number. Instead, it refers to
which option is installed to provide the range of the sample rate. Option 25 on the devices provides
-a maximum rate is 2.5GS/s, whereas option 50 allows a maximum rate of 5.0GS/s.
-If option DC is provided, the DCHB signal output path will amplitude range will be increased to have a maximum
+a maximum rate of 2.5GS/s, whereas option 50 allows a maximum rate of 5.0GS/s.
+If option DC is provided, the DCHB signal output path amplitude range will be increased to have a maximum
of 1.5V. The DCHV signal path increases this range further to 5.0V by including another amplifier.
@@ -521,7 +524,7 @@ _AWG5200 Constraints_
##### Sequential, Blocking and Overlapping Commands:
-The AWG5200's programming commands are seperated into three seperated categories: Sequential, Blocking, and Overlapping.
+The AWG5200's programming commands are separated into three separated categories: Sequential, Blocking, and Overlapping.
The type of command is important to consider, as using them in an incorrect order can lead to unintended results.
Sequential commands function as standard [PI](default:PI) commands. They will not start until the previous command has finished. These commands
@@ -533,7 +536,7 @@ Blocking commands often take longer to execute.
!!! caution
Due to the length of Blocking commands, a query may time out when sent if performed immediately after a large series of consecutive Blocking commands.
-Some commands can perform data analysis on another thread, these are referred to as Overlapping commands. They allow any command to be started
+Some commands can perform data analysis on another thread; these are referred to as Overlapping commands. They allow any command to be started
while they are being executed. They cannot begin if the previous command was blocking or sequential, or if the operation complete status register is
not set.
@@ -555,8 +558,9 @@ not set.
#### AWG70KA, AWG70KB
-The AWG70K series instruments are signal generators focused on waveform generation which operate on Windows.
-They accept communication through [USB](default:USB), [TCPIP](default:TCPIP), and [GPIB](default:GPIB) interfaces.
+The AWG70K series instruments are signal generators focused on waveform generation.
+These instruments operate on the Windows operating system, and they accept communication through
+[USB](default:USB), [TCPIP](default:TCPIP), and [GPIB](default:GPIB) interfaces.
`set_output_signal_path()` is uniquely defined within the
[`AWG70KA`][tm_devices.drivers.pi.signal_generators.awgs.awg70ka.AWG70KA] and
@@ -569,13 +573,13 @@ out otherwise.
##### Constraints:
-The AWG70K signal generator is a special case, where only the direct signal output path is allowed
+The AWG70K signal generator is a special case where only the direct signal output path is allowed
(unless option AC is installed). This means the amplitude is limited,
-and offset is not allowed to be set by default. However, there is a secondary device which allows for DC amplification, the MDC4500-4B.
-The MDC4500-4B is an amplifier which provides the ability to utilize DC offset on an AWG70K. It also provides a larger range of amplitude.
+and offset is not allowed to be set by default. However, there is a secondary device that allows for DC amplification, the MDC4500-4B.
+The MDC4500-4B provides the ability to utilize DC offset and large range of amplitude on an AWG70K.
Just like the AWG5200, the frequency is dependent on the option installed (150, 225, 216, 208).
-The first numbers in the option provides the number of source channels the AWG70K has, the next two numbers
+The first number in the option provides the number of source channels the AWG70K has; the next two numbers
indicate the sample rate in gigahertz.
!!! tip
@@ -601,16 +605,16 @@ the AWG5200 section.
[^TA]: AFG302xB has its upper bound for frequency halved for these functions.
-[^TB]: Amplitude upper bound is reduced to 16.0V when frequency is greater than 100.0MHz.
+[^TB]: The amplitude upper bound is reduced to 16.0V when the frequency is greater than 100.0MHz.
-[^TC]: Amplitude upper bound is reduced to 8.0V when frequency is greater than 200.0MHz.
+[^TC]: The amplitude upper bound is reduced to 8.0V when the frequency is greater than 200.0MHz.
[^TOA]: When waveform length is greater than 16Kb, otherwise, the sample rate is 250.0MS/s.
-[^TOB]: Amplitude upper bound is reduced to 16.0V when the frequency is greater than 60.0MHz. It is further reduced to 12.0V when the frequency is greater than 80.0MHz
+[^TOB]: The amplitude upper bound is reduced to 16.0V when the frequency is greater than 60.0MHz. It is further reduced to 12.0V when the frequency is greater than 80.0MHz
-[^TOC]: Amplitude upper bound is reduced to 8.0V when the frequency is greater than 200.0MHz.
+[^TOC]: The amplitude upper bound is reduced to 8.0V when the frequency is greater than 200.0MHz.
-[^SA]: Samples rates higher than 10GS/S(12GS/s for B/C) can only be done through Interleave.
+[^SA]: Sample rates higher than 10GS/S(12GS/s for B/C) can only be done through Interleave.
-[^SZA]: Although the MDC4500-4B allows for greater than 1.0V amplitude, there is a drop off in accuracy.
+[^SZA]: Although the MDC4500-4B allows for greater than 1.0V amplitude, there is a drop in accuracy.
diff --git a/docs/known_words.txt b/docs/known_words.txt
index f3fad3a4..b8d67578 100644
--- a/docs/known_words.txt
+++ b/docs/known_words.txt
@@ -5,7 +5,6 @@ alias_usage
api
artifact
artifacts
-autoclasstree
autocomplete
awgs
backend
@@ -51,7 +50,6 @@ licensor
linter
linters
linting
-literalinclude
mailto
md
mixin
diff --git a/mkdocs.yml b/mkdocs.yml
index f4fceb37..29a80d65 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -73,7 +73,6 @@ plugins:
- search:
prebuild_index: true
- include-markdown
- - mermaid2
- section-index
- autorefs
- macros:
@@ -91,6 +90,7 @@ plugins:
use_default: true
inline_refs: none
markdown_links: true
+ - mermaid2
- mkdocstrings: # additional customization takes place in docs/generate_api_pages.py
# noinspection YAMLIncompatibleTypes
enabled: !ENV [TM_DEVICES_API_GENERATION, true]
diff --git a/src/tm_devices/drivers/pi/signal_generators/afgs/afg.py b/src/tm_devices/drivers/pi/signal_generators/afgs/afg.py
index e5cf445b..66989c14 100644
--- a/src/tm_devices/drivers/pi/signal_generators/afgs/afg.py
+++ b/src/tm_devices/drivers/pi/signal_generators/afgs/afg.py
@@ -173,6 +173,7 @@ def setup_burst( # noqa: PLR0913 # pyright: ignore[reportIncompatibleMethodOve
polarity=polarity,
symmetry=symmetry,
)
+ source_channel.set_state(1)
def generate_burst(self) -> None:
"""Generate a burst of waveforms by forcing trigger."""
diff --git a/src/tm_devices/helpers/constants_and_dataclasses.py b/src/tm_devices/helpers/constants_and_dataclasses.py
index 145ce1c7..00648226 100644
--- a/src/tm_devices/helpers/constants_and_dataclasses.py
+++ b/src/tm_devices/helpers/constants_and_dataclasses.py
@@ -704,6 +704,16 @@ def __str__(self) -> str:
),
}
)
+
+LOAD_IMPEDANCE_LOOKUP: Final[Mapping[Union[float, str], LoadImpedanceAFG]] = MappingProxyType(
+ {
+ 9.97e37: LoadImpedanceAFG.HIGHZ,
+ 1.0e6: LoadImpedanceAFG.HIGHZ,
+ "HIGHZ": LoadImpedanceAFG.HIGHZ,
+ 50.0: LoadImpedanceAFG.FIFTY,
+ "FIFTY": LoadImpedanceAFG.FIFTY,
+ }
+)
"""A mapping of model USBTMC info."""
LOAD_IMPEDANCE_LOOKUP: Final[Mapping[Union[float, str], LoadImpedanceAFG]] = MappingProxyType(
@@ -715,4 +725,4 @@ def __str__(self) -> str:
"FIFTY": LoadImpedanceAFG.FIFTY,
}
)
-"""Conversions of literal values to Enum values."""
+"""Conversions of literal values representing impedances to Enum values representing impedances."""