Author Topic: Updated documentation, tips and tricks for Leeku PCBs  (Read 7707 times)

0 Members and 1 Guest are viewing this topic.

Offline wholypantalones

  • Thread Starter
  • Posts: 790
  • Location: The Mitten
Updated documentation, tips and tricks for Leeku PCBs
« on: Fri, 05 October 2018, 21:21:30 »
This should cover most Leeku boards: ALPhaS, Finger, FingerUp, CP-SQ, MX1800, MX3000, MX1830, Legacy 1800/3000.

I'd like to compile the knowledge gathered over the years that seems to be spread over multiple threads and forums concerning Leeku PCBs. Feel free to share corrections and other tips and I'll try to update this to reflect those corrections and additions.

How do I change the layout of my pcb?

Leeku PCBs are programmed using software called Jigon which can be found in this thread on kbdlab: http://kbdlab.co.kr/index.php?document_srl=2702787&mid=board_sw

You need the JigOn_xxxxxx.zip (Key mapping GUI) file.

Here is some helpful documentation on using the Jigon software: https://geekhack.org/index.php?topic=83950.msg2236885#msg2236885

Can I run Jigon on Linux or Mac?

Nope, jigon only works on Windows, sadly.

Jigon just crashes every time I try to update the layout on my PCB

Right click on the application icon and choose run Jigon as administrator from the context menu.

Why does the spacebar not work on my PCB?

I have encountered quite a few PCBs where the spacebar is not mapped to anything with the default keymap or mapped to fn, running Jigon and remapping the spacebar should fix this.

Where's the fn or function key?

Default mapping for fn is usually pause or spacebar by default. This can be changed by connecting your PCB to jiGon and remapping.

Why aren't my keymap or LEDs working?

From the linked Jigon documentation above:

Quote
If  the  keyboard  works,  but  setting  the  keymap  or  LEDs  doesn’t,  or  pressing  a  key  in  JigOn  doesn’t  turn  the  key  red,  then  the  version  of  JigOn  and  the  firmware  may  be  mismatched.  Flash  the  keyboard  to  the  firmware  that matches  the  version  of  JigOn  you’re  using(download  them  both  at  once  from  the  original  page!)

In other words use the same version of firmware that matches the Jigon version. If you're using the 170419 version of Jigon, use the 170419 version of firmware.

Why is my keyboard outputting strange characters when I type?

  • You forgot to hit disconnect in the Jigon program. It will output gibberish when connected instead of highlighting the keys in the program.
  • Switch your input language in windows to EN-US.

Can I map keys to turn the LEDs off and on?

For the top LEDs, yes you can. For the bottom RGB Leds, no you can't. They can only be controlled while Jigon is running and connected to your keyboard.

How do I flash the firmware?

You need to download the L3_xxxxxx.zip (All L3-xxx PCBs) or the L3_FW_RESET.zip (RESET FW - Factory reset when set or keymap is corrupted .) which is the firmware, either one will suffice as they tend to be the same.

Unzip the firmware file and plug your keyboard in. Click the loadfw.bat file which is a batch file that runs the l3cmd.exe file, opens bootloadHID_l3.exe and flashes the L3.hex file onto the PCB. You will see a command prompt window open and do it's thing. once done, press any key to continue. Firmware done.

Why am I getting a communication error with device?

Plug your USB cable directly into your computer instead of a USB hub.

Some helpful tips from OracleKev

https://geekhack.org/index.php?topic=95066.msg2660521#msg2660521

L3 boards are easy to deal with when you are aware of just a few things.

When flashing (with loadfw.bat under L3_yymmdd.zip) or updating settings (with JigOn), make sure:
1) L3 board is directly connected to PC's USB
2) There is just one L3 board connected to the PC

If the board is in weird state (not recognized as "L3" device or does not work with the latest firmware update or JigOn)
1) Boot into bootloader (press/short ~ and connect USB, "HIDBOOT" device gets recognized)
2) Run loadfw.bat under L3_FW_RESET.zip

Occasionally, bootloader/firmware are blown due to static electricity or voltage spike from faulty components (especially RGB LEDs), MCU needs to be reprogrammed via ISP loader physically connected to the board.
I haven't seen this being done on GH, so it would be really handy to have someone local (familiar with this sort of things) come up to speed.  If you need the connector (looks like this http://kbdlab.co.kr/index.php?mid=board_CDST33&document_srl=3854117), make one or talk to someone on kbdlab.  My guess is there are fair number of PCBs with blown bootloader/firmware floating around.
If MCU reprogramming doesn't fix things, most likely you are dealing with component failure.  This is beyond typical DIY territory, so your best bet is to talk to the GB runner or local guru.

