Build guide

See the guide here.

Gerbers

See the releases for this GitHub repo for the generated Gerber files. You probably want the most recent version.

If you need to generate your own gerbers, see how to turn the master PCB into the 3 generated PCBs and then how to generate gerbers.

Parts list

Parts you'll have to find yourself

• 2x top PCBs (optional if you're happy with PCB mount; untested)
• 2x middle PCBs (or 4x as they can also be used as the base)
• 2x base PCBs (if you didn't order 4x middle)
• 2x Pro Micros
• 1x TRRS cable
• 42x Cherry MX (or compatible) switches
• 42x Kailh hotswap PCB sockets
• 10x Kailh choc switches
• 42x 1U MX key caps
• 10x 1U Kailh choc key caps
• (optional) 2x WS2812 LED from a 144 LEDs/m strip, for layer status lights
• (optional) more WS2812 LEDs, of any density per meter strip, for underglow lighting. 12x is probably a sane number but if you want to run them at lower power, you could probably use more.
• 4x 15mm M2 standoffs (2 per side), for mounting the OLED/ProMicro acrylic cover
• 8x M2 screws, between 4 and 8mm long, for the above standoffs
• (optional) 1 or 2 OLED screens
• 36x M2x4 screw (See Note1 and Note2) for mounting the middle/PCB layer to the base plate

Note1: the screw/bolt length depends on the height of the standoffs you get. You want 1.6mm thick PCBs so make sure you don't have too much thread on your screws.

Note2: it's highly recommended to get hex head/allen key/ISO7380 screws (see image below). This is because a phillips head screwdriver probably won't fit through the holes in the switch plate to tighten the screws on the middle/PCB layer. You can always drill those holes a bit bigger or loctite the screws in (so they won't need tighening) to workaround this. As you have hotswap sockets, you may be able to remove the switches and pull the middle/PCB layer screws out through the switch holes. Beware: with 4mm long screws, I couldn't achieve this, though it was very close.

Parts available with PCB order

These are the parts you can order from LCSC at the same time as having your PCBs manufactured. The listed quantity is to assemble both halves.

Note3: the standoffs between the middle/PCB layer and the base plate can be quite small, probably as small as 3mm. The problem with that is making sure the bolts engage the threads enough. Feel free to experiment with getting a super slim keyboard. Perhaps use a long bolt, a threadless spacer and a nut?

Developers/contributing

Contributions are welcome. I'm not selling these keyboards and I already have two for myself so I can't afford to manfacture more PCBs to test changes. If you make changes to the PCB design, ideally you would confirm it all works by manufacturing your own PCBs.

Steps for contributing:

1. if it's a non-trival change, consider opening an issue on this repo to talk about the change before spending effort
2. fork this repo
3. make your changes
4. if you made a change to the PCB, you need to regenerate the 3 seperate generated PCBs
5. send a pull request

Generating 3 layers of sandwich case

We edit a single PCB file that contains the information required to generate all 3 layers (switch plate, circuitry, base) of a sandwich case keyboard. Keeping it all in one file ensures that things like mounting holes always stay lined up.

There is some magic in the settings of items on the PCB to indicate what layer they belong on. Read the code for the specifics but as a general guide:

• we use Eco1.User as the templates for edge cuts that only appear on some layers
• the width of the drawing lines are slightly different so we can determine which belongs on each layer
• the thickness of text is slightly different so we can determine which belongs on each layer

You must have Kicad installed in your system. Doing this makes the pcbnew python module available. Make sure you don't have any virtualenv, etc activated as you need to be using you system-wide python. Check for the module by running the following in the python REPL:

import pcbnew

Now you can regenerate the PCBs with:

python ./generate_pcbs.py

Normally keeping generated things in source control is not a good idea but in the interest of keeping things easy, we include the generated PCBs.

Generating gerbers

Using KiCad 5.1.4, here's the settings to generate gerbers.

Plot settings (should be the defaults):

Plot format: Gerber
Included layers:
  F.Cu
  B.Cu
  F.Paste
  B.Paste
  F.SilkS
  B.SilkS
  F.Mask
  B.Mask
  Edge.Cuts
Plot foorprint values: yes
Plot footprint references: yes
Exclude PCB edge layer from other layers: yes
Exclude pads from silkscreen: yes
Default line width: 0.1mm
Coordinate format: 4.6, unit mm

Drill settings:

Drill File Format: Excellon
Mirror Y axis: no
Minimal header: no
PTH and NPTH in single file: no
Oval Holes Drill Mode: Use alternate drill mode
Map File Format: PostScript
Drill Origin: Absolute
Drill Units: Inches
Zeros Format: Suppress leading zeros

The fix for the JLCPCB PTH layer error was to change the oval hole drill mode.

Credit for Kicad symbols/footprints

• Kailh reversible footprints (CC BY-SA)
• P-08073 TACT reset switch footprint (MIT License)
• symbols: TRRS jack, resistor (exported from schematic) (MIT License)
• LED symbol (no license)
• 2.54mm pin headers and diode footprints from built in Kicad library
• footprints: 4 pin TACT reset, ProMicro, diode (MIT License)

FAQ

How portable is it? It weighs 360grams (180grams for each half) with cheap DSA plastic keycaps. It measures 115mm x 102mm and with 6mm standoffs, it's 16mm to the top of the switch plate or 31mm to the top of DSA keycaps, including the height of rubber bump-ons. I'll let you decide how portable you think that is but it was designed to be portable.

Is I2C between the halves supported? Sort of. The OLED screens use I2C so you won't be able to use them. Also there's no solder jumpers so you'll have to jump some wires between the OLED header SDA/SCL pins and the SLAVE_LED pin/data pin on the unused TRRS jack. This isn't an intended use but you can certainly hack it, check the schematic for details.

What happened to a single PCB that works as all 3 layers? Originally I tried to make one PCB design that works as all 3 layers of a sandwich design: base, PCB and switch plate. The idea was taken from for-split-keyboard and mitosis. I failed because I wanted to have minimal post-manufacture cutting by hand and JLCPCB kept rejecting my desgins as they didn't have strong enough supports to hold the PCB together though the whole manufacture process. So now we have "master" PCB design and use a python script to generate the PCBs for each layer from that master.

Do you have keyboard-layout-editor source?
Yes. Either this file in this repo or here's a (hopefully up to date) permalink

Do you have a vector of the right hand "plate"?
Yep, see misc/ergoslab-right.svg.