Author Topic: Golbat keyboard programming guide  (Read 5176 times)

0 Members and 1 Guest are viewing this topic.

Offline sithlord

  • Thread Starter
  • Posts: 43
Golbat keyboard programming guide
« on: Thu, 29 December 2016, 13:22:35 »
Edit: New links updated.
Original guide to programming:

Step 1: Go to https://kai.tkg.io or yang.tkg.io (Chinese). This is the site that will be building the main firmware for the board.
Step 2: Choose the Kimera as the keyboard (not the two headed)
Step 3: Click the config button and replace the text in the "matrix mapping" box with the following code http://pastebin.com/Bf2uQWHv
Step 3.1: Modify the Row mapping to be 1-4, and Column mapping to be 5-16.
Step 4.1: Go to keyboard layout editor and setup your mapping http://www.keyboard-layout-editor.com/#/gists/83b7eb12b3bccdf4c55d
Step 4.2: When you're making your layouts, make each layout separately AND INCLUDE BOTH LEGENDS.
   For example, the "." key requires the "." and ">" in the mapping to work.
   See the help section on enjoyclick for all the symbols to use http://www.enjoyclick.org/tkg/#help
Step 5: Paste the layouts for each layer into the corresponding boxes on enjoyclick
Step 6: Choose your fn options.
   NOTE: fn covers a wide range of options including LEDs, not just changing layers.
Step 7: See the following for details on the LEDs http://pastebin.com/zSVN4f9j
Step 8: Download your firmware as a .eep file
Step 9: From the following toolkit, https://github.com/kairyu/tkg-toolkit, download the files in the windows tree.
Step 10.1: Run the batch file "setup.bat" from the toolkit.
   This only has to be done the first time you're flashing your board.