IMO, L3 boards and software are proven with years of track record.  It's easy to solder and utilities are all self contained.  There are idiosyncrasies like JigOn UI and limited hub/multi device support, but most people don't flash/update their keyboards often.

Can I use TMK or QMK instead of Jigon?

Here's the TMK port: https://github.com/xauser/tmk_keyboard/tree/xauser/keyboard/l3

QMK port: https://geekhack.org/index.php?topic=97623.msg2702250#msg2702250

QMK repo: https://github.com/wholypantalones/leeku_qmk

How do I know if I have a bricked PCB?

Well, this will happen when you plug it in and nothing works as well as a communication error in your device manager. https://imgur.com/OPDo4OV

How do I fix it?

You're going to need an ISP to re-flash the bootloader using the L3_bootloader.zip (Bootloader - use ISP Loader) from here: http://kbdlab.co.kr/index.php?document_srl=2702787&mid=board_sw

Here's a couple of helpful posts (need translation) to help out, I successfully fixed the above PCB last weekend.

http://kbdlab.co.kr/index.php?document_srl=3437863&mid=board_tune

https://web.archive.org/web/20180706063827/http://blog.naver.com/PostView.nhn?blogId=wioiw24&logNo=220781386856&parentCategoryNo=&categoryNo=312&viewDate=&isShowPopularPosts=false&from=postView

Other helpful posts / things /stuff

Having to reflash the layout on power cycle generally means that the firmware and / or jigon version needs to be updated. If that doesn't fix it a bootloader reflash is in order.

dorf_se has some useful videos on programming the PCB at that "keeb" talking site here: https://www.keebtalk.com/t/leeku-pcbs/3683
« Last Edit: Wed, 04 September 2019, 12:48:42 by wholypantalones »

Offline ba7777

  • Posts: 182
  • Location: China
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #1 on: Fri, 05 October 2018, 23:26:38 »
Well done! Thank you very much!

Offline nug

  • Posts: 66
  • Location: Melbourne
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #2 on: Sun, 06 January 2019, 21:26:49 »
Can I use TMK or QMK instead of Jigon?

Here's the TMK port: https://github.com/xauser/tmk_keyboard/tree/xauser/keyboard/l3

Still need clarification on using QMK, but it looks like the controller won't work with QMK.

https://geekhack.org/index.php?topic=94637.msg2594709;topicseen#msg2594709
Actually the board does work with QMK, I use it on my TX65, LZ GHv2 and Finger60 PCB.

I've attached the files in a zip, if you place that folder into the QMK keyboards folder and then run
Code: [Select]
make l3_tkl87:defaultYou can then flash the hex using the loadfw.bat file (referencing the newly created QMK hex file of course)

Note that configuring LEDs and RGB backlighting in QMK is tricky for these boards. I've only managed to get an LED indicator on layer activation to work.

EDIT: The attached zip contains the configs for L3_Finger60, L3_Finger65, and L3_TKL87. I haven't taken into account alternative layouts so you'll need to modify the keymaps. I was able to compile the default hex in MSYS2.
« Last Edit: Mon, 07 January 2019, 01:47:37 by nug »

Offline sapphyr

  • Posts: 58
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #3 on: Fri, 09 August 2019, 14:29:41 »
Can I use TMK or QMK instead of Jigon?

Here's the TMK port: https://github.com/xauser/tmk_keyboard/tree/xauser/keyboard/l3

Still need clarification on using QMK, but it looks like the controller won't work with QMK.

https://geekhack.org/index.php?topic=94637.msg2594709;topicseen#msg2594709
Actually the board does work with QMK, I use it on my TX65, LZ GHv2 and Finger60 PCB.

I've attached the files in a zip, if you place that folder into the QMK keyboards folder and then run
Code: [Select]
make l3_tkl87:defaultYou can then flash the hex using the loadfw.bat file (referencing the newly created QMK hex file of course)

Note that configuring LEDs and RGB backlighting in QMK is tricky for these boards. I've only managed to get an LED indicator on layer activation to work.

EDIT: The attached zip contains the configs for L3_Finger60, L3_Finger65, and L3_TKL87. I haven't taken into account alternative layouts so you'll need to modify the keymaps. I was able to compile the default hex in MSYS2.

i was able to build the hex file for qmk with my custom keymap. how do I now flash the PCB? I've put it in bootloader mode using ~ and USB cable, but doing a make l3_finger65:default:dfu doesn't find the PCB to flash it? Is there something else I need to do?

I'm on a mac. Thanks

Offline nug

  • Posts: 66
  • Location: Melbourne
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #4 on: Fri, 09 August 2019, 16:39:25 »

i was able to build the hex file for qmk with my custom keymap. how do I now flash the PCB? I've put it in bootloader mode using ~ and USB cable, but doing a make l3_finger65:default:dfu doesn't find the PCB to flash it? Is there something else I need to do?

