Easy AVR USB Keyboard Firmware and Keymapper

[metalliqaz]

Depends on the specific microcontroller part. Got to find that out.

[sethk_]

Depends on the specific microcontroller part. Got to find that out.

ATMEGA32A-A

[metalliqaz]

Unfortunately that's a no-go

[sethk_]

Unfortunately that's a no-go

Okay, thank you!

[henz]

I have a A87 ps2avr keyboard which is in a working condition which i want to change layout on. Ive tried browsing a couple of threads, but have not come to any conclusion. Isnt there a easy way to change layouts?

[metalliqaz]

I have a A87 ps2avr keyboard which is in a working condition which i want to change layout on. Ive tried browsing a couple of threads, but have not come to any conclusion. Isnt there a easy way to change layouts?

Not with this firmware.  Those Koreans are still married to the outdated PS/2 protocol, so they don't like to use the USB AVR parts.  My firmware is built for the USB AVR parts.

[henz]

I have a A87 ps2avr keyboard which is in a working condition which i want to change layout on. Ive tried browsing a couple of threads, but have not come to any conclusion. Isnt there a easy way to change layouts?

Not with this firmware.  Those Koreans are still married to the outdated PS/2 protocol, so they don't like to use the USB AVR parts.  My firmware is built for the USB AVR parts.

Any chance you can point me in the right direction?(if there is one )

[FreeChemicals]

What would you require to add Duck Viper support? It uses an ATMega32u4 and a 74HC237D.

[metalliqaz]

Basically I just need the hardware info.  Is there a matrix description anywhere?

[emguy]

How difficult it is to add support to the GH60 Satan PCB ? https://geekhack.org/index.php?topic=66624.msg1712129#msg1712129

[lebao]

I have a A87 ps2avr keyboard which is in a working condition which i want to change layout on. Ive tried browsing a couple of threads, but have not come to any conclusion. Isnt there a easy way to change layouts?

Not with this firmware.  Those Koreans are still married to the outdated PS/2 protocol, so they don't like to use the USB AVR parts.  My firmware is built for the USB AVR parts.

Any chance you can point me in the right direction?(if there is one )

FYI

[suicidal_orange]

How difficult it is to add support to the GH60 Satan PCB ? https://geekhack.org/index.php?topic=66624.msg1712129#msg1712129

Looks like a 32u4 so it will work, but you need to find/work out the key matrix (which pins on the controller go to which rows/columns of switches) and find some way of putting it into bootloader mode

[emguy]

How difficult it is to add support to the GH60 Satan PCB ? https://geekhack.org/index.php?topic=66624.msg1712129#msg1712129

Looks like a 32u4 so it will work, but you need to find/work out the key matrix (which pins on the controller go to which rows/columns of switches) and find some way of putting it into bootloader mode

This pcb (aka. GH60_REV_CHN) has been widely used in China. I bought one last week and discovered that the procedure of customization and reflashing is EXTREMELY tedious. If you can make your program work with this pcb, LOTS of Chinese people, as far as I know, will benefit from it.

The source of its firmware is modified from that for the GH60. You will find that there are only little differences (mostly in pins) between this GH60_REV_CHN and GH60 (Rev.A or Rev.B).  These differences can be found in this file https://github.com/kairyu/tmk_keyboard_custom/blob/master/keyboard/gh60/matrix.c (search for the keyword CHN).

There is also a very small change in setting the LEDs. See this file https://github.com/kairyu/tmk_keyboard_custom/blob/master/keyboard/gh60/config.h at line 59.

Other than those, this pcb should be the same as GH60 (either Rev.A or Rev.B), so is the way to enter the bootloader mode (I guess).  The bootloader mode can also be enter through pressing the push button on the backside of the pcb.

If you feel that adding the support for this pcb is not difficult, I'm very welling to help you to test your program.

[bovineblitz]

I feel like this has been asked before but I dug around for over and hour and figured I should just ask... is there a decent way to get this to work with a handwired TKL with a teensy 2.0?  I can't figure out how to get the handwiring layout to match up with an appropriate number of rows and columns.  I used it to make a small handwired footboard for a handicapped friend, so I get the general idea, I feel like I'm missing something simple here though.

[suicidal_orange]

