SCPI-Instrument-Control 2.0.0__tar.gz → 3.0.0__tar.gz

{scpi_instrument_control-2.0.0 → scpi_instrument_control-3.0.0}/CHANGELOG.md

@@ -7,6 +7,95 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0] - 2026-07-17
+
+### ⚠️ Breaking Changes
+
+- **The report generator's `WaveformData` fields are renamed, and `channel`
+  moved from the first constructor argument to the third.** `channel_name`,
+  `time_data`, and `voltage_data` are now `channel`, `time`, and `voltage`,
+  matching the base class's field order (`time`, `voltage`, `channel`, ...).
+  Because the position changed along with the name, positional construction
+  such as `WaveformData("CH1", t, v, ...)` does **not** fail with a
+  recognizable rename error — it silently assigns `"CH1"` to `time` and
+  blows up later with `AttributeError: 'str' object has no attribute
+  'shape'`. Construct with keywords (`channel=`, `time=`, `voltage=`) to
+  migrate safely. This is a documented public API — see
+  [`docs/report-generator/api-reference.md`](docs/report-generator/api-reference.md).
+- **`WaveformData.source` and `WaveformData.description` are removed**, on
+  both the library and report waveform types. `WaveformData(..., source="x")`
+  now raises `TypeError` instead of silently accepting the keyword.
+- **`WaveformData.timebase` and `WaveformData.voltage_scale` are `None`
+  unless an instrument actually reported them**, instead of being derived by
+  assuming a 14-division horizontal grid and an 8-division vertical one —
+  Siglent's geometry, previously applied to Tektronix and LeCroy captures too
+  — with a flat trace given a bare 1.0 V/div. Real acquisitions are
+  unaffected: all three vendor backends pass genuine scope values. Code that
+  does arithmetic on `timebase`/`voltage_scale` from a *synthetic* waveform
+  (a math channel, or hand-built test data) — e.g. `wf.timebase * 1e6` — now
+  raises `TypeError` on `None` instead of silently using an invented number.
+  Guard with a `None` check, or supply real values.
+
+### Added
+
+- Tektronix and LeCroy oscilloscope support (core control, waveform
+  acquisition, measurements): two more wire dialects (`tektronix`, `lecroy`)
+  alongside the existing Siglent legacy/modern pair, auto-detected from
+  `*IDN?` via a manufacturer-first routing step. Covers the Tektronix
+  TBS1000C Series and 2 Series MSO, and the LeCroy WaveSurfer 3000z and
+  WaveRunner 8000 series. See the
+  [SCPI Dialects guide](docs/user-guide/scpi-dialects.md) for the full
+  per-vendor command tables and known gaps (e.g. LeCroy
+  statistics/cursors/holdoff, Tek 16-bit waveform transfer).
+- Tektronix MSO 4/5/6 Series support (MSO44, MSO46, MSO54, MSO56, MSO58,
+  MSO58LP, MSO64), including 6- and 8-channel models.
+- Badge-based measurements for the modern Tektronix MSO families, which also
+  enables `measure()` on the MSO 2-Series.
+- **Report generator — local-LLM analysis and richer PDFs**
+  (`pip install "SCPI-Instrument-Control[report-generator]"`). Everything here
+  is local-only — no cloud providers, no API keys.
+  - Local-LLM (Ollama) tool calling: the model can call read-only report tools
+    to ground its answers, behind a capability gate that no-ops when the local
+    model cannot do tool calls.
+  - Waveform analysis tools for the model — `analyze_plateaus`, `list_edges`,
+    and `analyze_spectrum` — plus `WaveformAnalyzer.calculate_spectrum`.
+  - Deterministic no-LLM analysis: a `ComputedAnalyzer` populates per-waveform
+    statistics and regions on every report, and composes a summary, findings,
+    and recommendations when no LLM wrote them. Reports now attribute their
+    summary by source (manual / AI / computed) rather than a bare AI flag.
+  - Vector PDF plots: waveform, FFT, and region plots render as scalable vector
+    graphics instead of rasterized images.
+  - Page framework: a running header/footer and page numbers on every page,
+    with section headings kept from stranding at the bottom of a page.
+  - Template branding: a template's logo, company name, header/footer text, and
+    four brand colours apply to the generated PDF, and a built-in starter
+    template can be seeded from the Template Manager.
+
+### Changed
+
+- On the Siglent modern dialect, `trigger.holdoff`, measurement statistics,
+  cursors, and `channel.unit` now raise `FeatureNotSupportedError` immediately
+  instead of writing an unsupported command and timing out
+  (`SiglentTimeoutError`). Code that caught the timeout to detect these
+  unsupported operations must now catch `FeatureNotSupportedError` instead.
+- Probe-ratio wire format on the legacy and modern dialects now serializes
+  floats compactly (`10.0` is sent as `10`), matching how real scopes echo the
+  value back.
+- `add_measurement` now validates and case-normalizes its measurement type
+  (unknown types raise instead of being sent verbatim to the instrument).
+- Channel numbers are validated against the connected model's channel count
+  instead of a fixed 1-4 range. Scopes with fewer than four channels now raise
+  `InvalidParameterError` for a channel they do not have, where they
+  previously queried it.
+- The report generator's `WaveformData` is now a subclass of
+  `scpi_control.waveform.WaveformData` (see Breaking Changes above for the
+  field rename and reorder this involved). Report waveforms now inherit the
+  library's array-shape validation, and `channel` is now guaranteed to be a
+  `str` by the type itself. The loader's explicit `str()` calls at each
+  construction site are unchanged and now redundant, not removed — they stay
+  as a defensive measure against `np.str_`/`bytes` values handed back at the
+  MAT/HDF5 boundary.
+
 ## [2.0.0] - 2026-07-15
 
 ### ⚠️ Breaking Changes

