Add electronics README with project descriptions and display hat link#347
Conversation
…ignerPlus display hat Agent-Logs-Url: https://github.com/3rdIteration/seedsigner/sessions/9f823fc2-6d1a-4a1f-8f24-9735c2d8fdbc Co-authored-by: 3rdIteration <2230318+3rdIteration@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds top-level documentation for the electronics/ folder to help users understand the available hardware projects and where to find the related design files.
Changes:
- Introduces
electronics/README.mddescribing the three hardware projects in the folder. - Adds an external link to the SeedSignerPlus Display Hat design files hosted in
seedsigner-hardware. - Notes the mix of CAD/source formats used across the projects (KiCad, CircuitMaker, EasyEDA).
| @@ -0,0 +1,17 @@ | |||
| # Electronics | |||
|
|
|||
| This folder contains hardware design files for SeedSigner electronics projects. Source files are provided in a range of formats including KiCad, Circuitmaker, and EasyEDA. | |||
There was a problem hiding this comment.
"Circuitmaker" appears to be a capitalization typo; the product name is typically "CircuitMaker". Consider updating the casing for accuracy/consistency alongside KiCad and EasyEDA.
| This folder contains hardware design files for SeedSigner electronics projects. Source files are provided in a range of formats including KiCad, Circuitmaker, and EasyEDA. | |
| This folder contains hardware design files for SeedSigner electronics projects. Source files are provided in a range of formats including KiCad, CircuitMaker, and EasyEDA. |
|
|
||
| ## SEC1210 Smartcard Hat | ||
|
|
||
| The [`SmartcardHat/`](SmartcardHat/) folder contains the design files for a CCID/PCSC compatible Smart Card interface hat that connects over UART through a standard Raspberry Pi GPIO header (using the SEC1210-URT or SEC1210-UR2 serial interface). It also provides a USB-C socket for powering the device. Available in full-sized card, SIM-sized card, and dual-slot variants. See the [SmartcardHat readme](SmartcardHat/readme.md) for full details. |
There was a problem hiding this comment.
The smart card standards acronym is usually written "PC/SC" (often in "CCID/PC/SC-compatible") rather than "PCSC". Updating this would make the documentation more technically accurate/searchable.
| The [`SmartcardHat/`](SmartcardHat/) folder contains the design files for a CCID/PCSC compatible Smart Card interface hat that connects over UART through a standard Raspberry Pi GPIO header (using the SEC1210-URT or SEC1210-UR2 serial interface). It also provides a USB-C socket for powering the device. Available in full-sized card, SIM-sized card, and dual-slot variants. See the [SmartcardHat readme](SmartcardHat/readme.md) for full details. | |
| The [`SmartcardHat/`](SmartcardHat/) folder contains the design files for a CCID/PC/SC-compatible Smart Card interface hat that connects over UART through a standard Raspberry Pi GPIO header (using the SEC1210-URT or SEC1210-UR2 serial interface). It also provides a USB-C socket for powering the device. Available in full-sized card, SIM-sized card, and dual-slot variants. See the [SmartcardHat readme](SmartcardHat/readme.md) for full details. |
|
|
||
| The SeedSignerPlus display hat design files are maintained in a separate repository: | ||
|
|
||
| 👉 [**seedsigner-hardware — SeedSignerPlus Display Hat**](https://github.com/3rdIteration/seedsigner-hardware/tree/main/display_hats/plus_hat) |
There was a problem hiding this comment.
The "👉" symbol may not render well in all Markdown viewers and can be noisy for screen readers. Consider replacing it with a standard Markdown list item or a simple "Link:" line for better accessibility/portability.
| 👉 [**seedsigner-hardware — SeedSignerPlus Display Hat**](https://github.com/3rdIteration/seedsigner-hardware/tree/main/display_hats/plus_hat) | |
| - [**seedsigner-hardware — SeedSignerPlus Display Hat**](https://github.com/3rdIteration/seedsigner-hardware/tree/main/display_hats/plus_hat) |
* Create README.md * Create production files * Delete SeedSigner+ Smartcard combo hat/production files * Add files from XMRStreet Plus initial kicad import * Update .gitignore * Remove WIP Kicad version for now * Add electronics README with project descriptions and display hat link (#347) * Initial plan * Add electronics/README.md with project descriptions and link to SeedSignerPlus display hat Agent-Logs-Url: https://github.com/3rdIteration/seedsigner/sessions/9f823fc2-6d1a-4a1f-8f24-9735c2d8fdbc Co-authored-by: 3rdIteration <2230318+3rdIteration@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: 3rdIteration <2230318+3rdIteration@users.noreply.github.com> * Remove placeholder folder-name/ directory with empty README.md Agent-Logs-Url: https://github.com/3rdIteration/seedsigner/sessions/d6e6c89b-e871-4fe7-a10a-a4dbcacb72c2 Co-authored-by: 3rdIteration <2230318+3rdIteration@users.noreply.github.com> --------- Co-authored-by: xmrstreetstore <info@xmrstreet.store> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: 3rdIteration <2230318+3rdIteration@users.noreply.github.com>
Description
Adds
electronics/README.mddescribing the three hardware projects in the folder:SmartcardHat/) — CCID/PCSC smart card interface via UART with USB-C powerSeedSigner+ Smartcard combo hat/) — integrated single-board combining bothNotes that source files span KiCad, Circuitmaker, and EasyEDA formats.
No screenshots — documentation-only change.
This pull request is categorized as a:
Checklist
pytestand made sure all unit tests pass before sumbitting the PRIf you modified or added functionality/workflow, did you add new unit tests?
I have tested this PR on the following platforms/os: