Skip to content

willpuckett/zmk-config-ak3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZMK firmware for Apple Keyboard II.

.github/workflows/build.yml

AKIII

For most mechanical keyboard enthusiasts, the Apple Keyboard II is probably one of the most hated products ever made. It's rubber dome switches are known for their mushy-ness. It's a nostalgic keyboard for me though, and I wanted to bring some attention to it and modernize it a little bit.

As I worked into this project, it seemed to make sense to build a new pcb that could connect to the flat cable from the original keyboard membrane.

This repo houses the firmware for the project. You can find it under releases.

The pcb fabrication files are available in the pcb directory of this repository. There are also a couple of extras from my first run available.

Layout

QWERTY

                    +-------+
                    | reset | (double tap for bootloader)
                    +-------+
+---+---+---+---+---+---+---+---+---+---+---+---+---+-----+ +---+---+---+---+
| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | bks | |clr| = | / | * |
+---------------------------------------------------------+ +---+---+---+---+
| tab | q | w | e | r | t | y | u | i | o | p | [ | ] | \ | | 7 | 8 | 9 | + |
+---------------------------------------------------------| +---+---+---+---+
| caps | a | s | d | f | g | h | j | k | l | ; | ' |return| | 4 | 5 | 6 | - |
+---------------------------------------------------------+ +---+---+---+---+
| shift  | z | x | c | v | b | n | m | , | . | / |  shift | | 1 | 2 | 3 |   |
+---------------------------------------------------------+ +-------+---|ent|
|ctrl|opt|comnd |                   | esc |lef|rig|dwn|up | |   0   | . |   |
+---------------------------------------------------------+ +-------+---+---+

Engrammer

                    +-------+
                    | reset | (double tap for bootloader)
                    +-------+
+---+---+---+---+---+---+---+---+---+---+---+---+---+-----+ +---+---+---+---+
| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | [ | ] | bks | |clr| = | / | * |
+---------------------------------------------------------+ +---+---+---+---+
| tab | b | y | o | u | ' | ; | l | d | w | v | z | = | \ | | 7 | 8 | 9 | + |
+---------------------------------------------------------| +---+---+---+---+
| caps | c | i | e | a | , | . | h | t | s | n | q |return| | 4 | 5 | 6 | - |
+---------------------------------------------------------+ +---+---+---+---+
| shift  | g | x | j | k | - | / | r | m | f | p |  shift | | 1 | 2 | 3 |   |
+---------------------------------------------------------+ +-------+---|ent|
|ctrl|opt|comnd |                   | esc |lef|rig|dwn|up | |   0   | . |   |
+---------------------------------------------------------+ +-------+---+---+

Engrammer-Shifted

This reduces pinky strain significantly on the left hand. Nav layer can be accessed by holding caps or q while typing.

Double tap capswordesc to capitalize the next word.

                    +-------+
                    | reset | (double tap for bootloader)
                    +-------+
+---+---+---+---+---+---+---+---+---+---+---+---+---+-----+ +---+---+---+---+
| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | [ | ] | bks | |clr| = | / | * |
+---------------------------------------------------------+ +---+---+---+---+
| tab | b | y | o | u | ' | ; | l | d | w | v | z | = | \ | | 7 | 8 | 9 | + |
+---------------------------------------------------------| +---+---+---+---+
|nav/caps|^c |⌥i|⌘e|⇧a| , | . |⇧h|⌘t|⌥s|^n | nav/q |return| | 4 | 5 | 6 | - |
+---------------------------------------------------------+ +---+---+---+---+
|    g  | x | j | k | - | => | / | r | m | f | p |  shift | | 1 | 2 | 3 |   |
+---------------------------------------------------------+ +-------+---|ent|
|globe|capswordesc|bks |            | ret |lef|dwn|up |rgt| |   0   | . |   |
+---------------------------------------------------------+ +-------+---+---+

Nav

                    +-------+
                    | reset | (double tap for bootloader)
                    +-------+
+---+---+---+---+---+---+---+---+---+---+---+---+---+-----+ +---+---+---+---+
|   |F1|F2 |F3 |F4 |F5 |F6|F7 |F8 |F9 |F10 |F11 |F12 |    | |clr| = | / | * |
+---------------------------------------------------------+ +---+---+---+---+
|tab| !| @| [ | ] |bt_clr|bt_nxt|hm|pgdn|pgup|end|  |  |  | | 7 | 8 | 9 | + |
+---------------------------------------------------------| +---+---+---+---+
|    | ( | ) | { | } |=>|out_tog|lef|dwn|up|rgt|   |return| | 4 | 5 | 6 | - |
+---------------------------------------------------------+ +---+---+---+---+
|    <  | / | = | > |   |  |redo|undo|cut|cpy|pst|  shift | | 1 | 2 | 3 |   |
+---------------------------------------------------------+ +-------+---|ent|
|     |    |      |                 |     |   |   |   |   | |   0   | . |   |
+---------------------------------------------------------+ +-------+---+---+

Installation

  1. To install, solder up your Nice!Nano. Mill-max pins work better than diode legs, which tend to not want to come out of the socket very well.
  2. Socket the Nice!Nano.
  3. Open the case on the keyboard—three screws on the under side, and three screws inside above the keys.
  4. Slide the fitting for the flat flexible cable up, and lift the flat membrane cable out of the socket (it's labeled 5597).
  5. Remove the old pcb.
  6. You might want to take some time to clean the keyboard innards if it's not looking fresh in there. Compressed air, 90% rubbing alcohol on the membrane if it needs it...
  7. Tilt the AK3 pcb a little toward the back. The nice nano will just fit under a nub on the back left wall, and allow it to drop onto the pegs.
  8. Pressure fit the flat membrane cable into the new socket. It doesn't slide down to lock like the original one, you just have to press the flat cable in. It's tight when it's new! Press hard-ish without bending the cable. You might have to do it twice. Also, if the contacts don't look to fresh on the membrane cable, you can wipe it down with a q-tip and some 90% rubbing alcohol, allowing it to dry thoroughly before installing in its header.
  9. Connect your battery to the battery terminal. MAKE SURE THE POLARITY IS CORRECT BEFORE INSERTING. There is no reverse polarity protection. Use the multi-meter to check the polarity, and flip the wires in the JST-PH fitting if needed.
  10. Using a thermal tape or some bubble gum (not included), attach the battery inside the case so it doesn't flop around when you type really hard.
  11. Reinstall the three screws from above the keys.
  12. Reinstall the upper bezel, working from the top of the keyboard down.
  13. Reinstall the three screws from under the keyboard.

Schematic

Schematic

Module

This repository is configured as a ZMK module (I think). You should be able to add it to ZMK's config/build.yaml something like:

manifest:
  remotes:
    - name: zmkfirmware
      url-base: https://github.com/zmkfirmware
    # Additional modules containing boards/shields/custom code can be listed here as well
    # See https://docs.zephyrproject.org/3.2.0/develop/west/manifest.html#projects
    - name: willpuckett
      url-base: https://github.com/willpuckett
  projects:
    - name: zmk
      remote: zmkfirmware
      revision: main
      import: app/west.yml
    - name: zmk-config-ak3
      remote: willpuckett
      revision: main
  self:
    path: config

Doing this will allow you to use the 'ak3' shield without having to clone in the whole repo, and keep it up to date if it changes upstream (here). Download the starter template pre-configured with the ak3 module to make your own keymap. Once you push it to your github account, it'll build the firmware and place it in an artifact in your workflow runs.