Tm-devices

Merged Pull Requests

- feat: Added SourceXpress API support and AWG defects fix ([260](https://github.com/tektronix/tm_devices/pull/260))
- gh-actions(deps): bump hynek/build-and-inspect-python-package ([258](https://github.com/tektronix/tm_devices/pull/258))
- python-deps(deps-dev): bump the python-dependencies group with 2 updates ([257](https://github.com/tektronix/tm_devices/pull/257))
- Update jinja templates ([254](https://github.com/tektronix/tm_devices/pull/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.

---

Merged Pull Requests

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

- <span style="color:red">BREAKING CHANGE</span>. 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`.
- <span style="color:red">BREAKING CHANGE</span>. Changed the function name of `generate_waveform()` to `generate_function()`.
- `generate_waveform()` only exists on AWGs now, however the functionality is entirely changed.
- <span style="color:red">BREAKING CHANGE</span>. 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.

---

Merged Pull Requests

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

---

Merged Pull Requests

- docs: Add a copy button to the code blocks in the documentation ([211](https://github.com/tektronix/tm_devices/pull/211))
- docs: Update mkdocs-ezglossary-plugin version used for building docs ([210](https://github.com/tektronix/tm_devices/pull/210))
- docs: Add styling for a new method label ([209](https://github.com/tektronix/tm_devices/pull/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.

---

Merged Pull Requests

- ci: Revert python-semantic-release version bump since the GitHub Action no longer properly signs commits ([208](https://github.com/tektronix/tm_devices/pull/208))
- gh-actions(deps): bump the gh-actions-dependencies group with 2 updates ([207](https://github.com/tektronix/tm_devices/pull/207))
- Update contribution guide to remove outdated instructions ([205](https://github.com/tektronix/tm_devices/pull/205))
- fix: Update Changelog template to prevent pre-commit failures. when creating new versions with python-semantic-version ([204](https://github.com/tektronix/tm_devices/pull/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.

---

Merged Pull Requests

- fix: Update release notes generator script to account for markdown formatting changes ([203](https://github.com/tektronix/tm_devices/pull/203))
- Update package to point to ReadtheDocs for official documentation ([201](https://github.com/tektronix/tm_devices/pull/201))
- Fix ReadtheDocs builds by installing nodejs ([200](https://github.com/tektronix/tm_devices/pull/200))
- docs: Switch from Sphinx to Mkdocs for building documentation. ([11](https://github.com/tektronix/tm_devices/pull/11))
- gh-actions(deps): bump python-semantic-release/python-semantic-release ([197](https://github.com/tektronix/tm_devices/pull/197))
- python-deps(deps): bump the python-dependencies group with 2 updates ([192](https://github.com/tektronix/tm_devices/pull/192))
- gh-actions(deps): bump the gh-actions-dependencies group with 2 updates ([191](https://github.com/tektronix/tm_devices/pull/191))
- gh-actions(deps): bump the gh-actions-dependencies group with 3 updates ([190](https://github.com/tektronix/tm_devices/pull/190))
- python-deps(deps-dev): update pyright requirement from 1.1.356 to 1.1.357 in the python-dependencies group ([189](https://github.com/tektronix/tm_devices/pull/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](https://github.com/tektronix/tm_devices/issues/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.

---