Generated keyboard
Go to file
KostkaBrukowa 30435d4e48 choc_mini- | Sweep test 2022-05-01 22:53:52 +02:00
.github choc_mini- | Sweep test 2022-05-01 22:53:52 +02:00
images choc_mini- | Replaces images 2022-02-21 16:05:37 +01:00
.gitignore Add an order number placeholder on the top plate (#9) 2021-12-10 22:30:14 +01:00
.tool-versions Fix pinout (#3) 2021-11-11 23:40:02 +01:00
LICENSE Add MIT license (#14) 2022-01-06 23:38:51 +01:00
Makefile choc_mini- | Generates images 2022-02-21 15:51:22 +01:00
README.md Revert "Add warning" 2022-01-06 23:49:41 +01:00
broom.js choc_mini- | Sweep test 2022-05-01 22:53:52 +02:00
build.sh Wip Makefile 2021-09-16 21:29:22 +02:00
button.js choc_mini- | Removes pin names and reset text from keyboard 2022-02-21 11:57:33 +01:00
index.js choc_mini- | Sweep test 2022-05-01 22:53:52 +02:00
package-lock.json choc_mini- | Updates package lock 2022-01-21 09:06:05 +01:00
package.json choc_mini- | Moves back to soundastem fork 2022-01-21 09:00:57 +01:00
promicro.js choc_mini- | Removes pin names and reset text from keyboard 2022-02-21 11:57:33 +01:00
samoklava.yaml choc_mini- | Sweep test 2022-05-01 22:53:52 +02:00

README.md

samoklava

An autogenerated split 36 key keyboard

left right
left right

A 5x3 split keyboard with 3 thumbs. There is nothing unique about the keyboard layout. It's inspired by Corne and Kyria, and has the exact number of keys needed for the Miryoku layout.

The interesting thing about this keyboard is that it's a declarative design ("samoklava" can be loosely translated as "keyboard that assembles itself" from Russian).

  • Layout is declared using Ergogen
  • The build system uses Ergogen to translate YAML to a KiCad PCB and plate files for FR-4 fab or laser cutting
  • uses kicad-automation-scripts and FreeRouting to automatically route the traces on the PCB
  • uses KiKit to render PCB previews (see top of this file) and production-ready Gerber files

Features

  • Extra pins and a slider switch for battery for wireless Promicro clones (tested with nice!nano); the slider can be shorted with a jumper if CONFIG_ZMK_SLEEP is preferred.
  • Wired operation with QMK should be possible but is not tested; TRRS footprints are included and routed. The pinout is identical with a five-column Corne sans the RGBLEDs.
  • Reset switches are easily accessible. The footprints used are the same as on the Corne.

How to

If you would like to modify this:

  • fork it
  • change samoklava.yaml to your liking
  • push your changes; the build.yml GitHub Workflow will pick it up, autoroute and generate Gerbers, all in a zip file. See https://github.com/soundmonster/samoklava/actions
  • or:
    • make sure to have Docker CLI and NodeJS installed
    • run make setup clean all
    • check the output folder for KiCad PCBs and Gerbers

See the workflow or the Makefile for more details.