diff options
| author | WarmCat <32871908+WarmCatUK@users.noreply.github.com> | 2018-03-24 17:03:24 +0000 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2018-03-24 13:03:24 -0400 |
| commit | 00dfa73e4c642c296bbdbb92ab8202e2e1604ce7 (patch) | |
| tree | 5a432209b3ae424c133d808fa4193f42eaf7d1e4 /keyboards/jj50/README.md | |
| parent | 4adc333455f6f9f990e83df074c93f9c11e25883 (diff) | |
| download | qmk_firmware-00dfa73e4c642c296bbdbb92ab8202e2e1604ce7.tar.gz qmk_firmware-00dfa73e4c642c296bbdbb92ab8202e2e1604ce7.zip | |
Added basic support for JJ50 (preonic-like based on atmega32A) (#2546)
* Added support for JJ50 from KPRepublic, no rgb or backlight control yet. Added as a layout of ymd96 at the moment (same microprocessor). Basic keymap with three layers to get started.
* Added support for JJ50
Diffstat (limited to 'keyboards/jj50/README.md')
| -rw-r--r-- | keyboards/jj50/README.md | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/keyboards/jj50/README.md b/keyboards/jj50/README.md new file mode 100644 index 000000000..39cfc69ca --- /dev/null +++ b/keyboards/jj50/README.md | |||
| @@ -0,0 +1,79 @@ | |||
| 1 | JJ50 | ||
| 2 | ========================== | ||
| 3 | |||
| 4 | This is a port of the QMK firmware for boards that are based on the | ||
| 5 | ps2avrGB firmware, like the [ps2avrGB keyboard] (https://www.keyclack.com/product/gb-ps2avrgb/), for use on the JJ50, a preonic-like board. | ||
| 6 | |||
| 7 | Most of the code was taken and amended from YMD96, which in itself was taken from ps2avrGB and amended by Andrew Novak. | ||
| 8 | |||
| 9 | Note that this is a complete replacement for the firmware, so you won't be | ||
| 10 | using Bootmapper Client to change any keyboard settings, since not all the | ||
| 11 | USB report options are supported. | ||
| 12 | |||
| 13 | Hardware Supported: JJ50 with the ATmega32a chip. | ||
| 14 | Hardware Availability: The JJ50 PCB is available from kprepublic on AliExpress and suchlike. | ||
| 15 | |||
| 16 | |||
| 17 | ## Installing and Building | ||
| 18 | |||
| 19 | Make example for this keyboard (after setting up your build environment): | ||
| 20 | |||
| 21 | ``` | ||
| 22 | $ make jj50:default:program | ||
| 23 | ``` | ||
| 24 | It should detect the keyboard and set it to bootloader mode automatically, prior to flashing firmware. | ||
| 25 | |||
| 26 | See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. | ||
| 27 | |||
| 28 | Note that this is a complete replacement for the firmware, so you won't be | ||
| 29 | using Bootmapper Client to change any keyboard settings, since not all the | ||
| 30 | USB report options are supported. | ||
| 31 | In addition you may need the AVR toolchain and `bootloadHID` for flashing: | ||
| 32 | |||
| 33 | ``` | ||
| 34 | $ brew cask install crosspack-avr | ||
| 35 | $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb | ||
| 36 | ``` | ||
| 37 | |||
| 38 | In order to use the `./program` script, which can reboot the board into | ||
| 39 | the bootloader, you'll need Python 2 with PyUSB installed: | ||
| 40 | |||
| 41 | ``` | ||
| 42 | $ pip install pyusb | ||
| 43 | ``` | ||
| 44 | |||
| 45 | If you prefer, you can just build it and flash the firmware directly with | ||
| 46 | `bootloadHID` if you boot the board while holding down `Backspace` (`key below top right key`) to keep it | ||
| 47 | in the bootloader: | ||
| 48 | |||
| 49 | ``` | ||
| 50 | $ make jj50 | ||
| 51 | $ bootloadHID -r jj50_default.hex | ||
| 52 | ``` | ||
| 53 | I dont use windows personally, but the following is from ymd96 regarding flashing the atmega32a: | ||
| 54 | |||
| 55 | Since the JJ50 uses an ATmega32a chip instead of the 32u4, you need to download [HIDBootFlash v.1.0](http://vusb.wikidot.com/project:hidbootflash) for Windows. If anyone knows of a Linux/Mac bootflasher that works, edit this readme! | ||
| 56 | On Windows, I use [MINGw](http://www.mingw.org/) to compile the keymaps. On Linux or OSX you can simply use the terminal. | ||
| 57 | |||
| 58 | Once you have those two pieces of software: | ||
| 59 | Build the keyboard with | ||
| 60 | ``` | ||
| 61 | $ make jj50:default | ||
| 62 | ``` | ||
| 63 | If you make your own layout, change the `default` word to whatever your layout is. | ||
| 64 | |||
| 65 | And flash the compiled hex file with `HIDBootFlash`. Simply put the board in flashing mode by plugging it in while holding the key below the top right key, and click `find device`. Then you can specify the .hex file and flash it to the device. | ||
| 66 | |||
| 67 | |||
| 68 | ## Troubleshooting | ||
| 69 | |||
| 70 | 1. Try plugging the board in while pressing `Backspace` (`Key below the top right key`). This will force it to boot only the bootloader without loading the firmware. Once this is done, just reflash the board with the original firmware. | ||
| 71 | 2. Sometimes USB hubs can act weird, so try connecting the board directly to your computer or plugging/unplugging the USB hub. | ||
| 72 | 3. If you get an error such as "Resource Unavailable" when attemting to flash on Linux, you may want to compile and run `tools/usb_detach.c`. See `tools/README.md` for more info. | ||
| 73 | 4. I was occasionally finding that I wasn't flashing changes that I was making to my keymap. If that happens, simply force rebuild by making with: | ||
| 74 | ``` | ||
| 75 | $ make -B jj50:default:program | ||
| 76 | ``` | ||
| 77 | |||
| 78 | |||
| 79 | |||