{scpi_instrument_control-2.0.0 → scpi_instrument_control-3.0.0}/MANIFEST.in

@@ -6,7 +6,6 @@ include pyproject.toml
 
 # Include user-facing documentation
 recursive-include docs/images *.png *.jpg
-include docs/VISUAL_MEASUREMENTS.md
 include docs/SDS800XHD_Series_ProgrammingGuide_EN11G.pdf
 
 # Include resources (logos, icons)
@@ -23,8 +22,6 @@ recursive-include examples *.md
 exclude docs/development/*
 exclude docs/README_SCREENSHOTS.md
 exclude docs/SCREENSHOT_CHECKLIST.md
-exclude docs/CONTRIBUTING.md
-exclude docs/SECURITY.md
 recursive-exclude tests *
 recursive-exclude scripts *
 

{scpi_instrument_control-2.0.0/SCPI_Instrument_Control.egg-info → scpi_instrument_control-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SCPI-Instrument-Control
-Version: 2.0.0
+Version: 3.0.0
 Summary: Universal Python library for controlling SCPI-compatible test equipment via Ethernet/LAN. Supports oscilloscopes (Siglent SDS series, generic SCPI scopes), function generators/AWGs (Siglent SDG series, generic SCPI AWGs), and power supplies (Siglent SPD series, generic SCPI PSUs). Features include waveform capture, measurements, FFT analysis, PyQt6 GUI, automated report generation with AI analysis, and comprehensive SCPI command abstraction.
 Author: Robin Mumm
 Maintainer: little-did-I-know
@@ -64,7 +64,11 @@ Requires-Dist: PyQt6>=6.6.0; extra == "report-generator"
 Requires-Dist: Pillow>=10.0.0; extra == "report-generator"
 Requires-Dist: requests>=2.31.0; extra == "report-generator"
 Requires-Dist: reportlab>=4.0.0; extra == "report-generator"
+Requires-Dist: svglib>=1.5.0; extra == "report-generator"
 Requires-Dist: ollama>=0.6.0; extra == "report-generator"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "report-generator"
+Requires-Dist: psutil>=5.9.0; extra == "report-generator"
+Requires-Dist: nvidia-ml-py>=12.0.0; extra == "report-generator"
 Provides-Extra: power-supply-beta
 Provides-Extra: usb
 Requires-Dist: pyvisa>=1.14.0; extra == "usb"
@@ -89,7 +93,11 @@ Requires-Dist: Pillow>=10.0.0; extra == "all"
 Requires-Dist: svgpathtools>=1.6.0; extra == "all"
 Requires-Dist: requests>=2.31.0; extra == "all"
 Requires-Dist: reportlab>=4.0.0; extra == "all"
+Requires-Dist: svglib>=1.5.0; extra == "all"
 Requires-Dist: ollama>=0.6.0; extra == "all"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "all"
+Requires-Dist: psutil>=5.9.0; extra == "all"
+Requires-Dist: nvidia-ml-py>=12.0.0; extra == "all"
 Dynamic: license-file
 
 # SCPI Instrument Control
@@ -694,6 +702,8 @@ built-in mock (`mock: true`) for hardware-free use. The API is documented at
 `/docs` (OpenAPI). No authentication in this release — bind to `127.0.0.1`
 (the default) unless your LAN is trusted.
 
+Full documentation: [Web Gateway guide](https://little-did-I-know.github.io/SCPI-Instrument-Control/gateway/) — overview, browser UI tour, and the complete REST & WebSocket API reference.
+
 - `GET /api/discover` scans the gateway's subnet (or `?cidr=…`) for SCPI
   instruments on port 5025 and lists them with model and dialect — handy when
   DHCP moves your instruments around.
@@ -895,18 +905,33 @@ See the `examples/` directory for complete working examples:
 
 ## Supported Models
 
-### Fully Tested
+### Siglent (Fully Tested)
 
 - **SDS800X HD Series**: SDS804X HD, SDS824X HD
 - **SDS1000X-E Series**: SDS1102X-E, SDS1104X-E, SDS1202X-E, SDS1204X-E
 - **SDS2000X Plus Series**: SDS2104X+, SDS2204X+, SDS2354X+
 - **SDS5000X Series**: SDS5034X, SDS5054X, SDS5104X
 
+### Tektronix and LeCroy (core control + measurements)
+
+- **Tektronix TBS1000C Series**: TBS1102C
+- **Tektronix 2 Series MSO**: MSO24
+- **Tektronix 4 Series MSO**: MSO44, MSO46
+- **Tektronix 5 Series MSO**: MSO54, MSO56, MSO58, MSO58LP
+- **Tektronix 6 Series MSO**: MSO64
+- **LeCroy WaveSurfer 3000z Series**: WaveSurfer 3024z
+- **LeCroy WaveRunner 8000 Series**: WaveRunner 8104
+
+All Tektronix MSO models (2/4/5/6 Series) share one command variant and
+support automated measurements — see the [SCPI Dialects guide](https://little-did-I-know.github.io/SCPI-Instrument-Control/user-guide/scpi-dialects/) for the full per-vendor gap list.
+
+Command tables were verified command-by-command against the vendor programmer manuals (Tektronix TBS1000C, 2 Series MSO, and 4/5/6 Series MSO/6 Series LPD manuals; the Teledyne LeCroy MAUI Remote Control and Automation Manual) and exercised against a dialect-aware mock; not yet run against real Tektronix or LeCroy hardware.
+
 ### Compatibility
 
-Should work with other Siglent oscilloscopes that support SCPI commands over Ethernet. Model-specific features are auto-detected via the `ModelCapability` registry.
+Should work with other Siglent oscilloscopes that support SCPI commands over Ethernet. Model-specific features are auto-detected via the `ModelCapability` registry. Unrecognized Tektronix or LeCroy models fall back to a conservative generic profile for that vendor (with a logged warning) rather than being rejected outright.
 
-**Note**: Some SCPI commands vary between models. The library includes model-specific command variants for HD, X, and Plus series.
+**Note**: Some SCPI commands vary between models. The library includes model-specific command variants for HD, X, and Plus series (Siglent) and for TBS vs. MSO (2/4/5/6 Series share one variant) (Tektronix).
 
 ## Contributing
 

{scpi_instrument_control-2.0.0 → scpi_instrument_control-3.0.0}/README.md

@@ -600,6 +600,8 @@ built-in mock (`mock: true`) for hardware-free use. The API is documented at
 `/docs` (OpenAPI). No authentication in this release — bind to `127.0.0.1`
 (the default) unless your LAN is trusted.
 
+Full documentation: [Web Gateway guide](https://little-did-I-know.github.io/SCPI-Instrument-Control/gateway/) — overview, browser UI tour, and the complete REST & WebSocket API reference.
+
 - `GET /api/discover` scans the gateway's subnet (or `?cidr=…`) for SCPI
   instruments on port 5025 and lists them with model and dialect — handy when
   DHCP moves your instruments around.
@@ -801,18 +803,33 @@ See the `examples/` directory for complete working examples:
 
 ## Supported Models
 
-### Fully Tested
+### Siglent (Fully Tested)
 
 - **SDS800X HD Series**: SDS804X HD, SDS824X HD
 - **SDS1000X-E Series**: SDS1102X-E, SDS1104X-E, SDS1202X-E, SDS1204X-E
 - **SDS2000X Plus Series**: SDS2104X+, SDS2204X+, SDS2354X+
 - **SDS5000X Series**: SDS5034X, SDS5054X, SDS5104X
 
+### Tektronix and LeCroy (core control + measurements)
+
+- **Tektronix TBS1000C Series**: TBS1102C
+- **Tektronix 2 Series MSO**: MSO24
+- **Tektronix 4 Series MSO**: MSO44, MSO46
+- **Tektronix 5 Series MSO**: MSO54, MSO56, MSO58, MSO58LP
+- **Tektronix 6 Series MSO**: MSO64
+- **LeCroy WaveSurfer 3000z Series**: WaveSurfer 3024z
+- **LeCroy WaveRunner 8000 Series**: WaveRunner 8104
+
+All Tektronix MSO models (2/4/5/6 Series) share one command variant and
+support automated measurements — see the [SCPI Dialects guide](https://little-did-I-know.github.io/SCPI-Instrument-Control/user-guide/scpi-dialects/) for the full per-vendor gap list.
+
+Command tables were verified command-by-command against the vendor programmer manuals (Tektronix TBS1000C, 2 Series MSO, and 4/5/6 Series MSO/6 Series LPD manuals; the Teledyne LeCroy MAUI Remote Control and Automation Manual) and exercised against a dialect-aware mock; not yet run against real Tektronix or LeCroy hardware.
+
 ### Compatibility
 
-Should work with other Siglent oscilloscopes that support SCPI commands over Ethernet. Model-specific features are auto-detected via the `ModelCapability` registry.
+Should work with other Siglent oscilloscopes that support SCPI commands over Ethernet. Model-specific features are auto-detected via the `ModelCapability` registry. Unrecognized Tektronix or LeCroy models fall back to a conservative generic profile for that vendor (with a logged warning) rather than being rejected outright.
 
-**Note**: Some SCPI commands vary between models. The library includes model-specific command variants for HD, X, and Plus series.
+**Note**: Some SCPI commands vary between models. The library includes model-specific command variants for HD, X, and Plus series (Siglent) and for TBS vs. MSO (2/4/5/6 Series share one variant) (Tektronix).
 
 ## Contributing
 

{scpi_instrument_control-2.0.0 → scpi_instrument_control-3.0.0/SCPI_Instrument_Control.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SCPI-Instrument-Control
-Version: 2.0.0
+Version: 3.0.0
 Summary: Universal Python library for controlling SCPI-compatible test equipment via Ethernet/LAN. Supports oscilloscopes (Siglent SDS series, generic SCPI scopes), function generators/AWGs (Siglent SDG series, generic SCPI AWGs), and power supplies (Siglent SPD series, generic SCPI PSUs). Features include waveform capture, measurements, FFT analysis, PyQt6 GUI, automated report generation with AI analysis, and comprehensive SCPI command abstraction.
 Author: Robin Mumm
 Maintainer: little-did-I-know
@@ -64,7 +64,11 @@ Requires-Dist: PyQt6>=6.6.0; extra == "report-generator"
 Requires-Dist: Pillow>=10.0.0; extra == "report-generator"
 Requires-Dist: requests>=2.31.0; extra == "report-generator"
 Requires-Dist: reportlab>=4.0.0; extra == "report-generator"
+Requires-Dist: svglib>=1.5.0; extra == "report-generator"
 Requires-Dist: ollama>=0.6.0; extra == "report-generator"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "report-generator"
+Requires-Dist: psutil>=5.9.0; extra == "report-generator"
+Requires-Dist: nvidia-ml-py>=12.0.0; extra == "report-generator"
 Provides-Extra: power-supply-beta
 Provides-Extra: usb
 Requires-Dist: pyvisa>=1.14.0; extra == "usb"
@@ -89,7 +93,11 @@ Requires-Dist: Pillow>=10.0.0; extra == "all"
 Requires-Dist: svgpathtools>=1.6.0; extra == "all"
 Requires-Dist: requests>=2.31.0; extra == "all"
 Requires-Dist: reportlab>=4.0.0; extra == "all"
+Requires-Dist: svglib>=1.5.0; extra == "all"
 Requires-Dist: ollama>=0.6.0; extra == "all"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "all"
+Requires-Dist: psutil>=5.9.0; extra == "all"
+Requires-Dist: nvidia-ml-py>=12.0.0; extra == "all"
 Dynamic: license-file
 
 # SCPI Instrument Control
@@ -694,6 +702,8 @@ built-in mock (`mock: true`) for hardware-free use. The API is documented at
 `/docs` (OpenAPI). No authentication in this release — bind to `127.0.0.1`
 (the default) unless your LAN is trusted.
 
+Full documentation: [Web Gateway guide](https://little-did-I-know.github.io/SCPI-Instrument-Control/gateway/) — overview, browser UI tour, and the complete REST & WebSocket API reference.
+
 - `GET /api/discover` scans the gateway's subnet (or `?cidr=…`) for SCPI
   instruments on port 5025 and lists them with model and dialect — handy when
   DHCP moves your instruments around.
@@ -895,18 +905,33 @@ See the `examples/` directory for complete working examples:
 
 ## Supported Models
 
-### Fully Tested
+### Siglent (Fully Tested)
 
 - **SDS800X HD Series**: SDS804X HD, SDS824X HD
 - **SDS1000X-E Series**: SDS1102X-E, SDS1104X-E, SDS1202X-E, SDS1204X-E
 - **SDS2000X Plus Series**: SDS2104X+, SDS2204X+, SDS2354X+
 - **SDS5000X Series**: SDS5034X, SDS5054X, SDS5104X
 
+### Tektronix and LeCroy (core control + measurements)
+
+- **Tektronix TBS1000C Series**: TBS1102C
+- **Tektronix 2 Series MSO**: MSO24
+- **Tektronix 4 Series MSO**: MSO44, MSO46
+- **Tektronix 5 Series MSO**: MSO54, MSO56, MSO58, MSO58LP
+- **Tektronix 6 Series MSO**: MSO64
+- **LeCroy WaveSurfer 3000z Series**: WaveSurfer 3024z
+- **LeCroy WaveRunner 8000 Series**: WaveRunner 8104
+
+All Tektronix MSO models (2/4/5/6 Series) share one command variant and
+support automated measurements — see the [SCPI Dialects guide](https://little-did-I-know.github.io/SCPI-Instrument-Control/user-guide/scpi-dialects/) for the full per-vendor gap list.
+
+Command tables were verified command-by-command against the vendor programmer manuals (Tektronix TBS1000C, 2 Series MSO, and 4/5/6 Series MSO/6 Series LPD manuals; the Teledyne LeCroy MAUI Remote Control and Automation Manual) and exercised against a dialect-aware mock; not yet run against real Tektronix or LeCroy hardware.
+
 ### Compatibility
 
-Should work with other Siglent oscilloscopes that support SCPI commands over Ethernet. Model-specific features are auto-detected via the `ModelCapability` registry.
+Should work with other Siglent oscilloscopes that support SCPI commands over Ethernet. Model-specific features are auto-detected via the `ModelCapability` registry. Unrecognized Tektronix or LeCroy models fall back to a conservative generic profile for that vendor (with a logged warning) rather than being rejected outright.
 
-**Note**: Some SCPI commands vary between models. The library includes model-specific command variants for HD, X, and Plus series.
+**Note**: Some SCPI commands vary between models. The library includes model-specific command variants for HD, X, and Plus series (Siglent) and for TBS vs. MSO (2/4/5/6 Series share one variant) (Tektronix).
 
 ## Contributing
 

{scpi_instrument_control-2.0.0 → scpi_instrument_control-3.0.0}/SCPI_Instrument_Control.egg-info/SOURCES.txt

@@ -10,7 +10,6 @@ SCPI_Instrument_Control.egg-info/entry_points.txt
 SCPI_Instrument_Control.egg-info/requires.txt
 SCPI_Instrument_Control.egg-info/top_level.txt
 docs/SDS800XHD_Series_ProgrammingGuide_EN11G.pdf
-docs/VISUAL_MEASUREMENTS.md
 docs/images/01_main_window.png
 docs/images/channel_controls.png
 docs/images/cursors.png
@@ -24,7 +23,9 @@ examples/basic_usage.py
 examples/batch_capture.py
 examples/continuous_capture.py
 examples/data_logger_basic.py
+examples/dialect_override_example.py
 examples/function_generator_basic.py
+examples/gateway_rest_client.py
 examples/live_plot.py
 examples/measurements.py
 examples/probe_calibration_analysis.py
@@ -34,6 +35,7 @@ examples/psu_gui_test.py
 examples/psu_usb_connection.py
 examples/report_generation_example.py
 examples/simple_capture.py
+examples/trend_logging_walkthrough.py
 examples/trigger_based_capture.py
 examples/vector_graphics_xy_mode.py
 examples/waveform_capture.py
@@ -55,6 +57,7 @@ scpi_control/exceptions.py
 scpi_control/function_generator.py
 scpi_control/math_channel.py
 scpi_control/measurement.py
+scpi_control/measurement_badges.py
 scpi_control/measurement_config.py
 scpi_control/models.py
 scpi_control/oscilloscope.py
@@ -71,11 +74,18 @@ scpi_control/screen_capture.py
 scpi_control/trigger.py
 scpi_control/vector_graphics.py
 scpi_control/waveform.py
+scpi_control/waveform_schema.py
+scpi_control/waveform_transfer.py
 scpi_control/connection/__init__.py
 scpi_control/connection/base.py
-scpi_control/connection/mock.py
 scpi_control/connection/socket.py
 scpi_control/connection/visa_connection.py
+scpi_control/connection/mock/__init__.py
+scpi_control/connection/mock/base.py
+scpi_control/connection/mock/helpers.py
+scpi_control/connection/mock/lecroy.py
+scpi_control/connection/mock/siglent.py
+scpi_control/connection/mock/tektronix.py
 scpi_control/gui/__init__.py
 scpi_control/gui/app.py
 scpi_control/gui/connection_manager.py
@@ -120,6 +130,8 @@ scpi_control/protocol_decoders/uart_decoder.py
 scpi_control/report_generator/__init__.py
 scpi_control/report_generator/app.py
 scpi_control/report_generator/main_window.py
+scpi_control/report_generator/analysis/__init__.py
+scpi_control/report_generator/analysis/computed_analyzer.py
 scpi_control/report_generator/generators/__init__.py
 scpi_control/report_generator/generators/base.py
 scpi_control/report_generator/generators/markdown_generator.py
@@ -132,6 +144,7 @@ scpi_control/report_generator/llm/daq_analyzer.py
 scpi_control/report_generator/llm/daq_context_builder.py
 scpi_control/report_generator/llm/daq_prompts.py
 scpi_control/report_generator/llm/prompts.py
+scpi_control/report_generator/llm/tools.py
 scpi_control/report_generator/models/__init__.py
 scpi_control/report_generator/models/app_settings.py
 scpi_control/report_generator/models/criteria.py

{scpi_instrument_control-2.0.0 → scpi_instrument_control-3.0.0}/SCPI_Instrument_Control.egg-info/requires.txt

@@ -12,7 +12,11 @@ Pillow>=10.0.0
 svgpathtools>=1.6.0
 requests>=2.31.0
 reportlab>=4.0.0
+svglib>=1.5.0
 ollama>=0.6.0
+PyMuPDF>=1.23.0
+psutil>=5.9.0
+nvidia-ml-py>=12.0.0
 
 [build-exe]
 pyinstaller>=6.0.0
@@ -58,7 +62,11 @@ PyQt6>=6.6.0
 Pillow>=10.0.0
 requests>=2.31.0
 reportlab>=4.0.0
+svglib>=1.5.0
 ollama>=0.6.0
+PyMuPDF>=1.23.0
+psutil>=5.9.0
+nvidia-ml-py>=12.0.0
 
 [usb]
 pyvisa>=1.14.0

scpi_instrument_control-3.0.0/examples/README.md

@@ -0,0 +1,96 @@
+# SCPI Instrument Control — Examples
+
+These scripts show the library in action end to end: oscilloscope capture and
+analysis, the web gateway's REST API, function generator / AWG control,
+power supply control, data acquisition, and report generation. Most connect
+to real hardware over LAN by default (update the IP/host constant near the
+top of each file); a few run entirely against mock connections and need no
+instrument at all — those are called out below.
+
+Install the core library, then add the extras a given example needs:
+
+```bash
+pip install "SCPI-Instrument-Control"
+```
+
+## Oscilloscope
+
+| File | What it shows | Requirements |
+| --- | --- | --- |
+| `basic_usage.py` | Connecting to an oscilloscope, configuring channels and trigger, and performing basic operations. | Oscilloscope on the network |
+| `waveform_capture.py` | Capturing waveform data from the oscilloscope and saving it to a file. | Oscilloscope on the network, matplotlib |
+| `measurements.py` | Automated measurements (frequency, Vpp, RMS, period, etc.) on oscilloscope channels. | Oscilloscope on the network |
+| `live_plot.py` | Real-time waveform acquisition and plotting using matplotlib animation. | Oscilloscope on the network, matplotlib |
+| `simple_capture.py` | Single waveform capture with analysis via the automation API (Vpp, RMS, frequency) and saving to NumPy format. | Oscilloscope on the network |
+| `batch_capture.py` | Capturing multiple waveforms with different timebase and voltage-scale settings, for characterizing signals at different scales. | Oscilloscope on the network |
+| `continuous_capture.py` | Collecting waveforms continuously over a period of time, for monitoring, statistics, or time-varying phenomena. | Oscilloscope on the network |
+| `trigger_based_capture.py` | Waiting for specific trigger conditions and capturing waveforms when they occur, for sporadic events. | Oscilloscope on the network |
+| `advanced_analysis.py` | Advanced waveform analysis and visualization: FFT analysis, statistical analysis, and matplotlib plots. | Oscilloscope on the network, matplotlib |
+| `probe_calibration_analysis.py` | Waveform region extraction for probe compensation analysis: plateau detection, slope analysis, calibration guidance, and zoomed PDF report plots. | Oscilloscope on the network, `SCPI-Instrument-Control[report-generator]` |
+| `dialect_override_example.py` | SCPI dialect auto-detection from `*IDN?` and the `dialect=` override for forcing a command set; runs entirely on mock connections. | Core install only (no hardware) |
+
+## Web Gateway
+
+| File | What it shows | Requirements |
+| --- | --- | --- |
+| `gateway_rest_client.py` | Driving the web gateway's REST API from Python: creating a mock session, configuring a channel, fetching waveform JSON, downloading a screenshot, and sending a raw SCPI command — the same API the browser UI uses. | `SCPI-Instrument-Control[web]` + a running `scpi-web` gateway |
+| `trend_logging_walkthrough.py` | Recording measurement trends in-process via the gateway's session layer (no server or browser): polling measurements, recording them, and exporting to CSV. | Core install only (no hardware, no server) |
+
+## Function Generator / AWG
+
+| File | What it shows | Requirements |
+| --- | --- | --- |
+| `function_generator_basic.py` | Basic control of Siglent SDG-series function generators over Ethernet/LAN. | Function generator on the network |
+| `vector_graphics_xy_mode.py` | Using the oscilloscope as a vector display: generating X/Y waveform data for shapes, saving waveform files for an AWG, and animating via rotation/transforms. | `SCPI-Instrument-Control[fun]`, external AWG/DAC feeding the scope's channels |
+
+## Power Supply
+
+| File | What it shows | Requirements |
+| --- | --- | --- |
+| `psu_basic_control.py` | Controlling a SCPI power supply (Siglent SPD series or generic SCPI-99) over Ethernet/LAN. | Power supply on the network |
+| `psu_advanced_features.py` | Advanced PSU features: CSV data logging, tracking modes (series/parallel), timer functionality, waveform generation, and OVP/OCP protection. | Power supply on the network |
+| `psu_usb_connection.py` | Connecting to a power supply via USB/GPIB/Serial/TCP-IP using `VISAConnection`. | `SCPI-Instrument-Control[usb]`, PSU reachable via USB-TMC/GPIB/Serial/VXI-11 |
+| `psu_gui_test.py` | Testing the PSU control GUI against a mock connection, with no physical hardware required. | `SCPI-Instrument-Control[gui]` |
+
+## Data Acquisition
+
+| File | What it shows | Requirements |
+| --- | --- | --- |
+| `data_logger_basic.py` | Basic usage of the `DataLogger` class for DAQ/switch units (e.g. Keysight 34970A/DAQ970A style). | DAQ instrument on the network |
+
+## Report Generator
+
+| File | What it shows | Requirements |
+| --- | --- | --- |
+| `report_generation_example.py` | Generating professional PDF/Markdown test reports: loading waveform data, adding measurements with pass/fail criteria, optional AI analysis, and rendering the report. | `SCPI-Instrument-Control[report-generator]` |
+
+## Interactive Tutorial
+
+| File | What it shows | Requirements |
+| --- | --- | --- |
+| `interactive_tutorial.ipynb` | End-to-end Jupyter walkthrough: connect, configure channels/trigger, capture and plot a waveform, run automated measurements, FFT analysis, multi-channel capture, and export — narrated step by step. | Jupyter, oscilloscope on the network, matplotlib, scipy |
+
+## Configuration
+
+Most scripts read an IP/host constant (commonly `SCOPE_IP`) near the top of
+the file — update it to match your instrument. To find an oscilloscope's
+LAN address: **Utility → I/O → LAN** on the instrument's front panel.
+
+The scripts marked "no hardware" above (`dialect_override_example.py`,
+`trend_logging_walkthrough.py`, `psu_gui_test.py`) use mock connections and
+run as-is.
+
+## Running an example
+
+```bash
+python examples/basic_usage.py
+```
+
+For `gateway_rest_client.py`, start the gateway first, in another terminal:
+
+```bash
+pip install "SCPI-Instrument-Control[web]"
+scpi-web
+```
+
+Then run the client script.

scpi_instrument_control-3.0.0/examples/dialect_override_example.py

@@ -0,0 +1,59 @@
+"""SCPI dialect auto-detection and manual override.
+
+The library speaks two Siglent command sets: "legacy" (SDS1000X-E era,
+e.g. C1:VDIV 500mV) and "modern" (SDS800X HD era, e.g. :CHANnel1:SCALe 0.5).
+The dialect is auto-detected from *IDN? at connect; pass dialect= to force
+one when detection guesses wrong. This example uses mock connections so it
+runs without hardware.
+
+Requirements: SCPI-Instrument-Control (core install)
+"""
+
+from scpi_control import Oscilloscope
+from scpi_control.connection.mock import MockConnection
+from scpi_control.exceptions import SiglentTimeoutError
+
+LEGACY_IDN = "Siglent Technologies,SDS1104X-E,MOCK0001,1.0.0.0"
+MODERN_IDN = "Siglent Technologies,SDS824X HD,MOCK0002,3.8.12"
+
+
+def show(scope: Oscilloscope, label: str) -> None:
+    scope.connect()
+    try:
+        print(f"{label}: model={scope.device_info.get('model')}, detected dialect={scope.dialect}")
+        scope.timebase = 1e-3  # same API call regardless of dialect
+        print(f"  timebase set to {scope.timebase} s/div via the {scope.dialect} command set")
+    finally:
+        scope.disconnect()
+
+
+def main() -> None:
+    # Auto-detection from *IDN?
+    show(Oscilloscope("mock", connection=MockConnection("mock", idn=LEGACY_IDN)), "Legacy scope (auto)")
+    show(Oscilloscope("mock", connection=MockConnection("mock", idn=MODERN_IDN)), "Modern scope (auto)")
+
+    # Manual override: dialect= exists for the case where the model registry
+    # misidentifies real hardware from *IDN? and you need to force the wire
+    # protocol the instrument *actually* speaks. Forcing a dialect the
+    # instrument does NOT speak is a misuse - and our mock is faithful enough
+    # to prove it: it answers only the real protocol for its *IDN?, so
+    # forcing "modern" onto a legacy-speaking instrument here fails exactly
+    # like it would on real mismatched hardware (a timeout, not a crash).
+    forced = Oscilloscope("mock", connection=MockConnection("mock", idn=LEGACY_IDN), dialect="modern")
+    forced.connect()
+    try:
+        print(f"Legacy IDN, dialect forced to modern: model={forced.device_info.get('model')}, dialect={forced.dialect}")
+        try:
+            forced.timebase = 1e-3
+            print(f"  timebase set to {forced.timebase} s/div via the {forced.dialect} command set")
+        except SiglentTimeoutError:
+            print("  (expected) a modern-dialect query against a legacy-speaking instrument timed out")
+            print("  -- only override dialect to match what the real instrument speaks")
+    finally:
+        forced.disconnect()
+    # On real hardware, override with the dialect the instrument actually
+    # speaks: Oscilloscope("192.168.1.100", dialect="modern")
+
+
+if __name__ == "__main__":
+    main()

scpi_instrument_control-3.0.0/examples/gateway_rest_client.py

@@ -0,0 +1,71 @@
+"""Drive the web gateway's REST API from Python — no browser needed.
+
+Start the gateway first (in another terminal):
+
+    pip install "SCPI-Instrument-Control[web]"
+    scpi-web
+
+Then run this script. It creates a hardware-free mock session, configures a
+channel, fetches full-resolution waveform data as JSON, and downloads a
+screenshot PNG — the same API the browser UI uses.
+
+Requirements:
+    - SCPI-Instrument-Control[web] (for the gateway itself)
+    - Python standard library only for this client (urllib)
+"""
+
+import json
+import urllib.request
+from typing import Optional, Union
+
+BASE = "http://127.0.0.1:8765/api"
+
+Body = Optional[Union[dict, list]]  # examples run on the package floor, Python 3.9
+
+
+def call(method: str, path: str, body: Body = None) -> bytes:
+    data = None if body is None else json.dumps(body).encode()
+    request = urllib.request.Request(BASE + path, data=data, method=method)
+    if data is not None:
+        request.add_header("Content-Type", "application/json")
+    with urllib.request.urlopen(request) as response:
+        return response.read()
+
+
+def call_json(method: str, path: str, body: Body = None):
+    return json.loads(call(method, path, body))
+
+
+def main() -> None:
+    # 1. Create a mock oscilloscope session (no hardware required)
+    session = call_json("POST", "/sessions", {"mock": True, "label": "REST demo"})
+    session_id = session["id"]
+    print(f"Session {session_id}: {session['model']} ({session['dialect']} dialect)")
+
+    scope = f"/sessions/{session_id}/scope"
+    try:
+        # 2. Configure channel 1 and read the full state snapshot back
+        state = call_json("PATCH", f"{scope}/channels/1", {"enabled": True, "voltage_scale": 0.5})
+        print(f"Timebase: {state['timebase']} s/div, C1 scale: {state['channels']['1']['voltage_scale']} V/div")
+
+        # 3. Fetch full-resolution waveform data as JSON
+        waveform = call_json("GET", f"{scope}/waveform?channels=1&max_points=16")
+        channel = waveform["channels"][0]
+        print(f"Waveform C{channel['channel']}: {len(channel['points'])} points, dt={channel['dt']:.2e} s")
+
+        # 4. Download the instrument screenshot
+        png = call("GET", f"{scope}/screenshot.png")
+        with open("gateway_screenshot.png", "wb") as f:
+            f.write(png)
+        print(f"Saved gateway_screenshot.png ({len(png)} bytes)")
+
+        # 5. Send a raw SCPI query through the terminal endpoint
+        reply = call_json("POST", f"{scope}/command", {"command": "*IDN?"})
+        print(f"*IDN? -> {reply['response']}")
+    finally:
+        call("DELETE", f"/sessions/{session_id}")
+        print("Session closed.")
+
+
+if __name__ == "__main__":
+    main()