hmproto34s is a hand-fitted keyboard with 34 keys.
hmproto34s is a derivative of hmproto34.
The most simple way to use hmproto34s is to flash the pre-built firmware to your keyboard.
Download the latest firmware from Releases, which enables you to customize the keymap using Vial.
Then follow the instructions in How to Flash Firmware.
The next 2 subsections explain how to build firmware and flash it to your keyboard.
If you want to know how to build the keyboard, see How to Build Keyboard.
-
Setup your QMK environment
- if you use Windows, install QMK MSYS
- See https://docs.qmk.fm/#/newbs_getting_started?id=set-up-your-environment for more information.
- NOTE: assume that
qmk_firmware
directory is located at~/qmk_firmware
in the following steps.
-
Open QMK MSYS
- If you use Windows, open QMK from the start menu. See https://msys.qmk.fm/guide.html#next-steps.
-
Clone this repository
cd ~/qmk_firmware/keyboards git clone [email protected]:hmasdev/hmproto34s.git
-
Build firmware
qmk compile -kb hmproto34s -km default
Good! Now, you have a built firmware in ~/qmk_firmware/.build/hmproto34s_default.hex
.
- Visit Pro Micro Web Updater;
- Select the firmware file (
~/qmk_firmware/.build/hmproto34s_default.hex
); - Connect your left keyboard to your computer and press its reset button;
- Click the
Flash
button on the website; - Wait for the flashing process to complete;
- Repeat steps 3-5 for the right keyboard.
OK. Now, you can use your hmproto34s keyboard! Try typing something!
-
After step 3. of How to Build Firmware, edit
~/qmk_firmware/keyboards/hmproto34s/keymaps/default/keymap.c
to customize your keymap. If you want to add a new keymap, runqmk new-keymap
; -
Build firmware again;
qmk compile -kb hmproto34s -km {default or your keymap name}
Component | Quantity | Note |
---|---|---|
PCB | 1 | Gerber files |
Top Plate | 2 | Gerber files |
Pro Micro | 1 | |
Tactile Switch | 1 | Reset Switch |
Kalih PCB Socket | 34 | For MX Compatible Switch |
MX Compatible Switch | 34 | |
KeyCap | 30 (1u), 4 (1u-2u) | |
Micro USB Cable | 1 | the type of USB depends on the Pro Micro |
-
Solder PCB Sockets to the bottom of the PCB;
-
Attach diodes to the top of the PCB and solder them on the bottom of the PCB;
-
Attach a tactile switche to the top of the PCB and solder it on the bottom of the PCB;
-
Attach a Pro Micro to the top of the PCB;
-
Attach key switches to the top plate;
-
Joint the top plate and PCBs;
-
Build and flash firmware;
- See How to Build Firmware and How to Flash Firmware for more information.
-
Enjoy typing!
Gerber files are located in ./pcb directory. You can order the PCB from PCB manufacturers like JLCPCB etc.
-
Fork the repository: https://github.com/hmasdev/hmproto34s
-
Clone the repository
git clone https://github.com/{YOURE_NAME}/hmproto34s.git cd hmproto34s
-
Checkout your working branch
git checkout -b your-working-branch
-
Make your changes
-
Commit your changes
git add . git commit -m "Your commit message"
-
Push your changes
git push origin your-working-branch
-
Create a pull request: https://github.com/hmasdev/hmproto34s/compare
- QMK Firmware: https://docs.qmk.fm/
- QMK MSYS: https://msys.qmk.fm/
- kbd:https://github.com/foostan/kbd, https://github.com/7-rate/kbd
- Pro Micro Web Updater: https://sekigon-gonnoc.github.io/promicro-web-updater/index.html
- 自作キーボード設計入門: https://pskbd.booth.pm/items/1044084
- Vial: https://get.vial.today/
- Vial-QMK: https://github.com/vial-kb/vial-qmk