Easy AVR USB Keyboard Firmware and Keymapper

[MOZ]

Sir!

Here are the matrix positions of the GH-122.2016.  In addition to the main matrix (Row 0-6 and Column 0-23) there are three LED circuits and two PWM backlighting circuits.  I have not wired up the backlighting, but people might, so could you please enable them in software?

Here is the matrix, including a translation between my designations of A1 through G24 to your 0,0 through 6,23:


<table bgcolor=white border=1px>
<tr><th colspan=3>Matrix Position</th></tr>
<tr><th width=60px>Pin</th><th width=60px>Connection</th><th width=80px>Matrix</th></tr>
<tr><td>F7</td><td>1</td><td>Column 0</td></tr>
<tr><td>F6</td><td>2</td><td>Column 1</td></tr>
<tr><td>F5</td><td>3</td><td>Column 2</td></tr>
<tr><td>F4</td><td>4</td><td>Column 3</td></tr>
<tr><td>F3</td><td>5</td><td>Column 4</td></tr>
<tr><td>F2</td><td>6</td><td>Column 5</td></tr>
<tr><td>C7</td><td>7</td><td>Column 6</td></tr>
<tr><td>F0</td><td>8</td><td>Column 7</td></tr>
<tr><td>F1</td><td>9</td><td>Column 8</td></tr>
<tr><td>E1</td><td>10</td><td>Column 9</td></tr>
<tr><td>C0</td><td>11</td><td>Column 10</td></tr>
<tr><td>C1</td><td>12</td><td>Column 11</td></tr>
<tr><td>C2</td><td>13</td><td>Column 12</td></tr>
<tr><td>C3</td><td>14</td><td>Column 13</td></tr>
<tr><td>C4</td><td>15</td><td>Column 14</td></tr>
<tr><td>C5</td><td>16</td><td>Column 15</td></tr>
<tr><td>C6</td><td>17</td><td>Column 16</td></tr>
<tr><td>E7</td><td>18</td><td>Column 17</td></tr>
<tr><td>D7</td><td>19</td><td>Column 18</td></tr>
<tr><td>E6</td><td>20</td><td>Column 19</td></tr>
<tr><td>E0</td><td>21</td><td>Column 20</td></tr>
<tr><td>D6</td><td>22</td><td>Column 21</td></tr>
<tr><td>B0</td><td>23</td><td>Column 22</td></tr>
<tr><td>D5</td><td>24</td><td>Column 23</td></tr>
<tr><td>B6</td><td>A</td><td>Row 0</td></tr>
<tr><td>B5</td><td>B</td><td>Row 1</td></tr>
<tr><td>B1</td><td>C</td><td>Row 2</td></tr>
<tr><td>D4</td><td>D</td><td>Row 3</td></tr>
<tr><td>D3</td><td>E</td><td>Row 4</td></tr>
<tr><td>D2</td><td>F</td><td>Row 5</td></tr>
<tr><td>D1</td><td>G</td><td>Row 6</td></tr>
<tr><td>B3</td><td>CAPS</td><td></td></tr>
<tr><td>B4</td><td>NUM</td><td></td></tr>
<tr><td>B2</td><td>SCRL</td><td></td></tr>
<tr><td>B7</td><td>PWM 1</td><td></td></tr>
<tr><td>D0</td><td>PWM 2</td><td></td></tr>
</table>


Attached is a detail shot of the controller and a couple of switches so you can see the matrix and the diodes for yourself.  I'll also e-mail you a spreadsheet with all of this information sorted various ways.

Thanks for adding this little guy to your expanding roster!  Please let me know if you need anything else.  (ANSI and ISO layouts, for example.)

 - Ron | samwisekoi

How soon do you need this, I could give it a try to better understand my way around EasyAVR.

[metalliqaz]

I started last week so I'm mostly done already.

This board has so many layout options I'll never be able pre-program them all, but I'll make some example layout options and users can customize to their liking.

[samwisekoi]

I started last week so I'm mostly done already.

This board has so many layout options I'll never be able pre-program them all, but I'll make some example layout options and users can customize to their liking.

Thanks very much!

Those layout options are why I am SO looking forward to designing multi-purpose plates.

Anyhow, thanks!

 - Ron | samwisekoi

[metalliqaz]

