diff options
Diffstat (limited to 'keyboards/jj40/README.md')
-rw-r--r-- | keyboards/jj40/README.md | 79 |
1 files changed, 8 insertions, 71 deletions
diff --git a/keyboards/jj40/README.md b/keyboards/jj40/README.md index 7d3612554..5f4d2c8a9 100644 --- a/keyboards/jj40/README.md +++ b/keyboards/jj40/README.md | |||
@@ -4,81 +4,18 @@ | |||
4 | 4 | ||
5 | A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. | 5 | A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. |
6 | 6 | ||
7 | Keyboard Maintainer: [QMK Community](https://github.com/qmk) | 7 | * Keyboard Maintainer: [QMK Community](https://github.com/qmk) |
8 | Hardware Supported: Atmega32A | 8 | * Hardware Supported: Atmega32A |
9 | Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_32828781103.html) | 9 | * Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj40-Custom-Mechanical-Keyboard-40-PCB-programmed-40-planck-layouts-bface-firmware-gh40/3034003_32828781103.html) |
10 | 10 | ||
11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
12 | 12 | ||
13 | make jj40:default:program | 13 | make jj40:default |
14 | 14 | ||
15 | See [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. | 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) |
16 | 16 | ||
17 | Note that this is a complete replacement for the firmware, so you won't be | 17 | make jj40:default:flash |
18 | using Bootmapper Client to change any keyboard settings, since not all the | ||
19 | USB report options are supported. | ||
20 | 18 | ||
21 | In addition you may need the AVR toolchain and `bootloadHID` ([GitHub repo](https://github.com/whiteneon/bootloadHID)) for flashing: | 19 | **Reset Key**: Hold down the *Top Right Key* key, commonly programmed as *Backspace* while plugging in the keyboard. |
22 | 20 | ||
23 | For macOS: | 21 | 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). |
24 | ``` | ||
25 | $ brew cask install crosspack-avr | ||
26 | $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb | ||
27 | ``` | ||
28 | |||
29 | For Linux: | ||
30 | ``` | ||
31 | $ sudo apt install libusb-dev | ||
32 | $ wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz | ||
33 | $ tar -xzf bootloadHID.2012-12-08.tar.gz | ||
34 | $ cd bootloadHID.2012-12-08/commandline | ||
35 | $ make | ||
36 | $ sudo cp bootloadHID /usr/bin | ||
37 | ``` | ||
38 | |||
39 | In order to use the `././util/atmega32a_program.py` script, which can reboot the board into | ||
40 | the bootloader, you'll need Python 2 with PyUSB installed: | ||
41 | |||
42 | ``` | ||
43 | $ pip install pyusb | ||
44 | ``` | ||
45 | |||
46 | If you prefer (or are having issues with a `program` flash), you can just build it (`make jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with | ||
47 | `bootloadHID` if you boot the board while holding down `Backspace` (`Top Right Key`) to keep it | ||
48 | in the bootloader: | ||
49 | |||
50 | ``` | ||
51 | $ make jj40 | ||
52 | $ bootloadHID -r jj40_default.hex | ||
53 | ``` | ||
54 | |||
55 | For Windows 10: | ||
56 | Windows sometimes doesn't recognize the jj40. The easiest way of flashing a new layout is probably using [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
57 | 1. Go to Windows Device Manager and find the keyboard (plug it in while holding down `Backspace` (`Top Right Key`)). It can be found under Human Interface Devices or under Keyboards. | ||
58 | 2. Go to properties and the Details tab to find the hardware ID. You want the VID and the PID (code after the underscore). Plug them into HIDBootFlash and hit Find Device. | ||
59 | 3. Use `make jj40:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device. | ||
60 | |||
61 | |||
62 | ## Troubleshooting | ||
63 | |||
64 | 1. Try plugging the board in while pressing `Backspace` (`Top Right Key`). This will force it | ||
65 | to boot only the bootloader without loading the firmware. Once this is | ||
66 | done, just reflash the board with the original firmware. | ||
67 | 2. Sometimes USB hubs can act weird, so try connecting the board directly | ||
68 | to your computer or plugging/unplugging the USB hub. | ||
69 | 3. If you get an error such as "Resource Unavailable" when attemting to flash | ||
70 | on Linux, you may want to compile and run `tools/usb_detach.c`. See `tools/README.md` | ||
71 | for more info. | ||
72 | |||
73 | ## Recovery | ||
74 | If you flash a bad hex (e.g. you have a V1 board without RGB and compile/flash blindly without editing your rules.mk), your jj40 is now semi-bricked and you're stuck unless you have access to an ISP. The [ISP Flashing Guide](https://docs.qmk.fm/#/isp_flashing_guide) contains very good (but somewhat generalized) information. However, the instructions below should get you up and running provided you have an Arduino or clone. | ||
75 | |||
76 | ### Arduino Setup | ||
77 | 1. Upload the ArduinoISP sketch onto your Arduino board (https://www.arduino.cc/en/Tutorial/ArduinoISP). | ||
78 | 2. Wire the Arduino to the jj40. Match the data pins on the Arduino to those on the jj40. "RST" usually goes to D10 on the Arduino. I didn't need a capacitor when using my Uno. | ||
79 |  | ||
80 | 3. Get a working bootloader from https://blog.winkeyless.kr/m/152. The file is called "main.hex" from the archive called "ps2avrGB_bootloader_161215.zip" Copy "main.hex" to your qmk folder. | ||
81 | 4. Burn the bootloader with the following command | ||
82 | ` avrdude -b 19200 -c avrisp -p atmega32 -v -e -U hfuse:w:0xD0:m -U lfuse:w:0x0F:m -U flash:w:main.hex:i -P comPORT` | ||
83 | Change `comPORT` to whatever port is used by the Arduino (e.g. `com11` in Windows or `/dev/ttyACM0` in Linux). Use Device Manager in Windows to find the port being used. Use `ls /dev/tty*` in Linux. | ||
84 | 5. If this process is successful, you should now be able to upload normally. | ||