Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add KiCad files & example projects
Browse files Browse the repository at this point in the history
leah-splitkb committed Dec 1, 2023
1 parent 262e183 commit 82a1dd2
Showing 25 changed files with 13,659 additions and 2 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
![Myriad logo](assets/images/logo.png)

# Myriad

This repository stores the public documentation for the Myriad System.
This repository stores the public documentation for the Myriad System. Did you see any mistakes? Feel free to submit a pull request!

# Symbols & footprints
You can find KiCad symbols and footprints [here](assets/kicad/).

# Example projects
You can find some example projects [here](assets/example_projects/).
18 changes: 18 additions & 0 deletions assets/example_projects/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Myriad Example projects
## protoboard_??x??
![Proto board](renders/protoboard.png)

Simple prototyping board. Exposes basic GPIO functionality on the bottom two rows, while providing 3-long strips on the rest of the card. You can use this to build your own simple modules, without having to get a PCB manufactured.

## breakout_22x30
![Breakout board](renders/breakout.png)

Breakout board. Exposes all currently-available Myriad pins, making it ideal if you want to try connecting external hardware to it.

# Licensing

These files are available for **non-commercial use only**. See [https://myriad.splitkb.com/specification/terms_of_use.html](https://myriad.splitkb.com/specification/terms_of_use.html) for more information.

# More information

Are you looking for the specification, or just want to know more about the Myriad system in general? Visit [https://myriad.splitkb.com/](https://myriad.splitkb.com/)!
30 changes: 30 additions & 0 deletions assets/example_projects/breakout_22x30/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# For PCBs designed using KiCad: https://www.kicad.org/
# Format documentation: https://kicad.org/help/file-formats/

# Temporary files
*.000
*.bak
*.bck
*.kicad_pcb-bak
*.kicad_sch-bak
*-backups
*.kicad_prl
*.sch-bak
*~
_autosave-*
*.tmp
*-save.pro
*-save.kicad_pcb
fp-info-cache

# Netlist files (exported from Eeschema)
*.net

# Autorouter files (exported from Pcbnew)
*.dsn
*.ses

# Exported BOM files
*.xml
*.csv

1,685 changes: 1,685 additions & 0 deletions assets/example_projects/breakout_22x30/breakout_22x30.kicad_pcb

Large diffs are not rendered by default.

433 changes: 433 additions & 0 deletions assets/example_projects/breakout_22x30/breakout_22x30.kicad_pro

Large diffs are not rendered by default.

1,871 changes: 1,871 additions & 0 deletions assets/example_projects/breakout_22x30/breakout_22x30.kicad_sch

Large diffs are not rendered by default.

30 changes: 30 additions & 0 deletions assets/example_projects/protoboard_22x30/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# For PCBs designed using KiCad: https://www.kicad.org/
# Format documentation: https://kicad.org/help/file-formats/

# Temporary files
*.000
*.bak
*.bck
*.kicad_pcb-bak
*.kicad_sch-bak
*-backups
*.kicad_prl
*.sch-bak
*~
_autosave-*
*.tmp
*-save.pro
*-save.kicad_pcb
fp-info-cache

# Netlist files (exported from Eeschema)
*.net

# Autorouter files (exported from Pcbnew)
*.dsn
*.ses

# Exported BOM files
*.xml
*.csv

2,189 changes: 2,189 additions & 0 deletions assets/example_projects/protoboard_22x30/protoboard_22x30.kicad_pcb

Large diffs are not rendered by default.

434 changes: 434 additions & 0 deletions assets/example_projects/protoboard_22x30/protoboard_22x30.kicad_pro

Large diffs are not rendered by default.

1,103 changes: 1,103 additions & 0 deletions assets/example_projects/protoboard_22x30/protoboard_22x30.kicad_sch

Large diffs are not rendered by default.

30 changes: 30 additions & 0 deletions assets/example_projects/protoboard_30x40/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# For PCBs designed using KiCad: https://www.kicad.org/
# Format documentation: https://kicad.org/help/file-formats/

# Temporary files
*.000
*.bak
*.bck
*.kicad_pcb-bak
*.kicad_sch-bak
*-backups
*.kicad_prl
*.sch-bak
*~
_autosave-*
*.tmp
*-save.pro
*-save.kicad_pcb
fp-info-cache

# Netlist files (exported from Eeschema)
*.net

# Autorouter files (exported from Pcbnew)
*.dsn
*.ses

# Exported BOM files
*.xml
*.csv

4,235 changes: 4,235 additions & 0 deletions assets/example_projects/protoboard_30x40/protoboard_30x40.kicad_pcb

Large diffs are not rendered by default.

434 changes: 434 additions & 0 deletions assets/example_projects/protoboard_30x40/protoboard_30x40.kicad_pro

Large diffs are not rendered by default.

1,103 changes: 1,103 additions & 0 deletions assets/example_projects/protoboard_30x40/protoboard_30x40.kicad_sch

Large diffs are not rendered by default.

Binary file added assets/example_projects/renders/breakout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/example_projects/renders/protoboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions assets/kicad/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
If you're using KiCad, you can add `footprints/` as a footprint library, and `symbols/myriad.kycad_sym` as a symbol library.

![Kicad paths](renders/paths.png)

# Symbols
## Myriad_Module_Connector
![Myriad symbol](renders/myriad_symbol.png)

Myriad Module symbol. See [Electrical Specification](https://myriad.splitkb.com/specification/electrical.html) and [Pinout](https://myriad.splitkb.com/specification/pinout.html) for more information. They can be paired with the [Myriad_Module_??x??mm](#Myriad_Module_??x??mm) and [Myriad_Module_Edge](Myriad_Module_Edge) footprints.

# Myriad_Keyboard_Connector
Same as Myriad_Module_connector, but from the keyboard side. It is designed for use with the [Myriad_Socket](#Myriad_Socket) footprint

# ZD24C02A-STGMT
![Zetta symbol](renders/eeprom_symbol.png)

[Zetta ZD24CxxA](https://www.lcsc.com/product-detail/EEPROM_Zetta-ZD24C08A-STGMT_C2896640.html), a cheap generic I2C EEPROM which can be used for [card identification](https://myriad.splitkb.com/specification/card_identification/). Uses the regular KiCad-provided SOT-23-5 footprint.

# Footprints
## Myriad_Module_??x??mm
![Module footprint](renders/module_footprint.png)

Premade module footprints including the connector and relevant edge cuts are available for the [common module dimensions](https://myriad.splitkb.com/specification/physical.html). They use the [Myriad_Module_Connector](Myriad_Module_Connector) symbol.

## Myriad_Module_Edge
![Edge footprint](renders/edge_footprint.png)

If you're making a module which does not follow the standard sizing, we also provide a separate footprint for just the edge connector. This also uses the [Myriad_Module_Connector](Myriad_Module_Connector) symbol. Don't forget to add the plated through-hole for screwing it down!

## Myriad_Graphic_{Length/Width}-{S/M/L}
![Size indicator footprint](renders/marker_footprint.png)

These markers can be placed on the module to indicate the standard size they are using.

## Myriad_Socket
![Socket footprint](TODO)

If you're designing a Myriad-compatible keyboard, you can use this footprint to easily get the right dimensions. It is built around the [Myriad_Keyboard_Connector](#Myriad_Keyboard_Connector) footprint and uses the [TE Connectivity 2199230-8](https://eu.mouser.com/ProductDetail/TE-Connectivity/2199230-8) connector.

It comes with a Myriad logo, outlines of the Small & Medium cards on the `User.Drawings` layer, and offset markers for the `Myriad_Socket_Standoff` footprints.

## Myriad_Socket_Standoff_??mm

Used in combination with the `Myriad_Socket` footprint. Place only the 30mm one for Small cards, and use both 30mm and 40mm for Medium cards and above. If the marker on the `User.Drawings` layer matches up with the +00 line of the Myriad_Socket footprint, they are in the right spot.

# Licensing

See [https://myriad.splitkb.com/specification/terms_of_use.html](https://myriad.splitkb.com/specification/terms_of_use.html).

# More information

Are you looking for the specification, or just want to know more about the Myriad system in general? Visit [https://myriad.splitkb.com/](https://myriad.splitkb.com/)!
Binary file added assets/kicad/renders/edge_footprint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/kicad/renders/eeprom_symbol.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/kicad/renders/marker_footprint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/kicad/renders/module_footprint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/kicad/renders/myriad_symbol.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/kicad/renders/myrtest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/kicad/renders/paths.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion specification/terms_of_use.md
Original file line number Diff line number Diff line change
@@ -5,4 +5,6 @@ parent: Specification
nav_order: 6
---

TODO TODO TODO insert license here
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

These files are available for non-commercial use only. You explicitly have permission to make objects with these files for yourself, friends, family and coworkers. If you'd like to sell objects made from these files, please [get in touch](mailto:support@splitkb.com?subject=Myriad%20licensing).

0 comments on commit 82a1dd2

Please sign in to comment.