I'm on a mac. Thanks

I think you'll need to use a windows computer to flash the hex, I don't have any experience with mac. If you have access to a windows comp, you need to put the PCB into bootloader mode and then using Command Prompt, run loadfw.bat after editing the bat file to reference your new hex. e.g., the bat file should have something like:
Code: [Select]
l3cmd.exe cmd boot
bootloadHID_l3.exe -r your.hex
pause;
That will flash your new hex to the PCB.

Offline romevi

  • Formerly romevi
  • * Exalted Elder
  • Posts: 8907
  • Location: The Windy City
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #5 on: Fri, 09 August 2019, 16:41:55 »
The RGBs on mine suddenly go bonkers. Usually I can fix this with reflashing the firmware, but that doesn't work anymore. The lights now stutter, so I've turned them off.

The switch LEDs still work fine.

Offline Pejano

  • Posts: 4
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #6 on: Sun, 17 November 2019, 06:34:38 »
Does anyone know how to switch layers? I seem to be stuck on Layer 2 and I have no idea how to get back to Layer 0! Thanks.

Offline suicidal_orange

  • * Global Moderator
  • Posts: 3740
  • Location: England
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #7 on: Sun, 17 November 2019, 06:44:11 »
Does anyone know how to switch layers? I seem to be stuck on Layer 2 and I have no idea how to get back to Layer 0! Thanks.
You need to map a key on each layer to return to another layer.  If you're stuck unplug the USB and plug it in again and it will return to the default layer.


Great thread by the way, hadn't seen it before :thumb:
                               
Ducky Zero, MX Reds    JD40, Jailhouse Blues           GH60
Soarer controller

Offline wholypantalones

  • Thread Starter
  • Posts: 790
  • Location: The Mitten
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #8 on: Sun, 17 November 2019, 07:00:21 »
Does anyone know how to switch layers? I seem to be stuck on Layer 2 and I have no idea how to get back to Layer 0! Thanks.
You need to map a key on each layer to return to another layer.  If you're stuck unplug the USB and plug it in again and it will return to the default layer.


Great thread by the way, hadn't seen it before :thumb:

Thanks, in addition you should make sure your default layer is set to layer 0.

Offline Pejano

  • Posts: 4
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #9 on: Sun, 17 November 2019, 15:49:22 »
Thank you! I didn't notice the default was set to Layer 2 in the JigOn software.

For some reason it seemed to have lost some of my mappings. After I configured it back to how I had it, it's now doing some strange behaviour. For example, sometimes pressing the spacebar types "fx6d" in random patterns. I checked the mappings for spacebar on all layers and it is configured correctly. I've unplugged it several times and it's still acting strange.

I'm not sure why it's been behaving like this recently. Any ideas?

Update: I flashed the firmware again (to the same version) and the issue still persists. Sometimes when I press Ctrl it activates Caps Lock and seems to switch layers. Ctrl + A highlights and then erases all of my text. In JigOn when I press a button on the bottom row it highlights each key in the column from top-to-bottom before it identifies the correct key pressed. Are these indications that there might be a short or some bad soldering? I bought this keyboard (TX-CP v1) second hand but have been using it fine for the past few months.
« Last Edit: Sun, 17 November 2019, 17:29:37 by Pejano »

Offline suicidal_orange

  • * Global Moderator
  • Posts: 3740
  • Location: England
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #10 on: Mon, 18 November 2019, 02:43:48 »
When you press a key in a text editor while the keyboard is connected to jigon it will output something like [a-d] which (I assume) is the row and column identifier for that key.  If all the keys that light up share a letter they are electrically connected and you have a hardware issue.
                               
Ducky Zero, MX Reds    JD40, Jailhouse Blues           GH60
Soarer controller

Offline tonyjones

  • Posts: 23
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #11 on: Sun, 31 May 2020, 10:06:08 »
Does anybody know how to fix a Leeku PCB TX87 that is not recognized by windows... I get the  "Unknown USB Device (Descriptor Request Failed)" message in device manager

Offline Jubileus

  • Posts: 89
Re: Updated documentation, tips and tricks for Leeku PCBs
« Reply #12 on: Wed, 24 June 2020, 21:10:02 »
Hi, My TX1800 PCB seems to be bricked on its own.
I'm checking this guide to fix it up. https://kbdlab.co.kr/index.php?document_srl=3437863&mid=board_tune
Just wondering if I should use the same command "avrdude -c usbasp -p atmega32 -U hfuse:w:0xDF:m -U lfuse:w:0x0E:m"? Or do I have to change "0xDF" and "0x0E" thats specific to my board? Thanks