Skip to main content

Transfer waveforms from Tektronix Oscilloscopes using the High-Speed Interface.

Project description

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>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tekhsi-1.1.1.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tekhsi-1.1.1-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

Details for the file tekhsi-1.1.1.tar.gz.

File metadata

  • Download URL: tekhsi-1.1.1.tar.gz
  • Upload date:
  • Size: 34.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for tekhsi-1.1.1.tar.gz
Algorithm Hash digest
SHA256 21a9a675a493d832c2e1ff1647723080a98e0bcf05839064b4eb2f3798aa6636
MD5 b581bcda3df025a740547608d5ad8020
BLAKE2b-256 a1344ef74e3c367156568f343f51e966e6c8edcf5b88a85c012dd91f040a5163

See more details on using hashes here.

File details

Details for the file tekhsi-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: tekhsi-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 30.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for tekhsi-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04c2cc8f2b4adc3223ed58e9c7ea9265ba700694e7e9fdfc6752b35877f5fcd8
MD5 ff241d44e4e1b55755db7a51c1710ffb
BLAKE2b-256 c9c063d6870f0d93badb6893d8be5f7d475ee6382fcf9d52b9e127476bd8c895

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page