I feel like this has been asked before but I dug around for over and hour and figured I should just ask... is there a decent way to get this to work with a handwired TKL with a teensy 2.0?  I can't figure out how to get the handwiring layout to match up with an appropriate number of rows and columns.  I used it to make a small handwired footboard for a handicapped friend, so I get the general idea, I feel like I'm missing something simple here though.

I wrote the below before thinking about this again - the handwire option supports 6x17 and that's exactly what a standard TKL appears to be.  So you just need to connect the switches going across each row using diodes, and downwards using just wire.

Perhaps you mean making it look good in the keymap editor?  If so you need to remove the appropriate "MAKE_SPACER" entries in handwire.cfg - copy the example to the bottom of the file and give it a new name just in case it goes horribly wrong.  You don't want to hide any rows or columns, but will need some of those entries left in for the gaps around the arrows.

If I am missing something perhaps the below will help - it shows the kind of thinking needed to magic up extra space - seemed a waste to delete it

Have you tried merging the arrows in the main section by moving alt, menu and ctrl as far left as you can and shift left one?

The remaining keys need to be connected as two columns of six so I would connect the nav cluster as one "column" and print screen, scroll lock and pause/break as the other, then connect the "rows" from ins, home and page to the key above.

[punkpc]

Any hopes of support for the KC60 that is being sold on Massdrop?

https://www.massdrop.com/buy/kc60-mechanical-keyboard

it has the ATmega32u4 controller

[bovineblitz]

I feel like this has been asked before but I dug around for over and hour and figured I should just ask... is there a decent way to get this to work with a handwired TKL with a teensy 2.0?  I can't figure out how to get the handwiring layout to match up with an appropriate number of rows and columns.  I used it to make a small handwired footboard for a handicapped friend, so I get the general idea, I feel like I'm missing something simple here though.

I wrote the below before thinking about this again - the handwire option supports 6x17 and that's exactly what a standard TKL appears to be.  So you just need to connect the switches going across each row using diodes, and downwards using just wire.

Perhaps you mean making it look good in the keymap editor?  If so you need to remove the appropriate "MAKE_SPACER" entries in handwire.cfg - copy the example to the bottom of the file and give it a new name just in case it goes horribly wrong.  You don't want to hide any rows or columns, but will need some of those entries left in for the gaps around the arrows.

If I am missing something perhaps the below will help - it shows the kind of thinking needed to magic up extra space - seemed a waste to delete it

Have you tried merging the arrows in the main section by moving alt, menu and ctrl as far left as you can and shift left one?

The remaining keys need to be connected as two columns of six so I would connect the nav cluster as one "column" and print screen, scroll lock and pause/break as the other, then connect the "rows" from ins, home and page to the key above.

You are right, I totally did the noobest thing and forgot that 0 is a column.  I was thinking there were 16, and it would be confusing as all hell to deal with just 16.  The editor not looking perfect is fine, and there's enough pins in a teensy 2.0.  Thanks for the lightbulb!

[metalliqaz]

Any hopes of support for the KC60 that is being sold on Massdrop?

https://www.massdrop.com/buy/kc60-mechanical-keyboard

it has the ATmega32u4 controller

Probably, let me know when you have one in hand

[RavenII]

If you plan on adding the Nerd60 (Atmega32u4), there are some cool things you can do with one of the LEDs (the caps lock).

The "Key Lock" option is really the PB5 "Caps Lock"...with the stock firmware it...

1. Lights up while you hold "Macro Trigger".
2. Breathes (pulses) when you double tap (lock) the "Macro Trigger" button.
3. It blinks when you triple tap the "Macro Trigger" (Program Macros)
4. Blinks twice when you double tap (lock) either FN layer.

[punkpc]

Any hopes of support for the KC60 that is being sold on Massdrop?

https://www.massdrop.com/buy/kc60-mechanical-keyboard

it has the ATmega32u4 controller

Probably, let me know when you have one in hand

Won't have my hands on it till middle of August, but I will post all info needed once I do.

[metalliqaz]

How difficult it is to add support to the GH60 Satan PCB ? https://geekhack.org/index.php?topic=66624.msg1712129#msg1712129

Looks like a 32u4 so it will work, but you need to find/work out the key matrix (which pins on the controller go to which rows/columns of switches) and find some way of putting it into bootloader mode

