THIS IS A WORK IN PROGRESS...
Version 1.0 is finalized, but this readme still needs updating to reflect the final tweaks. I am also looking into a possible version 2.0 that incorperates stowable wrist rests into the case design.
The Allium58CAD is a wireless open source 6*4+4keys column-staggered split keyboard that integrates an ortholinear QWERTY layout, SpaceMouse, macro pad, and a left number pad into a single system to optimize productivity and ergonomics in 3D design, CAD, Engineering, and 3D CNC programming.
It is a fork of the Allium58 by beekeeb which is in turn based on Lily58 Pro created by kata0510.
Note
The SpaceMouse itself is a seperate product sold by 3DConnection The Allium58CAD is designed to integrate with the SpaceMouse by snapping tight to the SpaceMouse base with magnets.
If you have never used a SpaceMouse, I highly recommend them. There is definitely a learning curve, but once you figure it out the SpaceMouse is a lifechanging improvement for navigating in a 3D space.It alows you to manipulate the 3D space simultanious and independent of what your mouse is doing. This lets your mouse be dedicated to selcting, drawing, etc.
One beginner tip: Turn off perspective view to make navigation more predictable.
Tip
This design is configured for right handed mouse use, but could be easily mirrored to work in a left hand dominant setup.
The biggest downside of a spacemouse is that you must remove your hand, reaching up and over it to hit any of the keyboard keys. While most 3D software can be navigated almost completely with a mouse and the menus, shortcuts are much more efficient, and it is often still nessessary to use some of the modifier keys in conjunction with the mouse. The Allium58CAD was developed after scouring the internet for both commercial options and custom implementations to address this issue, and not finding a satisfactory solution. The Allium58CAD integrates a keyboard, SpaceMouse, number pad, and macro pad into a single system and I am convinced that “this is the way”.
Most of the availible solutions add additional buttons/keys around the SpaceMouse Joystick, basically adding a macro pad to go with the SpaceMouse. I, along with others, have discovered the utility of a left hand number pad, so that I can quickly enter in values without taking my hand off the mouse. When you put all of this together, it leaves you with a left number pad, a macro-pad, a spacemouse, and a traditional keyboard all taking up room on your desktop. Furthermore, since they are all seperate, they are unintentionally getting shifted around the desktop, which interferes with the muscle memory of what is where.
-
Allium58CAD utilizes ZMK programming and a custom case to integrate all of these items into a single system, decreasing desktop clutter instead of adding to it.
-
The split keyboard functionality has the added benifit of leaving desk space directly in front of you for hardcopy reference documents (such as the Machinery's Handbook).
-
The magnetic snap function allows the board to be used as two seperate keyboards, or snapped together to function like a unibody split keyboard
-
Most SpaceMouse users start off with the basic spacemouse model, getting a feel for using it before commiting further investment for added utility. The Allium58CAD allows users to utilize their existing equipment instead of reinvesting in a whole new module.
-
ZMK allows users to customize the key layout for their paticular preference or software. The starting keymap is designed to work with solidworks, but it can be adapted for other software packages.
I'm hoping it will be easier to tweak and modify my existing keymap instead of building one from scratch like I did. Same thing goes for the FK custom keymap legend included in this documentation. It ended up taking quite a bit of time to compile both of them, and I wish I had had someone elses map as a base to modify, instead of building the whole thing from scratch.
I chose to use low profile choc switches because of the angle at which you hold the SpaceMouse. The low, flat profile puts the mod keys in the right position to be easily reached while manupulating the SpaceMouse joystick. Tenting of the keyboard case was tested, but it got in the way of using the SpaceMouse. Raising the spacemouse up to compensate for the tenting height was tested as well but made the spacemouse akward to use.
The included keymap is designed to combine all the basic funcitons of a standard QWERTY layout with a left handed number pad, a macro pad, and a navigation pad. This is accomplished using a combination of varrious ZMK behaviors. An in depth explination is beyond the scope of this document, I recommend reading up on the official ZMK Behavior documentation
- One of my goals was to make sure that all of the standard availible QWERTY symbols be accessible in the "QWERTY" layer.
- The second priority was a left hand key layout that would provide both quick access to needed shortcut and macro keys while also providing an efficient 4x3 number pad within easy reach.
- Though the top number row has fallen out of favor with many ergonomic keymap enthusiasts, one of the main reasons for choosing the Allium58 layout was that extra row. Though, not for a top number row. That additional top row of keys is nesessary for a proper 4x3 number pad layout, an important addition for anyone working with lots of numbers.
- Instead of numbers on the top row of the QWERTY layer, it has just the symbols as the base fuction of the key. The number pad is availible via the momentary navigation key for quick access any time I need to imput numbers. I find the number pad much faster than the number row. And I find myself using that top row for the symbols far more often than I use the numbers.
- instead of splitting into many layers of working commands, I thought it made more sense to use 2 layers, and utilize modifier keys on the second layer to fit the extra commands. The benifit of this, is if you work in multiple 3D modeling programs you can seperate all of its related commands in a new layer. At that point I would probably alter the programming to utilize the layer key in conjunction with the number pad keys to select the active 3D program layer.
I would program new layers to be conditional over top of the
CADlayer such that you can still easily swap back to the alphabetical keys. This also saves you from duplicating any functions on the right keypad that are not getting changed (use&trans). It could be implimented in a simmilar way to the activation layers for theWirelayer andNum Locklayer - Realistically, the only reason for choosing a 4 row keyboard was to fit the number pad. It would actually be possible to use a corn style pcb on the right hand. I decided to utilize those extra unused keys on the right keypad of the
CADlayer for math and engineering symbols that I normally have to enter an Alt code for. There is plenty of room for customization in this area if you have differnt needs.
- Instead of number keys across the top row of the QWERTY layer, it has just the corrisponding symbols as the base fuction of the key. The number pad is availible via the momentary navigation key for quick access to enter numbers. The number pad much faster than the number row for numerical entry. The symbols attached to those keys are used more often than I use the numbers. The parentheses in particular come to mind...
- The layout tries to maintain as much standard QWERTY layout as possible, but not everything would fit perfectly. Several of the less used keys, : , ; , [ , ] , { , } , and DELETE, are implimented as side by side combos. Just hit two keys at the same time and it will output the corrisponding character.
- Caps Lock is activiated using a double tap on the shift key. It is a smart caps lock, so it will dissengage when any non alphabetical key is pressed. Traditional Caps Lock is activated with a tripple tap.
- The "CAD" layer contains the number pad and the shortcut keys on the left half, with the navigation arrow keys and additional math and engineering related symbols on the right half
- The left hand of this layer is intended to be the primary imput while 3D modeling, while your other hand remains on the mouse. This is why the left side is crammed full of programing to hold all of the macros in addition to the all important number pad for dimention and data entry. It should be noted that for solidworks, these keys do not cover all of my most frequently used commands. I have a lot of frequently used commands mapped to mouse gestures in the custom configurator.
- The left hand numberpad keys are mapped to the standard keyboard number row keys, not the keypad ones. Some programs dont work with the keypad numbers in the same way and since this pad is the only numeric entry it made the most sense to do it this way. (there is an optional layer to enable the keypad number mapping.
- In general, the Ergo Keyboard Community encorages no legend keycaps, touchtyping from memory only. However, the infrequency of using some of these shortcuts makes memorizing them difficult, Thus why I thought it would be important to have labeled legends. The touchtype memory is also effected by the shifting of the hand durring use. Although a much shorter distance that the standard SpaceMouse setup, the hand will still be required to shift back and forth between the number pad and the spacemouse position. (Additional Homing Keys are being considered to help this).
- There are two other very frequently used commands that I have left out of the keymap because I have mapped them to the two keys on the spacemouse base.
- Fit Normal To (a custom macro) - Executes "normal to" and then zooms to fit on the selected item, if one is selected. Great for working with non orthogonal working planes. Macro is set to execute "Normal To" and then "Zoom to Selection" in that order. If nothing selected, the zoom does nothing and it just re-orient to the closest orthogonal view.
- Lock Rotation - This command is specific to the SpaceMouse and is used to lock it into a pan only mode. Excellent for moving around a sketch on a werid plane.
I've included a copy of my solidworks workspace settings in the firmware section for reference to how I have the other commands set up)
-
Workhorse and Control Mod Key Placement: All of the most used keys are grouped close to the spacemouse such that they should be able to be pressed with pinky or ring finger while holding the SpaceMouse Joystick. 1
-
Sketch Commands: All of the sketch related shortcuts are activated using the Shift key as the modifier and then the legends top left listed command will be the action.
-
Model Commands: All of the Model and Assembly related commands are activated using the Alt key as the modifier. The action is listed as the second line in the top left corner of the legend, underneath the sketch command mentioned above.
1: Some of the keymap code references an A, S, and D keys mapped to the G, F, and R key locations. These keys are referencing default shortcuts key chosen by solidworks, I only kept the names for continuity. This is also why the icons incorperate the A and S, to help solidworks users familiar with those commands.
-
In general, the Ergo Keyboard Community seems to recommend legendless or blank keycaps, encoraging touchtype from memory. However, the infrequency of using some of these shortcuts makes memorizing them difficult, Thus why I thought it would be important to have labeled legends. The touchtype memory is also effected by the shifting of the hand durring use. Although a much shorter distance that the standard SpaceMouse setup, the hand will still be required to shift back and forth between the number pad and the spacemouse position. (Additional Homing Keys are being considered to help this).
-
The "CAD" layer is accessed in two ways:
- A layer toggle on/off on the lower left pinky on the left keypad.(
) - A "sticky momentary layer" toggle on the thumb of the right pad.
This momentary switch is positioned such that it is easily reached while pressing the arrow keys. Holding the key will temporarily toggle the layer untill the key is released.
("sticky momentary layer" is the term I use for urobs capsword PR 1451 that I use. In fact I use his entire fork. This PR allows you to impliment smart layers which is a modified capsword type of behavior for layers and things that are not alphanumerics. So after you tap the arrow nav toggle button, the layer will stay active untill you type anything that isnt a nav key, number key, or the layer toggle key)
- A layer toggle on/off on the lower left pinky on the left keypad.(
Warning
There are a couple of non-model related commands on the CAD layer, such as the Check-In and Check-Out commands that are specific to PDM use that my not apply to everyone. If creating your own build, assess the provided list of default commands to make sure that they meet your needs before ordering a set of custom keycaps.
- This contains needed utility keys such as boot mode and bluetooth connectivity buttons.
- Layer can be accessed from the QWERTY or CAD layers by holding the left layer key. This layer is designed with a sticky layer. you must hold the layer key to activate it and then press the desired action. The layer is automatically deactivated after that keypress to prevent accidental keypressing. To subsequently hit a different key in the utility layer, you would have to hold the layer key again.
- Programming is implimented to require a hold to activate boot, reset, and BT clear keys. This is to prevent accidental activation.
- Blue Tooth Clear only clears the pairing for the currently selected connection, each pariring must be cleared individuallly.
- The key for bluetooth disconnect of each blutooth pairing is not labeled in the legend but are located in the row below their corrisponding selector key.
- The Num Lock key is used to toggle the number layout in the CAD layer to output keypad numbers presses instead of number row presses. This is occassionally needed for some programs where they are mapped for a different use, or for entering in alt code characters. See Num Lock Layer below for implimentation.
- This layer is used only to impliment a toggle key function. This allows a key to output one macro with the first press, and a different macro on the second before switching back to the first macro if pressed a third time.
- Wireframe to shaded with lines requires two differnent commands in solidworks, but I wanted a key that would toggle back and forth between them.
- The first keypress in the CAD layer sends the first macro and then activates this layer that is completely transparent exept for this key.
- The Wire Activate layer is completely transparent and is used to activate the wire layer on the conditional basis that the CAD layer is active. This way the wire layer function will only be active when the CAD layer is also active.
- When active, the Num Lock layer overlays the standard number row key mappings on the CAD layer, and will instead output the equivelant number pad keypress. Most of the time this will not be needed. However, the bindings of the number row and the number pad numbers are treated slightly different by the system and in some programs they are mapped to different things. Alt code symbols are an excellent example of this.
- The Num Lock layer is completely transparent except for the numbers.
- The Num Activate layer is completely transparent and is only used to activate the Num layer on the conditional basis that the CAD layer is also active. This way the Num Lock layer will turn itself on and off in tandom with the CAD layer. This way it wont interfere with the functions on any other layers.
- Combos and other behaviors are utilized to fit some things that didn't otherwise have a spot. Combo keys are indicated by little icons on the touching edges of both keys.
- All Combos are side by side keys making it easier to remember them.
- Macros are heavily utilized to output the alt codes for the symbol keys on the right side of the CAD layout.
- The outermost lower left key () on the left keypad switches between the QWERTY and the CAD layer, holding it will toggle the utility layer.
- The utility layer is a momentary sticky layer. The left layer key must be held to activate the layer, and then it is only good for one keypress before deactivating.
- While the Layer Key
on the left keypad toggles the layers on and off, the Navigation layer key on the right keypad is used for temporary layer activation utilizing the smart layer function of urobs PR #1415
- Pressing the Navigation layer key
from the QWERTY layer temporarily activates the CAD layer, allowing you to enter numbers and navigate with the arrow keys until spacebar, enter, return or a letter is pressed, when it will automatically return to the QWERTY layer. - Tapping the Navigation layer key from the CAD layer will toggle back to the QWERTY layer. Holding the key will temporarily pull up the QWERTY layer until it is released.
- While the Layer Key
Link_to FK custom layout If you create a login, you should be able to modify this for your own customizations. If you go back to the keycap selection you can choose to change to precolored keycaps instead of blank PBT.
- You can also piece together a custom remix to add a little personality and flair.
Initial build has been finished. I am actively using this for my daily work. The readme still needs some finalization. I've also added some personal tweaks, such as custom art, to my primary config repository.
An example of a personal tweak that I made: I changed the display names of the QWERTY and CAD layers so that it would be easier to identify which was active. For the way I usually have things positioned, the Nice!View display is often at a low viewing angle making it hard to read easily. To combat this, the CAD layer is just a series of pipes to fill in the display area while the QWERTY layer is just "abc".
&nsbp;
Use the mirror command to get the other top plate. I found that I had to tweak the size of the top plate a bit to make it fit the switches right. I think it has to do with the 3D printer. I had to scale up by 0.05%, and even then it didn't want so sit down around the switches very well untill I had it screwed down. The good news, is that this means it's holding the switches very solidly.
Also note that I used flat head M2 screws on the bottom, however, i put the countersinks in manually after printing because they didnt want to print very well.
- The left and right sides of the top and bottom are implimented as different configurations of the same parts. There is also an expirimental design in there that has an extra pillar built in for added glass support, it is not finalized.
- The key switches and caps are rough placeholders for appearance only and the dimentions should be regarded as approxamate.
Warning
This section should be attempted with caution to make sure you don't render your keyboard unusable. Hoping to find an alternative solution for this in the future, but for now the modification will have to do. It really doesnt remove that much material if done correctly.
-
The Allium58 PCB will require slight trimming on the lower right corner of the left hand PCB. This puts the spacemouse in a comfortable position to allow your ring and pinky fingers to reach the Control, S, D, A, and Escape buttons without repositioning your hand from the spacemouse. (S, D, and A are solidworks specific shortcut examples. These can be programmed differently for a different software)
-
I recommend throughly taping off the rest of the exposed PCB with removable painters tape etc. to protect it from dust and debris.
-
A dremel tool with a cut off wheel would work, I ended up doing it with a sander and an 80grit belt. A fine tooth coping saw could probably also be used.
Important
Use the 3D printed Top Plate as a template for where to trim the PCB.
Caution
Overcutting the PCB could render the bottom row of keys unuseable! Be cautious and precise to make sure you dont go too far and damage any of the circut traces in that corner of the board!
-
ZMK - supported
-
Custom labeled MBK Keycap set - In PBT white, allows for a custom color dye job!
-
Optional Customization: Custom color mod keys MBK keycaps
-
Solidworks Shortcuts to Program (WIP)
| Key(s) | Legend Symbol | Command |
|---|---|---|
| G | Opens a Shortcut Bar Menu at your cursor for quick selection. (This may get less use as I learn the shortcut keys) | |
| R | Toggles command option type. Toggles through availible command options such as tangent arc vs. 3 point arc. | |
| F | Brings confimation or cancellation box right to your mouse. | |
| Ctrl | Multi Item Select | |
| Space | Shortcut for the orthogonal view selector cube. | |
| Tab | Used to Hide or Show a part in an assembly | |
| Delete, Alt, Shift, Esc, Enter | Need for these should be somewhat obvious | |
| Ctrl + G | Redo | |
| Ctrl + F | Undo | |
| Ctrl + R | Expand Quick Access Feature Tree | |
| V & Ctrl V | The combination of these two commands will toggle the view between wireframe and shaded with edges. Gives you X-ray vision... | |
| Ctrl + Esc | Save Shortcut |
| Key(s) | Legend Symbol | Command |
|---|---|---|
| Shift + 9 | Override dimentions on Drag/Move | |
| Shift + 8 | Close Sketch to Model | |
| Shift + 7 | Silhouette Entities | |
| Shift + 4 | Derived Sketch | |
| Alt + 4 | Magnified Selection | |
| Shift + 5 | Convert Entities | |
| Shift + / | Fully Define Sketch | |
| Alt + / | Select Other | |
| Shift + V | Toggle "For Construction" | |
| Alt + V | *Reserved for future Transparancy toggle coding | |
| Utility + # | Toggle External Power Mode | |
| Shift [Double Tap] | CapsWord with auto deactivation | |
| Shift [Tripple Tap] | Traditional CapsLock function | |
| Shift + 1 | Show Spline Handles | |
| Alt + 1 | Spell Check |
In this list, I have only included the shortcuts relevant to the CAD layer of the Allium58CAD key layout. The full List, including defalut shortcuts, is availible as a PDF in the firmware section.
| Quick Access Comands | ||
|---|---|---|
| Catagory | Command | Shortcut Keys |
| View | Orientation.. | SpaceBar |
| Others | View Selector | Ctrl + SpaceBar |
| Others | Hide the Hovered-over Component/Bodies | TAB |
| Others | Show the Hovered-over Component/Bodies | Shift + TAB |
| Others | Show all the hidden Components/Bodies | Ctrl + Shift + TAB |
| Edit | Repeat Last Command.. | Enter |
| Others | Expand/Collapse Tree | C |
| Others | Normal To | Alt + SpaceBar |
| Others | Zoom to Selection | Shift + SpaceBar |
| Others | Shortcut Bar | S |
| Others | Command option toggle | A |
| Others | Move Selection Breadcrumbs, Confirmation Corner | D |
| View | Wireframe.. | Q |
| View | Shaded With Edges.. | Alt + Q |
| Others | Spell Checker | Alt + Num 1 |
| Sketch Commands | ||
| Tools | Construction Geometry.. | Shift + Q |
| Tools | Line.. | Shift + Num - |
| Tools | Spline.. | Shift + Period |
| Tools | Circle.. | Shift + Num + |
| Tools | 3 Point Arc.. | Shift + Num * |
| Insert | Hole Wizard.. | Alt + Num + |
| Tools | Fully Define Sketch.. | Shift + Num / |
| Tools | Override Dims on Drag/Move.. | Shift + 9 |
| Tools | Close Sketch to Model.. | Shift + 8 |
| Tools | Silhouette Entities.. | Shift + 7 |
| Tools | Corner Rectangle.. | Shift + 6 |
| Tools | Convert Entities.. | Shift + 5 |
| Insert | Derived Sketch.. | Shift + 4 |
| Tools | Straight Slot.. | Shift + 3 |
| Tools | Offset Entities.. | Shift + 2 |
| Tools | Display/Delete.. | Shift + 0 |
| Tools | Show Spline Handles.. | Shift + 1 |
| Standard Commands | ||
| Edit | Delete.. | Delete |
| Edit | Undo.. | Ctrl + Z |
| Edit | Redo.. | Ctrl + Y |
| Edit | Cut.. | Ctrl + X |
| Edit | Copy.. | Ctrl + C |
| Edit | Paste.. | Ctrl + V |
| File | Save.. | Ctrl + S |
| View | Previous View.. | Shift + Ctrl + Z (Shift + Undo Combo) |
| Edit | Copy Appearance.. | Shift + Ctrl + C (Shift + Copy Combo) |
| Edit | Paste Appearance.. | Shift + Ctrl + V (Shift + Paste Combo) |
| Model and Assembly Commands | ||
| Others | Select Other | Alt + Num / |
| Insert | Plane.. | Alt + Period |
| Insert | Extruded Cut | Alt + Num * |
| Insert | Extrude.. | Alt + Num - |
| Insert | Sweep.. | Alt + 2 |
| Insert | Revolve.. | Alt + 3, |
| Tools | Magnified Selection.. | Alt + 4 |
| Insert | Sweep Cut | Alt + 5 |
| Insert | Revolved Cut | Alt + 6 |
| PDM Commands | ||
| Tools | Get Latest Version.. | Alt + 7 |
| Tools | Check Out.. | Alt + 8 |
| Tools | Check In.. | Alt + 9 |
| Quick View Commands | ||
| Others | Isometric | Ctrl + 7 |
| Others | Bottom | Ctrl + 6 |
| Others | Top | Ctrl + 5 |
| Others | Right | Ctrl + 4 |
| Others | Left | Ctrl + 3 |
| Others | Back | Ctrl + 2 |
| Others | Front | Ctrl + 1 |
| Name | Count | Remarks |
|---|---|---|
| PCB | 1 set | |
| Top plate | 2 sheets | 1.2mm thick |
| Bottom plate / 3D printed case | 1 set | |
| OLED cover | 2 | |
| nice!nano or equivalent | 2 | |
| Reset switch | 2 | |
| Diodes | 58 | SMD Only (SOD-123 Package) |
| Hotswap Sockets | 58 | Choc Recommended, [Gateron is slightly taller alternative)(https://showcase.beekeeb.com/the-keycaps-of-gateron-low-profile-key-switches-and-kailh-choc-v1-key-switch/) |
| Key switches | 58 | Sunset Orange Choc switches are recommended |
| Keycaps | 58 pieces | 1u: 48 pcs, 1u convex: 6, 1u homing: 2, 1.5u: 2 pcs (Link) |
| Female Threaded Brass Spacer M2 5mm | 10 pieces | For Case assembly |
| Female Threaded Brass Spacer M2 9mm (or 14mm with MCU sockets) | 4 pieces | For OLED cover |
| GP823 Screw M2 4mm | 28 screws | |
| [Wired build] TRRS (4 poles) cable | 1 | |
| [Wired build] TRRS jack | 2 | |
| [Wired build] Micro USB or USB-C cable | 1 | Avoid charge-only cables |
| [Wireless build] JST battery socket | 2 | |
| [Wireless build] Battery with JST connector | 2 |
| Name | Count | Remarks |
|---|---|---|
| nice!view display | 2 | |
| Microcontroller | 1 set |
- Pre built Wireless: (https://shop.beekeeb.com/product/wireless-allium58-choc/)
*Although Beekeeb does not currently offer an unsoldered DIY kit for the Choc version of the Allium58 on his website, he is very responsive, and if asked nicely he could probably send you one.
-
Keymap Editor by Nick Coutsos is a very handy GUI for creating keymaps.
- It wont code everything, especially the details of the custom PR patches by urob but it sure helps for building and visualizing the layout code.
-
For understanding the nuances of the different hold-tap flavors and options, I found the animations of this beta ZMK Hold-Tap Documentation to be quite helpful. I dont know why it never got implimented, but be aware that some of the other sections in that ZMK document version contains out of date information and may be missleading.
-
- beekeeb also has an etsy store. I've noticed that sometimes there are things listed on etsy that are not listed on the offical store website, and vice-versa
-
FK Custom Keycaps has a very intuitive web based builder for custom keycap legends. There is quite a selection provided and there is also provisions for uploading your own custom font and or vector image.
-
Rough guidelines for creating a Custom Gradient Dye Job. *Keycaps must be PBT for this to work!
-
Interesting guide for implimenting ball bearing home key bumps. **Be sure to use stainless steel ball bearings, long term users reported back that standard carbon steel BB's were causing some staining from the formation of slight surface rust. - For anyone with a perfectionism streak, the machinists version can be found here.
This fork by zxku is an open source hardware project originally created by beekeeb and other contributors. It is based on Lily58 Pro created by kata0510.
zxku is a pseudonym for Zac Morhous. A senior product design and development engineer who will over-engineer the shit out of a personal side project if nobody makes what he's looking for.