Author Topic: RedScarfIII Manual (WIP)  (Read 26481 times)

0 Members and 1 Guest are viewing this topic.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
RedScarfIII Manual (WIP)
« on: Thu, 26 February 2015, 03:42:19 »
Some people asked about a manual, and I found some informations, so I'll share what I've found so far, so everyone can experiment and report back.

Feizor gave me a manual for a 60% RedScarfIII (.doc attached file), in chinese sadly.

Please note that I have yet to test anything!!! Just sharing informations.

After a quick glance it seems that you simply create your mapping on http://www.keyboard-layout-editor.com
and then import it on this website : http://www.enjoyclick.org/tkg/. by pasting your raw data into the desired layer.

The Avaible labels being here:
http://www.enjoyclick.org/tkg/#help


Here is the exemple showed in the doc of a pokerII layout(only missing the WASD lock on rShift):
http://www.keyboard-layout-editor.com/#/layouts/7d55431c8a8d9f9bf94b6f6af8ce7c12

Looks like you can do the Fn layer by simply putting the labels into the side-print label.

The pokerII layout exemple helped me understand this part of the manual :

Quote
fn数据

"0":["ACTION_LAYER_MOMENTARY","1"],"1":["ACTION_BACKLIGHT_DECREASE"],"2":["ACTION_BACKLIGHT_TOGGLE"],"3":["ACTION_BACKLIGHT_INCREASE"],"4":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_E"],"5":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_D"],"6":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_R"],"7":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_F"],"8":["ACTION_LAYER_TOGGLE","2"]

This correspond to the action of the label for Fn0 to Fn8 , it seems that Fn8+ are mappable to additional layer.
Fn0: Activate Layer1
Fn1 : backlight decrease
Fn2 : backlight on/off
Fn3 : backlight increase

No idea what the rest is.


Will continue once I have more time.



« Last Edit: Fri, 13 March 2015, 05:20:17 by azhdar »

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #1 on: Thu, 26 February 2015, 03:42:48 »
    This manual is only aimed at helping you set your layout on your redscarfIII keyboard, I'll use the RS96 as an exemple since I got i on hand at the moment.

    • Creating your layout
    * Keyboard layout editor
    * Different modes
    * Labels avaible and priorities


    • Reflashing the keyboard

    * pdf manual
    * precision on the web tool

Creating your layout

Keyboard layout editor
The utily tool to create your layouts for your redscarf is pretty simple, you create it on : http://www.keyboard-layout-editor.com/ and then past it on the web tool to get your keymapping file. You obviously need to be sure that your layout is accepted by the PCB you're working on.

Different modes
On the website (I'll get to the website part latter) there's 3 different modes to generate your layout:
Normal, simple and All-In-One.
I adress it before the website part because It changes how you need to prepare your layout.

Normal: you want to make one layout for each layer , for exemple :
Layer0 : http://www.keyboard-layout-editor.com/#/layouts/c69d3d242b7eca4fcfb534d0d4810604
Layer1 : http://www.keyboard-layout-editor.com/#/layouts/3ee6332b881aa263175a1ddf76b2a336

Simple: you only make one layout and it covers 2 layers , Top label & Bottom label for your regular layout, and Side-Printed label for the second layer. I don't know if you can make more that 2 layers on that mode. exemple :
http://www.keyboard-layout-editor.com/#/layouts/1e84476c846afc053faa0be569906adf

All-in-One: almost similar to Normal mode but you put each of your layer in the same layout just seperate it vertically :
http://www.keyboard-layout-editor.com/#/layouts/254775420a71e52bfb79d6da39000a8e

I achieved the same final layout and layers with the differents links posted above.

Label avaible and priority:
You can find all the usable labels here : http://www.enjoyclick.org/tkg/#help

$INSERT EXPLANATION OF PRIORITY HERE$


About Fn layer: the backlight commands are on the fn mapping, Fn3 is Backlight on/off, Fn1 is increase backlit , Fn2 is decrease , more details on this picture:

Fn0 is the label you want to use to do your regular Fn layer (see the layout posted above).

Since Backlit is taking Fn1 to Fn24 , you still have a total of 9 layers possible: Normal, Fn0, Fn25=>Fn31

$ TEST Fn25+ layers and come back with precisisons$

Reflashing the keyboard
To reflash the keyboard we'll go onto this website:
http://www.enjoyclick.org/tkg/

Before attempting anything on the website please read the "Red Scarf III User's Guide - How to Reflash.pdf" that Ryu provided and that you can download in OP

« Last Edit: Fri, 13 March 2015, 05:19:54 by azhdar »

Offline Shanghaied

  • Posts: 44
  • Location: Sunny Sweden
Re: RedScarfIII Manual
« Reply #2 on: Thu, 26 February 2015, 09:06:13 »
Wow nice, I actually speak Chinese new and have a hopefully working redscarf, so I'll take a look when I get home.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #3 on: Thu, 26 February 2015, 09:13:16 »
Wow nice, I actually speak Chinese new and have a hopefully working redscarf, so I'll take a look when I get home.

Let me know how it goes and report back !

Offline Shanghaied

  • Posts: 44
  • Location: Sunny Sweden
Re: RedScarfIII Manual
« Reply #4 on: Thu, 26 February 2015, 11:46:44 »
Okay, been playing with it for a bit, and azhdar, you appear to be mostly correct. Fn1 - Fn3 are fixed - they control the backlighting. I'm not sure what side labels do, but it might have something to do with the All-in-One and simple modes on the TMK GUI - there all the layers are edited together. In "normal" mode the TMK web GUI lets you edit each layer in the Keyboard Layout Editor - for example picture 3 in the manual shows the Fn0 layer (default), and picture 4 the Fn1 layer (Fn key held down). The URL for each layer is pasted into the respective fields in the GUI, then the GUI will allow you to choose the function of the Fn keys (Fn0-F7), they can either be a momentary modifier for activating layers (e.g. Fn key) or perform other functions, which are listed in the list of labels azhdar posted. Just write past the labels for the desired function into the top label of the key in the Keyboard Layout Editor. After all is done, the border of the input field turns green if everything is correctly edited and you can download the .eep file, otherwise the border remains red.

So far I've not been able to program some Nordic characters ( , etc), because they were not part of the allowable labels, but I'm guessing this can be done with the labels International1 - International9 and LAN1 - LAN9, although I'm sure how yet.

Also I'm still not totally sure how the firmware can be flashed yet. Instruction is provided for GH60: basically, download a package called dfu-reflash.zip; connect the keyboard to the PC and then press the the S1 button on the back of the PCB; wait for the driver to update/install; copy and paste the .eep file into the reflash-gh60_rev_cn.bat file under the dfu-reflash folder; then a window should appear prompting you to press any key to continue; press any key and you are done. Rather ominously, there's a red warning text underneath saying that flashing must been strictly performed as outlined above. Not sure exactly how it will work on RSIII since they are no physical buttons on the back of the PCB that I can see.

Anyway this has been my first programmable keyboard, so anyone with more experience please chime in.




« Last Edit: Thu, 26 February 2015, 11:51:28 by Shanghaied »

Offline byker

  • Literally Canada
  • ** Moderator Emeritus
  • Posts: 3120
  • Location: West Coast - Canada
Re: RedScarfIII Manual
« Reply #5 on: Thu, 26 February 2015, 11:51:00 »
Thanks for starting to put this together azhdar! I am sure it will be useful when my board finally arrives.  :)

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #6 on: Sun, 01 March 2015, 20:18:56 »
Sorry everyone, it's my fault :(
I'm writing the manual and will complete it soon.

Let me explain about the 3 layer modes first.
Normal mode: Ordinary, one raw data one layer.
Simple mode: One raw data for two layers - top&bottom for layer0 and side for layer1, and automatic set fn0~fn3 to common usage.
All-in-one mode: One raw data for mutiple layers, just put layers one by one vertically, for example http://www.keyboard-layout-editor.com/#/layouts/2794625e34ece7201585646e75be9822

You can find more samples here: http://www.enjoyclick.org/wiki/tkg

If you have any question in a rush, please feel free to ask me directly.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #7 on: Sun, 01 March 2015, 22:25:03 »
Quote
Quote
fn数据

"0":["ACTION_LAYER_MOMENTARY","1"],"1":["ACTION_BACKLIGHT_DECREASE"],"2":["ACTION_BACKLIGHT_TOGGLE"],"3":["ACTION_BACKLIGHT_INCREASE"],"4":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_E"],"5":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_D"],"6":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_R"],"7":["ACTION_MODS_KEY","LR_LEFT",["MOD_GUI"],"KC_F"],"8":["ACTION_LAYER_TOGGLE","2"]

This correspond to the action of the label for Fn0 to Fn8 , it seems that Fn8+ are mappable to additional layer.
Fn0: Activate Layer1
Fn1 : backlight decrease
Fn2 : backlight on/off
Fn3 : backlight increase

No idea what the rest is.

The rest seems that someone is using left win key as fn key but he also want some win key combinations work as well, so
Fn4: LWin+E
Fn5: LWin+D
Fn6: LWin+R
Fn7: LWin+F
Fn8: Toggle layer2

I guess layer2 maybe a arrow keys overlay on RShift/RAlt/RWin/RCtrl.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #8 on: Mon, 02 March 2015, 10:16:21 »
Sorry to keep you waiting.
Here is a simple manual for how to reflash RedScarfIII.
And sorry for my poor English.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #9 on: Mon, 02 March 2015, 10:27:25 »
Sorry to keep you waiting.
Here is a simple manual for how to reflash RedScarfIII.
And sorry for my poor English.
No problem man, thanks a lot for this , I'm building mine tomorrow I'll look at it and see if anything is "poorly" translated.

Offline Shanghaied

  • Posts: 44
  • Location: Sunny Sweden
Re: RedScarfIII Manual
« Reply #10 on: Mon, 02 March 2015, 11:49:08 »
Hi ryu, any idea how non English characters like can be programmed in TKG? How do I use the labels like lang1 or thereint1? Thanks.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #11 on: Tue, 03 March 2015, 03:22:51 »
Hi ryu, any idea how non English characters like can be programmed in TKG? How do I use the labels like lang1 or thereint1? Thanks.

I'm not sure what's your goal, so I will try to answer your question with some assuming prerequisite.

First of all, you should know that TKG's mechanism is translating keycap printing to scancode. It attempts to guess what the key is (what the scancode should be) by recognizing the combinations of the labels. So actually a keymap is a cluster of scancodes.

For the first question. As far as I know, how to type non English characters is depended on the keyboard layout setting and IME setting of your host.

If you are using a physical US layout and you want to set your host (I suppose it's a Windows PC) to use US layout too, you can open "Text Services and Input Languages" and add "English > Keyboard > United States-International". Then switch to the new layout added just now, you will get by typing RAlt+p, RAlt+q, RAlt+w respectively.
If your goal is type them by only one key stroking, you can set for example Fn4="Key action > Modified key, modifier=Right Alt, key=p and P", Fn5="Key action > Modified key, modifier=Right Alt, key=q and Q", Fn6="Key action > Modified key, modifier=Right Alt, key=w and W" on TKG. Then you can get by typing fn4, fn5 and fn6.

If you are using a physical Swedish (sorry I'm not familiar with those characters, maybe Swedish?) layout and you want to set your host to use Swedish layout too, you can add the "Swedish > Keyboard > Swedish" layout first (maybe you already have it). And on this condition, actually the scancodes of are same with ;(semi-colon), '(single-quote) and [(square-brackets) of US layout. So putting the US symbols on your keymap is equal to putting the non English characters on it.
Certainly, it's more grace to use the non English characters' self as the label than use the US stand-ins. If you expect this, please help me to collect these characters into a table because I'm really not familiar with them. And then I will add them to available labels, just like how I support ISO layout (you can find them from the number keys).

For the second question, I'm afraid that you may not use lang1 and international1 in that way.

To explain this, here is a specification for reference: Keyboard Scan Code Specification - Microsoft

You can find the descriptions of lang1 (Keyboard LANG1) and international1 (Keyboard Kanji1) at the footnotes of Appendix C. They are handled by the host so we can't decide what they stand for on the keyboard side.

Please feel free to ask me any questions.

Offline Shanghaied

  • Posts: 44
  • Location: Sunny Sweden
Re: RedScarfIII Manual
« Reply #12 on: Tue, 03 March 2015, 08:43:45 »
Ah ryu, what you said is actually very useful! Thank you!

Sorry, but yes it is Swedish (also Finnish, they have the same layout), and I'm currently on a physical Swedish layout. I'll have to think this over once I get home, and try a few things out on TKG.

As for character labels, I was getting seven (7) "unknown label" errors when I was putting in a full Swe/Fin layout, which were ; ` (the last two are a bit weird, since they seem to only exist on Scandinavian layouts). I might take you up on your offer of adding non-English character labels. I can certainly make a table for Scandinavian characters since those are the ones I'm most familiar with. Not sure when though, since I'm in the middle of writing a big report, but hopefully I'll have a bit more time next week...

Thanks again!
« Last Edit: Tue, 03 March 2015, 09:04:20 by Shanghaied »

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #13 on: Wed, 04 March 2015, 14:32:23 »
Hey ryu, I finally tried my hand on this and while trying this layout :
http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
I ended up with the keymap (attached to my post)

I tried both all-in mode and dual layer mode with those layouts:
http://www.keyboard-layout-editor.com/#/layouts/35cfe9dd0da60b6b802c49b73efea04a
http://www.keyboard-layout-editor.com/#/layouts/3ee6332b881aa263175a1ddf76b2a336


Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #14 on: Thu, 05 March 2015, 01:16:57 »
Hi azhdar, I tried your link of KLE as it is and got a seemingly working keymap as the attachment.

The keymap you attached seems to have a empty layout. Did you get any error messages (something in red) when you make it?

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #15 on: Thu, 05 March 2015, 01:32:45 »
Hi azhdar, I tried your link of KLE as it is and got a seemingly working keymap as the attachment.

The keymap you attached seems to have a empty layout. Did you get any error messages (something in red) when you make it?
http://www.keyboard-layout-editor.com/#/layouts/35cfe9dd0da60b6b802c49b73efea04a
I got this:


http://www.keyboard-layout-editor.com/#/layouts/3ee6332b881aa263175a1ddf76b2a336
And for the Fn layer I got this error:
« Last Edit: Thu, 05 March 2015, 01:53:40 by azhdar »

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #16 on: Thu, 05 March 2015, 02:01:21 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #17 on: Thu, 05 March 2015, 02:08:39 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
Damn how did I missed that  :confused:
Will try and report back.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #18 on: Thu, 05 March 2015, 06:57:35 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?



Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #19 on: Thu, 05 March 2015, 21:58:27 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?
I tried the keymap you attached on my bare PCB and I see it works.
It's not necessary to reload Hex file unless you have overwritten the firmware by mistake.
Could you describe your problem in more detail?
For example keyboard cannot be recognized by PC, or can be recognized but nothing happens when typing keys, or key works but keymap is not updated?

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #20 on: Fri, 06 March 2015, 01:06:10 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?
I tried the keymap you attached on my bare PCB and I see it works.
It's not necessary to reload Hex file unless you have overwritten the firmware by mistake.
Could you describe your problem in more detail?
For example keyboard cannot be recognized by PC, or can be recognized but nothing happens when typing keys, or key works but keymap is not updated?
keyboard is recognized , it evens appears as "redscarfIII" but none of the keys works.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #21 on: Fri, 06 March 2015, 01:19:48 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?
I tried the keymap you attached on my bare PCB and I see it works.
It's not necessary to reload Hex file unless you have overwritten the firmware by mistake.
Could you describe your problem in more detail?
For example keyboard cannot be recognized by PC, or can be recognized but nothing happens when typing keys, or key works but keymap is not updated?
keyboard is recognized , it evens appears as "redscarfIII" but none of the keys works.
Then it seems that the firmware is live.
Are you using online reflash or offline reflash? Was the eep file reflashed successfully?
As I wrote in the manual, the task will be cleared from the printing list when successfully completed.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #22 on: Fri, 06 March 2015, 01:30:56 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?
I tried the keymap you attached on my bare PCB and I see it works.
It's not necessary to reload Hex file unless you have overwritten the firmware by mistake.
Could you describe your problem in more detail?
For example keyboard cannot be recognized by PC, or can be recognized but nothing happens when typing keys, or key works but keymap is not updated?
keyboard is recognized , it evens appears as "redscarfIII" but none of the keys works.
Then it seems that the firmware is live.
Are you using online reflash or offline reflash? Was the eep file reflashed successfully?
As I wrote in the manual, the task will be cleared from the printing list when successfully completed.
Offline, I guess it was, It cleared from the printing list.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #23 on: Fri, 06 March 2015, 02:08:18 »
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?
I tried the keymap you attached on my bare PCB and I see it works.
It's not necessary to reload Hex file unless you have overwritten the firmware by mistake.
Could you describe your problem in more detail?
For example keyboard cannot be recognized by PC, or can be recognized but nothing happens when typing keys, or key works but keymap is not updated?
keyboard is recognized , it evens appears as "redscarfIII" but none of the keys works.
Then it seems that the firmware is live.
Are you using online reflash or offline reflash? Was the eep file reflashed successfully?
As I wrote in the manual, the task will be cleared from the printing list when successfully completed.
Offline, I guess it was, It cleared from the printing list.
That's so weird.
Are the keys available before reflashing?
Maybe we should launch hid_listen and play with some magic commands.
Press LShift+RShift+D, LShift+RShift+X, LShift+RShift+K, and then you can get some debug messages when typing keys.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #24 on: Fri, 06 March 2015, 02:18:17 »
More
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?
I tried the keymap you attached on my bare PCB and I see it works.
It's not necessary to reload Hex file unless you have overwritten the firmware by mistake.
Could you describe your problem in more detail?
For example keyboard cannot be recognized by PC, or can be recognized but nothing happens when typing keys, or key works but keymap is not updated?
keyboard is recognized , it evens appears as "redscarfIII" but none of the keys works.
Then it seems that the firmware is live.
Are you using online reflash or offline reflash? Was the eep file reflashed successfully?
As I wrote in the manual, the task will be cleared from the printing list when successfully completed.
Offline, I guess it was, It cleared from the printing list.
That's so weird.
Are the keys available before reflashing?
Maybe we should launch hid_listen and play with some magic commands.
Press LShift+RShift+D, LShift+RShift+X, LShift+RShift+K, and then you can get some debug messages when typing keys.
Where do I find hid_listen? I'll try that.
Yeah I had keymaps before the first reflash. Also before reflash It RGB flashed whenever I plugged it in.
And now no more keymaps, and only light if I play with the remote.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #25 on: Fri, 06 March 2015, 02:28:48 »
More
Oh, I see what's the problem.
I confirmed your first link with simple mode but not your second and third link.
It seems that the top row (Esc, F1, F2, etc.) is missing in your third link (the layout for fn layer), so the rest keys are all mismatched.
so trying with this layout : http://www.keyboard-layout-editor.com/#/layouts/5202bd017285426aefc56e7342d968f5
Simple mode gave me the keymap that I attached below, still don't work.
Should I reload the Hex file onto the keyboard?
I tried the keymap you attached on my bare PCB and I see it works.
It's not necessary to reload Hex file unless you have overwritten the firmware by mistake.
Could you describe your problem in more detail?
For example keyboard cannot be recognized by PC, or can be recognized but nothing happens when typing keys, or key works but keymap is not updated?
keyboard is recognized , it evens appears as "redscarfIII" but none of the keys works.
Then it seems that the firmware is live.
Are you using online reflash or offline reflash? Was the eep file reflashed successfully?
As I wrote in the manual, the task will be cleared from the printing list when successfully completed.
Offline, I guess it was, It cleared from the printing list.
That's so weird.
Are the keys available before reflashing?
Maybe we should launch hid_listen and play with some magic commands.
Press LShift+RShift+D, LShift+RShift+X, LShift+RShift+K, and then you can get some debug messages when typing keys.
Where do I find hid_listen? I'll try that.
Yeah I had keymaps before the first reflash. Also before reflash It RGB flashed whenever I plugged it in.
And now no more keymaps, and only light if I play with the remote.
You can find hid_listen on PJRC's website. https://www.pjrc.com/teensy/hid_listen.html
Anyway please make sure you have reflashed the proper keymap :)

Offline Bromono

  • Wanabe Cicerone
  • * Destiny Supporter
  • Posts: 1112
  • Location: The Alamo's Basement
  • HHKB > Your Opinion
Re: RedScarfIII Manual
« Reply #26 on: Fri, 06 March 2015, 06:05:49 »
I want to contribute to this thread.. But mine is stuck in the endless shipping loop :(

Offline xauser

  • Posts: 97
Re: RedScarfIII Manual
« Reply #27 on: Fri, 06 March 2015, 13:25:29 »
Could you please tell me which controller is used on the redscarfIII pcb? Thank you!

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #28 on: Fri, 06 March 2015, 21:11:22 »
Could you please tell me which controller is used on the redscarfIII pcb? Thank you!
Hi xauser, off course.
Red Scarf III uses the familiar atmega32u4 as it's main controller.
And the official firmware is based on a customized tmk_keyboard.
You can find the source code here: https://github.com/kairyu/tmk_keyboard_custom/tree/master/keyboard/RedScarfIII

Offline xauser

  • Posts: 97
Re: RedScarfIII Manual
« Reply #29 on: Sat, 07 March 2015, 05:09:56 »
Great! Happy to see more tmk based firmwares. Really interesting stuff in there. I'm looking forward to dig into this deeper once my redscarfIII pcb arrives.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #30 on: Sun, 08 March 2015, 17:29:17 »
Hey ryu, using this layout, the 2 keys in red ouput the same thing, which is incorrect. I tried different lang keys or international keys but it doesnt work.
http://www.keyboard-layout-editor.com/#/layouts/da3a2dd7ae786c935e570bfcab5e5179

Side question: one the mapping manual, som output are grey, doest that mean something?

Offline Shanghaied

  • Posts: 44
  • Location: Sunny Sweden
Re: RedScarfIII Manual
« Reply #31 on: Sun, 08 March 2015, 18:25:42 »
Ryu mentioned earlier that the lang and int labels are usually defined by the OS for some languages, and can't be programmed by the user.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #32 on: Sun, 08 March 2015, 23:11:50 »
Hey ryu, using this layout, the 2 keys in red ouput the same thing, which is incorrect. I tried different lang keys or international keys but it doesnt work.
http://www.keyboard-layout-editor.com/#/layouts/da3a2dd7ae786c935e570bfcab5e5179

Side question: one the mapping manual, som output are grey, doest that mean something?

Good question. I think you may be the first man who try to make an ISO layout with TKG.

As I said earlier, TKG guesses what the key is by recognizing the combinations of the labels.
Inevitably, some keys have the same labels while they are actually different keys. For example left shift and right shift, they have the same label "Shift".
To decide which shift the "Shift" should be, I gave a high priority to left shift, and added explicit labels to both left and right shift.
So when you say "Shift", TKG supposes it's left shift, and only when you specify "RShift", TKG supposes it's right shift.
Every time TKG resolves this type of conflicts, it adds the result to the "Solved conflict" section of  the "INFO" of layer. (mouse over the keys to see result)

But for "\ and |" and "Non-US \ and |", I have no idea about what should the explicit label be.
So I just gave the US "\ and |" a high priority, and this cause the "Non-US \ and |" actually can not be assigned by user at present.
To solve this, could you please give me some advises about the explicit label of "Non-US \ and |".

And for your side question, yes, you have noted the gray labels.
They mean the keys have low priorities on the gray labels. In other word, some other keys have high priorities on the same labels and the low-priority keys can not be assigned by the labels.
BTW, you can see a "low priority" tooltip when popmouse over the gray labels.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #33 on: Mon, 09 March 2015, 02:04:23 »
Hey ryu, using this layout, the 2 keys in red ouput the same thing, which is incorrect. I tried different lang keys or international keys but it doesnt work.
http://www.keyboard-layout-editor.com/#/layouts/da3a2dd7ae786c935e570bfcab5e5179

Side question: one the mapping manual, som output are grey, doest that mean something?

Good question. I think you may be the first man who try to make an ISO layout with TKG.

As I said earlier, TKG guesses what the key is by recognizing the combinations of the labels.
Inevitably, some keys have the same labels while they are actually different keys. For example left shift and right shift, they have the same label "Shift".
To decide which shift the "Shift" should be, I gave a high priority to left shift, and added explicit labels to both left and right shift.
So when you say "Shift", TKG supposes it's left shift, and only when you specify "RShift", TKG supposes it's right shift.
Every time TKG resolves this type of conflicts, it adds the result to the "Solved conflict" section of  the "INFO" of layer. (mouse over the keys to see result)

But for "\ and |" and "Non-US \ and |", I have no idea about what should the explicit label be.
So I just gave the US "\ and |" a high priority, and this cause the "Non-US \ and |" actually can not be assigned by user at present.
To solve this, could you please give me some advises about the explicit label of "Non-US \ and |".

And for your side question, yes, you have noted the gray labels.
They mean the keys have low priorities on the gray labels. In other word, some other keys have high priorities on the same labels and the low-priority keys can not be assigned by the labels.
BTW, you can see a "low priority" tooltip when popmouse over the gray labels.
Thanks for the explanation about grey label, that explains why I couldn't get the Keypad enter to be different from the regular enter.


In ISO Qwerty (for UK users), "non-US \ and |" is "\ and |" and "non-US ~ and #" is "~and #", the problem is that 2 differents label on TMK output the exact same things which is this key:


The 2 labels are the one colored in this link : http://www.keyboard-layout-editor.com/#/layouts/b8de2e29803176a6c89a0929ee244aee
Green is correct key for the output above, but red one is the same that red and shouldn't be.

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #34 on: Mon, 09 March 2015, 02:41:09 »
Hey ryu, using this layout, the 2 keys in red ouput the same thing, which is incorrect. I tried different lang keys or international keys but it doesnt work.
http://www.keyboard-layout-editor.com/#/layouts/da3a2dd7ae786c935e570bfcab5e5179

Side question: one the mapping manual, som output are grey, doest that mean something?

Good question. I think you may be the first man who try to make an ISO layout with TKG.

As I said earlier, TKG guesses what the key is by recognizing the combinations of the labels.
Inevitably, some keys have the same labels while they are actually different keys. For example left shift and right shift, they have the same label "Shift".
To decide which shift the "Shift" should be, I gave a high priority to left shift, and added explicit labels to both left and right shift.
So when you say "Shift", TKG supposes it's left shift, and only when you specify "RShift", TKG supposes it's right shift.
Every time TKG resolves this type of conflicts, it adds the result to the "Solved conflict" section of  the "INFO" of layer. (mouse over the keys to see result)

But for "\ and |" and "Non-US \ and |", I have no idea about what should the explicit label be.
So I just gave the US "\ and |" a high priority, and this cause the "Non-US \ and |" actually can not be assigned by user at present.
To solve this, could you please give me some advises about the explicit label of "Non-US \ and |".

And for your side question, yes, you have noted the gray labels.
They mean the keys have low priorities on the gray labels. In other word, some other keys have high priorities on the same labels and the low-priority keys can not be assigned by the labels.
BTW, you can see a "low priority" tooltip when popmouse over the gray labels.
Thanks for the explanation about grey label, that explains why I couldn't get the Keypad enter to be different from the regular enter.


In ISO Qwerty (for UK users), "non-US \ and |" is "\ and |" and "non-US ~ and #" is "~and #", the problem is that 2 differents label on TMK output the exact same things which is this key:
Show Image


The 2 labels are the one colored in this link : http://www.keyboard-layout-editor.com/#/layouts/b8de2e29803176a6c89a0929ee244aee
Green is correct key for the output above, but red one is the same that red and shouldn't be.

Yes, you are right. Please let me explain this by a table.
Code: [Select]
+----------------+-----------+----------------+
| Keys           | US Layout | ISO Layout     |
+----------------+----------------------------+
| \ and |        | \ and |   | Non-US # and ~ |
+----------------+----------------------------|
| Non-US \ and | | N/A       | Non-US \ and | |
+----------------+----------------------------+
| Non-US # and ~ | \ and |   | Non-US # and ~ |
+----------------+-----------+----------------+
I tried this on Windows, so we can see Windows treat \ and | and Non-US # and ~ as same function and \ and | and Non-US \ and | as different functions.
And at present we have no way to assign a key to Non-US \ and |. This is why you always get only \ and | key lighted on.

Now what should we do is making a explicit label to tell TKG that key is Non-US \ and | but not a US \ and |.
(TKG recognizes keys by key units, it cannot know what the layout actually is.)
I need your suggestion.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #35 on: Mon, 09 March 2015, 02:49:51 »
Can you simply name it ISO?

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #36 on: Mon, 09 March 2015, 03:04:14 »
Can you simply name it ISO?
Thank you, fixed!
Now you can use "iso |\n\\" to assign a key to "Non-US \ and |".

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #37 on: Mon, 09 March 2015, 07:12:02 »
Can you simply name it ISO?
Thank you, fixed!
Now you can use "iso |\n\\" to assign a key to "Non-US \ and |".
thanks, unknow label for the moment let me know when updated :)

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #38 on: Mon, 09 March 2015, 08:00:25 »
Can you simply name it ISO?
Thank you, fixed!
Now you can use "iso |\n\\" to assign a key to "Non-US \ and |".
thanks, unknow label for the moment let me know when updated :)
It should have been updated when my previous post.
You can find a new "iso |" label at the help page. If not, please try to hit Ctrl+R to reload the webpage.
And please note that the bottom label "\" is still necessary.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #39 on: Mon, 09 March 2015, 12:41:41 »

Offline Ryu

  • Posts: 60
  • Location: Japan
    • GitHub
Re: RedScarfIII Manual
« Reply #40 on: Mon, 09 March 2015, 20:10:27 »
Still unknow label:
Show Image


layout:
http://www.keyboard-layout-editor.com/#/layouts/1e84476c846afc053faa0be569906adf
I tried your layout and it just works well.
I think your browser is using the locally cached file. Please press Ctrl+R until you see the following in the help page.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual
« Reply #41 on: Tue, 10 March 2015, 06:02:50 »
Still unknow label:
Show Image


layout:
http://www.keyboard-layout-editor.com/#/layouts/1e84476c846afc053faa0be569906adf
I tried your layout and it just works well.
I think your browser is using the locally cached file. Please press Ctrl+R until you see the following in the help page.
(Attachment Link)

Indeed it was that. Layout is all working know.
Thanks for your help ryu.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual (WIP)
« Reply #42 on: Fri, 13 March 2015, 05:21:12 »
Managed to work a bit on putting it together (see the second post).
Will continue later.

Offline Manchias

  • Posts: 55
Re: RedScarfIII Manual (WIP)
« Reply #43 on: Thu, 02 April 2015, 12:22:51 »
I already can mapkey success for my RS3 with this layout: http://www.keyboard-layout-editor.com/#/layouts/d804d0f625657bc6bee7a6cb5efbb976

However, there is a problem. Everytime I hit Fn0, seem like my RS3 went to a loop which disable all the key.

This is what I have done:
1. Creat layout by using  http://www.keyboard-layout-editor.com/
2. Copy all the raw data to http://www.enjoyclick.org/tkg/# with layout mode: Simple
3. Import Fn from the RS3 guide:
"0":["ACTION_LAYER_MOMENTARY",1],"1":["ACTION_BACKLIGHT_TOGGLE"],"2":["ACTION_BACKLIGHT_DECREASE"],"3":["ACTION_BACKLIGHT_INCREASE"],"4":["ACTION_FUNCTION","2",0],"5":["ACTION_FUNCTION","7",0],"6":["ACTION_FUNCTION","7","1"],"7":["ACTION_FUNCTION","4",0],"8":["ACTION_FUNCTION","3",0],"9":["ACTION_FUNCTION","6","2"],"10":["ACTION_FUNCTION","5","1"],"11":["ACTION_FUNCTION","5","4"],"12":["ACTION_FUNCTION","5","13"],"13":["ACTION_FUNCTION","5","5"],"14":["ACTION_FUNCTION","5","11"],"15":["ACTION_FUNCTION","5","6"],"16":["ACTION_FUNCTION","5","15"],"17":["ACTION_FUNCTION","5",0]
 
4. Download eep file then flash to the keyboard.

After that, everything worked but after I press Fn0, my RS3 seem get in a loop without get out, so all the key no function anymore. Can you please let me know if I did something wrong with Fn key ?




Offline Manchias

  • Posts: 55
Re: RedScarfIII Manual (WIP)
« Reply #44 on: Thu, 02 April 2015, 12:39:54 »
I fixed the problem. All the keys worked after I press Fn0 by using this layout: http://www.keyboard-layout-editor.com/#/layouts/0409c3a4710f80955aca9b188071de4d

This is what I have done:

1. Creat layout by using  http://www.keyboard-layout-editor.com/
2. Copy all the raw data to http://www.enjoyclick.org/tkg/# with layout mode: All-in-one
3. I don't import Fn from RS3 guide.
4. Download eep file then flash to the keyboard.

But now I have another problem: how to add turn on/increase/decrease the backlight. I don't really understand how the mapkey to control backlight.

Offline Manchias

  • Posts: 55
Re: RedScarfIII Manual (WIP)
« Reply #45 on: Thu, 02 April 2015, 12:46:58 »
Fixed backlight control by change Fn on TMK to :

Fn0 - Layout action>Momentary -  layer 1
Fn1 - Backlight action> Toggle
Fn2 - Backlight action> Decrease
Fn3 - Backlight action> Increase.


As I remember, the original layout of RS3 can control the backlit without remote by using:

Fn + ESC - backlit on/off
Fn + F1 - backlit red
Fn + F2 - backlit green
...........v............v............

Now how can I control the backlit light without the remote ? With new layout ? Can someone please guide me.



« Last Edit: Thu, 02 April 2015, 12:56:30 by Manchias »

Offline Manchias

  • Posts: 55
Re: RedScarfIII Manual (WIP)
« Reply #46 on: Thu, 02 April 2015, 13:09:21 »
Fixed. I already can control the backlit.

I think the most important thing you need to do is choose a Red Scraft 3 keyboard on http://www.enjoyclick.org/tkg/# before you do anything.

Offline azhdar

  • Praise the AZERTY god
  • Thread Starter
  • Posts: 2292
  • Location: France
  • 65% Enlighted
Re: RedScarfIII Manual (WIP)
« Reply #47 on: Thu, 02 April 2015, 13:35:34 »
I already can mapkey success for my RS3 with this layout: http://www.keyboard-layout-editor.com/#/layouts/d804d0f625657bc6bee7a6cb5efbb976

However, there is a problem. Everytime I hit Fn0, seem like my RS3 went to a loop which disable all the key.

This is what I have done:
1. Creat layout by using  http://www.keyboard-layout-editor.com/
2. Copy all the raw data to http://www.enjoyclick.org/tkg/# with layout mode: Simple
3. Import Fn from the RS3 guide:
"0":["ACTION_LAYER_MOMENTARY",1],"1":["ACTION_BACKLIGHT_TOGGLE"],"2":["ACTION_BACKLIGHT_DECREASE"],"3":["ACTION_BACKLIGHT_INCREASE"],"4":["ACTION_FUNCTION","2",0],"5":["ACTION_FUNCTION","7",0],"6":["ACTION_FUNCTION","7","1"],"7":["ACTION_FUNCTION","4",0],"8":["ACTION_FUNCTION","3",0],"9":["ACTION_FUNCTION","6","2"],"10":["ACTION_FUNCTION","5","1"],"11":["ACTION_FUNCTION","5","4"],"12":["ACTION_FUNCTION","5","13"],"13":["ACTION_FUNCTION","5","5"],"14":["ACTION_FUNCTION","5","11"],"15":["ACTION_FUNCTION","5","6"],"16":["ACTION_FUNCTION","5","15"],"17":["ACTION_FUNCTION","5",0]
 
4. Download eep file then flash to the keyboard.

After that, everything worked but after I press Fn0, my RS3 seem get in a loop without get out, so all the key no function anymore. Can you please let me know if I did something wrong with Fn key ?





On the layout you linked, there's no binding related to the Fn layer, so you probably should have used the normal mode, with only one layer.
I fixed the problem. All the keys worked after I press Fn0 by using this layout: http://www.keyboard-layout-editor.com/#/layouts/0409c3a4710f80955aca9b188071de4d

This is what I have done:

1. Creat layout by using  http://www.keyboard-layout-editor.com/
2. Copy all the raw data to http://www.enjoyclick.org/tkg/# with layout mode: All-in-one
3. I don't import Fn from RS3 guide.
4. Download eep file then flash to the keyboard.

But now I have another problem: how to add turn on/increase/decrease the backlight. I don't really understand how the mapkey to control backlight.
I haven't tested the Backlight Features a lot but if I remember correctly it's on Fn2 and Fn3, but when I tested it, It also changed the backlight mode, breathing, full backlight ... So I'm unsure about it.


Fixed backlight control by change Fn on TMK to :

Fn0 - Layout action>Momentary -  layer 1
Fn1 - Backlight action> Toggle
Fn2 - Backlight action> Decrease
Fn3 - Backlight action> Increase.


As I remember, the original layout of RS3 can control the backlit without remote by using:

Fn + ESC - backlit on/off
Fn + F1 - backlit red
Fn + F2 - backlit green
...........v............v............

Now how can I control the backlit light without the remote ? With new layout ? Can someone please guide me.




You should refer to this picture:

I believe you can use the Fn numbers of the remote to have the remote buttons onto the keyboard, but I have not tested it.
Fixed. I already can control the backlit.

I think the most important thing you need to do is choose a Red Scraft 3 keyboard on http://www.enjoyclick.org/tkg/# before you do anything.

Yeah, I made that mistake at the beggining too :)

If you haven't read it yet, my first and second post are a quick introduction to what I've tested on the keyboard so far.
I'll need to finish the manual on day.

Offline poog

  • Posts: 32
Re: RedScarfIII Manual (WIP)
« Reply #48 on: Wed, 13 May 2015, 16:49:38 »
Hello,

I soldered up the switches and tried flashing firmware last night but it looks like I'm having some trouble with the smd leds. I don't have any leds on the keys yet so there were no flashes or anything to confirm certain modes but when I first plugged it in (without pressing anything) the smd leds came on automatically and switched colors over and over.

I unplugged it and held down the upper left button (esc) and replugged it and this time no smd leds came on. The driver installed correctly and I saw the generic/text only printer in my devices. I tried flashing a configuration online (simple mode) but the little box kept spinning so I switched to offline flashing. The print job never left the "what's printing" queue even after a couple minutes but when I unplugged and replugged in normal mode (after waiting in vain for the job to disappear) the configuration I had made was flashed to the keyboard!

However, now I can't figure out how to light up the smd leds. I tried using the remote control (after pulling out that plastic thing on the batterry) and it doesn't seem to be working. I also tried the function keys (fn1, fn2, fn3) but they didn't do anything.

Any ideas on what I could troubleshoot to fix it?

Thanks

Offline poog

  • Posts: 32
Re: RedScarfIII Manual (WIP)
« Reply #49 on: Wed, 13 May 2015, 21:43:52 »
After sleeping on it I figured out that I just didn't have the function keys set up correctly. After importing the ones found in that user manual, I can use the keyboard to adjust the smd leds and the button leds. So the only thing not working now is the remote control. I checked that the battery has juice left with a multimeter. Is there anything else we need to do to get that working?

Really cool keyboard though.