Coder Social home page Coder Social logo

hmproto34s's Introduction

hmproto34s

GitHub tag (latest SemVer) GitHub Liecense GitHub last commit Scheduled Build Scheduled Sync With hmproto34

hmproto34s is a hand-fitted keyboard with 34 keys.

hmproto34s is a derivative of hmproto34.

hmproto34s

How to Use

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.

How to Build Firmware

  1. Setup your QMK environment

  2. Open QMK MSYS

  3. Clone this repository

    cd ~/qmk_firmware/keyboards
    git clone [email protected]:hmasdev/hmproto34s.git
  4. Build firmware

    qmk compile -kb hmproto34s -km default

Good! Now, you have a built firmware in ~/qmk_firmware/.build/hmproto34s_default.hex.

How to Flash Firmware

  1. Visit Pro Micro Web Updater;
  2. Select the firmware file (~/qmk_firmware/.build/hmproto34s_default.hex);
  3. Connect your left keyboard to your computer and press its reset button;
  4. Click the Flash button on the website;
  5. Wait for the flashing process to complete;
  6. Repeat steps 3-5 for the right keyboard.

OK. Now, you can use your hmproto34s keyboard! Try typing something!

How to Customize Keymap

  1. 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, run qmk new-keymap;

  2. Build firmware again;

    qmk compile -kb hmproto34s -km {default or your keymap name}
  3. Flash firmware again;

How to Build Keyboard

Required Components

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

Assembly Steps

  1. Solder PCB Sockets to the bottom of the PCB;

  2. Attach diodes to the top of the PCB and solder them on the bottom of the PCB;

  3. Attach a tactile switche to the top of the PCB and solder it on the bottom of the PCB;

  4. Attach a Pro Micro to the top of the PCB;

  5. Attach key switches to the top plate;

    Attach Key Switches to Top Plate

  6. Joint the top plate and PCBs;

  7. Build and flash firmware;

  8. Enjoy typing!

PCB and Top Plate

PCB

Gerber files are located in ./pcb directory. You can order the PCB from PCB manufacturers like JLCPCB etc.

Top Plate

See Top Plate of hmproto34.

How to Contribute

  1. Fork the repository: https://github.com/hmasdev/hmproto34s

  2. Clone the repository

    git clone https://github.com/{YOURE_NAME}/hmproto34s.git
    cd hmproto34s
  3. Checkout your working branch

    git checkout -b your-working-branch
  4. Make your changes

  5. Commit your changes

    git add .
    git commit -m "Your commit message"
  6. Push your changes

    git push origin your-working-branch
  7. Create a pull request: https://github.com/hmasdev/hmproto34s/compare

LICENSE

Author

References

hmproto34s's People

Contributors

hmasdev avatar github-actions[bot] avatar

Watchers

 avatar  avatar

hmproto34s's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.