I committed GH-122 support just now.  The next release will have it.  When the boards show up there will probably have to be some tweaks, but don't sweat it.  Shouldn't be difficult.

[samwisekoi]

I committed GH-122 support just now.  The next release will have it.  When the boards show up there will probably have to be some tweaks, but don't sweat it.  Shouldn't be difficult.

Awesome!  Thanks very much!

I see the Python on Github, but no current executable on the wiki.  Am I missing something?

Thanks again,

 - Ron | samwisekoi

[edit] Ah, I see: "The next release will have it." Ok.  I won't start my layout this morning. [/edit]

[metalliqaz]

I committed GH-122 support just now.  The next release will have it.  When the boards show up there will probably have to be some tweaks, but don't sweat it.  Shouldn't be difficult.

Awesome!  Thanks very much!

I see the Python on Github, but no current executable on the wiki.  Am I missing something?

Thanks again,

 - Ron | samwisekoi

[edit] Ah, I see: "The next release will have it." Ok.  I won't start my layout this morning. [/edit]

Okay I posted 2.1.7 to the wiki

[kagey]

I played around with the customizing the firmware to work properly on the Mac. Previous and Next Track keycodes worked with iTunes just fine, but not anything else like Spotify. What I found is that the Rewind (0xB4) and Fast Foward (0xB3) keycodes should be sent instead. Just as a quick dirty hack I modified SC_WIN_CP_NEXT_TRACK and SC_WIN_CP_PREV_TRACK to these values, and they work correctly. Spotify seems happy, iTunes still works as well.

Scroll Lock and Pause will decrease and increase monitor brightness respectively for anyone interested and wasn't aware. The Mac will take those keys and make them F14 and F15, and Print Screen should be F13. F14 and F15 are the default Brightness controls set by the OS. I was trying to assign additional function keys but the Mac will not pick up any of the function keys higher than F12, I'm still looking into that.

I'm using a QFR with a Frosty Flake v2, love it with no real issues to complain about. The firmware works great otherwise.

I have never owned a Mac, so I know that my Mac support is weak.  All the media keys were added using Microsoft's guidance.  Thanks for this input.  Perhaps Mac support can be added.

Actually for the most part everything works. Just had to swap those keys around for Media playback to function properly. I haven't had an issue with anything else but the function keys. If I figure out anything on that I'll let you know. I'm using it full time on an iMac with 3 layers and nothing bad to say. I had more trouble installing the Atmel Studio as I selected the wrong chip support the first go round.

Did you ever figure out how to get the mission control / expose (f3) to work?

[metalliqaz]

mission control / expose (f3)

I don't know what this means.

[kagey]

mission control / expose (f3)

I don't know what this means.

This key:

[MJ45]

@kagey; You can set your f4 key for expose in the system preferences/mission control/pane, or any other f key you want for it.

[kagey]

@kagey; You can set your f4 key for expose in the system preferences/mission control/pane, or any other f key you want for it.

Yeah, that's what I've done for the time being, but I'd like to assign that expose keycode to a different key if it's possible in firmware.

[MJ45]

@kagey; You can set your f4 key for expose in the system preferences/mission control/pane, or any other f key you want for it.

Yeah, that's what I've done for the time being, but I'd like to assign that expose keycode to a different key if it's possible in firmware.

I don't think that is possible, its a Mac OS thing not a standard USB keyboard key scancode. Once you set it in the system preferences whatever keyboard you use will respond with that same key choice. 

[HPE1000]

Anyone try it with the satan gh60 yet?

[Moistgun]

Anyone try it with the satan gh60 yet?

Nope, I used TMK for mine.

[wery]

How do we request a keyboard to be added. Interested in using this on the Bantamm.

[MOZ]

You can check the GitHub repo for how to add a custom keyboard, it is quite easy to be honest.

[Siraj]

Is it possible to program a key to BackspaceFn so that it works as backspace when pressed and released but works as a function key when pressed and held down in combination with another key (like a modifier).
I've tried programming the primary function as Fn and the Tap key as Backspace but I don't actually have the switches in my PCB to check if it works.

[metalliqaz]

Is it possible to program a key to BackspaceFn so that it works as backspace when pressed and released but works as a function key when pressed and held down in combination with another key (like a modifier).
I've tried programming the primary function as Fn and the Tap key as Backspace but I don't actually have the switches in my PCB to check if it works.

