Skip to content

board_spec: document the exposed connector conventions, connector types, accessories, the CLI and the editor - #352

Merged
lovyan03 merged 5 commits into
m5stack:developfrom
ainyan03:board_spec_connector_docs
Oct 13, 2026
Merged

lovyan03 merged 5 commits into
m5stack:developfrom
ainyan03:board_spec_connector_docs

Conversation

@ainyan03

Copy link
Copy Markdown
Contributor

Summary

Documentation only (extras/board_spec/README.md, no code or catalog data changed).

  • Exposed connectors: the conventions used when the connectors of every board were cataloged (Catalog exposed connectors and official references for M5 boards #346): write only values confirmed by official sources, port_a to port_e as the M5Unified pin-table contract, logical terminal types for undocumented layouts, multi_gpio, group, and what is not cataloged.
  • Connector types and Accessories: what the files under connector_types/ and accessories/ hold (layout, positions, standards, rails, verified.layout; attaches, host_pins, settings) and how accessory wiring reaches the compositions and the M5Unified pin table.
  • Directory map and command list: every directory that exists today, every cli/spec.js command with its output location, and what check verifies (formatting plus every generated output being present and current).
  • Editor: moved out of the detection notes into its own section, with the page layout from Board spec editor: page list layout and readable connector pinouts #347.

node cli/spec.js check and npm test (236 tests) pass; the README is not an input of either.

… catalog

Describe how connectors, official links and conn roles relate to detect_class, that port_a..port_e are the M5Unified pin-table contract, and how to represent undocumented placement, shared terminals and paired sockets.
@lovyan03
lovyan03 merged commit 87cf03a into m5stack:develop Oct 13, 2026
26 checks passed
@ainyan03
ainyan03 deleted the board_spec_connector_docs branch October 13, 2026 06:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants