Repository navigation
Catalog exposed connectors and official references for M5 boards - #346
Merged
Merged
Conversation
Accept resolved endpoints with multiple GPIOs on one terminal. Allow terminal catalogs to declare that physical pitch and layout are unverified.
Describe documented Grove, rear sockets and Proto terminals. Keep library port contracts and record conflicts between official pin maps and schematics. Use logical ordering where physical geometry is unverified.
Describe the exposed HAT sockets and documented power directions. Record shared or unused GPIO terminal restrictions and differences between specifications and printed labels.
Describe documented pads, expansion buses and LCD footprints using logical terminal order where physical geometry is unverified. Preserve library port contracts and register StamPLC PORT.C as a physical connector. Leave products without published documentation unchanged and record official-source discrepancies.
Describe CoreInk sockets and Tab5 side and STAMP expansion terminals. Keep accessory connectors on their accessories and preserve library port aliases. Document power-rail connections and base conditions. Leave products without published documentation unchanged.
Represent PaperS3 with its actual HC1.25 connector and 3.3V supply while preserving logical port numbering. Record published references and power-control conditions. Leave undocumented products unchanged.
Describe documented headers, sockets, Chain ports and PoE-P4 expansion FPCs. Preserve library contracts while distinguishing physical sockets and accessory connectors. Record translated voltage levels, unpopulated clock routing and conflicts in official tables. Use logical ordering for unverified geometry and leave unpublished products unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the user-exposed connectors (headers, sockets, HAT buses, Grove ports, Proto pads, expansion FPC/BTB connectors) and links to the official product pages and schematics to the board specification catalog.
The main purpose is to make the existing validation rule complete: a pin that users can reach through a connector must not be used as an invariant detection class (
E_DETECT_CLASS_CONNECTOR). Until now only Port A, M-Bus and a few other ports were described, so most exposed pins were not protected by that rule.pitch_mm: null, logical numbering only).port_a..port_ekeep their meaning as the M5Unified pin-table contract. Physical ports without a pin-table entry use separate names (e.g. StamPLCgrove_c, Stationgrove_a2), and ports that belong to a base or sub-board stay in the accessory definitions.official_name) were checked against the official product page titles; matching names are markedofficial_name_verified, and differing spellings were corrected. Entries that describe several products (Basic/Gray/Fire, Station Bat/485) or a module sold inside a set (Atom PSRAM) are left unverified.connector.groupmarks separate sockets that form one physical set (Atom bottom headers, StopWatch rear sockets, Stamp pin rows) so tools can show them together. Each socket keeps its own terminal numbering and first pin.src/board_detect/m5/generated/) is unchanged.Not covered
Testing
extras/board_spec:npm test(216 tests, also with M5Unified absent) andnpm run checkat every commit.