You've got it right but it won't work until I release the next version.  There is a known bug in the code that would prevent tapkeys from working.  Releasing it now...

[metalliqaz]

Okay, 2.1.9 has been posted to the wiki.  I strongly urge everyone to upgrade.  There was a pretty big bug in the keymapper that broke most advanced key assignments.

[MOZ]

Is it possible to program a key to BackspaceFn so that it works as backspace when pressed and released but works as a function key when pressed and held down in combination with another key (like a modifier).
I've tried programming the primary function as Fn and the Tap key as Backspace but I don't actually have the switches in my PCB to check if it works.

You've got it right but it won't work until I release the next version.  There is a known bug in the code that would prevent tapkeys from working.  Releasing it now...

Confirmed. Just tested on my Phantom. Set the key as FN key and Backspace for tap function.

[dragonpower2000]

is rgb support in handqired boards a thing?

[metalliqaz]

is rgb support in handqired boards a thing?

I know of several users who are working to add RGB support for their own projects.  Hopefully they will do it well enough that their work can be integrated into the main project.  I don't own one myself.

[metalliqaz]

And user dchae is on fire, with two bugs found in two days.

Version 2.1.10 is released!  This one fixes tapkeys getting unwelcome modification from their mother keys.

[Siraj]

Good to see that you're passionate about your software   

Quick question: What does the boot function do? I'm assuming it boots the keyboard with the flashed layout but how would it recognise that boot has been pressed if the keyboard hasn't been booted yet!

[MOZ]

The Boot key, puts the keyboard in boot mode to flash a new firmware. This is useful if you don't have easy access to the boot mode key (usually a small push button on the underside of the PCB)

[metalliqaz]

Boot is short for bootloader.

[Cadriel]

Hi all,

Slightly confused individual here. I have some questions for clarification;

I have my first custom inbound, being a GH 60 Satan. It's going to have LED's for each key installed. I have EasyAVR running in mint and windows.

1.
Is back lighting setup to work with the default config? I.e., if I assign the BL_ENABLE, BL_DIMMER and BL_MODE to keys - my led's will dim etc? (It looks like the back light boolean is set to false in the config)

