aboutsummaryrefslogtreecommitdiff
path: root/keyboards/jj50
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2019-11-24 04:42:20 +0000
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2019-11-23 20:42:20 -0800
commit6a8c0a6468f4e4ce48a59152418a226d0f027497 (patch)
tree4937e648fb7d9afdf89fc6c4c92444ac90153fee /keyboards/jj50
parentd14573620d3e964730af960aab3c05a5d061796f (diff)
downloadqmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.tar.gz
qmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.zip
[Keyboard] Update ATmega32A readme files to match template (#7462)
* Update atmega32a readme files to match template * Update atmega32a readme files to match template - fixes * Apply suggestions from code review
Diffstat (limited to 'keyboards/jj50')
-rw-r--r--keyboards/jj50/README.md84
1 files changed, 10 insertions, 74 deletions
diff --git a/keyboards/jj50/README.md b/keyboards/jj50/README.md
index f7b8acc64..2d3e711be 100644
--- a/keyboards/jj50/README.md
+++ b/keyboards/jj50/README.md
@@ -1,83 +1,19 @@
1JJ50 1# JJ50
2==========================
3 2
4This is a port of the QMK firmware for boards that are based on the 3A preonic-like board
5ps2avrGB firmware, like the [ps2avrGB keyboard](https://www.keyclack.com/product/gb-ps2avrgb/), for use on the JJ50, a preonic-like board.
6 4
7Most of the code was taken and amended from YMD96, which in itself was taken from ps2avrGB and amended by Andrew Novak. 5* Keyboard Maintainer: [Wayne K. Jones](github.com/WarmCatUK)
8 6* Hardware Supported: JJ50 with the ATmega32a chip.
9Note that this is a complete replacement for the firmware, so you won't be 7* Hardware Availability: [KPrepublic on AliExpress](https://www.aliexpress.com/item/jj50-v1-0-Custom-Mechanical-Keyboard-50-PCB-programmed-50-preonic-layouts-bface-firmware-with-rgb/32848915277.html)
10using Bootmapper Client to change any keyboard settings, since not all the
11USB report options are supported.
12
13Hardware Supported: JJ50 with the ATmega32a chip.
14Hardware Availability: [KPrepublic on AliExpress](https://www.aliexpress.com/item/jj50-v1-0-Custom-Mechanical-Keyboard-50-PCB-programmed-50-preonic-layouts-bface-firmware-with-rgb/32848915277.html)
15
16This version by [Wayne K. Jones](github.com/WarmCatUK).
17
18
19## Installing and Building
20 8
21Make example for this keyboard (after setting up your build environment): 9Make example for this keyboard (after setting up your build environment):
22 10
23``` 11 make jj50:default
24$ make jj50:default:program
25```
26It should detect the keyboard and set it to bootloader mode automatically, prior to flashing firmware.
27
28See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
29
30Note that this is a complete replacement for the firmware, so you won't be
31using Bootmapper Client to change any keyboard settings, since not all the
32USB report options are supported.
33In addition you may need the AVR toolchain and `bootloadHID` for flashing:
34
35```
36$ brew cask install crosspack-avr
37$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
38```
39
40In order to use the `././util/atmega32a_program.py` script, which can reboot the board into
41the bootloader, you'll need Python 2 with PyUSB installed:
42
43```
44$ pip install pyusb
45```
46
47If you prefer, you can just build it and flash the firmware directly with
48`bootloadHID` if you boot the board while holding down `Backspace` (`key below top right key`) to keep it
49in the bootloader:
50
51```
52$ make jj50
53$ bootloadHID -r jj50_default.hex
54```
55I dont use windows personally, but the following is from ymd96 regarding flashing the atmega32a:
56
57Since 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!
58On Windows, I use [MINGw](http://www.mingw.org/) to compile the keymaps. On Linux or OSX you can simply use the terminal.
59
60Once you have those two pieces of software:
61Build the keyboard with
62```
63$ make jj50:default
64```
65If you make your own layout, change the `default` word to whatever your layout is.
66
67And 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.
68
69
70## Troubleshooting
71 12
721. 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. 13Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
732. Sometimes USB hubs can act weird, so try connecting the board directly to your computer or plugging/unplugging the USB hub.
743. 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.
754. I was occasionally finding that I wasn't flashing changes that I was making to my keymap. If that happens, remove the previous build and simply force rebuild by making with:
76```
77$ rm jj50_default.hex
78$ make -B jj50:default
79$ make -B jj50:default:program
80```
81 14
15 make jj50:default:flash
82 16
17**Reset Key**: Hold down the key `Backspace` (`Key below the top right key`) while plugging in the keyboard.
83 18
19See 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).