embeddedci 2.13.0__tar.gz → 2.13.2__tar.gz

{embeddedci-2.13.0 → embeddedci-2.13.2}/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog — `embeddedci`
 
+## 2.13.2
+
+- Docs: `calibrate()` corrects every ADC source from firmware 3.9.3 (they share the front end) and
+  the pod accepts an offset up to 150 mV. On the LAN, `capture_adc` volts use the fit the pod now
+  reports in `status`, so they include the pod's calibrated offset.
+- The LAN API over TLS (pod firmware 3.9.3+): a network address on the default port connects to
+  8443 with TLS when the pod has it and falls back to plaintext 8080 only when 8443 refuses and
+  nothing is pinned. The pod's certificate is pinned on first use in `known_pods.json`, shared with
+  `benchpod-cli`; a different one raises `TlsPinMismatchError`. `BENCHPOD_TLS` (auto/on/off) and
+  `BENCHPOD_TLS_CA` (verify against a CA instead). New: `BenchPod.lan_tls()`,
+  `set_lan_tls_https_only()`, `regenerate_lan_tls()`, `set_lan_tls_cert()`, `LanTls`,
+  `trust_lan_tls()`, `forget_lan_tls()`, `TcpTransport.last_tls`, `TcpTransport.command_sequence()`.
+  The transport keeps the last TLS session per pod, so later connections resume in ~35 ms instead
+  of the pod's ~0.46 s full handshake.
+  The 8443 probe waits 1.5 s, past the host's 1 s SYN retransmit (a pod can leave the first SYN
+  unanswered), and a probe that times out is remembered like a refusal, so a pod without LAN TLS
+  costs one probe per process instead of 0.5 s on every command.
+
+## 2.13.1
+
+- `Capabilities.scope` is False on the digital-only board. Current firmware lists `signal` on every
+  board; it only stands for the scope on firmware without the `analog` flag.
+- `generate`, `replay`, `Waveforms.preview` and `replay_waveform` (for a waveform stored without
+  a path) default to `dac_path="3v3"` instead of `"5v"`, so a call that leaves the output out can
+  no longer put 5 V on a 3.3 V pin. Pass `dac_path="5v"` to keep the old output. With
+  `route=False` (a loopback set up with `analog_path`), `generate` and `replay` scale for the
+  output this connection last routed (`cal1` = 5 V, `cal2` = 12 V), else `5v` as before.
+
 ## 2.13.0
 
 - `generate()` on firmware 3.9.1+ (`Capabilities.generate16`) sends the volts (or microamps on

{embeddedci-2.13.0 → embeddedci-2.13.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: embeddedci
-Version: 2.13.0
+Version: 2.13.2
 Summary: BenchPod SDK and pytest plugin for EmbeddedCI hardware-in-the-loop testing
 Project-URL: Homepage, https://embeddedci.com
 Project-URL: Repository, https://github.com/embeddedci-com/embeddedci-python
@@ -292,6 +292,36 @@ power moved to the network too; see the compatibility table above.)
 | `replay()` / client-side `replay_waveform()` (streams the waveform to the pod) | yes | yes | no | yes |
 | Device lease | — | — | — | yes |
 
+### TLS on the LAN
+
+Pods with firmware 3.9.3 or later also serve the API on port 8443 with TLS. For a network address
+on the default port (`192.168.1.5`, `:8080`, a pod name) the SDK connects to 8443 first and falls
+back to plaintext 8080 only when the pod has no TLS port and nothing is pinned for it, so older
+pods keep working. `:8443` means TLS only; any other port and the USB network adapter (`usb`, a
+physical link) stay plaintext. `BENCHPOD_TLS=on|off` overrides (`auto` is the default).
+`bp.transport.last_tls` says which one the last connection used.
+
+The pod's certificate is its own, so the SDK pins its SHA-256 the first time (trust on first use)
+in `known_pods.json` next to `benchpod-cli`'s config; the CLI reads and writes the same file. A
+different certificate later raises `TlsPinMismatchError` (`addr`, `pinned`, `got`). After a
+deliberate change elsewhere, `trust_lan_tls(host, sha256=None)` pins the certificate the pod
+presents now (`sha256` only accepts that one) and `forget_lan_tls(host)` drops the pin. With
+`BENCHPOD_TLS_CA=ca.pem` the certificate and host name are verified against that CA instead (for a
+certificate you installed, signed by your own CA).
+
+```python
+bp = BenchPod("192.168.1.220")
+info = bp.lan_tls()            # LanTls: port, https_only, sessions, subject, san, sha256, ...
+bp.set_lan_tls_https_only(True)   # plaintext 8080 off on Ethernet and Wi-Fi (USB keeps it)
+bp.set_lan_tls_cert(open("pod.pem").read(), open("pod.key").read())
+bp.regenerate_lan_tls()
+```
+
+`set_lan_tls_https_only(False)`, `regenerate_lan_tls()` and `set_lan_tls_cert()` need a TLS, USB or
+cloud connection; over plaintext Ethernet or Wi-Fi the pod refuses (`PodLockedError`).
+`set_lan_tls_cert` needs a network connection (it uploads the bundle); after it and after
+`regenerate_lan_tls()` the SDK pins the new certificate for the address it used.
+
 ### Environment variables
 
 | Variable | Used when | Purpose |
@@ -304,6 +334,8 @@ power moved to the network too; see the compatibility table above.)
 | `BENCHPOD_WIRING` | no `wiring` argument / `--benchpod-wiring` / `benchpod_wiring` fixture | wiring profile file (`.json`/`.toml`), see [Wiring profile](#wiring-profile) |
 | `BENCHPOD_WIRING_SOURCE` | no `wiring_source` argument | `local` never asks embeddedci.com for the pod's stored wiring profile; `auto` (default) does, see [Wiring profile](#wiring-profile) |
 | `BENCHPOD_LIFT_DAC_LIMITS` | pytest sessions | `1` clears the pod's DAC output limits for the session and restores the same limits at the end, even when tests fail (only with the output stage switched off) |
+| `BENCHPOD_TLS` | network connections | `auto` (default), `on` or `off`: TLS to the pod's LAN API on 8443, see [TLS on the LAN](#tls-on-the-lan) |
+| `BENCHPOD_TLS_CA` | network connections over TLS | PEM file of CA certificates: verify the pod's certificate and host name instead of pinning it |
 | `BENCHPOD_STALL_TIMEOUT` | flashing | seconds with no SWD traffic before a flash attempt is aborted and retried (default 60) |
 
 ## API conventions and stability
@@ -989,11 +1021,12 @@ microvolt resolution (about 76 µV a step on `"5v"`) and `code16` is the 16-bit
 stays the nearest 8-bit level. On older firmware `code16` is `None` and the steps are 8-bit. `adc_read` routes the source (`"ext"`, `"cal1"`, `"cal2"`, `"current_in"`) and returns one averaged,
 calibrated reading; the pod refuses it while the input is still moving (e.g. a DAC left running).
 
-### Calibrating the 4-20 mA input
+### Calibrating the ADC offset
 
 `"current_in"` reads the 4-20 mA terminal (J8) across a 249 Ω resistor, so 4 mA is 0.996 V and 20 mA is
-4.98 V. Each pod is off by a few mV there. The pod can measure that offset itself and keep it in
-its flash:
+4.98 V. Each pod's analog input has its own offset, from part tolerances: anywhere from a few mV
+to about 50 mV. With J8 open the terminal is at 0 V, so the pod can measure that offset itself and
+keep it in its flash:
 
 ```python
 cal = bp.calibrate()                       # disconnect J8 first. Calibration(source, calibrated, offset, a, b, ...)
@@ -1006,10 +1039,15 @@ bp.clear_calibration()                     # back to the built-in fit
 ```
 
 Calibrate once per pod: it survives a reboot and a firmware update. The pod refuses
-(`BenchPodError`) when something is driving J8 (more than 50 mV) and keeps what it had. `a` and `b`
-are the fit the pod now uses for `current_in` (`volts = a + b * count`). Only the offset of `current_in` is
-calibrated; the other sources use the built-in fits. Needs firmware 3.4.0 (capability
-`calibrate`, `Capabilities.calibrate`).
+(`BenchPodError`) when something is driving J8 (more than 150 mV; 50 mV before firmware 3.9.3)
+and keeps what it had. `a` and `b` are the fit the pod now uses for `current_in`
+(`volts = a + b * count`).
+
+Every ADC source shares the same front end after its input switch, so from firmware 3.9.3 the pod
+takes the offset out of all of them: `adc_read` on `ext`, `cal1` and `cal2`, and `capture_adc`,
+whose `volts` use the fit the pod reports (on the LAN in `status`, through embeddedci.com in its
+capabilities). Older firmware corrects `current_in` only. Only the offset is calibrated; the gain
+uses the built-in fits. Needs firmware 3.4.0 (capability `calibrate`, `Capabilities.calibrate`).
 
 ### The 4-20 mA output
 
@@ -1176,7 +1214,12 @@ v35+ (`Capabilities.capture_trigger`).
 
 Every DAC output keeps running until stopped. The returned `DacHandle` / `ReplayHandle` is a
 context manager that stops it on exit; `bp.dac_stop()` stops any output (generator, replay or
-control loop). DAC paths are `"3v3"`, `"5v"` and `"12v"`.
+control loop). DAC paths are `"3v3"`, `"5v"` and `"12v"`. `generate`, `replay` and
+`replay_waveform` (for a waveform stored without a path) default to `"3v3"`, the lowest voltage
+output: pass the output your DUT pin tolerates, since `"5v"` and `"12v"` can drive more than a
+3.3 V pin takes. With `route=False` nothing is switched and the path only scales the volts, so the
+default is the output this connection last routed (`analog_path("cal1")` is the 5 V DAC,
+`"cal2"` the 12 V one), else `"5v"`.
 
 ```python
 from embeddedci.benchpod import Fault
@@ -1203,11 +1246,11 @@ with bp.replay(ramp, dac_path="3v3", sample_rate_hz=10_000,
     print(r.samples, r.sample_rate_hz, r.deep)
 ```
 