Step 10.2: The options tree is as such "12Kimera core>N>1.Default>1.ateml_dfu"
Step 11: Click the reset button on the golbat PCB (it's on the back).
Step 12: Run "zadig_2.1.2.exe" and Install the Driver (Not WCID).
   This only has to be done the first time you're flashing the golbat.
Step 12.1 :When you go to the "TOOL" folder and open "ZADIG_2.2" make sure your device is in boot mode (by pressing button first).
   Then under "options" click "List all devices" and select "ATm32UDFU" then you will be able to "INSTALL DRIVER"
Step 13: Drag and drop the .eep firmware file (Icons on the folder) that you created onto the batch file "reflash.bat"

Here is a guild I created to program the Golbat keyboard if you want screenshots and pictures:
https://docs.google.com/document/d/1PKgcLqUNK5ih4HROSKHDGSnp7DRoiRm6Ttt0aHPeTos

I made it to help the buyer of my keyboard make their own layout.

As I am seeing several people encounter problems when making new firmware, I think it is a better idea to start a new thread rather than use the GB thread ( https://geekhack.org/index.php?topic=78510.500)

When posting your problem, please describe what kind of problems you are encountering, including screenshots of your matrix and layout if possible.

I will do my best to answer your questions but please keep in mind that I have already sold my Golbat so anything I tell you is from memory and personal experience.

I've attached the firmware file that I used last to this post and Dropbox version is in the link below:
(For anyone that needs to test if their keyboard if functional).

https://www.dropbox.com/s/pvapuamq69zvr13/keymap_8.eep?dl=0

« Last Edit: Fri, 20 January 2017, 16:48:11 by sithlord »

Online exitfire401

  • * Global Moderator
  • Posts: 2928
  • Location: United States
  • The Force is Re/\l
Re: Golbat keyboard programming guide
« Reply #1 on: Thu, 29 December 2016, 13:33:50 »
Here is a guild I created to program the Golbat keyboard:
https://docs.google.com/document/d/1PKgcLqUNK5ih4HROSKHDGSnp7DRoiRm6Ttt0aHPeTos

I made it to help the buyer of my keyboard make their own layout.

As I am seeing several people encounter problems when making new firmware, I think it is a better idea to start a new thread rather than use the GB thread ( https://geekhack.org/index.php?topic=78510.500)

When posting your problem, please describe what kind of problems you are encountering, including screenshots of your matrix and layout if possible.

I will do my best to answer your questions but please keep in mind that I have already sold my Golbat so anything I tell you is from memory and personal experience.

I've been putting off building mine because I forgot where to find the original guide. Thanks a ton! Looks like I have no reason not to build mine anymore!
Boards: Kingsaver Complicated Blue Alps |Sprit 60% Transparent MX Clears in Gateron housings with 62g gold Sprit springs lubed and RGB color shifting LEDs | Ducky Shine Zone MX Black with Blue LEDs | Realforce 10AE Variable Silenced

B/S/T thread: https://geekhack.org/index.php?topic=55351.0

Past projects: KBT Race 2 L.E.
Past Boards: Ducky Shine 2 | KBT Pure | LZ Aluminum Skin| HHKB | Realforce 23u |

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #2 on: Thu, 29 December 2016, 16:19:43 »
Do you still want me to post the original guide that I made? I know I have it around somewhere. I'll probably need to remake it too with R2.

Offline sithlord

  • Thread Starter
  • Posts: 43
Re: Golbat keyboard programming guide
« Reply #3 on: Thu, 29 December 2016, 16:31:39 »
Do you still want me to post the original guide that I made? I know I have it around somewhere. I'll probably need to remake it too with R2.

Sure. Let me know where to find it and I will edit it into my post.

Is it this list?

Step 1: Go to http://www.enjoyclick.org/tkg/#. This is the site that will be building the main firmware for the board.
Step 2: Choose the Kimera as the keyboard (not the two headed)
Step 3: Click the config button and replace the text in the "matrix mapping" box with the following code http://pastebin.com/Bf2uQWHv
Step 3.1: Modify the Row mapping to be 1-4, and Column mapping to be 5-16.
Step 4.1: Go to keyboard layout editor and setup your mapping http://www.keyboard-layout-editor.com/#/gists/83b7eb12b3bccdf4c55d
Step 4.2: When you're making your layouts, make each layout separately AND INCLUDE BOTH LEGENDS.
   For example, the "." key requires the "." and ">" in the mapping to work.
   See the help section on enjoyclick for all the symbols to use http://www.enjoyclick.org/tkg/#help
Step 5: Paste the layouts for each layer into the corresponding boxes on enjoyclick
Step 6: Choose your fn options.
   NOTE: fn covers a wide range of options including LEDs, not just changing layers.
Step 7: See the following for details on the LEDs http://pastebin.com/zSVN4f9j
Step 8: Download your firmware as a .eep file
Step 9: From the following toolkit, https://github.com/kairyu/tkg-toolkit, download the files in the windows tree.
Step 10.1: Run the batch file "setup.bat" from the toolkit.
   This only has to be done the first time you're flashing your board.
Step 10.2: The options tree is as such "12Kimera core>N>1.Default>1.ateml_dfu"
Step 11: Click the reset button on the golbat PCB (it's on the back).
Step 12: Run "zadig_2.1.2.exe" and Install the Driver (Not WCID).
   This only has to be done the first time you're flashing the golbat.
Step 12.1 :When you go to the "TOOL" folder and open "ZADIG_2.2" make sure your device is in boot mode (by pressing button first).
   Then under "options" click "List all devices" and select "ATm32UDFU" then you will be able to "INSTALL DRIVER"
Step 13: Drag and drop the .eep firmware file (Icons on the folder) that you created onto the batch file "reflash.bat"

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #4 on: Thu, 29 December 2016, 17:39:06 »
Yup that's the one!

Offline sithlord

  • Thread Starter
  • Posts: 43
Re: Golbat keyboard programming guide
« Reply #5 on: Mon, 09 January 2017, 11:10:59 »
Yup that's the one!

It's actually on the first page of my guide.

I've added it to the original post.

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #6 on: Fri, 13 January 2017, 12:52:26 »
New address :kai.tkg.io or yang.tkg.io.
The golbat in GB1, choose kimera-golbat v2.
The golbat in GB2 will add into the tkg web tool after it finish.

Offline sithlord

  • Thread Starter
  • Posts: 43
Re: Golbat keyboard programming guide
« Reply #7 on: Wed, 18 January 2017, 14:46:18 »
guide updated

Offline sithlord

  • Thread Starter
  • Posts: 43
Re: Golbat keyboard programming guide
« Reply #8 on: Mon, 30 January 2017, 18:38:25 »
morph2k4 has reported that the eep file created from the new website is shifting the rows and columns.

Offline morph2k4

  • Posts: 6
Re: Golbat keyboard programming guide
« Reply #9 on: Wed, 01 February 2017, 16:46:51 »
I suspect that it is actually ignoring the layout all together and sending down a default layout.  I haven't confirmed this yet, but when I flash one of these eep files, I get number keys on row 2, which are no where in my layout.

Offline Quakemz

  • Posts: 66
  • Location: Washington
Re: Golbat keyboard programming guide
« Reply #10 on: Sun, 05 February 2017, 05:29:12 »
This exact same issue is happening with me. :/

I'm pretty darn positive I did the setup and layout correctly, but when I successfully flash, I get some keys doing nothing and others doing something completely different - F-keys on some of row 1, numbers on some of row 2, etc.

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #11 on: Sun, 05 February 2017, 14:03:13 »
I'll make sure to notify GFW about this to get it working shortly (hopefully)

Offline Quakemz

  • Posts: 66
  • Location: Washington
Re: Golbat keyboard programming guide
« Reply #12 on: Tue, 07 February 2017, 08:25:57 »
I'll make sure to notify GFW about this to get it working shortly (hopefully)

Thanks, bud!
« Last Edit: Fri, 10 February 2017, 18:13:21 by Quakemz »

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #13 on: Sat, 11 February 2017, 00:25:59 »
This is what GFW replied back with:
enjoyclick.org is closed.
Please use the new address :kai.tkg.io or yang.tkg.io
In the new web-tool, choose the setting:kimera default>config>Preset:Golbat v2.

I suspect that he misunderstood the problem so I'll follow up because I don't thin kit works.

Offline morph2k4

  • Posts: 6
Re: Golbat keyboard programming guide
« Reply #14 on: Thu, 23 February 2017, 13:47:11 »
Any update on this?  Golbat programming is still down afaik.

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #15 on: Thu, 23 February 2017, 13:57:22 »
I'm still in contact with GFW about the issue!

Offline morph2k4

  • Posts: 6
Re: Golbat keyboard programming guide
« Reply #16 on: Thu, 09 March 2017, 00:39:55 »
Anything?

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #17 on: Fri, 10 March 2017, 06:27:41 »
Not yet :( sorry about the delay in this.


Offline morph2k4

  • Posts: 6
Re: Golbat keyboard programming guide
« Reply #18 on: Fri, 31 March 2017, 16:47:27 »
up!  Still dead in the water.

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #19 on: Mon, 03 April 2017, 06:32:38 »
I'm back from my training so I'll talk to GFW about this. But the last time I talked to him he said it was working on his end (he's programming the new golbats atm)

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #20 on: Mon, 03 April 2017, 17:04:07 »
I've attached the stock firmware and my final mapping to this post so you can maybe adapt to one of them in the meantime while I try and get the firmware builder sorted.

Offline hebbler

  • Posts: 13
  • Location: Tampa, FL
Re: Golbat keyboard programming guide
« Reply #21 on: Thu, 11 May 2017, 16:25:39 »
Didn't know if anyone else was waiting on an update, so I thought I'd bump this.

IT WORKS NOW!

I was able to successfully reflash a new custom layout using the instructions in the first post, plus the notes from January 13th about what to select.  Got the keys mapped correctly and the LEDs working.  I was also able to reflash mine using the browser built-in flash utility.

Offline sithlord

  • Thread Starter
  • Posts: 43
Re: Golbat keyboard programming guide
« Reply #22 on: Thu, 10 August 2017, 22:13:53 »
vadurr is reporting an issue with flashing the board in WIN 10

"Apparently I am unable to drop the .eep folder into the reflash. It just doesn't do anything when I try and drag and drop it. I've tried running the reflash, hitting yes, and resetting the board as well and it doesnt seem to do anything. I'm just kind of stuck with the stock layout which I'm not even sure is haha. Any help you can give me would be greatly appreciated! Cheers!"

Is anyone else getting this issue?

Offline MAR82

  • Posts: 475
  • Location: It says I'm in France
  • Keyboard Addict
Re: Golbat keyboard programming guide
« Reply #23 on: Sun, 03 September 2017, 15:55:39 »
vadurr is reporting an issue with flashing the board in WIN 10

"Apparently I am unable to drop the .eep folder into the reflash. It just doesn't do anything when I try and drag and drop it. I've tried running the reflash, hitting yes, and resetting the board as well and it doesnt seem to do anything. I'm just kind of stuck with the stock layout which I'm not even sure is haha. Any help you can give me would be greatly appreciated! Cheers!"

Is anyone else getting this issue?

I'm not having any issues flashing with Win10. But I am having issues setting up my eep file. It seems that my row and columns are off again, and I'm not sure how to fix it.
When put the row and column info manually it just goes to Golbat v2, but all my keys are off from what they should be
I really suck at programming this board :(

Offline MAR82

  • Posts: 475
  • Location: It says I'm in France
  • Keyboard Addict
Re: Golbat keyboard programming guide
« Reply #24 on: Sun, 03 September 2017, 16:07:58 »
Yeah here's a picture of my setup
177405-0
But when I type a "B" it gives me a "W", a "V" gives me a "Q", and "C" gives me "Tab"
If anyone knows why or has any ideas please let me know

Offline odd

  • Posts: 227
Re: Golbat keyboard programming guide
« Reply #25 on: Sun, 19 November 2017, 20:26:15 »
Yeah here's a picture of my setup
(Attachment Link)
But when I type a "B" it gives me a "W", a "V" gives me a "Q", and "C" gives me "Tab"
If anyone knows why or has any ideas please let me know

I have the same issue. I have tried everything to flash this board, At this point I think I might just toss the PCB and handwire it because the case it really nice and I have had enough frustration with this PCB.

Offline MAR82

  • Posts: 475
  • Location: It says I'm in France
  • Keyboard Addict
Re: Golbat keyboard programming guide
« Reply #26 on: Wed, 22 November 2017, 04:34:03 »
Yeah here's a picture of my setup
(Attachment Link)
But when I type a "B" it gives me a "W", a "V" gives me a "Q", and "C" gives me "Tab"
If anyone knows why or has any ideas please let me know

I have the same issue. I have tried everything to flash this board, At this point I think I might just toss the PCB and handwire it because the case it really nice and I have had enough frustration with this PCB.

I have some good news.
Turns out I was able to flash the board back to a working keyboard. The problem is not with the hardware, it's just the configuration tool and/or builder

So like you I had tried everything I could think of to try to get the board to work again, but with no luck.
Then one day I was sorting some old files on a thumb drive and was able to find my original compiled firmware for this board. Tried flashing it, and it worked.

It seems that we just need to see if we can find someone that knows more about this firmware stuff than us, but our boards are still good!

(if it can help and you like my layout, I can always see about sending you the file just to get your board working again)

Offline GL1TCH3D

  • Posts: 1116
  • Location: Quebec, Canada
  • Audiophile, tea lover and now keyboard hugger!
Re: Golbat keyboard programming guide
« Reply #27 on: Sun, 26 November 2017, 22:45:21 »
GUIDE FOR V2

1.kai.tkg.io
2.keyboard>>>kimera
3.Config>>>Golbat v2
4.your keyboard layout
5.download
6.download the toolkit from github(use the last version)

Offline jrhie

  • Posts: 1
  • Location: Seattle, WA
Re: Golbat keyboard programming guide
« Reply #28 on: Tue, 06 March 2018, 23:06:59 »
Does anyone have any updates on their progress? I've been trying to flash my eep and hex files from TMK Keymap Generator (https://kai.tkg.io/) and having no luck. Once I flash, it looks like the layout on my Goldbat R2 is that of a numpad because I can only type 7, 8, 9, /, *, and num lock.

 :(

Offline buckyballs

  • Posts: 62
Re: Golbat keyboard programming guide
« Reply #29 on: Wed, 07 March 2018, 05:33:17 »
Pictures, please?

Offline crusader_alex

  • Posts: 37
Re: Golbat keyboard programming guide
« Reply #30 on: Wed, 14 March 2018, 02:53:31 »
Hey guys,so i bought a golbat r2 from mecharket and i wanted to reprogram it.When i plugged it in to test the pcb all LEDs worked fine but when i actually reprogrammed it none of them worked but one.All the keys are in the places i set them to be.Can anyone please tell me where i've went wrong?

Sent from my ONEPLUS A5000 using Tapatalk


Offline yeahsure

  • Posts: 17
  • -lurks-
Re: Golbat keyboard programming guide
« Reply #31 on: Wed, 14 March 2018, 03:33:22 »
Is it the RGB LEDs you are having trouble with?

EDIT: Oh duh my bad. I just now noticed there aren't any in switch LEDs installed.

To get the RGB LEDs to work you must set LED4 to RGB LED. You'll then get an option for "number of leds" which should be set to 8. You'll also need to change the assigned Fn keys to "Others > Built-in function" which then gives you access to the lighting controls specifically for the RGB leds.
« Last Edit: Wed, 14 March 2018, 03:51:33 by yeahsure »

Offline crusader_alex

  • Posts: 37
Re: Golbat keyboard programming guide
« Reply #32 on: Wed, 14 March 2018, 05:20:02 »
Is it the RGB LEDs you are having trouble with?

EDIT: Oh duh my bad. I just now noticed there aren't any in switch LEDs installed.

To get the RGB LEDs to work you must set LED4 to RGB LED. You'll then get an option for "number of leds" which should be set to 8. You'll also need to change the assigned Fn keys to "Others > Built-in function" which then gives you access to the lighting controls specifically for the RGB leds.
Thank you very much.I'll try it and see if it works.

Sent from my ONEPLUS A5000 using Tapatalk


Offline crusader_alex

  • Posts: 37
Re: Golbat keyboard programming guide
« Reply #33 on: Wed, 14 March 2018, 07:22:19 »
For some reason that didn't seem to work

EDIT: Fixed it.I had to do what you said to all leds and then it started working.

Sent from my ONEPLUS A5000 using Tapatalk
« Last Edit: Wed, 14 March 2018, 07:46:37 by crusader_alex »

Offline yeahsure

  • Posts: 17
  • -lurks-
Re: Golbat keyboard programming guide
« Reply #34 on: Wed, 14 March 2018, 08:42:18 »
For some reason that didn't seem to work

EDIT: Fixed it.I had to do what you said to all leds and then it started working.

Sent from my ONEPLUS A5000 using Tapatalk

Good to hear!  :thumb:

It's been a long time since I last fiddled around with my Golbat so I remembered wrong. Led 1 or 3 may have been the correct one but setting them all to RGB is a sure fire fix. lol

Offline crusader_alex

  • Posts: 37
Re: Golbat keyboard programming guide
« Reply #35 on: Wed, 14 March 2018, 08:53:51 »
For some reason that didn't seem to work

EDIT: Fixed it.I had to do what you said to all leds and then it started working.

Sent from my ONEPLUS A5000 using Tapatalk

Good to hear!  :thumb:

It's been a long time since I last fiddled around with my Golbat so I remembered wrong. Led 1 or 3 may have been the correct one but setting them all to RGB is a sure fire fix. lol
Yeah i think its led 2 and 4 but setting them all sure is a good fix

Sent from my ONEPLUS A5000 using Tapatalk