diff options
Diffstat (limited to 'keyboards/jj4x4/README.md')
-rw-r--r-- | keyboards/jj4x4/README.md | 68 |
1 files changed, 9 insertions, 59 deletions
diff --git a/keyboards/jj4x4/README.md b/keyboards/jj4x4/README.md index 29dc2605d..a7c93c930 100644 --- a/keyboards/jj4x4/README.md +++ b/keyboards/jj4x4/README.md | |||
@@ -2,70 +2,20 @@ | |||
2 | 2 | ||
3 |  | 3 |  |
4 | 4 | ||
5 | A 4x4 keypad kit made and KPRepublic on AliExpress. This is a chopped off version of the jj40 with rearranged keys. | 5 | A 4x4 keypad kit made and KPRepublic on AliExpress. This is a chopped off version of the jj40 with rearranged keys. |
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/item/jj4x4-jj4X4-16-keys-Custom-Mechanical-Keyboard-PCB-programmed-numpad-layouts-bface-firmware-with-rgb-bottom/32901955446.html?spm=2114.search0104.3.7.3ebf431ae1d9ic&ws_ab_test=searchweb0_0,searchweb201602_4_10065_10130_10068_10547_319_317_10548_10545_10696_453_10084_454_10083_433_10618_431_10307_537_536_10902_10059_10884_10887_321_322_10103,searchweb201603_6,ppcSwitch_0&algo_expid=9d1891dd-80af-4793-a889-5a62e1fdfdd8-1&algo_pvid=9d1891dd-80af-4793-a889-5a62e1fdfdd8&transAbTest=ae803_5) | 9 | * Hardware Availability: [AliExpress](https://www.aliexpress.com/item/jj4x4-jj4X4-16-keys-Custom-Mechanical-Keyboard-PCB-programmed-numpad-layouts-bface-firmware-with-rgb-bottom/32901955446.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 jj4x4:default:program | 13 | make jj4x4: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 jj4x4: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 key located at *K00*, commonly programmed as *8* 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 `8` (second from top, second from left, with usb plug is at the top) to keep it | ||
48 | in the bootloader: | ||
49 | |||
50 | ``` | ||
51 | $ make jj40 | ||
52 | $ bootloadHID -r jj4x4_default.hex | ||
53 | ``` | ||
54 | |||
55 | For Windows 10: | ||
56 | Windows sometimes doesn't recognize the jj4x4. 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 `8` (second from top, second from left, with usb plug is at the top)). 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 jj4x4:<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 `8` (usb plug at top, second from top, second from left). 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. | ||