All the credit goes to karnadii for his initial work. This repo is primarily for my documentation purposes and as a guide for anyone that would like to build this but might be as inexperienced as I was when I attempted this. This contains only documentation and updates to the split layout.
Shoutout to karnadii, Nicell, bravekarma and the other zmk and nice!nano discord folks that helped me get as far as I did.
I'm running nice!nano on my build instead of nrfmicro.
If you're buildings his other layouts (marvelous65 and marvelous65-ergo), some of my changes might work there as well. YMMV.
- added nice_nano_v2.overlay, with changes to the mosi-pin
- added oled changes to marvelous_split.dtsi, a zmk change implemented here
- updated marvelous65_split.dtsi to reverse flipped encoder
- OLED issue
- Split peripheral encoder
- I pulled infused-tree's changes pending it getting merged into ZMK. So far working OK as of 9/30/22.
- Case does not have access to reset button, or on/off switch toggle
- Seeming to have some lag between the left and the right side in terms of input, I type at a range of 90-130WPM depending on the day but I'm not sure if it's apparent for folks that type slower
Much like his original repo - you'll have to order these PCBs off of a site like JLCPCB (reach out to me as I might have a few extras lying around).
You can upload the Gerbers I included to JLCPCB (Hardware/Gerbers/Gerbers.zip) or generate them yourself from the Kicad project file.
Options I chose, many of them are default, but I'm including them here for anyone that might find it useful:
- Base material: FR-4
- Layers: 2
- Dimensions: 345.28 * 107.17 (this should be default)
- Panel Qty: 5 (this is the minimum)
- Product Type: Industrial/Consumer electronics
- Different design: 2
- This defaults to 1 but it's 2 as they're two separate boards
- Delivery Format: Panel by Customer
- PCB Thickness: 1.6
- PCB Color: Hey, you do you
- Silkscreen: White
- Silkscreen Technology: Ink-jet/Screen Printing Silkscreen
- Sufrace Finish: LeadFree HASL
- Outer Copper Weight: 1 oz
- Gold Fingers: No
- Confirm Production file: Yes
- Flying Probe Test: Fully Test
- Castellated Holes: No
- Remove Order Number: No
- PCBA Type: Standard
- Assembly Side: Both Sides
- I believe you only need the Bottom, but I opted not to risk it during my first build
- PCBA Qty: 5
- Edge Rails/Fiducials: Added by JLCPCB
- Confirm Parts Placement: Yes
After this, you'll need to upload a BOM file and a CPL file. These are Marvelous65 Split-bom.csv and Marvelous65 Split-all-pos.csv respectively.
You might have to confirm/review the parts. I've noticed that the LED (WS2812B) and the 3.5mm audio jack (PJ-320D) tends to fail to match. Do a search for it and select the appropriate one.
Double check your PCB, I had to rotate the headphone jack to be vertical.
Boom - you're good to go. Pay the good folks and while you're waiting impatiently for your PCBs, get ready to do more shopping.
I'm assuming you already have a soldering kit etc. Note that while I'll link to the shop pages I bought from - there are no affiliate links whatsoever and I have no relationships with these stores. Feel free to shop around and get what serves you best.
For this keyboard specifically, you'll need at least:
- 2x nice!nano v2s
- 2x Lithium batteries
- 2x Machine sockets and pins
- Technically a nice-to-have but this saved me from a screwup, and it's helpful to be able to unplug the board for troubleshooting
- 2x 128x32 OLED
- Note: ZMK seems to have an OLED issue
- 2x rotary encoder and knob
- 2x USB-C cables
- You could just cut up USB-C cables you have and solder one end to the board and plug the other into your nice!nano, but note that the clearance for the nice!nano USB-C and the reset button etc is very slim
- I opted for some USB 2.0 cable along with some USB-C 2.0 connectors
- Case for the keyboard
- I'm having mine printed from craftcloud3d, and they provided me with a 10% referral code:
REF49BRI7SK - The .stl files worked better in my case, and a full PLA build cost about $50-60
- I'm having mine printed from craftcloud3d, and they provided me with a 10% referral code:
- Optional
- Elegoo wire jumper cables
- I'm soldering these for RGB lighting in order to retain removability - female on nice!nano and male on the PCB
- If you're building the case included in the repo:
- M2*5mm
- You'll need at least eight of these for each corner of the case
- M2 screws
- 4x 12mm for the front
- 4x 20mm to 24mm for the rear corners
- I'm using 4x20mm but I'd recommend getting 22mm to be safe, it's barely grabbing the top case at all
- M2*5mm
- Elegoo wire jumper cables
You have two options here.
Once built, you could simply rename the marvelous65_split_left.uf2 and marvelous65_split_right.uf2 to zmk.uf2 files, and drop them into your left/right nice!nano board once it's connected to your machine as a USB device.
If you're looking to make changes to the keymaps etc, I followed zmk's development setup instructions and zephyr's installation guide as well.
After that's done, you can copy/paste the files in the Firmware\marvelous65_split folder into zmk/app/boards/shields/marvelous65_split.
In your terminal, you can generate both left/right files at the same time with this command:
west build -d build/right -p -b nice_nano_v2 -- -DSHIELD=marvelous65_split_right && west build -d build/left -p -b nice_nano_v2 -- -DSHIELD=marvelous65_split_left
If you run into Zephyr build issues after installing zmk and zephy, make sure you have this in your .src file (bashrc or zshrc)
export ZEPHYR_TOOLCHAIN_VARIANT=gnuarmemb
export GNUARMEMB_TOOLCHAIN_PATH=$(brew --prefix)