embeddedci 0.2.2__tar.gz → 2.0.0__tar.gz

embeddedci-2.0.0/.gitignore

@@ -0,0 +1,20 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+
+# Build artifacts
+build/
+dist/
+
+# Virtualenvs
+.venv/
+venv/
+
+# ADC FFT capture outputs (scripts/adc_fft_capture.py)
+adc_capture_*.csv
+adc_capture_*.json
+adc_capture_*.png
+
+.DS_Store

embeddedci-2.0.0/CHANGELOG.md

@@ -0,0 +1,167 @@
+# Changelog — `embeddedci`
+
+## 2.0.0 — the frozen API
+
+2.0.0 is the first release with a stability promise. Everything in
+`embeddedci.benchpod.__all__` follows [semantic versioning](https://semver.org): within 2.x
+names and signatures only grow, never break. `tests/api_surface.json` snapshots that surface and
+CI fails on any unreviewed change. `BenchPod.command()`, `BenchPod.transport` and
+`BenchPod.lowlevel` are escape hatches **outside** the promise.
+
+### Conventions (apply everywhere)
+
+- **Units are volts, seconds and hertz.** `sample_rate_mhz` → `sample_rate_hz`, `*_us`/`*_ms`
+  arguments → seconds, millivolt/microamp readings → volts/amps.
+- **Invalid arguments raise `ValueError`.** `BenchPodError` (and subclasses) now means a device,
+  transport or server failure only.
+- **Device state is typed.** Methods that returned raw firmware dicts return frozen dataclasses
+  from `embeddedci.benchpod.state` (each keeps the untouched reply in `.raw`).
+- **String options are `Literal` types** (`DacPath`, `AnalogPath`, `AdcSource`, `LoopSource`,
+  `Waveshape`, `ReplayMapping`, `DecodeProtocol`, `CanMode`, `FaultType`) and are validated.
+- Python **3.10+** (3.9 is end-of-life).
+
+### Migration table
+
+| 1.x / 0.x | 2.0 |
+| --- | --- |
+| **Connection** | |
+| `bp = BenchPod(conn); bp.set_la_voltage(3.3)` | `BenchPod(conn, la_voltage=3.3)` (or `BENCHPOD_LA_VOLTAGE=3.3`) |
+| pytest: `--benchpod-la-voltage 3.3` on every run | override the `benchpod_la_voltage` fixture once in `conftest.py` (the flag remains a per-run override) |
+| `status()` returned text over serial | `status()` is a dict on every transport |
+| `transport.set_la_voltage(mv)` / `get_la_voltage()` | removed — use `BenchPod.set_la_voltage` / `get_la_voltage` |
+| **LA voltage** | |
+| `set_la_voltage(3300)` (millivolts accepted) | `set_la_voltage(3.3)` — volts only |
+| `set_la_voltage(...)` / `get_la_voltage()` → `{"mv", "st"}` | → `LaVoltage(voltage, readback)`; `voltage is None` until selected |
+| **Power** | |
+| `power_status()` → `{"internal": {"bus_mv", "current_ua"}, …}` | → `PowerStatus`: `.rail(1).bus_voltage` (V), `.current` (A) |
+| `command({"cmd": "target_status"})` | `target_status()` → `TargetStatus`: `.efuse(1).fault` |
+| — | new: `reset_target(pulse=0.1)`, `set_reset(asserted)`, `reset_state()`, `usb_cc()` |
+| **Bias resistors** | |
+| `pullup(la, on=True/False)` | `set_pull(la, enabled)` → `PullState` |
+| `pullup(la)` (query) | `pull_state(la)` → `PullState(enabled, direction, ohms)` |
+| `pullup_status()` → `{"la_pullup_mask"}` | `enabled_pulls()` → `[1, 2]` |
+| `enable_pullup(7)` silently engaged a pull-**down** | raises `ValueError`; use `enable_pulldown(7)` / `disable_pulldown(7)` |
+| **Flash** | |
+| `flash(nreset=PIN3)` — an LA channel wired to the target's NRST | `flash(nreset=True)` — NRST wired to the pod's own reset pin (DUT header J1 pin 22, rev3 pods) |
+| **Emulated I2C sensor** | |
+| `i2c_sensor_la_decoded(samples, sample_rate_mhz)` | `i2c_sensor_capture(samples, *, sample_rate_hz)` |
+| `i2c_sensor_la(...)` (raw packed bytes) | removed — `i2c_sensor_capture` decodes |
+| `i2c_sensor_regs(start, length)` | `i2c_sensor_regs(*, start, length)` |
+| **Analog** | |
+| `analog_path("5v")`, `("ext")`, `("sma")` aliases | canonical names only: `"dac_5v"`, `"adc_ext"`; returns `AnalogPathState` |
+| `dac_output(path, volts)` → `{"path", "mv", "code"}` | `dac_output(path, *, volts=)` → `DacOutput(path, voltage, code)` |
+| `adc_read(source)` → `{"source", "mv", "count"}` | → `AdcReading(source, voltage, count, span)` |
+| `measure_volts(source)` | `adc_read(source).voltage` |
+| `route_dac_to_adc("5v")` / `("12v")` | `analog_path("cal1")` / `analog_path("cal2")` |
+| `adc_from_sma()` | `analog_path("adc_ext")` |
+| `dac_mux`, `dac_mux_status`, `cal_switch`, `cal_switch_status` | `bp.lowlevel.dac_mux(...)` etc. (outside the stability promise) |
+| `dac_set(value, channel=)` (`channel` was ignored) | `bp.lowlevel.dac_set(code, divider=)` |
+| **Captures** | |
+| `capture(samples, sample_rate_mhz=)` → raw `List[int]` | `capture_adc(samples).counts` |
+| `scope_capture(samples, *, sample_rate_mhz, source)` | `capture_adc(samples, *, sample_rate_hz, source)` — `source` now actually routes the ADC; default 4096 samples; above 32768 it streams from PSRAM |
+| `capture_la(n, *, sample_rate_mhz, stop_dac_after_us)` | `capture_la(n, *, sample_rate_hz, stop_dac_after)` (seconds) |
+| `capture_analog(adc_samples, adc_rate_mhz, la_samples, la_rate_mhz, stop_dac_after_us)` | `capture_correlated(adc_samples, adc_sample_rate_hz, la_samples, la_sample_rate_hz, stop_dac_after)` |
+| `AnalogCapture` | `CorrelatedCapture` |
+| `Capture.duration_s`, `LaCapture.duration_s` | `.duration` |
+| `LaCapture.decode_i2c(sda=, scl=)` | `LaCapture.decode("i2c", sda=, scl=)` |
+| **DAC** | |
+| `generate(w, *, freq, amplitude, offset=0.0, duration_ms, sample_rate_mhz)` — amplitude/offset were firmware 8-bit **codes**, offset defaulted to code 0 | `generate(w, *, freq_hz, amplitude, offset=None, dac_path="5v", duration, sample_rate_hz)` — **volts**; offset defaults to mid-range; routes `dac_path`; returns a `DacHandle` |
+| `replay(..., sample_rate_mhz=)` | `replay(..., sample_rate_hz=)` (defaults to a `Capture`'s own rate) |
+| `replaying(...)` | `replay(...)` (already a context manager) |
+| `replay_waveform(waveform_id="…")` | `replay_waveform("…")` (positional id or `Waveform`) |
+| `replay_waveform(..., dac_path="5v")` default | `dac_path=None` → the waveform's own path (else `5v`), used for both routing and scaling |
+| `Segment(shape, duration_ms, v_start, v_end)` | `Segment(shape, duration, v_start, v_end)` — `duration` in seconds |
+| `dac_stop()` / `ReplayHandle.stop()` returned the reply | return `None` |
+| **UART** | |
+| `UartSession.read(timeout=)` returned everything received so far | returns the output since the last read and marks it read (everything received is `.text`) |
+| `UartSession.drain()` | `read()` |
+| `UartSession.read_until` / `expect` searched everything ever received and consumed nothing; both returned the match | both search the unread output and mark it read up to the end of the match; `read_until` returns that output (or `None`), `expect` returns the match (`re.Match` for a regex) |
+| **Control loop** | |
+| `loop_input(...)` → dict | → `LoopState(source, input_code, step, output_code)` |
+| `ControlLoopHandle.set_input(...)` → dict | → `LoopState` |
+| `IVPoint.current_code`, `IVPoint.voltage_code` | `IVPoint.i`, `IVPoint.v` |
+| `fpga_image(0)` → dict | `fpga_image(FpgaImage.LOOP)` → `FpgaImageInfo(image, version, features)` |
+| **CAN** | |
+| `can_read(max=8)` → `{"frames", "overflow"}` | `can_read(max_frames=8)` → `CanReadResult(frames: List[CanFrame], overflow)` |
+| `CanBus.read(max=8)` | `CanBus.read(max_frames=8)` |
+| **Stepper** | |
+| `la_step(la, steps, delay_us, dir_la, direction)` | `la_step(la, *, steps, delay, dir_la=None, direction=0)` — `delay` in seconds |
+| **Errors** | |
+| `coerce_pin` / `coerce_efuse` / decoder and flash argument checks raised `BenchPodError` / `FlashError` | raise `ValueError` |
+
+### Added
+
+- `BenchPod(la_voltage=...)` / `BENCHPOD_LA_VOLTAGE` select the LA bank voltage on connect; the
+  `benchpod_la_voltage` pytest fixture sets it once for a test suite from `conftest.py`.
+- `target_status()`, `reset_target()`, `set_reset()`, `reset_state()`, `usb_cc()`.
+- `enable_pulldown()`, `disable_pulldown()`, `set_pull()`, `pull_state()`, `enabled_pulls()`.
+- `LoopInputMap` (`control_loop(input_map=...)`) and `Capabilities.dac_loop_input_map` for
+  gateware v30's engineering-units loop input.
+- `LaCapture.edges(la)`, `FpgaImage`, `DacHandle`, `CanReadResult`, `CloudAuthError` export,
+  the `Literal` option types, and the `embeddedci[pytest]` extra.
+- The serial transport probes whether the pod's USB console has a JSON mode. The STM32 pod's does
+  not (it is a text shell), so over USB `status()` (parsed from the text report), `ping()`, the LA
+  voltage and target power on/off run as text commands, and every other operation raises a
+  `TransportError` at once that points at the network/cloud connection (instead of timing out).
+  On firmware with a JSON mode, chunked replies now stream too.
+- `generate(..., route=False)` / `replay(..., route=False)` keep the current analog switching, so a
+  DAC→ADC loopback set up with `analog_path("cal1")` survives starting the output.
+- `BenchPod.leased`: whether this client holds a cloud device lease.
+- **Automatic gateware image switching.** `control_loop()`, `replay()` and `replay_waveform()` take
+  `switch_image=True` and switch the pod to the image they need (loop / deep replay) instead of
+  failing, logging a warning; `ControlLoopHandle.switched_image` / `ReplayHandle.switched_image`
+  record the switch. `switch_image=False` raises a `BenchPodError` (the control loop used to reach
+  the firmware and fail there). The `benchpod_capability` marker switches the image for
+  `dac_control_loop` / `dac_deep_replay` instead of skipping. The README has a new
+  "Gateware images" section.
+- **Wiring profiles.** `Wiring` / `Signal` describe which DUT signal is on which LA channel (UART, I2C,
+  SWD, SPI roles, the target-power rail, the LA voltage and named signals) with the same schema the
+  embeddedci.com server and web UI store. `BenchPod(wiring=...)`, `bp.wiring` (argument → `BENCHPOD_WIRING`
+  file → a cloud device's stored profile → defaults), `bp.save_wiring()`, `bp.signal(name)`, the pytest
+  `benchpod_wiring` fixture and `--benchpod-wiring`. Channel arguments of `open_uart`, `capture_uart`,
+  `power_cycle_and_capture`, `flash`, `enable_i2c_sensor` and the power methods are now optional and
+  fall back to the profile; LA arguments accept role/signal names.
+- **GPIO on the LA pins and pin ownership.** `bp.gpio()` → `GpioPin` (`configure`, `set`, `high`/`low`,
+  `activate`, `read`, `wait_for`, `pulse`, `release`), `set_gpio`, `read_gpio`, `pin_levels`,
+  `wait_for_level`, `release_gpio`, `la_pins()` → `LaPinState`, and `gpio_pins()`/`configure_gpio()` to
+  claim several channels as one group (a conflict on any of them claims none). Each channel has one
+  function at a time:
+  a second one fails with `PinConflictError`, an incompatible bias resistor with `PullConflictError`.
+- **Triggered captures.** `Trigger(la, edge)` on `capture_adc`/`capture_la`/`capture_correlated`
+  (`trigger_timeout`, `TriggerTimeout`); results carry `.trigger`.
+- **Timing helpers.** `LaCapture.edge_times`, `first_edge`, `level_at`, `pulse_widths`, `frequency`,
+  `duty_cycle`, `delay`; `Capture.crossing_times`, `first_crossing`; the `Edge` option type.
+- **Power profiles.** `bp.measure_power()` and `bp.power_profile()` → `PowerProfile` /
+  `PowerProfileSession` (average/min/peak current, voltage, energy, charge, trace) from timestamped
+  sampling of the rail monitor, integrated over real time. `rate_hz` is the rate actually delivered
+  (measured) and `adc_rate_hz` the sensor's configured conversion rate: ask for 100-500 Hz and the
+  pod tracks the request to ~200 Hz, flattening near 365 Hz. The README documents the rails' current
+  limits.
+- `Capabilities.la_pins`, `gpio_read`, `capture_trigger`, `power_profile`.
+- The `hardware` marker now skips a test when no connection is configured, even if the test
+  requests no device fixture.
+
+### Fixed
+
+- `generate()` sent `offset=0.0` (8-bit code 0) by default and truncated fractional volts; it now
+  converts volts to the generator's codes for the chosen path.
+- `BENCHPOD_API_BASE` was ignored by the cloud transport when `BenchPod` was constructed directly.
+- `scope_capture(source=...)` only labelled the result; `capture_adc(source=...)` routes it.
+- The `benchpod_target` fixture ignored `--benchpod-efuse`.
+- Over USB, `target_power` sent a `target-power` verb the STM32 console doesn't have (it is
+  `power`); a delayed change over USB now raises instead of being silently ignored.
+- `LaVoltage.readback` is `None` (not 0.0 V) on boards that cannot measure the bank.
+- `fpga_image` was documented as a ~10 ms warm boot; it reprograms the FPGA (~2-3 s).
+- The `12v` DAC path was mapped as 0..12 V; it is bipolar −12..+12 V (0 V at mid-scale), so
+  `generate` and `replay` volts on it were wrong — confirmed against the firmware calibration and on
+  a pod. `generate`'s default offset on `12v` is now 0 V. (`dsp.volts_to_codes` gained
+  `path_min_v`; `dsp.dac_path_range_v` gives each path's range.)
+- A replay deeper than 2048 samples on the control-loop gateware image was accepted and then
+  produced no output (measured on a pod); it now switches the pod to the deep-replay image first
+  (or raises a `BenchPodError` with `switch_image=False`).
+- `DacOutput.path` reports the output path you asked for (`5v`), not the firmware's analog-path
+  name (`dac_5v`).
+- `replay_waveform` scaled a segments waveform for its stored path but routed the `5v` default.
+- `capture_adc(source=...)` now waits for the relays to settle before capturing.
+- Error messages no longer claim the cloud destination is CI-only or suggest OpenOCD builds that
+  lack the `cmsis_dap_tcp` backend.

embeddedci-2.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.