This pcb (aka. GH60_REV_CHN) has been widely used in China. I bought one last week and discovered that the procedure of customization and reflashing is EXTREMELY tedious. If you can make your program work with this pcb, LOTS of Chinese people, as far as I know, will benefit from it.

The source of its firmware is modified from that for the GH60. You will find that there are only little differences (mostly in pins) between this GH60_REV_CHN and GH60 (Rev.A or Rev.B).  These differences can be found in this file https://github.com/kairyu/tmk_keyboard_custom/blob/master/keyboard/gh60/matrix.c (search for the keyword CHN).

There is also a very small change in setting the LEDs. See this file https://github.com/kairyu/tmk_keyboard_custom/blob/master/keyboard/gh60/config.h at line 59.

Other than those, this pcb should be the same as GH60 (either Rev.A or Rev.B), so is the way to enter the bootloader mode (I guess).  The bootloader mode can also be enter through pressing the push button on the backside of the pcb.

If you feel that adding the support for this pcb is not difficult, I'm very welling to help you to test your program.

I'll check it out.  Do you think many will make it to the USA?

[metalliqaz]

If you plan on adding the Nerd60 (Atmega32u4), there are some cool things you can do with one of the LEDs (the caps lock).

The "Key Lock" option is really the PB5 "Caps Lock"...with the stock firmware it...

1. Lights up while you hold "Macro Trigger".
2. Breathes (pulses) when you double tap (lock) the "Macro Trigger" button.
3. It blinks when you triple tap the "Macro Trigger" (Program Macros)
4. Blinks twice when you double tap (lock) either FN layer.

I've started adding some enhanced LED functions.  It's been going slow, I've been enjoying the summer lately.

[RavenII]

I've started adding some enhanced LED functions.  It's been going slow, I've been enjoying the summer lately.

I don't blame you, if we ever see Sumner this year in Chicago...I'll probably enjoy it too...

[suicidal_orange]

I'll check it out.  Do you think many [GH60 Satans] will make it to the USA?

I've seen this PCB mentioned on here quite a lot recently, half the time as a cheap option for a 60% build and the other half people moaning about the firmware.  Seems a good candidate for EasyAVR

[metalliqaz]

The Advanced LED Config is starting to shape up.  Here's my current Zeta config.



Trying to test it now

[metalliqaz]

Okay I put up a new release (6/20) with the latest expansion to LED configuration.  It hasn't had enough testing to call it a full release.

The normal LED menus are gone, and there is now a popup window for configuring LEDs.  It runs in one of two modes.  Basic is just like before.  Advanced gives full control over what LED gets set for every situation.  These actions can now include blink codes.

[RavenII]

Okay I put up a new release (6/20) with the latest expansion to LED configuration.  It hasn't had enough testing to call it a full release.

The normal LED menus are gone, and there is now a popup window for configuring LEDs.  It runs in one of two modes.  Basic is just like before.  Advanced gives full control over what LED gets set for every situation.  These actions can now include blink codes.

Works fine on the Frosty Flake. Perhaps you can add "All" as an LED location??

[suicidal_orange]

Oh no, you've expanded the matrix on the handwire )  Is this feature now stabilised?  I'll have to revisit my config files which isn't fun, so I'll wait until it is if not. 

Oh and thanks for bringing back the multiplatform build

[metalliqaz]

Its stable now

[JaccoW]

Is this compatible with the Duck Lightpad/Butterlfy pad?

[metalliqaz]

Not yet.  If you can dig up the details I can probably support it

[JaccoW]

What kind of details would you need?

[RavenII]

What kind of details would you need?

Row/column to what pins.

Something like this or this

[wes1099]

Does it work with the RedScarf 60% (RS60)? I know it uses the ATMEGA32U4. Other than that, there is no information on it or how to do the firmware stuff.

[RavenII]

Does it work with the RedScarf 60% (RS60)? I know it uses the ATMEGA32U4. Other than that, there is no information on it or how to do the firmware stuff.

Supports ATmega32U4, ATmega32U2, and ATmega16U2

Technically it's possible, but I can imagine that between life, work, adding keyboards, features, taking care of bugs, work, and life...etc...I can imagine that it might take a while if it even gets added. Not only that, but if you look at a few posts above, you need to know the Matrix of the keyboard in question. I gave examples.

