geekhack Projects > Making Stuff Together!

RedScarfIII Manual (WIP)

(1/21) > >>

azhdar:
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"]

--- End quote ---

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.

azhdar:
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

Shanghaied:
Wow nice, I actually speak Chinese new and have a hopefully working redscarf, so I'll take a look when I get home.

azhdar:

--- Quote from: Shanghaied 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.

--- End quote ---

Let me know how it goes and report back !

Shanghaied:
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.

Navigation

[0] Message Index

[#] Next page