2.
In the advanced LED setup, I notice that I can only configure a single indicator - being the caps lock. I assume this means I'd have to modify the board configuration to define other LED's capable of toggling on and off.. (i.e., I'd like to have the LED associated with my Fn key toggle based on if the layer is active). I've taken a look at the configuration, and it appears I may need to assign specific pin's to each LED. Is this possible with my PCB?

3.
Are there some docs describing what each Mode: drop-down is for in the key mapper?

If I'm on the right track then I might attempt to get all of this working and fire off a PR.

Cheers!

[metalliqaz]

Hi all,

Slightly confused individual here. I have some questions for clarification;

I have my first custom inbound, being a GH 60 Satan. It's going to have LED's for each key installed. I have EasyAVR running in mint and windows.

1.
Is back lighting setup to work with the default config? I.e., if I assign the BL_ENABLE, BL_DIMMER and BL_MODE to keys - my led's will dim etc? (It looks like the back light boolean is set to false in the config)

The Satan support currently doesn't support backlights.  Honestly I didn't know the Satan had backlights.  I don't own one.  Support is trivial to add, but I need someone to give me the details of the hardware.  What pins control the backlights?

2.
In the advanced LED setup, I notice that I can only configure a single indicator - being the caps lock. I assume this means I'd have to modify the board configuration to define other LED's capable of toggling on and off.. (i.e., I'd like to have the LED associated with my Fn key toggle based on if the layer is active). I've taken a look at the configuration, and it appears I may need to assign specific pin's to each LED. Is this possible with my PCB?

Again, I don't know the specific details of the hardware, but if it's anything like the GH60, the Caps Lock is the only indicator.

3.
Are there some docs describing what each Mode: drop-down is for in the key mapper?

If I'm on the right track then I might attempt to get all of this working and fire off a PR.

Cheers!

there are docs.  Use the Help menu.  It is your friend.

[suicidal_orange]

Metalliqaz - according to this TMK branch the backlight on the GH60revCHN is PWM on PB6 and the Caps Lock indicator is on PB2

[metalliqaz]

Metalliqaz - according to this TMK branch the backlight on the GH60revCHN is PWM on PB6 and the Caps Lock indicator is on PB2

Okay great.  That will take about 30 seconds to implement.

[metalliqaz]

Hi all,

Slightly confused individual here. I have some questions for clarification;

I have my first custom inbound, being a GH 60 Satan. It's going to have LED's for each key installed. I have EasyAVR running in mint and windows.

1.
Is back lighting setup to work with the default config? I.e., if I assign the BL_ENABLE, BL_DIMMER and BL_MODE to keys - my led's will dim etc? (It looks like the back light boolean is set to false in the config)

2.
In the advanced LED setup, I notice that I can only configure a single indicator - being the caps lock. I assume this means I'd have to modify the board configuration to define other LED's capable of toggling on and off.. (i.e., I'd like to have the LED associated with my Fn key toggle based on if the layer is active). I've taken a look at the configuration, and it appears I may need to assign specific pin's to each LED. Is this possible with my PCB?

3.
Are there some docs describing what each Mode: drop-down is for in the key mapper?

If I'm on the right track then I might attempt to get all of this working and fire off a PR.

Cheers!

Posted ver 2.1.11 with backlight support added to the GH60 Satan.  Unfortunately this is a hardware change so old saved layouts won't work

Thanks to suicidal_orange

[Cadriel]

Fantastic! Thank you!

[samwisekoi]

Building GH-122.2016 firmware with v 2.01.08 to push onto a Teensy++ and this happened.

It seems ungood.

 - Ron | samwisekoi

[metalliqaz]

Building GH-122.2016 firmware with v 2.01.08 to push onto a Teensy++ and this happened.

It seems ungood.

 - Ron | samwisekoi

It's one of your macros. Sequences longer than 1 char have to end with a comma.  \ENTER, and so on

[samwisekoi]

Yup.  Thanks.  It was this one:

Code: [Select]

\CTRL(\SHIFT(u))2588\SPACE,
That compiles now, anyhow.  (It is the Linux way of typing special characters using Unicode values instead of ASCII.)

Thanks for your help!

 - Ron | samwisekoi

[metalliqaz]

Good to hear it

I really wish I hadn't been a lazy bastard when I wrote the macro stuff.  The macro language makes parsing easy but is so un-intuitive.  Oh well, too late to change it now.

What I should do, however, is make the error messages for macro syntax errors more helpful.

[samwisekoi]

Good to hear it

I really wish I hadn't been a lazy bastard when I wrote the macro stuff.  The macro language makes parsing easy but is so un-intuitive.  Oh well, too late to change it now.

What I should do, however, is make the error messages for macro syntax errors more helpful.

Especially if you are going to Soarer out on us!

Anyhow, Good News, Everyone!  I have a Teensy++ programmed with firmware that functions on at least two random-ish simulated keypresses. (Placing a diode between pins F4 and B1 sends a "1" out via the USB cable!)  Now I just need a giant PCB and a couple of hours of soldering time...

Thanks again, sir!

 - Ron | samwisekoi  <-- soon to be typed via Fn+F1

[AKmalamute]

I haven't seen any mention of the Sentraq (recently shipped from MD) 60% ...
I've just finished following the directions for writing a "hand wired" board and the EasyKeyMap program doesn't immediately die (turns out "teensy = false" is wrong; it's "teensy = False" ) so I'm thinking maybe I'm on to something.

my config file is here but be warned it's WKL / Dvorak and I'm not totally sure I read the TMK file correctly to set the LED.

 I haven't soldered mine together yet so I can't test this but maybe someone else following, has this keyboard ...? I can post the notes in the TMK file explaining about ISO / split backspace (and the extra key for 1.25/6.25 layout) if anybody's curious.

[metalliqaz]

I haven't seen any mention of the Sentraq (recently shipped from MD) 60% ...
I've just finished following the directions for writing a "hand wired" board and the EasyKeyMap program doesn't immediately die (turns out "teensy = false" is wrong; it's "teensy = False" ) so I'm thinking maybe I'm on to something.

my config file is here but be warned it's WKL / Dvorak and I'm not totally sure I read the TMK file correctly to set the LED.

 I haven't soldered mine together yet so I can't test this but maybe someone else following, has this keyboard ...? I can post the notes in the TMK file explaining about ISO / split backspace (and the extra key for 1.25/6.25 layout) if anybody's curious.

Never heard of it.  Just point me towards the TMK I can make sure your file works. 

[AKmalamute]

Never heard of it.  Just point me towards the TMK I can make sure your file works.

It's in here.
https://github.com/VinnyCordeiro/tmk_keyboard/tree/master/keyboard/s60-x

Thanks for looking over my handiwork.

[Jersern]

Just wondering, is possible to make the Monarch LHTK keyboard compatible with EasyAVR? Thanks!

[suicidal_orange]

Just wondering, is possible to make the Monarch LHTK keyboard compatible with EasyAVR? Thanks!

ATMega? check. Documentation? check.

Yup, no problem here.  I'll have a go if metalliqaz doesn't get there first )

[Jersern]

ATMega? check. Documentation? check.

Yup, no problem here.  I'll have a go if metalliqaz doesn't get there first )

Please do! If you (or metalliqaz) can get it working, that would be absolutely amazing

[metalliqaz]

Just wondering, is possible to make the Monarch LHTK keyboard compatible with EasyAVR? Thanks!

ATMega? check. Documentation? check.

Yup, no problem here.  I'll have a go if metalliqaz doesn't get there first )

I'd appreciate it.  My Sigma project is taking up most of my time these days.  If you work it out send a pull request and we'll get it into the releases.

[samwisekoi]

Ok, I am sure there needs to be a comma or two in here:

Code: [Select]

/CTRL(CV)
My desire is to have ^c ^v be output (COPY then PASTE).

But so far I get the text of the macro as shown above.

Thanks in advance!

 - Ron | samwisekoi
(Auto-typed by my GH36 Matrix Keypad.)

[metalliqaz]

You used forward slash instead of backslash

[suicidal_orange]

I've gone for this layout from the Monarch thread, strange as the numberpad is
 


Apart from the little "key" (not usable) over the number pad enter it looks right, but does it work?  I hope so...

The hex is attached, please test it

edit: I have + and - switched on the numberpad, that will be corrected.

edit2 I also have an up arrow in the numberpad, that will be corrected too

[metalliqaz]

I've gone for this layout from the Monarch thread, strange as the numberpad is
 

Show Image

Show Image

Apart from the little "key" (not usable) over the number pad enter it looks right, but does it work?  I hope so...

The hex is attached, please test it

edit: I have + and - switched on the numberpad, that will be corrected.

Nice!  To fix that enter key you should need a spacer of width -4, like this: (-4, None, '0')

Do you have a github account?  If so send a pull request.  Don't forget to give yourself attribution in the new file.  Otherwise I can add it to master whenever.

[suicidal_orange]

I've gone for this layout from the Monarch thread, strange as the numberpad is
 

Show Image

Show Image

Apart from the little "key" (not usable) over the number pad enter it looks right, but does it work?  I hope so...

The hex is attached, please test it

edit: I have + and - switched on the numberpad, that will be corrected.

Nice!  To fix that enter key you should need a spacer of width -4, like this: (-4, None, '0')

Do you have a github account?  If so send a pull request.  Don't forget to give yourself attribution in the new file.  Otherwise I can add it to master whenever.

Thanks - layout fixed.  Looks much better without a floating part-key )

I don't have github, might be worth setting one up though if I can get confident with doing these (not sure on the diode and LED settings when converting TMK config) but not doing anything with this one until I know it works, does the attribution in the copyright at the top or ??  Would never have thought to add one!

[metalliqaz]

I've gone for this layout from the Monarch thread, strange as the numberpad is
 

Show Image

Show Image

Apart from the little "key" (not usable) over the number pad enter it looks right, but does it work?  I hope so...

The hex is attached, please test it

edit: I have + and - switched on the numberpad, that will be corrected.

Nice!  To fix that enter key you should need a spacer of width -4, like this: (-4, None, '0')

Do you have a github account?  If so send a pull request.  Don't forget to give yourself attribution in the new file.  Otherwise I can add it to master whenever.

Thanks - layout fixed.  Looks much better without a floating part-key )

I don't have github, might be worth setting one up though if I can get confident with doing these (not sure on the diode and LED settings when converting TMK config) but not doing anything with this one until I know it works, does the attribution in the copyright at the top or ??  Would never have thought to add one!

Yeah it's at the top with the copyright line.  You'd just add another line under mine with 2016 and your name, if you choose to use it.  By the terms of the GPL, the license has to stay.