diff options
Diffstat (limited to 'keyboards/redox_media/readme.md')
| -rw-r--r-- | keyboards/redox_media/readme.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/keyboards/redox_media/readme.md b/keyboards/redox_media/readme.md new file mode 100644 index 0000000000..511c604451 --- /dev/null +++ b/keyboards/redox_media/readme.md @@ -0,0 +1,57 @@ +# The Redox Media Keyboard + +I've taken the Redox keyboard and modified the SCAD files as well as the QMK layout to include media and scroll features: +- 3 Media buttons + - Play / Pause button + - Next track + - Mute (previous track on secondary layout) +- Volume knob +- Scroll wheel on the keyboard + +For an in-depth report see [my page](https://shiftux.org/making_projects/keyboard.html) and a [video](https://youtu.be/Cwkf7HFcUkY) about the build process, design, printing, programing and assembly. + +## IMAGE + +### The build +I've used 2 [Sparkfun Pro Micros (5V)](https://www.sparkfun.com/products/12640) and a single hand master setup providing power and serial connection via a TRS jack. + +### The pro micro and how to flash it +To try out your pro micro and setup your environment to flash such a device I recommend following [this guide](https://learn.sparkfun.com/tutorials/pro-micro--fio-v3-hookup-guide/all). It will take you through the install and setup and provides a first easy to flash program so you can test your setup quickly. + +Whenever you can't program one of the pro micros or the USB-COM port is not found on your computer, it most probably means that is is not in "bootloader mode". What you want to do is connect the GND and RST pin twice to reset the device and put it into bootloader mode (details [here](https://learn.sparkfun.com/tutorials/pro-micro--fio-v3-hookup-guide/troubleshooting-and-faq#ts-serial)). + +### Compiling and flashing + +Obviously start by [installing QMK](https://docs.qmk.fm/#/getting_started_build_tools?id=set-up-your-environment). + +- Before flashing the firmware you should make sure that it compiles. Thus assuring that your QMK setup works fine and the keyboard and keymap files are correct: +``` +qmk compile -kb redox_media -km default +``` +The generated `.hex` file is output to the QMK root. + +Once you are comfortable flashing your Pro Micros and your setup works continue with the following steps: + +- I've had the most success with using the `EE_HANDS` setting and flashing the EEPROM to the left and right halves of the keyboard respectively. To do this start with flashing the EEPROM of the 2 pro micros separately by setting the bootloader flag in the flash command (the pro micro uses the avrdude bootloader): +``` +qmk flash -kb redox/media -km media_ch -bl avrdude-split-left +qmk flash -kb redox/media -km media_ch -bl avrdude-split-right +``` +Note that you need to reset the pro micro to set it to bootloader mode before you can flash it: connect GND to RST twice in quick succession (750ms), then you have 8 seconds to upload the new eep file. + +### Adapting the keyboard layout + +Copy the `keymaps/media_ch` folder to `keymaps/media_<your-layout>` and adapt the `keymap.c` file in there. + +I recommend testing the key codes with the [QMK tester](https://config.qmk.fm/#/test) and then adapting the `keymap.c` file accordingly. + +Finally compile your new layout from the QMK root with: +``` +qmk compile -kb redox/media -km media_<your-layout> +``` +and proceed to flashing it equivalent to the above instructions. + +### CAD files and additional resources +See [here](https://shiftux.org/making_projects/keyboard.html) for a detailed build description and video. + +You can find the CAD and SCAD files, I created here: https://github.com/shiftux/redox-media-keyboard |