mcsam27 / yampad Goto Github PK

The Yampad project is an open-source, QMK (Quantum Mechanical Keyboard Firmware) powered, hot-swappable, RGB-backlighted, OLED featured, mechanical numpad. This repository will be used to share information about the project and instruction on how to use and assemble the Yampad.

Designer's bio: Mattia Dal Ben (aka u/TiaMaT102) obtained a master's degree in Electrical Engineering with a specialization in Computer Science at the University of Udine. Currently works as a Software Engineer in R&D department for a big IoT and Embedded Computers company.

• Rationale
• Default Layout
• Bill of materials
• Assembly guide
• Firmware

The Yampad is a Macropad/Numpad which uses Cherry MX style mechanical switches laid out in the usual numeric pad layout. The only difference comes from the bottom row, which uses a 4 keys configuration, thus enabling the use of the macropad as a nav cluster.

The name comes from the acronym: Yet Another Mechanical numPAD, referring to the disruptive and innovative nature of the project.

The main goal of this project is to have a cheap, easy-to-build, feature-rich numpad which is completely open source.

Features:

• Cheap to build: the PCB can be manufactured for less than 1$ per piece.
• Easy to source components.
• Easy to build.
• Hot swappable keys using Kailh PCB sockets.
• Arduino Pro Micro powered.
• QMK compatible.
• RGB backlighting support (optional).
• OLED 0.91" screen (optional).
• Completely open-source.

• YamPAD on Hackaday.io

There's no wrong order for the YamPAD assembly with the exception of the Arduino/OLED/ResetButton. Here I will suggest an order because I found more comfortable to solder the components this way.

1. Start with soldering the WS2812 LEDs. Start by applying solder to a pad, then heat it up while adding the component, finally solder the remaining pads.
2. Now add the 0805 100nF caps. Use the same technique as before.
3. Add the 1N4148 diodes.
4. Add the CPG151101S11 Kailh PCB sockets.
5. Add the reset 6mm button switch.
6. Add some electrical tape just to be sure.
7. Add the Arduino Pro Micro bottom side up.
8. Add the OLED screen
9. Move to the firmware section and you should be set!

The LEDs have a direction, this is indicated by a small cut out corner showing a triangle on the LED itself that must align with a corner indicated on the PCB as a visible corner angle. Top left on images below.

The diodes have a direction, the side indicated by the line on the diode must align to the closed side of the shape on the PCB. Left on the three images below.

For now the firmware is available through mattdibi's QMK firmware repository fork, making sure you checkout the yampad branch.

Make example for this keyboard (after setting up your build environment):

make yampad:default

Example of flashing this keyboard:

make yampad:default:avrdude

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

I also added a pre-built .HEX file in the 'firmware/' folder here to test the electronics.

If you've read this far and found something useful, please consider donating to help me maintain and further develop this project.