Skip to content

Transfer waveforms from Tektronix Oscilloscopes using the High-Speed Interface

License

Notifications You must be signed in to change notification settings

tektronix/TekHSI

Testing Code testing status Docs testing status Coverage status
Code Quality CodeQL status CodeFactor grade pre-commit status
Package PyPI: Package status PyPI: Latest release version PyPI: Supported Python versions PyPI: Downloads License: Apache 2.0 Package build status PyPI upload status
Documentation ReadtheDocs Status
Code Style Test style: pytest Code style: ruff Docstring style: google
Linting pre-commit enabled Docstring formatter: docformatterLinter: pylint

TekHSI: Tektronix High Speed Interface

TekHSI is a Python library that provides a low latency, high-speed data link between Tektronix scopes and host computer using gRPC. This library is designed to provide a reliable and efficient way to transfer data between devices, especially when dealing with large amounts of data.

With TekHSI, you can easily connect your Tektronix scope to other devices, such as host computers or other test equipment, and transmit data quickly and efficiently. This library is especially useful for applications that require real-time data acquisition and analysis, such as in the fields of electronics, telecommunications, and signal processing.

TekHSI uses gRPC, a high-performance, open-source framework that provides a platform-independent way to communicate between applications. This means you can use TekHSI with any platform supporting gRPC, including Windows, Linux, and macOS.

Key Features

  1. Low latency - TekHSI provides a fast and efficient data link between devices, with minimal delay between data transmission and reception.
  2. High speed - TekHSI can transfer large amounts of data quickly and efficiently.
  3. Easy to use - TekHSI is designed to be easy to use, with a simple and intuitive API that makes it easy to connect your Tektronix scope.
  4. Consistent sets - TekHSI guarantees that data arrives in "consistent sets." This means that data is all from the same acquisition. This is true when the instrument is stopped and when it is running. When using SCPI commands, this is only guaranteed when the instrument is stopped.
  5. Richer Synchronization - TekHSI allows a rich set of synchronization options. This includes accepting any arriving acquisition, accepting acquisitions with vertical or horizontal changes, or only accepting acquisitions after a certain time.

In summary, if you need a reliable and efficient way to transfer data between your Tektronix scope and host computer, TekHSI is the library for you. With its low latency, high speed, and easy-to-use API, TekHSI provides a powerful solution for data acquisition and analysis.

Installation

Important

TekHSI requires a 64-bit Python installation due to its external dependencies

pip install tekhsi

Device Support

Type Series/Model
Scopes 4 Series B MSO
5 Series MSO
5 Series B MSO
5 Series MSO (LP)
6 Series MSO
6 Series B MSO
6 Series LPD

Documentation

See the full documentation at https://TekHSI.readthedocs.io

Maintainers

Before reaching out to any maintainers directly, please first check if your issue or question is already covered by any open issues. If the issue or question you have is not already covered, please file a new issue or start a discussion and the maintainers will review and respond there.

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

TekHSI was created by Tektronix. It is licensed under the terms of the Apache License 2.0.

Security

The signatures of the files uploaded to PyPI and each GitHub Release can be verified using the GitHub CLI attestation verify command. The artifact attestations can also be directly downloaded from the GitHub repo attestations page if desired.

gh attestation verify --owner tektronix <file>