logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

readme.md (1605B)

    

  1. # Big Knob
  3. ![big_knob](https://i.imgur.com/KLS0O7Zh.png)
  5. A 3D printed single encoder volume knob with a SPI Screen.
  7. * Keyboard Maintainer: [jpe230](https://github.com/jpe230)
  8. * Hardware Supported: Big Knob PCB, Sparkfun ProMicro RP2040 (*See notes*)
  9. * Hardware Availability: <https://github.com/Jpe230/big_knob>
  10. ## Features
  12. The Big Knob was designed to be easy to assemble:
  13. * Designed to be used with a RP2040 board (*See notes*)
  14. * ST7735 0.96 inch color display
  15. * RGBLight
  16. * Easy to 3D print
  18. ### Notes
  19. You can use any compatible RP2040 board (I.E.: KB2040, Elite Pi, etc), but you will need to modify the pin definition to match you board
  21. ## Flashing
  23. Make example for this keyboard (after setting up your build environment):
  25.     qmk compile -kb jpe230/big_knob -km default
  27. Flashing example for this keyboard:
  29.     qmk flash -kb jpe230/big_knob -km default
  31. See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
  33. ## Building Instructions
  35. You can find the required materials and the instructions to build your own Big Knob in the [project repo](https://github.com/Jpe230/big_knob)
  37. ## Bootloader
  39. Enter the bootloader in 3 ways:
  41. * **Bootmagic reset**: Hold down the encoder buitton and plug in the keyboard
  42. * **Physical reset button**: Briefly press the reset button on the front of the RP2040 board
  43. * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available