introduce support for Royal Kludge RK61 non-hotswap rgb edition (PID 0x24F) #252

mr-july · 2022-03-10T16:55:37Z

This is improved version of euwbah (see https://github.com/euwbah/qmk_firmware/tree/sn32/keyboards/royal_kludge/rk61_rgb):

better organized directory structure
add support for ISO layout
implement a keymap, which supports Neo Layout (https://www.neo-layout.org/) layers 3 and 4

Description

Types of Changes

Keyboard (addition or update)
Keymap/layout/userspace (addition or update)

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

…0x24F) This is improved version of euwbah (see https://github.com/euwbah/qmk_firmware/tree/sn32/keyboards/royal_kludge/rk61_rgb): - better organized directory structure - add support for ISO layout - implement a keymap, which supports Neo Layout (https://www.neo-layout.org/) layers 3 and 4

use `_______` instead of `KC_TRNS` to improve readability

for bootloader

vjdato21

My little brother owns RK61 so I just made a little suggestion to the keymap (will update if I get to know more about RK61). I also included some comments and heads-up for some, you're free to decline those or accept.

keyboards/royal_kludge/rk61/keymaps/default/keymap.h

keyboards/royal_kludge/rk61/rgb/config.h

keyboards/royal_kludge/rk61/rgb/info.json

keyboards/royal_kludge/rk61/rgb/readme.md

keyboards/royal_kludge/rk61/rgb/rules.mk

…oot Keyboard protocol switching Co-authored-by: vjdato21 <[email protected]>

Co-authored-by: vjdato21 <[email protected]>

vjdato21

Just a suggestion and a correction to readme.md. By the way, I can't get it to compile on my end.

I'm no expert so I can't truly rule out the cause of the problem.

keyboards/royal_kludge/rk61/rgb/readme.md

vjdato21 · 2022-03-28T07:04:55Z

keyboards/royal_kludge/rk61/rgb/readme.md

+  ![HW bootloader](imgs/enter-bootloader.jpg)
+  After shorting, just connect the USB cable. The keyboard started in bootloader mode and is ready to be flashed.
+- Layout (after loading QMK): FN + CapsLock
+


Maybe try adding Sonix flasher as an easy way to get into bootloader.

As far as i know the Sonix flasher does not currently support the RK61. We need implement it first in Sonix flasher repo. (This is not a big deal, i hope). I'll look into it.

But we need testing to ensure, that the bootloader can be entered with the aid of Sonix flasher.

As far as i know the Sonix flasher does not currently support the RK61. We need implement it first in Sonix flasher repo. (This is not a big deal, i hope). I'll look into it.

But we need testing to ensure, that the bootloader can be entered with the aid of Sonix flasher.

It kinda does, RK uses HFD, and by that, the keyboard gets put into bootloader. Currently, Sonix flasher supports putting into bootloader for HFD and eVision Sonix clone chips. By the way, if QMK gets installed in the keyboard, and you put it into bootloader, it will still get detected by Sonix flasher.

P.S.
Tested Sonix flasher on my end, it works for my little brother's keyboard. (at least for the bootloader part). I haven't tested flashing though; I will update you once I've tested it.

P.P.S.S.
Tested Sonix flasher for putting keyboard into bootloader and flashing. It works fine.

Maybe try adding Sonix flasher as an easy way to get into bootloader.

I have just completed the documentation.

As far as i know the Sonix flasher does not currently support the RK61.

Actually it is supported. But it is detected as "Apple Keyboard / Keychron / Flashquark Horizon Z" if the original firmware is installed. If the QMK is installed, then it will not be detected.

We need implement it first in Sonix flasher repo. (This is not a big deal, i hope). I'll look into it.

The following patch need to be applied to Sonix flasher to add support for RK61.

diff --git a/src/main/python/main.py b/src/main/python/main.py index 586a7e3..288e137 100644 --- a/src/main/python/main.py +++ b/src/main/python/main.py @@ -41,6 +41,7 @@ DEVICE_DESC = { (0x0c45, 0x766b): "Kemove", (0x0c45, 0x7698): "Womier", (0x320f, 0x5013): "Akko", + (0x0c45, 0x024f): "Royal Kludge RK61 RGB", (0x0c45, 0x5004): "Redragon", (0x0c45, 0x5104): "Redragon", (0x0C45, 0x8513): "Sharkoon",

Should I create a PR for this?

Actually I'm not sure which VENDOR_ID and PRODUCT_ID need to be used for QMK. Are there any rules or guidelines?

As far as i know the Sonix flasher does not currently support the RK61.

Actually it is supported. But it is detected as "Apple Keyboard / Keychron / Flashquark Horizon Z" if the original firmware is installed. If the QMK is installed, then it will not be detected.

We need implement it first in Sonix flasher repo. (This is not a big deal, i hope). I'll look into it.

The following patch need to be applied to Sonix flasher to add support for RK61.

diff --git a/src/main/python/main.py b/src/main/python/main.py index 586a7e3..288e137 100644 --- a/src/main/python/main.py +++ b/src/main/python/main.py @@ -41,6 +41,7 @@ DEVICE_DESC = { (0x0c45, 0x766b): "Kemove", (0x0c45, 0x7698): "Womier", (0x320f, 0x5013): "Akko", + (0x0c45, 0x024f): "Royal Kludge RK61 RGB", (0x0c45, 0x5004): "Redragon", (0x0c45, 0x5104): "Redragon", (0x0C45, 0x8513): "Sharkoon",

Should I create a PR for this?

Actually I'm not sure which VENDOR_ID and PRODUCT_ID need to be used for QMK. Are there any rules or guidelines?

You don't have to make a patch for Sonix Flasher though you can if you want to. Anyway, regarding the VID and PID, only the Keychron has guidelines around that. You can copy the stock firmware's PID and VID, provided that they don't mimic the Apple keyboard.

Anyway, regarding the VID and PID, only the Keychron has guidelines around that.

Could you provide me an info link, please?

You can copy the stock firmware's PID and VID, provided that they don't mimic the Apple keyboard.

But for RK61 RGB, that is just the case. Original firmware masquerades as an Apple keyboard (05ac:024f). So, it is probably not an option just to use the original PID and VID. So, we need change it. But the values currently used (0c45:024f) are unknown for the Sonix Flasher. So, after first flash (from original firmware to self compiled QMK), the second flash will not be possible with the Sonix Flasher, because the keyboard (0c45:024f) will not be identified. It is necessary to manually switch the keyboard into bootloader first, then it will be recognized (0c45:7040) and can be flashed. Is it so for other keyboards too?

Could you provide me an info link, please?

Refer to #152

But for RK61 RGB, that is just the case. Original firmware masquerades as an Apple keyboard (05ac:024f). So, it is probably not an option just to use the original PID and VID. So, we need change it. But the values currently used (0c45:024f) are unknown for the Sonix Flasher. So, after first flash (from original firmware to self compiled QMK), the second flash will not be possible with the Sonix Flasher, because the keyboard (0c45:024f) will not be identified. It is necessary to manually switch the keyboard into bootloader first, then it will be recognized (0c45:7040) and can be flashed. Is it so for other keyboards too?

If RK61 RGB doesn't mimic Apple Keyboard's PID and VID, then you don't have to change it. To address your next question too, Sonix Flasher cannot put the keyboard anyway to bootloader mode when you have already flashed QMK, so that's fine.

Co-authored-by: vjdato21 <[email protected]>

mr-july · 2022-03-28T08:37:07Z

I can't reproduce this compiling issue. But i could find some tips on reddit, which hopefully can help.

vjdato21 · 2022-03-28T13:14:24Z

I can't reproduce this compiling issue. But i could find some tips on reddit, which hopefully can help.

Hmm... What are you using when you're compiling the firmware?

mr-july · 2022-03-28T14:59:44Z

I have installed the Arch Linux `qmk` package and compile the keymap by running ```sh qmk compile -k royal_kludge/rk61/rgb -m default ``` something like this...

vjdato21 · 2022-03-28T15:57:20Z

I have installed the Arch Linux qmk package and compile the keymap by running sh qmk compile -k royal_kludge/rk61/rgb -m default something like this...
…
On 28 March 2022 15:14:36 vjdato21 @.***> wrote: I can't reproduce this compiling issue. But i could find some tips on reddit, which hopefully can help. Hmm... What are you using when you're compiling the firmware? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.

Hmm... I'm using QMK MSYS and I've tried make and qmk compile, seems like both don't work on my end. I'll try using it in another operating system once I get some time.

mr-july · 2022-03-28T18:41:36Z

Sorry, it was really a problem with ´keymap.h´ (this name seems to conflict with the system one), so I have renamed the file to ´layout.h´. Now your compile problem should be fixed.

vjdato21 · 2022-03-29T00:21:35Z

Sorry, it was really a problem with ´keymap.h´ (this name seems to conflict with the system one), so I have renamed the file to ´layout.h´. Now your compile problem should be fixed.

Yep, it compiled now. It's kinda weird that yours doesn't complain about it.

vjdato21 · 2022-03-29T00:40:34Z

I'm looking right now for a plate file for RK61. This will be useful for making the .json file for VIA, if ever you do find one, that'll be helpful.

vjdato21 · 2022-03-30T23:55:05Z

I'm looking right now for a plate file for RK61. This will be useful for making the .json file for VIA, if ever you do find one, that'll be helpful.

Update:
Seems to be using a standard layout. Keycaps sizes should be easily sorted out now. I'll try make a .json file later.

…5 keys

fix `RMODS_KEYMAP_` definition ('}' was used instead of ')')

on english language support layer

…r-royal_kludge-rk61-rgb

to functional layer

rnayabed · 2023-02-05T09:00:11Z

any updates?

github-actions · 2023-06-21T02:29:34Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

github-actions · 2023-07-22T02:23:18Z

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.
// [stale-action-closed]

github-actions bot added keyboard keymap labels Mar 10, 2022

mr-july added 6 commits March 14, 2022 10:44

add missed "0" to the Neo layer 4

c1cbd58

improve keymap definiton consistence

0b986ba

use `_______` instead of `KC_TRNS` to improve readability

add the PCB picture with marked contacts to be shorted

c9fe2bb

for bootloader

Merge branch 'sn32_master' into sn32_master-royal_kludge-rk61-rgb

d61df4d

change vendor ID, manufacturer and product description

49ae2b8

add the section about original firmware to the documentation

91537aa

vjdato21 reviewed Mar 22, 2022

View reviewed changes

mr-july and others added 7 commits March 22, 2022 09:00

make the keyboard functional in some BIOSes, which do not implement B…

f9cbd3d

…oot Keyboard protocol switching Co-authored-by: vjdato21 <[email protected]>

improve keyboard description

5a83076

Co-authored-by: vjdato21 <[email protected]>

add GUI toggle key to functional layer

8821650

Co-authored-by: vjdato21 <[email protected]>

change keyboard maintainer for RK61 rgb

7077747

change keyboard maintainer for RK61 rgb

9276e89

fix: SonixFlasherC is a C programm

fa95a18

implement GUI key highlighting if it is disabled

0d77f25

vjdato21 reviewed Mar 28, 2022

View reviewed changes

fix make call for building default keymap

e1e69c0

Co-authored-by: vjdato21 <[email protected]>

rename "keymap.h" to "layout.h" to prevent compile problems

a65a8d8

mr-july added 2 commits March 31, 2022 09:43

introduce entering bootloader with the aid of Sonix Flasher

7c2cb28

introduce the layout definnition macro for RK61

2fe8a3f

mr-july added 18 commits May 20, 2022 15:55

introduce custom layout inspired by "miryoku" and "neo", using just 3…

b310fe7

…5 keys

rename german layout specific definitions

f033dcc

add initial support for US international software layout

3ceab34

improve formatting

b40373d

generalie handling of '?'/'!' on home row

565c696

change layout definition macro name

29ec65b

fix `RMODS_KEYMAP_` definition ('}' was used instead of ')')

use general key codes for special symbols

e4a0328

on english language support layer

prepare new keyboard layout "KÖRKEM"

b1275a9

initial verssion of the new keyboard layout "KÖRKEM"

24c13fb

Merge remote-tracking branch 'mainstream/sn32_master' into sn32_maste…

8c59134

…r-royal_kludge-rk61-rgb

improve keymap configuration parameters

cdb76df

small restructuring, add some comments

87a9149

fix formatting

3129892

improve bottom row alignment

3593e4e

add "Print Screen", "Screen Lock" and "Pause" keys

f6ce336

to functional layer

add mouse buttons to mouse layer

65b6616

improve thumbs cluster on symbol layer

7df3f2c

remove unused statement

84c12ea

github-actions bot added the stale label Jun 21, 2023

github-actions bot closed this Jul 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

introduce support for Royal Kludge RK61 non-hotswap rgb edition (PID 0x24F) #252

introduce support for Royal Kludge RK61 non-hotswap rgb edition (PID 0x24F) #252

mr-july commented Mar 10, 2022

vjdato21 left a comment

vjdato21 left a comment

vjdato21 Mar 28, 2022

mr-july Mar 28, 2022

vjdato21 Mar 29, 2022 •

edited

Loading

mr-july Mar 31, 2022

mr-july Mar 31, 2022 •

edited

Loading

vjdato21 Mar 31, 2022 •

edited

Loading

mr-july Apr 1, 2022

vjdato21 Apr 2, 2022 •

edited

Loading

mr-july commented Mar 28, 2022

vjdato21 commented Mar 28, 2022

mr-july commented Mar 28, 2022 via email •

edited

Loading

vjdato21 commented Mar 28, 2022 •

edited

Loading

mr-july commented Mar 28, 2022

vjdato21 commented Mar 29, 2022

vjdato21 commented Mar 29, 2022

vjdato21 commented Mar 30, 2022

rnayabed commented Feb 5, 2023

github-actions bot commented Jun 21, 2023

github-actions bot commented Jul 22, 2023

introduce support for Royal Kludge RK61 non-hotswap rgb edition (PID 0x24F) #252

introduce support for Royal Kludge RK61 non-hotswap rgb edition (PID 0x24F) #252

Conversation

mr-july commented Mar 10, 2022

Description

Types of Changes

Checklist

vjdato21 left a comment

Choose a reason for hiding this comment

vjdato21 left a comment

Choose a reason for hiding this comment

vjdato21 Mar 28, 2022

Choose a reason for hiding this comment

mr-july Mar 28, 2022

Choose a reason for hiding this comment

vjdato21 Mar 29, 2022 • edited Loading

Choose a reason for hiding this comment

mr-july Mar 31, 2022

Choose a reason for hiding this comment

mr-july Mar 31, 2022 • edited Loading

Choose a reason for hiding this comment

vjdato21 Mar 31, 2022 • edited Loading

Choose a reason for hiding this comment

mr-july Apr 1, 2022

Choose a reason for hiding this comment

vjdato21 Apr 2, 2022 • edited Loading

Choose a reason for hiding this comment

mr-july commented Mar 28, 2022

vjdato21 commented Mar 28, 2022

mr-july commented Mar 28, 2022 via email • edited Loading

vjdato21 commented Mar 28, 2022 • edited Loading

mr-july commented Mar 28, 2022

vjdato21 commented Mar 29, 2022

vjdato21 commented Mar 29, 2022

vjdato21 commented Mar 30, 2022

rnayabed commented Feb 5, 2023

github-actions bot commented Jun 21, 2023

github-actions bot commented Jul 22, 2023

vjdato21 Mar 29, 2022 •

edited

Loading

mr-july Mar 31, 2022 •

edited

Loading

vjdato21 Mar 31, 2022 •

edited

Loading

vjdato21 Apr 2, 2022 •

edited

Loading

mr-july commented Mar 28, 2022 via email •

edited

Loading

vjdato21 commented Mar 28, 2022 •

edited

Loading