v2.2.0

v2.2.0 (2024-08-02)

Merged Pull Requests

• Enable adding unsupported device types via the DeviceManager (#262)
• test: Ignore http-rate-limited warnings to avoid failure due to the abundance of GitHub URLs in the Changelog (#261)

Added

• Added a new method to the DeviceManager class, add_unsupported_device(), which enables adding an unsupported device type.

v2.1.0

v2.1.0 (2024-07-31)

Merged Pull Requests

• feat: Added SourceXpress API support and AWG defects fix (#260)
• gh-actions(deps): bump hynek/build-and-inspect-python-package (#258)
• python-deps(deps-dev): bump the python-dependencies group with 2 updates (#257)
• Update jinja templates (#254)

Added

• Full Python API support for SourceXpress to AWG70KA, AWG70KB and AWG7K models.

Fixed

• Fixed APIs with writes and queries accepting arguments for AWG70KA and AWG70KB models drivers.

v2.0.0

v2.0.0 (2024-07-24)

Merged Pull Requests

• Downgrade python-semantic-release to allow release workflow to run (#253)
• docs: Updated the signal generation docs to fix some bugs that were found (#252)
• Signal Generation Restructure and addition of high level methods (#246)
• gh-actions(deps): bump the gh-actions-dependencies group with 2 updates (#250)
• python-deps(deps-dev): bump the python-dependencies group with 3 updates (#242)
• gh-actions(deps): bump anchore/scan-action (#248)
• python-deps(deps-dev): bump the python-dependencies group with 2 updates (#238)
• gh-actions(deps): bump python-semantic-release/python-semantic-release (#244)
• ci: Add back file sorter hook to pre-commit (#243)
• python-deps(deps): bump the python-dependencies group with 3 updates (#241)
• gh-actions(deps): bump the gh-actions-dependencies group across 1 directory with 3 updates (#239)
• refactor: Miscellaneous refactors to reduce technical debt in variable declarations and comparison operations (#236)

Added

• Added the constraint ranges for all signal generators
• Added drivers for AWG and AFG channels
• Added a property named source_channel in AWG's and AFG's.
• Added drivers for the internal AFG in TekScopes.
• Added a property named internal_afg in TekScope.
• Added implementation of generate_function for all AWG models.
• Added two burst functions to SignalGeneratorMixin: one to set up burst and one to generate the burst by forcing trigger.
  • NOTE: Only the AFGs and Internal AFGs have these functions implemented.
• Added OutputSignalPath enum attribute in AWGs representing output signal path options.
• Added two functions for loading waveform set files in the AWG70k and AWG5200 drivers: one for loading a waveform set file and another for loading a specific waveform from a waveform set file.
• Added sample_waveform_set_file attribute in the AWG70k and AWG5200 drivers to define the default waveform set file.

Changed

• BREAKING CHANGE. Changed the term "signal source" to "signal generator".
  • All uses of this term are changed. Import paths now use signal_generator instead of signal_source.
• BREAKING CHANGE. Changed the function name of generate_waveform() to generate_function().
  • generate_waveform() only exists on AWGs now, however the functionality is entirely changed.
• BREAKING CHANGE. Changed the generate_function() function by removing burst functionality.
  • Any use of burst now must use setup_burst() and generate_burst() instead.
• Updated AWGs such that the family_base_class is at the series level.

v1.5.0

v1.5.0 (2024-06-10)

Merged Pull Requests

• fix: Update the commands to have uniform spacing of arguments. (#234)
• ci: Update the updater workflow to skip running poetry-audit during the updater process (#235)
• python-deps(deps-dev): bump the python-dependencies group with 3 updates (#233)
• gh-actions(deps): bump the gh-actions-dependencies group with 2 updates (#218)
• docs: Properly sort modules when building the API documentation (#231)
• Enable Virtual GPIB connections to supported instruments (#230)
• ci: Update build and release workflows to verify the package can be installed for all supported Python versions and Operating Systems (#229)
• python-deps(deps-dev): bump the python-dependencies group with 2 updates (#225)
• Add workflows to check for changes that break public APIs (#227)
• gh-actions(deps): bump the gh-actions-dependencies group across 1 directory with 2 updates (#226)
• docs: Update the trademark symbols (#223)
• docs: Add analytics code for documentation (#222)
• Sign all published files (#221)
• Add attestations to artifacts (#220)
• python-deps(deps-dev): update pylint requirement from 3.2.0 to 3.2.1 in the python-dependencies group (#219)
• docs: Update wording of API package Modules section (#217)
• Update api template usage (#216)
• Cleanup init files and rename abstract classes (#215)
• gh-actions(deps): bump python-semantic-release/python-semantic-release from 9.6.0 to 9.7.2 in the gh-actions-dependencies group (#213)
• python-deps(deps-dev): update ruff requirement from 0.4.3 to 0.4.4 in the python-dependencies group (#214)
• docs: Update copy code button to not show up on doc signatures in the API documentation (#212)

Added

• Added a new section in the documentation of each package/subpackage that shows the submodules (files) of that package/subpackage.
• Added signed build provenance attestations to workflow artifacts for the built package.
• Added signed build provenance attestations to the generated SBOMs.
• Documentation was added explaining how to verify the attestations on uploaded files.
• Enabled support for Virtual GPIB connections to supported devices.

Removed

• docs: Removed the copy code button from the Python API signatures in the documentation.

Changed

• Updated most __init__.py files to not include __all__ variable definitions.
• Renamed some of the abstract base classes to separate them from the actual device driver classes.
• Updated the documentation templates to use the new jinja template style that mkdocstrings-python is switching to.

Fixed

• Fixed the API documentation to properly sort all the modules so that the Table of Contents is readable.

v1.4.2

v1.4.2 (2024-05-09)

Merged Pull Requests

• docs: Add a copy button to the code blocks in the documentation (#211)
• docs: Update mkdocs-ezglossary-plugin version used for building docs (#210)
• docs: Add styling for a new method label (#209)

Added

• Added a click to copy button to all code blocks.

Fixed

• Updated mkdocs-ezglossary-plugin to a version that allows linking to glossary entries from the
  home page of documentation that is hosted on ReadtheDocs.

v1.4.1

v1.4.1 (2024-05-06)

Merged Pull Requests

• ci: Revert python-semantic-release version bump since the GitHub Action no longer properly signs commits (#208)
• gh-actions(deps): bump the gh-actions-dependencies group with 2 updates (#207)
• Update contribution guide to remove outdated instructions (#205)
• fix: Update Changelog template to prevent pre-commit failures. when creating new versions with python-semantic-version (#204)

Fixed

• Updated the changelog template to not cause pre-commit failures when it is used to update the changelog.
• Updated the readme to properly render on PyPI.

Removed

• Removed outdated instructions from the contribution guide.

v1.4.0

v1.4.0 (2024-05-03)

Merged Pull Requests

• fix: Update release notes generator script to account for markdown formatting changes (#203)
• Update package to point to ReadtheDocs for official documentation (#201)
• Fix ReadtheDocs builds by installing nodejs (#200)
• docs: Switch from Sphinx to Mkdocs for building documentation. (#11)
• gh-actions(deps): bump python-semantic-release/python-semantic-release (#197)
• python-deps(deps): bump the python-dependencies group with 2 updates (#192)
• gh-actions(deps): bump the gh-actions-dependencies group with 2 updates (#191)
• gh-actions(deps): bump the gh-actions-dependencies group with 3 updates (#190)
• python-deps(deps-dev): update pyright requirement from 1.1.356 to 1.1.357 in the python-dependencies group (#189)

Changed

• Switched from using sphinx to mkdocs for building the documentation. This enables building the
  documentation in under 10 minutes while using less than 6 GB of RAM and saving almost 2 GB of
  disk space. Fixes #77.
• Switched from GitHub Pages to ReadtheDocs for official documentation hosting.

Fixed

• Fixed the Readme to display as intended in GitHub and PyPI while maintaining all functionality in
  the generated documentation site.

v1.3.0

v1.3.0 (2024-04-04)

Merged Pull Requests

• Updated the get_acquisition_data example to select source for the measurement. (#187)

Changed

• Updated get_acquisition_data example to select source for the measurement.

v1.2.3

v1.2.3 (2024-04-03)

Merged Pull Requests

• Update SBOM scanning workflow to be able to upload artifacts to GitHub releases (#186)

Security

• Updated the workflow that creates SBOMs to be able to upload the SBOM as an artifact to a GitHub release.

v1.2.2

v1.2.2 (2024-04-03)

Merged Pull Requests

• Fix packaging workflows to correctly gate on the repo name. (#185)
• Convert PyPI upload workflows into reusable workflows. (#184)
• ci: Update docformatter version, it no longer causes issues. (#182)
• Add test results to job summary and pull request comments (#181)
• Convert workflows into reusable workflows (#178)
• Update file checker workflow (#179)
• gh-actions(deps): bump the gh-actions-dependencies group with 2 updates (#177)
• python-deps(deps-dev): bump the python-dependencies group with 1 update (#176)
• Update admonition in readme to fix a glitch/bug in GitHub web UI (#174)
• Update supported devices and VISA backends in the readme (#170)
• fix: Updated the measurement source selection command for the MDO3K, MDO4K, MSO4K and DPO4K models to work properly. (#173)
• ci: Update codecov-action to v4. (#140)
• Handle Visa IO Error on first connection (#172)
• Misc. workflow updates (#171)
• gh-actions(deps): Bump the gh-actions-dependencies group with 1 update (#158)
• python-deps(deps): Bump the python-dependencies group with 2 updates (#159)
• gh-actions(deps): Bump the gh-actions-dependencies group with 2 updates (#166)
• ci: Update documentation builds to use node.js version 20. (#163)
• refactor: Update the type aliases used by the DeviceManager add/get methods to return TypeVars with default values that are bound to the appropriate device type. (#162)
• ci: Add a step to upload the sarif file as a workflow artifact. (#157)
• refactor: Update the get_model_series() method to only warn the user if the model isn't contained in the list of supported models. (#156)
• test: Update tox to test building the package in a unique environment to prevent race conditions when running tox environments in parallel. (#155)
• ci: Add permissions to write security events for the SBOM scan. (#154)
• Add SBOM generation and scanning workflow (#153)

Added

• Added TekVISA as one of the VISA backends supported.

Changed

• Updated the get_model_series() function to only warn the user if the model is not found in the SupportedModels enumeration. This also eliminates false warnings during unit tests.

Fixed

• Updated the measurement source selection command for the MDO3K, MDO4K, MSO4K and DPO4K models to work properly.