feat: add secure connections and FastFrame support by SaiDeepikaKuchibhotla · Pull Request #192 · tektronix/TekHSI

SaiDeepikaKuchibhotla · 2026-10-06T07:07:41Z

Proposed changes

This PR adds two related capabilities to TekHSI:

Secure connections
- Adds support for secure TLS connections.
- Supports TLS with HTTP Basic authentication.
- Adds certificate trust configuration and credential-store support.
Fast-Frame acquisitions
- Adds support for stopped-scope analog and digital multi-frame waveforms.
- Preserves per-frame timing and frame metadata.
- Adds FastFrame transfer-timing diagnostics and summary-frame handling.
- Adds access to individual frames without changing the current frame.

These changes improve secure instrument communication and provide complete Fast-Frame waveform handling for acquisition and analysis.

Addresses #< fill in issue number here >

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Functionality update (non-breaking change which updates or changes existing functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

read-the-docs-community · 2026-10-06T07:08:45Z

Documentation build overview

📚 TekHSI | 🛠️ Build #34977413 | 📁 Comparing 954c112 against latest (850db7b)

🔍 Preview build

12 files changed · + 6 added · ± 6 modified

+ Added

± Modified

+    return True, None
+
+
+def discover(url: str) -> tuple[bool, Path | None, dict, bool]:


github-actions · 2026-10-06T11:43:13Z

Test Results (macos)

path	passed	subtotal
tests/test_auth_basic.py	8	8
tests/test_client.py	79	79
tests/test_credential_store.py	13	13
tests/test_fastframe_native.py	26	26
tests/test_load_timing.py	15	15
tests/test_logging.py	3	3
tests/test_security.py	63	63
tests/test_security_wiring.py	13	13
tests/test_wfm_digital.py	9	9
TOTAL	229	229

Link to workflow run

github-actions · 2026-10-06T11:43:13Z

Test Results (ubuntu)

path	passed	subtotal
tests/test_auth_basic.py	8	8
tests/test_client.py	79	79
tests/test_credential_store.py	13	13
tests/test_fastframe_native.py	26	26
tests/test_load_timing.py	15	15
tests/test_logging.py	3	3
tests/test_security.py	63	63
tests/test_security_wiring.py	13	13
tests/test_wfm_digital.py	9	9
TOTAL	229	229

Link to workflow run

github-actions · 2026-10-06T11:43:13Z

Test Results (windows)

path	passed	skipped	xpassed	subtotal
tests\test_auth_basic.py	8			8
tests\test_client.py	74		5	79
tests\test_credential_store.py	12	1		13
tests\test_fastframe_native.py	26			26
tests\test_load_timing.py	15			15
tests\test_logging.py	3			3
tests\test_security.py	63			63
tests\test_security_wiring.py	13			13
tests\test_wfm_digital.py	9			9
TOTAL	223	1	5	229

tests\test_credential_store.py

('D:\\a\\TekHSI\\TekHSI\\tests\\test_credential_store.py', 118, 'Skipped: POSIX chmod only')

Link to workflow run

nfelt14

You also need to make sure to run pre-commit run -a ruff-check and pre-commit run -a ruff-format to fix issues, that is why all the checks are failing.

nfelt14 · 2026-10-06T15:43:55Z

 legacy_tox_ini = """
 [tox]
 requires = tox>4
-isolated_build = True


Why was this removed?

nfelt14 · 2026-10-06T15:50:12Z

+```
+
+The first connection can use `on_trust_prompt` to approve the scope certificate. The certificate fingerprint and credentials are then stored for later connections. A changed certificate raises a certificate-mismatch error rather than silently trusting a different endpoint.
+The default store locations are:


Why is the store on Linux .tektronix, but other platforms just tektronix (no dot)?

The leading dot follows the Unix convention for hidden application configuration directories. Windows uses %APPDATA%, while macOS uses its standard Application Support directory, so neither needs a dot-prefixed folder.

Why not put it in the user folder on Windows too?

nfelt14 · 2026-10-06T15:52:01Z

+| ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
+| `UNAUTHENTICATED`                                                   | Confirm the scope is in the expected security mode and verify the password.                               |
+| Certificate mismatch                                                | Remove the stale stored certificate only after verifying the new certificate, then trust it deliberately. |
+| No active channel                                                   | Enable the channel on the scope and check `TEKHSI_SCOPE_CHANNEL`.                                         |


Manual integration test information should not live in this usage document. This is for package users only, not package developers.

github-actions · 2026-10-06T19:10:32Z

Breaking API Changes

src/tekhsi/_tek_highspeed_server_pb2.py:185: WaveformHeader.__slots__:
Attribute value was changed:
  Old: ['bitmask', 'chunksize', 'dataid', 'hasdata', 'horizontalUnits', 'horizontalfractionalzeroindex', 'horizontalspacing', 'horizontalzeroindex', 'iq_centerFrequency', 'iq_fftLength', 'iq_rbw', 'iq_span', 'iq_windowType', 'noofsamples', 'pairtype', 'sourcename', 'sourcewidth', 'transid', 'verticaloffset', 'verticalspacing', 'verticalunits', 'wfmtype']
  New: ('sourcename', 'sourcewidth', 'dataid', 'transid', 'horizontalUnits', 'horizontalspacing', 'horizontalzeroindex', 'horizontalfractionalzeroindex', 'noofsamples', 'chunksize', 'wfmtype', 'bitmask', 'pairtype', 'verticalunits', 'verticalspacing', 'verticaloffset', 'iq_centerFrequency', 'iq_fftLength', 'iq_rbw', 'iq_span', 'iq_windowType', 'hasdata', 'num_frames', 'frame_info', 'current_frame_index', 'probe_details', 'channel_sparam')

src/tekhsi/tek_hsi_connect.py:196: TekHSIConnect.d_datatypes:
Attribute value was changed:
  Old: {1: np.int8}
  New: {1: np.int8, 2: np.int16}

Link to workflow run

nfelt14 · 2026-10-07T01:05:16Z

+- [`TekCertificateMismatch`][tekhsi.security.TekCertificateMismatch]
+- [`TekSecurityError`][tekhsi.security.TekSecurityError]
+- [`FastFrameLoadTiming`][tekhsi.load_timing.WaveformTransferTiming] (the compatibility alias for [`WaveformTransferTiming`][tekhsi.load_timing.WaveformTransferTiming])
+- [`FastFrameDigitalWaveform`](https://tm-data-types.readthedocs.io/en/stable/)


Use a dot syntax like tekhsi, it resolves due to the imported libraries in the build process.

nfelt14 · 2026-10-07T01:06:56Z

This file is just an example of bad code. We shouldn't have an example that imports private members.

nfelt14 · 2026-10-07T01:08:22Z

-  "missing-class-docstring",  # caught by ruff
-  "missing-module-docstring",  # caught by ruff
-  "no-member",  # caught by pyright
+  "locally-disabled",  # local suppressions are reviewed at their usage sites


Why was this added?

nfelt14 · 2026-10-07T01:08:41Z

  "consider-using-with",  # TODO: enable this check
  "deprecated-typing-alias",  # caught by ruff
  "duplicate-code",
-  "fixme",  # caught by ruff


Why were these removed?

nfelt14 · 2026-10-07T01:09:25Z

 output-format = "text"  # colorized could be another option

 [tool.pyright]
+executionEnvironments = [


This shouldn't be necessary if the tests are set up properly. The tests shouldn't be manipulating sys.path

nfelt14 · 2026-10-07T01:10:35Z

 "src/tekhsi/_tek_highspeed_server_pb2*.py*" = [
  "ALL",
 ]
+"src/tekhsi/credential_store.py" = ["ALL"]


Remove total file ignore for these filea

nfelt14 · 2026-10-07T01:10:59Z

 pydantic = "^2.7.4"
 pygments = "^2.17.2"
-pymdown-extensions = "^12.1.0"
+pymdown-extensions = "^11.0.1"


It is not reverted

nfelt14 · 2026-10-07T01:11:41Z

    )

-    global _logger_initialized  # noqa: PLW0603
+    global _logger_initialized  # noqa: PLW0603  # pylint: disable=global-statement


This pylint error can still be ignored globally, since it is caught by ruff

nfelt14 · 2026-10-07T01:13:30Z

+
+
+@pytest.fixture
+def manual_scope_enabled_fixture() -> None:


This should just be an auto use fixture, it doesn't need to be used manually. Also, this env var should be removed, just use the presence of the scope ip address to skip.

feat: add secure connections and FastFrame support

b958950

SaiDeepikaKuchibhotla requested a review from a team as a code owner October 6, 2026 07:07

SaiDeepikaKuchibhotla requested review from amccann-Tek, nfelt14, pradhansk, tekperson and v12ganesh October 6, 2026 07:07

SaiDeepikaKuchibhotla deployed to package-build October 6, 2026 07:07 — with GitHub Actions Active

github-advanced-security Bot found potential problems Oct 6, 2026

View reviewed changes

fix: stabilize CI tooling and manual tests

cf43b31

SaiDeepikaKuchibhotla deployed to package-build October 6, 2026 10:50 — with GitHub Actions Active

fix: resolve CodeQL control-flow findings

ddd91fc

SaiDeepikaKuchibhotla deployed to package-build October 6, 2026 10:56 — with GitHub Actions Active

SaiDeepikaKuchibhotla added 2 commits October 6, 2026 16:33

fix: resolve remaining CodeQL findings

ba01787

fix: add copyright headers for ruff

f813a31

SaiDeepikaKuchibhotla deployed to package-build October 6, 2026 11:22 — with GitHub Actions Active

nfelt14 requested changes Oct 6, 2026

View reviewed changes

feat: add secure FastFrame support

d608e48

SaiDeepikaKuchibhotla deployed to package-build October 6, 2026 18:02 — with GitHub Actions Active

fix: resolve lint and documentation review issues

954c112

SaiDeepikaKuchibhotla deployed to package-build October 6, 2026 19:09 — with GitHub Actions Active

nfelt14 requested changes Oct 7, 2026

View reviewed changes

		return True, None


		def discover(url: str) -> tuple[bool, Path \| None, dict, bool]:

Conversation

SaiDeepikaKuchibhotla commented Oct 6, 2026

Proposed changes

Types of changes

Checklist

Uh oh!

read-the-docs-community Bot commented Oct 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Oct 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results (macos)

Uh oh!

github-actions Bot commented Oct 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results (ubuntu)

Uh oh!

github-actions Bot commented Oct 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results (windows)

Uh oh!

nfelt14 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Oct 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking API Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

read-the-docs-community Bot commented Oct 6, 2026 •

edited

Loading

github-actions Bot commented Oct 6, 2026 •

edited

Loading

github-actions Bot commented Oct 6, 2026 •

edited

Loading

github-actions Bot commented Oct 6, 2026 •

edited

Loading

github-actions Bot commented Oct 6, 2026 •

edited

Loading