Metadata-Version: 2.3
Name: board-pinout
Version: 0.2.0a1
Summary: Vendor-neutral schema, resolve, editor, and Sphinx widget for interactive board pinouts
Project-URL: Homepage, https://github.com/malto101/board-pinout
Project-URL: Repository, https://github.com/malto101/board-pinout.git
Project-URL: Issues, https://github.com/malto101/board-pinout/issues
Author-email: Dhruv Menon <reach.dhruvmenon@gmail.com>
License:                                  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 2026 Dhruv Menon
        
           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.
Keywords: hardware,jsonschema,pinout,sphinx-extension
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: jsonschema>=4.18
Requires-Dist: pyyaml>=6.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Provides-Extra: fast
Requires-Dist: fastjsonschema>=2.16; extra == 'fast'
Provides-Extra: sphinx
Requires-Dist: sphinx>=6.0; extra == 'sphinx'
Description-Content-Type: text/markdown

# Board Pinout

Author and publish interactive board pinout diagrams from YAML. The project
includes a visual editor for placing parts, a Python CLI for validating and
resolving board data, and a Sphinx extension that embeds the interactive
viewer in any Sphinx documentation site.

> **Status:** Alpha (`0.2.0`). The hosted documentation and editor are available
> at the links below, and the repository includes a complete ESP32-S3 example.

![Board Pinout preview](gif/board-pinout-preview.gif)

**Hosted editor:** <https://malto101.github.io/board-pinout/editor/>

**Documentation:** <https://malto101.github.io/board-pinout/>

The editor creates board `pinout.yaml` files. Boards using `mux_source: soc` also
need a separate SoC pad table, conventionally stored in Zephyr at
`soc/<vendor>/<soc>/doc/pinmux/<soc>.yaml`.

> **Note:** The editor is an authoring aid; validate exported files with
> `board-pinout validate` and `board-pinout soc-pads validate` before committing.


