embeddedci 0.1.0__tar.gz

embeddedci-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.11", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package + test deps
+        run: python -m pip install -e ".[dev]"
+      - name: Run tests
+        # Hardware fixtures skip automatically without a BENCHPOD_CONNECTION,
+        # so the suite stays green on runners without a pod attached.
+        run: pytest -q
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Build and check distribution
+        run: |
+          python -m pip install --upgrade build twine
+          python -m build
+          twine check dist/*

embeddedci-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Publish to PyPI
+
+# Publishes a release to PyPI when a version tag is pushed, e.g. `v0.1.0`.
+# Uses PyPI Trusted Publishing (OIDC) — no API token / secret required.
+# One-time setup on PyPI: project settings → Publishing → add a GitHub
+# trusted publisher with:
+#   owner: embeddedci-com   repo: embeddedci-python
+#   workflow: publish.yml    environment: pypi
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade build
+          python -m build
+      - name: Check artifacts render
+        run: |
+          python -m pip install --upgrade twine
+          twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # required for trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

embeddedci-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+
+# Build artifacts
+build/
+dist/
+
+# Virtualenvs
+.venv/
+venv/

embeddedci-0.1.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.

embeddedci-0.1.0/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: embeddedci
+Version: 0.1.0
+Summary: BenchPod pytest client for EmbeddedCI hardware-in-the-loop testing
+Project-URL: Homepage, https://embeddedci.com
+Project-URL: Repository, https://github.com/embeddedci-com/embeddedci-python
+Project-URL: Issues, https://github.com/embeddedci-com/embeddedci-python/issues
+Author: EmbeddedCI
+License: Apache-2.0
+License-File: LICENSE
+Keywords: benchpod,embedded,hardware-in-the-loop,openocd,pytest,swd
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pytest
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Requires-Dist: pyserial>=3.5
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# embeddedci (BenchPod pytest library)
+
+A pytest-friendly Python client for an [EmbeddedCI](https://embeddedci.com)
+**BenchPod** — the same device operations you do today with `benchpod-cli`,
+available straight from your tests:
+
+* connect to a BenchPod over **wifi/network or serial**
+* power the target on/off
+* **flash** firmware to the target and **assert ok / not ok**
+* emulate an I2C sensor (BMP280) and decode the bus traffic
+
+```python
+from embeddedci import benchpod
+
+with benchpod.BenchPod("192.168.1.213") as bp:   # or "/dev/ttyACM0", or "serial"
+    bp.ping()
+    bp.power_on(benchpod.INTERNAL)
+    result = bp.flash(
+        file="firmware.elf", target="target/stm32f1x.cfg",
+        swclk=benchpod.PIN1, swdio=benchpod.PIN2, nreset=benchpod.PIN3,
+        target_power=benchpod.INTERNAL,
+    )
+    assert result.ok
+    bp.power_off(benchpod.INTERNAL)
+```
+
+## Install
+
+```bash
+pip install embeddedci
+```
+
+Flashing shells out to **OpenOCD**, which must be on your `PATH`
+(`brew install open-ocd` / `apt install openocd`).
+
+## Named constants (no magic numbers)
+
+| Concept | Constants | Wire value |
+|---|---|---|
+| Target-power eFuse | `benchpod.INTERNAL`, `benchpod.EXTERNAL` | 1, 2 |
+| LA pins (SWCLK/SWDIO/NRESET) | `benchpod.PIN1` … `benchpod.PIN12` | 1 … 12 |
+
+Plain ints still work (`efuse=1`, `swclk=1`); they're validated and coerced.
+
+## Using it in pytest
+
+Installing the package registers a pytest plugin. Point it at a pod and use the
+fixtures:
+
+```bash
+pytest --benchpod-connection=192.168.1.213
+# or: export BENCHPOD_CONNECTION=serial
+```
+
+```python
+def test_firmware_flashes(benchpod):
+    benchpod.power_on(benchpod.INTERNAL)
+    assert benchpod.flash(
+        file="firmware.elf", target="target/stm32f1x.cfg",
+        swclk=benchpod.PIN1, swdio=benchpod.PIN2,
+    ).ok
+
+# benchpod_target powers the target on for the test and off at teardown:
+def test_with_powered_target(benchpod_target):
+    ...
+```
+
+Without a connection configured the fixtures **skip** rather than fail, so the
+suite stays green in CI runners without hardware.
+
+## Connection strings
+
+| Form | Transport |
+|---|---|
+| `192.168.1.213` or `host:8080` | wifi/network (JSON over TCP, port 8080 default) |
+| `/dev/ttyACM0`, `COM3` | serial (USB CDC-ACM console) |
+| `serial` / `usb` | serial, auto-detected by USB VID `0x2E8A` |
+
+Resolution order: explicit argument / `--benchpod-connection` →
+`benchpod_connection` ini option → `BENCHPOD_CONNECTION` env var.
+
+## Status of features
+
+| Feature | State |
+|---|---|
+| Connect (wifi + serial) | ✅ |
+| Power on/off (+ scheduled delay) | ✅ |
+| Flash + assert ok/not ok | ✅ (pure-Python OpenOCD `remote_bitbang` bridge) |
+| Emulated I2C sensor (BMP280) | ✅ wifi + serial (serial via `json` console mode) |
+| I2C bus decode (`benchpod.i2c`) | ✅ START/STOP, R/W, ACK, register reads |
+| UART capture (`capture_uart`) | ✅ wifi + serial |
+| Signal helpers (`capture`, `gpio_set`) | ✅ minimal, TCP transport only |
+
+## Emulated I2C sensor + UART capture (HIL)
+
+The pod can **pretend to be an I2C sensor** (a BMP280) on two LA channels while
+you capture the DUT's UART — so you can flash an app, power-cycle it, and assert
+on its boot output with and without the sensor present:
+
+```python
+from embeddedci import benchpod
+
+with benchpod.BenchPod("192.168.1.213") as bp:
+    bp.flash(file="app.elf", target="target/stm32f4x.cfg",
+             swclk=benchpod.PIN13, swdio=benchpod.PIN14, target_power=benchpod.INTERNAL)
+
+    # I2C is open-drain — enable the pod's pull-ups on SDA/SCL (LA1-8 only),
+    # then have the pod become a BMP280 on those lines.
+    bp.enable_pullup(benchpod.PIN1, benchpod.PIN2)
+    bp.enable_i2c_sensor(benchpod.Sensor.BMP280, sda=benchpod.PIN1, scl=benchpod.PIN2,
+                         temperature_c=22.5, pressure_pa=101000)
+
+    # Power-cycle while capturing UART so the boot banner lands in the window.
+    cap = bp.power_cycle_and_capture(rx=benchpod.PIN5, tx=benchpod.PIN6,
+                                     delay=1.5, duration=6.0, until=r"APP_OK")
+    assert cap.match("APP_OK")
+    assert cap.match(r"chip id match=0x58|bmp280_detected=yes")
+```
+
+How the power-cycle works: `power_cycle_and_capture` powers the eFuse off, then
+schedules a power-on `delay` seconds out (a **pod-side timer** via
+`target_power`'s `delay_ms`), then enters UART capture — so the scheduled
+power-on, and the DUT's boot output, land *inside* the capture window. This
+sidesteps the firmware's one-connection-at-a-time limit (you can't send a
+power-on while the UART proxy owns the link).
+
+`rx` is the LA channel the pod **samples** (wire the DUT's TX here); `tx` is the
+channel the pod **drives** (DUT's RX).
+
+> **Serial gets the full JSON API too.** The pod's TCP API is JSON; the serial
+> console is normally text-only. The firmware exposes a `json` console command
+> that switches the console into the same JSON dispatcher (exit with
+> `{"cmd":"json_exit"}`). The serial transport enters/leaves this mode
+> automatically, so `enable_i2c_sensor(...)`, `i2c_sensor_la_decoded(...)`, etc.
+> work over serial as well as wifi — no code change in your test.
+
+### Decode the I2C bus
+
+While the pod serves the emulated sensor it also samples the SDA/SCL lines. The
+`benchpod.i2c` module turns that raw capture into decoded transactions, so you
+can assert what the DUT *actually did* on the wire — not just that it booted:
+
+```python
+from embeddedci import benchpod
+from embeddedci.benchpod import i2c
+
+with benchpod.BenchPod("192.168.1.213") as bp:
+    bp.enable_i2c_sensor(benchpod.Sensor.BMP280, sda=benchpod.PIN7, scl=benchpod.PIN8)
+    bp.power_off(benchpod.INTERNAL); bp.power_on(benchpod.INTERNAL)  # DUT boots & probes
+
+    txns = bp.i2c_sensor_la_decoded(samples=4096, sample_rate_mhz=0.5)
+    print(i2c.format_transactions(txns))
+    # -> S 0x76W+ 0xD0+ Sr 0x76R+ 0x58- P   (write reg 0xD0, read chip id 0x58)
+    assert i2c.read_register(txns, 0x76, 0xD0) == [0x58]
+```
+
+The decoder handles START/repeated-START/STOP, the R/W bit, per-byte ACK/NACK,
+and the common "write register pointer, then read" pattern (`read_register`). It
+works on a `(scl, sda)` stream too (`i2c.decode_samples`) and ships a waveform
+synthesizer (`i2c.synthesize`) so you can build and decode traces with no
+hardware — see [`tests/test_i2c_decode.py`](tests/test_i2c_decode.py).
+
+### Getting started: one clean HIL test
+
+The "hello world" of EmbeddedCI HIL — flash → emulate a BMP280 → power-cycle →
+assert on UART — is in [`examples/test_bmp280.py`](examples/test_bmp280.py), with
+a wiring table and run command at the top:
+
+```bash
+pytest examples/test_bmp280.py \
+    --benchpod-connection=/dev/tty.usbserial-0001 \   # or an IP for wifi
+    --benchpod-firmware=path/to/your_app.elf
+```
+
+It uses the plugin's `benchpod`, `pins` and `firmware` fixtures and the
+`@pytest.mark.hardware` marker, and **skips automatically** without a connection.
+The pin map comes from `--benchpod-swclk/-swdio/-nreset/-uart-rx/-uart-tx/-i2c-sda/-i2c-scl/-efuse`
+options (sensible defaults) so tests aren't hardcoded to your wiring. See
+[`examples/README.md`](examples/README.md) for the full wiring table.
+
+A more thorough multi-case version (present/absent + I2C-bus decode) lives in
+[`tests/examples/test_bmp280_hil.py`](tests/examples/test_bmp280_hil.py).
+
+## Releasing (maintainers)
+
+Releases publish to [PyPI](https://pypi.org/project/embeddedci/) automatically
+via [`.github/workflows/publish.yml`](.github/workflows/publish.yml) using PyPI
+**Trusted Publishing** (OIDC) — no API token or secret is stored in GitHub.
+
+**One-time setup** on PyPI (or first via [TestPyPI](https://test.pypi.org)):
+project → *Settings → Publishing → Add a pending publisher* with
+owner `embeddedci-com`, repo `embeddedci-python`, workflow `publish.yml`,
+environment `pypi`.
+
+To cut a release:
+
+```bash
+# 1. bump the version in pyproject.toml (e.g. 0.1.0 -> 0.1.1), commit it
+# 2. tag and push — the tag must match the version
+git tag v0.1.1
+git push origin v0.1.1
+```
+
+The tag push builds the sdist + wheel, runs `twine check`, and publishes. The
+git tag is the source of truth for what shipped; keep it equal to the
+`version` in `pyproject.toml`.
+
+Build and verify locally before tagging:
+
+```bash
+python -m pip install build twine
+python -m build           # -> dist/embeddedci-*.tar.gz and *.whl
+twine check dist/*
+```