[VinnyCordeiro]

Does it work with the RedScarf 60% (RS60)? I know it uses the ATMEGA32U4. Other than that, there is no information on it or how to do the firmware stuff.

Supports ATmega32U4, ATmega32U2, and ATmega16U2

Technically it's possible, but I can imagine that between life, work, adding keyboards, features, taking care of bugs, work, and life...etc...I can imagine that it might take a while if it even gets added. Not only that, but if you look at a few posts above, you need to know the Matrix of the keyboard in question. I gave examples.

This guy added support for Redscarf on TMK, but I don't know if it is the same model.

[metalliqaz]

A TMK build is sufficient, because I can get the matrix info from the code.  If there are several models of the RedScarf with different matrix configurations, then obviously that would be a problem.

At this point, I've had requests for the following

KMAC mini
viper
lightpad
kc60
G60 Satan
RS60

I think that's everything.  Since I don't own the hardware, the most important requirement for each is a "champion".  Someone who owns the board, is able to track down the hardware details, and willing to try out lots of test builds.  The energy of the champion is what makes it happen.

If you want support but don't have the skill or time to be a champion, then your only other option is to ship me your keyboard and wait.

I was on vacation, so I may be able to get a test for some of the above boards out fairly soon now that I'm home.

[RavenII]

A TMK build is sufficient, because I can get the matrix info from the code.  If there are several models of the RedScarf with different matrix configurations, then obviously that would be a problem.

At this point, I've had requests for the following

KMAC mini
viper
lightpad
kc60
G60 Satan
RS60

I think that's everything.  Since I don't own the hardware, the most important requirement for each is a "champion".  Someone who owns the board, is able to track down the hardware details, and willing to try out lots of test builds.  The energy of the champion is what makes it happen.

If you want support but don't have the skill or time to be a champion, then your only other option is to ship me your keyboard and wait.

I was on vacation, so I may be able to get a test for some of the above boards out fairly soon now that I'm home.

Nerd60?

[flabbergast]

This guy added support for Redscarf on TMK, but I don't know if it is the same model.

I recently got a Red Scarf II 60% (Ver A, rs60) from taobao. I'm using that firmware, it works relatively OK, once I figured out the other changes that he did to the standard TMK (like reading the keymap from eeprom, which is not erased on reprogramming - so I couldn't understand why it's still using the old keymap even though I changed stuff in keymap.c).

I am willing to do some work for supporting this board in Easy AVR. I can check connections on the PCB and such, and can do some firmware testing. As far as LEDs are concerned, ATM I only have the Caps Lock LED (and these funky 4 SMT LEDs on the bottom for the "logo"). I can also understand avr-gcc code - but I guess that's not too helpful here

I'll provide the hardware matrix (perhaps tomorrow). It's my main keyboard at the moment.

EDIT: I'm using KBT Pure layout (standard - split right shift). Until I have another usable board, I don't really want to resolder the switches to something else - so I hope that the support can be done without that.

[JaccoW]

A TMK build is sufficient, because I can get the matrix info from the code.  If there are several models of the RedScarf with different matrix configurations, then obviously that would be a problem.

At this point, I've had requests for the following

KMAC mini
viper
lightpad
kc60
G60 Satan
RS60

I might be getting my hands on one of those in the next few weeks. I'll look into it and make some pictures of the PCB if I can.

[wes1099]

A TMK build is sufficient, because I can get the matrix info from the code.  If there are several models of the RedScarf with different matrix configurations, then obviously that would be a problem.

At this point, I've had requests for the following

KMAC mini
viper
lightpad
kc60
G60 Satan
RS60

I think that's everything.  Since I don't own the hardware, the most important requirement for each is a "champion".  Someone who owns the board, is able to track down the hardware details, and willing to try out lots of test builds.  The energy of the champion is what makes it happen.

If you want support but don't have the skill or time to be a champion, then your only other option is to ship me your keyboard and wait.

I was on vacation, so I may be able to get a test for some of the above boards out fairly soon now that I'm home.

Nerd60?

Why not use GON's tool he made for that? He has a guide for it here and you can download it on the same page from the downloads tab.

[metalliqaz]

I've been told that GON's boards dont use the DFU or Teensy bootloaders, so there isn't really a way to program my code to the Nerd60.  If I'm mistaken about that, just let me know.