-* `generate(waveform, *, freq_hz, amplitude, offset=None, dac_path="5v", duration=None,
+* `generate(waveform, *, freq_hz, amplitude, offset=None, dac_path=None, duration=None,
   sample_rate_hz=None, on_capture=False)` — `sine`, `square` or `sawtooth`. `amplitude` is the peak
-  and `offset` the centre (default: mid-range of the path). The firmware builds the waveform from
+  and `offset` the center (default: mid-range of the path). The firmware builds the waveform from
   8-bit levels, so volts are quantised to full-scale / 255.
-* `replay(source, *, dac_path="5v", mapping="faithful", sample_rate_hz=None, deep=None, fault=None,
+* `replay(source, *, dac_path=None, mapping="faithful", sample_rate_hz=None, deep=None, fault=None,
   are_codes=False, on_capture=False)` — `source` is a `Capture` (its volts, at its own sample rate
   by default), a sequence of volts, or raw DAC codes with `are_codes=True`. `mapping="faithful"`
   reproduces the voltage (clipping outside the path's range), `"fit"` auto-scales. Above 2048 samples
@@ -1534,6 +1577,7 @@ Invalid arguments raise `ValueError` before anything is sent. Everything else ra
 | `TransportError` | the pod or tunnel could not be reached / talked to | |
 | `TransportTimeout` (a `TransportError` and a `TimeoutError`) | the pod or tunnel did not answer in time | |
 | `ConnectionClosedError` (a `TransportError`) | the connection ended or reset before the reply | |
+| `TlsPinMismatchError` (a `TransportError`) | the pod's TLS certificate is not the one pinned for it (see [TLS on the LAN](#tls-on-the-lan)) | `addr`, `pinned`, `got` |
 | `FirmwareError` | the pod replied with an error (e.g. "la voltage not set"); a fix the firmware spells as a raw protocol command is rewritten into the SDK call in the message, and `firmware_message` keeps the pod's own text | `firmware_message`, `cmd` |
 | `FlashError` | OpenOCD failed, is missing, or lacks the TCP backend | |
 | `TargetUnreachableError` (a `FlashError`) | the probe worked but no target answered on SWD | |
@@ -1578,7 +1622,7 @@ lease_wait=600.0, lease_ttl=120, wiring=None)`. A context manager; `close()` is
 
 | Area | Methods and properties |
 |---|---|
-| Connection and device | `ping()`, `status()`, `capabilities`, `refresh_capabilities()` (drop the cached capabilities and read them again), `close()`, `leased` (true while this client holds the cloud lease), `wiring`, `save_wiring(wiring=None)` (store a cloud device's profile on embeddedci.com), `signal(name)`, `fpga_image(image)`, `usb_cc()`, `usb_network(on=None)` (the USB network setting; `False` turns the adapter off over the USB link) |
+| Connection and device | `ping()`, `status()`, `capabilities`, `refresh_capabilities()` (drop the cached capabilities and read them again), `close()`, `leased` (true while this client holds the cloud lease), `wiring`, `save_wiring(wiring=None)` (store a cloud device's profile on embeddedci.com), `signal(name)`, `fpga_image(image)`, `usb_cc()`, `usb_network(on=None)` (the USB network setting; `False` turns the adapter off over the USB link), `lan_tls()`, `set_lan_tls_https_only(on)`, `regenerate_lan_tls()`, `set_lan_tls_cert(cert_pem, key_pem)` (the LAN API over TLS, see [TLS on the LAN](#tls-on-the-lan)) |
 | LA voltage | `set_la_voltage(volts)`, `get_la_voltage()` |
 | Power and reset | `power_on(efuse=None, *, delay=None)`, `power_off(efuse=None, *, delay=None)`, `target_power(efuse=None, *, on, delay=None)`, `target_status()`, `power_status()`, `measure_power(duration, *, efuse=None, rate_hz=500.0, keep_samples=0)`, `power_profile(*, efuse=None, rate_hz=500.0, keep_samples=4096, max_duration=60.0)`, `reset_target(*, pulse=0.1)`, `set_reset(asserted)`, `reset_state()` |
 | Flashing | `flash(...)`, `spi_flash(image, addr=0, *, erase=True, verify=True, hold_reset=False, sck=, mosi=, miso=, cs=)`, `open_spi(...)`, `open_motor_emulator(...)` |
@@ -1610,6 +1654,7 @@ few built from other shapes); `to_dict()` goes the other way where a type is sen
 | `PowerProfile` | `measure_power`, `PowerProfileSession.result` | see [Power profiles](#power-profiles) |
 | `PowerProfileSession` | `power_profile` (a context manager) | `start()`, `stop()`, `status()`, `result` |
 | `ResetState` | `reset_target`, `set_reset`, `reset_state` | `asserted`, `supported` |
+| `LanTls` | `lan_tls`, `set_lan_tls_https_only`, `regenerate_lan_tls`, `set_lan_tls_cert` | `port`, `https_only`, `sessions`, `origin` (`generated`/`user`), `key`, `subject`, `san`, `not_after`, `sha256` (what clients pin), `error` (no certificate) |
 | `UsbCcStatus` | `usb_cc` | `orientation`, `advertised`, `advertised_current` (A), `cc1_voltage`, `cc2_voltage` (V) |
 | `PullState` | `pull_state`, `set_pull` | `la`, `enabled`, `direction`, `ohms`, `available` |
 | `LaPinState` | `la_pins`, `configure_gpio` | `la`, `function`, `gpio`, `level`, `pull`, `pull_ohms`, `pull_on`, `in_use` |
@@ -1710,6 +1755,7 @@ timeout=60.0, lease_id=None)`. Errors raise `ServerApiError` (`status`), and an
 |---|---|
 | `parse_connection(raw)` | parse a connection string into a `ConnSpec` (raises `ConnectionConfigError`) |
 | `resolve_connection(connection=None)` | the same, falling back to `BENCHPOD_CONNECTION` |
+| `trust_lan_tls(host, port=8080, *, sha256=None)`, `forget_lan_tls(host, port=8080)` | pin the TLS certificate the pod presents now (returns its SHA-256), or drop the pin (see [TLS on the LAN](#tls-on-the-lan)) |
 | `make_build_reporter(*, api_base=None, audience=None, target="", name="")` | a `BuildReporter` inside GitHub Actions, else a `NoopBuildReporter` |
 | `build_panel_curve(voc_code, sharpness=4.0, points=256)`, `build_linear_curve(max_code, rising=True, points=256)`, `build_constant_curve(value_code, points=256)` | control-loop curves (see [In-fabric DAC control loop](#in-fabric-dac-control-loop)) |
 | `curve_output_at(curve, input_code)`, `input_percent_to_code(percent)` | evaluate a curve the way the gateware does; an input percentage as a code |

{embeddedci-2.13.0 → embeddedci-2.13.2}/README.md

@@ -254,6 +254,36 @@ power moved to the network too; see the compatibility table above.)
 | `replay()` / client-side `replay_waveform()` (streams the waveform to the pod) | yes | yes | no | yes |
 | Device lease | — | — | — | yes |
 
+### TLS on the LAN
+
+Pods with firmware 3.9.3 or later also serve the API on port 8443 with TLS. For a network address
+on the default port (`192.168.1.5`, `:8080`, a pod name) the SDK connects to 8443 first and falls
+back to plaintext 8080 only when the pod has no TLS port and nothing is pinned for it, so older
+pods keep working. `:8443` means TLS only; any other port and the USB network adapter (`usb`, a
+physical link) stay plaintext. `BENCHPOD_TLS=on|off` overrides (`auto` is the default).
+`bp.transport.last_tls` says which one the last connection used.
+
+The pod's certificate is its own, so the SDK pins its SHA-256 the first time (trust on first use)
+in `known_pods.json` next to `benchpod-cli`'s config; the CLI reads and writes the same file. A
+different certificate later raises `TlsPinMismatchError` (`addr`, `pinned`, `got`). After a
+deliberate change elsewhere, `trust_lan_tls(host, sha256=None)` pins the certificate the pod
+presents now (`sha256` only accepts that one) and `forget_lan_tls(host)` drops the pin. With
+`BENCHPOD_TLS_CA=ca.pem` the certificate and host name are verified against that CA instead (for a
+certificate you installed, signed by your own CA).
+
+```python
+bp = BenchPod("192.168.1.220")
+info = bp.lan_tls()            # LanTls: port, https_only, sessions, subject, san, sha256, ...
+bp.set_lan_tls_https_only(True)   # plaintext 8080 off on Ethernet and Wi-Fi (USB keeps it)
+bp.set_lan_tls_cert(open("pod.pem").read(), open("pod.key").read())
+bp.regenerate_lan_tls()
+```
+
+`set_lan_tls_https_only(False)`, `regenerate_lan_tls()` and `set_lan_tls_cert()` need a TLS, USB or
+cloud connection; over plaintext Ethernet or Wi-Fi the pod refuses (`PodLockedError`).
+`set_lan_tls_cert` needs a network connection (it uploads the bundle); after it and after
+`regenerate_lan_tls()` the SDK pins the new certificate for the address it used.
+
 ### Environment variables
 
 | Variable | Used when | Purpose |
@@ -266,6 +296,8 @@ power moved to the network too; see the compatibility table above.)
 | `BENCHPOD_WIRING` | no `wiring` argument / `--benchpod-wiring` / `benchpod_wiring` fixture | wiring profile file (`.json`/`.toml`), see [Wiring profile](#wiring-profile) |
 | `BENCHPOD_WIRING_SOURCE` | no `wiring_source` argument | `local` never asks embeddedci.com for the pod's stored wiring profile; `auto` (default) does, see [Wiring profile](#wiring-profile) |
 | `BENCHPOD_LIFT_DAC_LIMITS` | pytest sessions | `1` clears the pod's DAC output limits for the session and restores the same limits at the end, even when tests fail (only with the output stage switched off) |
+| `BENCHPOD_TLS` | network connections | `auto` (default), `on` or `off`: TLS to the pod's LAN API on 8443, see [TLS on the LAN](#tls-on-the-lan) |
+| `BENCHPOD_TLS_CA` | network connections over TLS | PEM file of CA certificates: verify the pod's certificate and host name instead of pinning it |
 | `BENCHPOD_STALL_TIMEOUT` | flashing | seconds with no SWD traffic before a flash attempt is aborted and retried (default 60) |
 
 ## API conventions and stability
@@ -951,11 +983,12 @@ microvolt resolution (about 76 µV a step on `"5v"`) and `code16` is the 16-bit
 stays the nearest 8-bit level. On older firmware `code16` is `None` and the steps are 8-bit. `adc_read` routes the source (`"ext"`, `"cal1"`, `"cal2"`, `"current_in"`) and returns one averaged,
 calibrated reading; the pod refuses it while the input is still moving (e.g. a DAC left running).
 
-### Calibrating the 4-20 mA input
+### Calibrating the ADC offset
 
 `"current_in"` reads the 4-20 mA terminal (J8) across a 249 Ω resistor, so 4 mA is 0.996 V and 20 mA is
-4.98 V. Each pod is off by a few mV there. The pod can measure that offset itself and keep it in
-its flash:
+4.98 V. Each pod's analog input has its own offset, from part tolerances: anywhere from a few mV
+to about 50 mV. With J8 open the terminal is at 0 V, so the pod can measure that offset itself and
+keep it in its flash:
 
 ```python
 cal = bp.calibrate()                       # disconnect J8 first. Calibration(source, calibrated, offset, a, b, ...)
@@ -968,10 +1001,15 @@ bp.clear_calibration()                     # back to the built-in fit
 ```
 
 Calibrate once per pod: it survives a reboot and a firmware update. The pod refuses
-(`BenchPodError`) when something is driving J8 (more than 50 mV) and keeps what it had. `a` and `b`
-are the fit the pod now uses for `current_in` (`volts = a + b * count`). Only the offset of `current_in` is
-calibrated; the other sources use the built-in fits. Needs firmware 3.4.0 (capability
-`calibrate`, `Capabilities.calibrate`).
+(`BenchPodError`) when something is driving J8 (more than 150 mV; 50 mV before firmware 3.9.3)
+and keeps what it had. `a` and `b` are the fit the pod now uses for `current_in`
+(`volts = a + b * count`).
+
+Every ADC source shares the same front end after its input switch, so from firmware 3.9.3 the pod
+takes the offset out of all of them: `adc_read` on `ext`, `cal1` and `cal2`, and `capture_adc`,
+whose `volts` use the fit the pod reports (on the LAN in `status`, through embeddedci.com in its
+capabilities). Older firmware corrects `current_in` only. Only the offset is calibrated; the gain
+uses the built-in fits. Needs firmware 3.4.0 (capability `calibrate`, `Capabilities.calibrate`).
 
 ### The 4-20 mA output
 
@@ -1138,7 +1176,12 @@ v35+ (`Capabilities.capture_trigger`).
 
 Every DAC output keeps running until stopped. The returned `DacHandle` / `ReplayHandle` is a
 context manager that stops it on exit; `bp.dac_stop()` stops any output (generator, replay or
-control loop). DAC paths are `"3v3"`, `"5v"` and `"12v"`.
+control loop). DAC paths are `"3v3"`, `"5v"` and `"12v"`. `generate`, `replay` and
+`replay_waveform` (for a waveform stored without a path) default to `"3v3"`, the lowest voltage
+output: pass the output your DUT pin tolerates, since `"5v"` and `"12v"` can drive more than a
+3.3 V pin takes. With `route=False` nothing is switched and the path only scales the volts, so the
+default is the output this connection last routed (`analog_path("cal1")` is the 5 V DAC,
+`"cal2"` the 12 V one), else `"5v"`.
 
 ```python
 from embeddedci.benchpod import Fault
@@ -1165,11 +1208,11 @@ with bp.replay(ramp, dac_path="3v3", sample_rate_hz=10_000,
     print(r.samples, r.sample_rate_hz, r.deep)
 ```
 
-* `generate(waveform, *, freq_hz, amplitude, offset=None, dac_path="5v", duration=None,
+* `generate(waveform, *, freq_hz, amplitude, offset=None, dac_path=None, duration=None,
   sample_rate_hz=None, on_capture=False)` — `sine`, `square` or `sawtooth`. `amplitude` is the peak
-  and `offset` the centre (default: mid-range of the path). The firmware builds the waveform from
+  and `offset` the center (default: mid-range of the path). The firmware builds the waveform from
   8-bit levels, so volts are quantised to full-scale / 255.
-* `replay(source, *, dac_path="5v", mapping="faithful", sample_rate_hz=None, deep=None, fault=None,
+* `replay(source, *, dac_path=None, mapping="faithful", sample_rate_hz=None, deep=None, fault=None,
   are_codes=False, on_capture=False)` — `source` is a `Capture` (its volts, at its own sample rate
   by default), a sequence of volts, or raw DAC codes with `are_codes=True`. `mapping="faithful"`
   reproduces the voltage (clipping outside the path's range), `"fit"` auto-scales. Above 2048 samples
@@ -1496,6 +1539,7 @@ Invalid arguments raise `ValueError` before anything is sent. Everything else ra
 | `TransportError` | the pod or tunnel could not be reached / talked to | |
 | `TransportTimeout` (a `TransportError` and a `TimeoutError`) | the pod or tunnel did not answer in time | |
 | `ConnectionClosedError` (a `TransportError`) | the connection ended or reset before the reply | |
+| `TlsPinMismatchError` (a `TransportError`) | the pod's TLS certificate is not the one pinned for it (see [TLS on the LAN](#tls-on-the-lan)) | `addr`, `pinned`, `got` |
 | `FirmwareError` | the pod replied with an error (e.g. "la voltage not set"); a fix the firmware spells as a raw protocol command is rewritten into the SDK call in the message, and `firmware_message` keeps the pod's own text | `firmware_message`, `cmd` |
 | `FlashError` | OpenOCD failed, is missing, or lacks the TCP backend | |
 | `TargetUnreachableError` (a `FlashError`) | the probe worked but no target answered on SWD | |
@@ -1540,7 +1584,7 @@ lease_wait=600.0, lease_ttl=120, wiring=None)`. A context manager; `close()` is
 
 | Area | Methods and properties |
 |---|---|
-| Connection and device | `ping()`, `status()`, `capabilities`, `refresh_capabilities()` (drop the cached capabilities and read them again), `close()`, `leased` (true while this client holds the cloud lease), `wiring`, `save_wiring(wiring=None)` (store a cloud device's profile on embeddedci.com), `signal(name)`, `fpga_image(image)`, `usb_cc()`, `usb_network(on=None)` (the USB network setting; `False` turns the adapter off over the USB link) |
+| Connection and device | `ping()`, `status()`, `capabilities`, `refresh_capabilities()` (drop the cached capabilities and read them again), `close()`, `leased` (true while this client holds the cloud lease), `wiring`, `save_wiring(wiring=None)` (store a cloud device's profile on embeddedci.com), `signal(name)`, `fpga_image(image)`, `usb_cc()`, `usb_network(on=None)` (the USB network setting; `False` turns the adapter off over the USB link), `lan_tls()`, `set_lan_tls_https_only(on)`, `regenerate_lan_tls()`, `set_lan_tls_cert(cert_pem, key_pem)` (the LAN API over TLS, see [TLS on the LAN](#tls-on-the-lan)) |
 | LA voltage | `set_la_voltage(volts)`, `get_la_voltage()` |
 | Power and reset | `power_on(efuse=None, *, delay=None)`, `power_off(efuse=None, *, delay=None)`, `target_power(efuse=None, *, on, delay=None)`, `target_status()`, `power_status()`, `measure_power(duration, *, efuse=None, rate_hz=500.0, keep_samples=0)`, `power_profile(*, efuse=None, rate_hz=500.0, keep_samples=4096, max_duration=60.0)`, `reset_target(*, pulse=0.1)`, `set_reset(asserted)`, `reset_state()` |
 | Flashing | `flash(...)`, `spi_flash(image, addr=0, *, erase=True, verify=True, hold_reset=False, sck=, mosi=, miso=, cs=)`, `open_spi(...)`, `open_motor_emulator(...)` |
@@ -1572,6 +1616,7 @@ few built from other shapes); `to_dict()` goes the other way where a type is sen
 | `PowerProfile` | `measure_power`, `PowerProfileSession.result` | see [Power profiles](#power-profiles) |
 | `PowerProfileSession` | `power_profile` (a context manager) | `start()`, `stop()`, `status()`, `result` |
 | `ResetState` | `reset_target`, `set_reset`, `reset_state` | `asserted`, `supported` |
+| `LanTls` | `lan_tls`, `set_lan_tls_https_only`, `regenerate_lan_tls`, `set_lan_tls_cert` | `port`, `https_only`, `sessions`, `origin` (`generated`/`user`), `key`, `subject`, `san`, `not_after`, `sha256` (what clients pin), `error` (no certificate) |
 | `UsbCcStatus` | `usb_cc` | `orientation`, `advertised`, `advertised_current` (A), `cc1_voltage`, `cc2_voltage` (V) |
 | `PullState` | `pull_state`, `set_pull` | `la`, `enabled`, `direction`, `ohms`, `available` |
 | `LaPinState` | `la_pins`, `configure_gpio` | `la`, `function`, `gpio`, `level`, `pull`, `pull_ohms`, `pull_on`, `in_use` |
@@ -1672,6 +1717,7 @@ timeout=60.0, lease_id=None)`. Errors raise `ServerApiError` (`status`), and an
 |---|---|
 | `parse_connection(raw)` | parse a connection string into a `ConnSpec` (raises `ConnectionConfigError`) |
 | `resolve_connection(connection=None)` | the same, falling back to `BENCHPOD_CONNECTION` |
+| `trust_lan_tls(host, port=8080, *, sha256=None)`, `forget_lan_tls(host, port=8080)` | pin the TLS certificate the pod presents now (returns its SHA-256), or drop the pin (see [TLS on the LAN](#tls-on-the-lan)) |
 | `make_build_reporter(*, api_base=None, audience=None, target="", name="")` | a `BuildReporter` inside GitHub Actions, else a `NoopBuildReporter` |
 | `build_panel_curve(voc_code, sharpness=4.0, points=256)`, `build_linear_curve(max_code, rising=True, points=256)`, `build_constant_curve(value_code, points=256)` | control-loop curves (see [In-fabric DAC control loop](#in-fabric-dac-control-loop)) |
 | `curve_output_at(curve, input_code)`, `input_percent_to_code(percent)` | evaluate a curve the way the gateware does; an input percentage as a code |

{embeddedci-2.13.0 → embeddedci-2.13.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "embeddedci"
-version = "2.13.0"
+version = "2.13.2"
 description = "BenchPod SDK and pytest plugin for EmbeddedCI hardware-in-the-loop testing"
 readme = "README.md"
 requires-python = ">=3.10"

{embeddedci-2.13.0 → embeddedci-2.13.2}/src/embeddedci/benchpod/__init__.py

@@ -95,6 +95,7 @@ from .errors import (
     PodLockedError,
     PullConflictError,
     TargetUnreachableError,
+    TlsPinMismatchError,
     TransportError,
     TransportTimeout,
     TriggerTimeout,
@@ -109,7 +110,8 @@ from .lease import DeviceLease
 from .lowlevel import LowLevel
 from .power import PowerProfile, PowerProfileSession
 from .replay import DacHandle, Fault, ReplayHandle, Segment
-from .results import Capture, CorrelatedCapture, LaCapture, Trigger
+from .results import Capture, CorrelatedCapture, LaCapture, LanTls, Trigger
+from .transport.tls import delete_pin as forget_lan_tls, trust_lan_tls
 from .server_api import ServerApi, ServerApiError, ServerPermissionDeniedError
 from .state import (
     AdcReading,
@@ -190,6 +192,10 @@ __all__ = [
     "dsp",
     "Capabilities",
     "Capture",
+    "LanTls",
+    "TlsPinMismatchError",
+    "trust_lan_tls",
+    "forget_lan_tls",
     "LaCapture",
     "CorrelatedCapture",
     "Trigger",

{embeddedci-2.13.0 → embeddedci-2.13.2}/src/embeddedci/benchpod/capabilities.py

@@ -285,7 +285,11 @@ class Capabilities:
         caps = status.get("caps")
         if isinstance(caps, (list, tuple)):
             names = {str(x).lower() for x in caps}
-            c.scope = c.scope or ("signal" in names or "scope" in names)
+            # "signal" stood for the scope on firmware that predates the analog flag. Current
+            # firmware lists it on every board, the digital-only one included, and names "scope"
+            # itself, so it only counts when the status has no analog flag.
+            legacy = _as_bool(status, "analog") is None
+            c.scope = c.scope or "scope" in names or (legacy and "signal" in names)
             c.analyzer = c.analyzer or ("la" in names or "analyzer" in names)
             c.serial = c.serial or ("uart" in names or "serial" in names)
             # The DAC/gateware features. Firmware advertises these in status.caps[] built from