The GIF is a compact visual preview. For the interactive version, build the
[local Sphinx demo](#try-the-interactive-demo) or run the editor.

## What it does

A board pinout is more useful when the image, physical parts, pads, and
software-facing information can be explored together. Board Pinout provides:

- a normalized YAML format for board faces, underlays, parts, pins, headers,
  mux functions, and optional software/Zephyr metadata;
- a visual editor that imports and exports `pinout.yaml` files;
- schema and structural validation before the data reaches documentation;
- type references, `based_on` inheritance, default children, and automatic
  pin-array synthesis during resolution;
- an interactive Sphinx widget with search, marker selection, pan/zoom/rotate,
  hierarchical drill-down, and peripheral filtering; and
- packaged schema, base types, JavaScript, and CSS, so a consuming docs tree
  does not need to copy a private `_data` directory.

Boards may use `mux_source: soc` to join a reusable SoC pad table at resolve time.
Provide the table with `--soc-tables` (or the Sphinx search configuration), and
validate it separately with `board-pinout soc-pads validate`. Inline mux entries
remain supported for boards that do not use a SoC table.

## Choose your path

| You want to… | Start here |
| --- | --- |
| See a working diagram | [Try the interactive demo](#try-the-interactive-demo) |
| Place parts visually | [Use the editor](#use-the-editor) |
| Embed a diagram in Sphinx | [Integrate with Sphinx](#integrate-with-sphinx) |
| Add a board or custom part | [Author board data](#author-board-data) |
| Modify the project | [Develop the project](#develop-the-project) |

## Try the interactive demo

The checked-in ESP32-S3 DevKitC example includes both its `pinout.yaml` and
matching board image. Build the Sphinx demo from the repository root:

```bash
python -m pip install -e ".[sphinx]"
sphinx-build -b html docs docs/_build/html
```

Open `docs/_build/html/index.html`. The page uses the real
`board_pinout.sphinx_ext` directive and the same widget that a consuming Sphinx
site loads. It demonstrates underlay copying, resolved parts, nested groups,
mux data, search, and the documentation-style detail panel.

The source example is at:

```text
docs/example/esp32s3_devkitc/pinout.yaml
docs/example/esp32s3_devkitc/esp32s3_devkitc.webp
```

For a visual authoring preview, start the editor instead:

```bash
cd editor
npm install
npm run dev
```

Open <http://localhost:5173>, then choose **ESP32 sample**. This loads the
matching YAML and WebP from `editor/public/examples/esp32s3_devkitc/`.

## Integrate with Sphinx

Install this checkout into the environment used to build your documentation:

```bash
python -m pip install ".[sphinx]"
```

For an editable checkout during development:

```bash
uv pip install -e ".[dev,sphinx]"
```

Enable the extension in `conf.py`:

```python
extensions = [
    "board_pinout.sphinx_ext",
]
```

Place a `pinout.yaml` where the extension can find it and add the directive to
an RST page:

```rst
.. board-pinout::
```

You can select a board, face, or file explicitly:

```rst
.. board-pinout:: my_board
   :face: top
   :file: pinout.yaml
```

By default, the extension searches beside the current page and then uses these
globs under the Sphinx source directory:

```python
board_pinout_search_globs = [
    "**/doc/pinout.yaml",
    "**/pinout.yaml",
]
```

If your boards live elsewhere, set `board_pinout_src_root` and adjust the
globs. Types and static assets default to the copies shipped in the package;
`board_pinout_types_path` and `board_pinout_static_path` are available when a
site needs overrides.

For a large documentation tree, externalize the resolved JSON payload instead
of embedding it in every HTML page:

```python
board_pinout_payload_mode = "external"
```

The default `"inline"` mode is simplest and remains compatible with small
sites.

## Author board data

A minimal board document looks like this:

```yaml
schema_version: "1.0"
board: my_board

faces:
  top:
    underlay: img/my_board.webp
    underlay_rotation: 0
    children:
      - id: usb
        ref: usb_c
        silk: USB-C
        point: [0.20, 0.50]
```

Important authoring rules:

- `board` and at least one `faces` entry are required.
- Each face has a `children` list; every top-level part needs a `point`.
- Part IDs are unique and a part provides either `ref` or `kind`.
- `point` and `label_offset` use normalized `[x, y]` coordinates in underlay
  space, normally between `0` and `1`.
- `node_scale` and `label_scale` are optional unitless display multipliers.
  They default to `1`; `node_scale` changes the marker geometry and
  `label_scale` changes the label text and box. Reusable type values are
  inherited by parts, while an instance value overrides its type. Supported
  ranges are `0.5..3` for nodes and `0.75..2` for labels.
- `underlay` is relative to `pinout.yaml`. Keep the image beside the YAML,
  commonly in `doc/img/`; WebP, PNG, SVG, and JPEG are supported.
- `underlay_rotation` is optional and uses 90-degree steps.

The editor writes the underlay path into YAML but does not embed or copy the
image. Commit the image at that path alongside the board YAML. During a Sphinx
build, the extension copies an existing underlay into the generated site and
warns if it cannot find the file.

Validate and resolve a board from the checkout with:

```bash
uv run board-pinout validate schema/fixtures/nrf_shaped.yaml
uv run board-pinout resolve \
  types/ schema/fixtures/nrf_shaped.yaml \
  -o /tmp/resolved.json --summary /tmp/summary.json
```

`resolve` expands type references and `based_on` chains, merges defaults, and
synthesizes children for pin arrays.

### Add reusable and board-specific parts

Use a packaged type by referencing it from a part:

```yaml
- id: debug
  ref: header_2x5_swd
  silk: SWD
  point: [0.15, 0.88]
```

A board- or vendor-specific part belongs in that board's `types_inline`, not in
the shared package library:

```yaml
types_inline:
  expansion_header:
    kind: pin_array
    based_on: header_pin_array
    rows: 2
    cols: 10
    numbering: row_major
    description: Board-specific 2x10 header

faces:
  top:
    children:
      - id: expansion
        ref: expansion_header
        silk: EXPANSION
        point: [0.55, 0.30]
```

A `pin_array` without explicit `children` gets synthesized pins from `rows`,
`cols`, `numbering`, and optional `pin_ids`. Synthesized IDs are prefixed with
the parent ID. A type appears in the editor's **New part** palette when it has
an `editor:` block; use `editor.palette: false` for a type that should remain
available to resolution but hidden from the palette.

### Add pad and mux information

A board can identify its SoC and describe how its pads are used:

```yaml
soc: esp32s3
mux_source: inline
faces:
  top:
    children:
      - id: gpio4
        kind: pin
        silk: "4"
        pad: GPIO4
        point: [0.30, 0.25]
        mux:
          - function: I2C1_SDA
            peripheral: i2c1
            signal: SDA
            mode: 0
```

Peripheral filtering in the widget is derived from the effective `mux` entries.
For reusable SoC data, set `mux_source: soc` and keep the board-specific table
separate:

```yaml
schema_version: "1.1"
board: my_board
soc: my_soc
mux_source: soc
faces:
  top:
    children:
      - id: gpio4
        kind: pin
        pad: GPIO4
        point: [0.30, 0.25]
```

Resolve it with `--soc-tables path/to/soc-tables`; the canonical Zephyr layout is
`soc/<vendor>/<soc>/doc/pinmux/<soc>.yaml`.

## Use the editor

Start it from the repository root:

```bash
cd editor
npm install
npm run sync-types
npm run dev
```

`npm run dev` also synchronizes the generated type catalog. In the browser:

1. Choose **ESP32 sample**, or use **Import** for an existing YAML file.
2. Use **Underlay** to upload or reselect the board image.
3. Add parts from **New part** and choose a grid for pin arrays.
4. Drag marker circles to set points and drag labels independently.
5. Nest, group, rename, duplicate, or delete parts in the parts tree.
6. Edit board name, SoC, mux source, and underlay rotation in **Board**.
7. Add pad, mux, notes, and other part metadata in **Selected**.
8. Use **Preview** to inspect the docs-style top-level view and drill down.
9. Choose **Export** to download `pinout.yaml`.

The editor also provides grid/object snapping, pan/zoom/rotate, focus, leader
vertices, undo/redo, search, and peripheral grouping. Importing YAML does not
load a local image into the browser automatically; use **Underlay** to upload
or reselect that image before editing. Export still only records its path, so
ship the image beside the YAML.

## What the viewer shows

When the corresponding data is present, the Sphinx widget provides:

- a board underlay with normalized markers and readable labels;
- pan, scroll-wheel zoom, focus, reset, and 90-degree rotation controls;
- click-to-highlight markers and hierarchical breadcrumb navigation;
- expandable groups and pin-array child grids;
- search over part ID, silk, pad, reference, kind, notes, compatible values,
  and mux fields;
- peripheral filtering with matching pin/signal lists and automatic focus;
- part details including ID, silk, kind, ref, pad, net, and gating metadata;
- mux peripheral, signal, function, and mode details; and
- optional Zephyr status, devicetree node, compatible, binding, and notes.

Electrical correctness is not inferred from the schema: the viewer displays
what the board YAML author provides. Missing software status values are shown
as `unknown`.

## Develop the project

Set up the Python package and its development dependencies:

```bash
uv sync --extra dev --extra sphinx
uv run pytest
uv run ruff check src/ tests/
uv run board-pinout --help
```

Useful focused commands:

```bash
uv run board-pinout validate schema/fixtures/nrf_shaped.yaml
uv run board-pinout resolve types/ schema/fixtures/nrf_shaped.yaml \
  -o /tmp/nrf-resolved.json
```

The editor uses Vite and its source is under `editor/src/`. After changing the
editor or widget source, rebuild the checked-in widget bundle:

```bash
cd editor
npm install
npm run sync-types
npm run build
npm run build:widget
```

`npm run build:widget` writes the production IIFE to
`src/board_pinout/static/board_pinout/board-pinout.js`. The source modules live
under `src/board_pinout/static/board_pinout/js/`; do not hand-edit the bundle.

For a Zephyr checkout, validate board pinouts with:

```bash
ZEPHYR_BASE=/path/to/zephyr ./scripts/sync_to_zephyr.sh
```

The standalone board preview script is debug-only and requires an external
Zephyr board:

```bash
ZEPHYR_BASE=/path/to/zephyr \
  ./scripts/preview_board.sh --debug nrf54l15dk
```

## Package contents

A built wheel includes the Python package, widget CSS/JavaScript, JSON Schema,
and base types. The package metadata targets Python 3.10 or newer. The Sphinx
extra installs Sphinx; the optional `fast` extra installs `fastjsonschema` for
faster validation on large docs trees.

For deeper reference, see:

- [`schema/board.schema.json`](schema/board.schema.json) — authoritative board schema
- [`schema/fixtures/nrf_shaped.yaml`](schema/fixtures/nrf_shaped.yaml) — advanced YAML example
- [`editor/README.md`](editor/README.md) — editor-specific details
- [`PYTHON_PKG.md`](PYTHON_PKG.md) — package and Sphinx notes
