Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 4.05 KB

README.md

File metadata and controls

65 lines (48 loc) · 4.05 KB
Raw

Swirl

A Split keyboard with a thumb encoder on either side heavily inspired by the helix

20230909_151407

ToDo

  • diconnect the 2 pairs of inner pins on the trrs jack. both being ground causes a short circuit and requires modification of the TRRS jack at this time
    • I'm pretty sure there's something i2c related with this that you're supposed to do, but I don't actually understand that.
  • Get the button part of the encoder in the appropriate col/row rather than being it's own direct connect key which is poorly supported in qmk

Build Guide

Ingredients

  • 2x PCBs (Upload the zip from here to https://jlcpcb.com/ (the minimum order quantity is 5, maybe get six and share with a couple friends?)
  • 2x Pro-micro or pro-micro-compatible microcontrollers (I like the elite pi from here)
  • 70x 1N4148 surface mounted diodes (SMD) like these (you actually only need 64, but they're almost always sold in 10s)
  • 70x kailh choc v1 keyswitches of your choice like these (you actually only need 64, but they're almost always sold in 10s)
  • 70x kailh choc v1 key caps of your choice like these (you actually only need 64, but they're almost always sold in 10s)
  • 2x 3.5mm trrs headphone jack like these
  • 2x If you don't use the elite pi or have a will to do paperclip-resets, get some reset switches like these
  • 2x EVQWGD001 roller encoder like these (please don't buy these on amazon, try ebay or something because these are wildly overpriced, but this link should be more stable than an ebay listing)
  • Soldering tools
  • Optionally, all of the hotswap stuff for your controllers and switches

Hardware Steps

  1. Bridge the microcontroller connections depending on your controller's orientation If you want the smooth side up, solder the bridges on the bottom, if you want the components (and the reset button on an eliete-pi) facing up, solder the bridges that face up
  2. Solder SMDs (Ensure that the line on the SMD is on the same side of the connection as the line printed on the PCB)
  3. Solder microcontroller
  4. Solder TRRS connector
  5. Solder key switches
  6. Solder roller encoder

Software Steps

Prerequisites

  • Have qmk installed and setup, try the docs here if you don't already have that setup

  1. clone my qmk fork (maybe we get this merged into upstream at some point??) git clone [email protected]:vmorganp/qmk_firmware.git

  2. Compile and flash the firmware. (The default firmware is NOT good and I highly recommend creating your own)

    • Assuming you're using an elite-pi, compile the firmware using:

      1. qmk compile -kb swirl -km default -e CONVERT_TO=elite_pi`
      2. Drag and drop the compiled .uf2 file onto the pi

    • Otherwise:

      1. Run qmk flash -kb swirl -km default
      2. press the reset button/bridge the reset contact
      3. let it run

  3. enjoy!

Credits

@mrzealot and the other maintainers of ergogen

@ceoloide for having ergogen v4 footprints over in https://github.com/ceoloide/corney-island

@superfola on discord for helping me find me the reversible encoder footprint

@benvallack for informing me in a digestible way that this whole thing is actually doable

@imstubtw (i think) for the tutorial at https://flatfootfox.com/ergogen-part4-footprints-cases/

@aejay for the "swirl" text graphic here