[RavenII]

I've been told that GON's boards dont use the DFU or Teensy bootloaders, so there isn't really a way to program my code to the Nerd60.  If I'm mistaken about that, just let me know.

You're required to change the bootloader, but after that...field day.

[metalliqaz]

Yeah not sure how many people have AVR dev kits

[RavenII]

Not supporting it, got it.

[suicidal_orange]

Not supporting it, got it.

You can always pretend it's handwired and set it up yourself, the firmware won't be offended )

[flabbergast]

OK, so here's the info I gathered about my Red Scarf II. If you need some photos, just ask.

Code: [Select]

Board Info
==========

- Silkscreen on the bottom side says "Red Scarf II 60" and "Ver.A". Top side "logo" says "RS60".
- This version has no ISO option, only ANSI.
- Right shift can be split, backspace can be split (HHKB-style).
- DFU bootloader (activated on reset, does not erase eeprom on erase).
- AVR ISP pins are broken out to through-hole pads (yay!), order is (starting from the end closer to the middle of the board).

    gnd miso vcc sck mosi reset

- The [TMK files from Kai Ryu](https://github.com/kairyu/tmk_keyboard_custom/blob/master/keyboard/RedScarfII) work with this keyboard. Note that these sources assume a bigger keyboard (numpad + function keys), but 60% is really just a subset of that.

Summary
=======

Rows
----

Row selection is done via a 74HCT138 decoder. Its inputs are routed to PB0, PB1 and PB2. Rows are unselected by taking these high. Rows (0,1,2,3,4 for the 60% version) are selected by writing the binary representation of the row to the three pins; here's a table from the above sources:

    row:     0   1   2   3   4   5   x
    pin: B2  0   1   0   1   0   1   1
         B1  0   0   1   1   0   0   1
         B0  0   0   0   0   1   1   1

Initialisation is just marking the pins as outputs.

Columns
-------

Tied like this:

    col: 0   1   2   3   4   5   6   7   8   9   10  11  12  13
    pin: F4  F1  F0  B3  D0  D1  D4  D5  D6  D7  F7  F6  D2  D3

    -------------------------------------------------------------
    |C0 | C1| C2| C3| C4| C5| C6| C7| C8| C9|C10|C11|C12| C13 |(R2,C12 if split Bsp)
    +-----------------------------------------------------------+
    |C0   | C1| C2| C3| C4| C5| C6| C7| C8| C9|C10|C11|C12| C13 |
    +-----------------------------------------------------------+
    |C0    | C1| C2| C3| C4| C5| C6| C7| C8| C9|C10|C11|  C13   |
    +-----------------------------------------------------------+
    |C0      | C2| C3| C4| C5| C6| C7| C8| C9|C10|C11|  C12 |C13|
    +-----------------------------------------------------------+
    |C0  | C1 | C2 |           C9           |C10 |C11 |C12 |C13 |
    -------------------------------------------------------------

Initialised as inputs with pull-ups; triggered when low.

Wiring
------

Column_pin --- switch --- diode anode (+) --- diode cathode (-) --- row pin on 74HCT138

LEDs
----

- CapsLock:  PC7 (on when pin low)
- Logo:      PC6 (this is 4 SMT leds on the bottom side below spacebar + one unpopulated SMT led on the bottom side, edge below Tab) (on when pin high)
- Backlight: PB7 (on when pin high)
- There is no numlock LED.

I would be really happy if you could add support for this board into your firmware! (I'm willing to test!)

[RavenII]

Not supporting it, got it.

You can always pretend it's handwired and set it up yourself, the firmware won't be offended )

Wait, you mean, it doesn't HAVE to be a teensy?

[nova779]

I really like this firmware, I have it loaded on my phantom and my Ghost Squid that just arrived today and all the testing that I have done so far it works great on the Ghost Squid, the only thing missing is the windows key lock LED that is located on F9 not a big deal considering I don't use it. Thanks for all of your hard work on it.

[RavenII]

Not supporting it, got it.

You can always pretend it's handwired and set it up yourself, the firmware won't be offended )

Wait, you mean, it doesn't HAVE to be a teensy?

Nevermind, I realized what/how you meant...but I don't think it'll work, the matrix uses PE2 which isn't mapped on a teensy.