[Feature Request] Add Keychron Q3 #16812

i-am-logger · 2022-04-07T00:42:31Z

Support for KeyChron Q3 Keyboard

yanfali · 2022-04-07T01:35:28Z

As soon as it hits firmware it should work in configurator.

IBNobody · 2022-04-15T14:39:55Z

Some of the delay of getting Q3 into Firmware might be because those of us with Q3 keyboards with encoders are reporting that the encoder is skipping events when the Q3 is loaded with compiled-from-source .bins. (It's not sampling the encoder fast enough to detect the required pulse edge transitions that indicate encoder turn direction.)

i-am-logger · 2022-04-15T14:54:59Z

Yes, i'm aware of it. I am actually waiting to receive the knob version and will work towards a fix if one isn't present by the time i get it. the knob issue is across al Q knob keyboards

IBNobody · 2022-04-15T15:06:05Z

That's good to know. I've troubleshot the problem down to the pin sampling level in encoder.c and witnessed the missing A and B line transition states, but I'm not sure how to increase the sampling rate. Is the culprit the overall matrix scan frequency of 188-191 for my board?

i-am-logger · 2022-04-15T15:15:46Z

great, can you mark the function for me? will be easier to find when i get the keyboard. Thanks!

IBNobody · 2022-04-15T15:39:57Z

encoder_read:

qmk_firmware/quantum/encoder.c

Line 140 in 8de4065

bool encoder_read(void) {

encoder_update called by encoder_read:

qmk_firmware/quantum/encoder.c

Line 107 in 8de4065

static bool encoder_update(uint8_t index, uint8_t state) {

This is the line in encoder_read that reads the pins.

qmk_firmware/quantum/encoder.c

Line 144 in 8de4065

    
           encoder_state[i] |= (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1);

And for this encoder, it needs to see 4 separate edges on the pulse on a counterclockwise turn:

I'm using the format of (pin A state, pin B state)

(1,1) to (1,0)
(1,0) to (0,0)
(0,0) to (0,1)
(0,1) to (1,1)

Sometimes it just misses the edge, usually the 3rd or 4th state where pins A and B are rising.

IBNobody · 2022-04-19T01:16:43Z

@ibootstrapper The issue is clearly related to the matrix scan frequency. I played around with the ChibiOS settings CH_CFG_ST_FREQUENCY and was able to get the matrix scan frequency up from 191 to 600+ by turning off features and saw that the number of dropped encoder ticks was reduced but not eliminated. So we just need to get the scan frequency up above this.

The keyboard advertises a 1000Hz polling rate. One would think that this would mean that the keyboard scan rate could also achieve this level . . .

IBNobody · 2022-04-19T05:17:37Z

So, the issue is indeed caused by the matrix scan rate. The low scan rate is caused by 3 factors.

CKLED2001 RGB matrix driver - can this be optimized? It's significantly slowing down the scan rate.
Custom Matrix (half the columns are using I/O, half using a '595 shift register) - There might be a better way to handle the shift register. Right now, the code shifts in a 0 to trigger a column and then shifts in all F's to clear the register. If instead of clearing the column it just shifted the 0 to the next column, a number of shifting operations could be eliminated and the keyboard matrix scan routine would run faster.
CH_CFG_ST_FREQUENCY could be tweaked from 10k to 100k.

If I compile QMK or Keychron's fork with the RGB Matrix disabled, the custom matrix excluded, and CH_CFG_ST_FREQUENCY set to 10k, my matrix scan frequency jumps up to 2400Hz and that is well above the level needed for the matrix encodes to start working.

@lalalademaxiya1 FYI

i-am-logger · 2022-04-19T19:19:13Z

@IBNobody i just got my Q3 with knob, are you on keychron's discord?

IBNobody · 2022-04-19T19:22:10Z

There's a KC Discord? I'm on the QMK and SonixQMK ones. Throw me an invite. I'm also /u/IBNobody on Reddit.

i-am-logger · 2022-04-19T19:27:01Z

https://discord.com/invite/HAYbRrTsjN, sent you a friend invite.

mwyborski · 2022-04-25T10:11:21Z

Please check if this PR solves your problem:
#16932
You will have to define in config.h:

#define ENCODER_RESOLUTION 4
#define ENCODER_DEFAULT_POS 0x3

lokher · 2022-04-30T01:17:26Z

Please refer to PR #16954 to fix encoder issue.

IBNobody · 2022-05-03T13:38:40Z

Please refer to PR #16954 to fixed encoder issue.

Yes, I can confirm that this fixes the issue on Q3. Now I just need a repo branch that has both the encoder fix and the EEPROM/VIA fix.

lokher · 2022-05-03T14:49:43Z

It's already done in playground branch of keychron fork.

damianesteban · 2022-05-11T03:02:19Z

Excellent. This will be great to have.

Cr8zyIvan · 2022-05-25T13:31:13Z

I'm very new to mechanical keyboards and QMK. I acquired the Keychron Q3 with the hopes of getting into it.

Is this project piloted by the folks at Keychron, or is this purely fan based?
Is there an estimate when the firmware might available for the Q3?
- My intention is not to pressure anyone. I know close to nothing about the process involved. This is simply a question of curiosity and eagerness to start coding with QMK!... and not knowing where else to post this question.

Cheers!

mwyborski · 2022-05-25T15:20:51Z

@Cr8zyIvan this project is not related to keychron. They make pull-requests and try to get their code into the project.
This being said, you should compile and flash the fork from keychron. I think the q3 should be available:
https://github.com/Keychron/qmk_firmware

In their fork they can commit what they see fitting and latest code code for the q series is there. It may take time for the code to be merged to this repository.

mwyborski · 2022-05-25T15:22:47Z

They have a q3 branch:
https://github.com/Keychron/qmk_firmware/tree/keychron-q3

Cr8zyIvan · 2022-05-25T15:46:55Z

Thank you!

FWest98 · 2022-06-05T23:34:14Z

Please refer to PR #16954 to fixed encoder issue.

Yes, I can confirm that this fixes the issue on Q3. Now I just need a repo branch that has both the encoder fix and the EEPROM/VIA fix.

I spent some time over the past few days to make such a branch: https://github.com/FWest98/OS-QMK_Firmware/tree/keychron/q3_fwest
It took some time, but it is based on the most recent QMK master with the Q3 definitions and the EEPROM and rotary encoder fixes.

pandages · 2022-06-14T19:27:12Z

Please refer to PR #16954 to fixed encoder issue.

Yes, I can confirm that this fixes the issue on Q3. Now I just need a repo branch that has both the encoder fix and the EEPROM/VIA fix.

I spent some time over the past few days to make such a branch: https://github.com/FWest98/OS-QMK_Firmware/tree/keychron/q3_fwest It took some time, but it is based on the most recent QMK master with the Q3 definitions and the EEPROM and rotary encoder fixes.

this looks good! I was thinking about trying to set per-key colors and per-layer effects by modifying QMK itself directly, rather than using VIA. but I don't know a lot about working with QMK, I'm new to it.

I've seen some really cool videos of effects people have achieved on other keyboards by modifying QMK.

pandages · 2022-06-16T14:40:21Z

I'm not familiar with compiling QMK; I don't have a build environment prepared yet. But I'd be happy to help review the merges and such. I'd like to see some of the intended QMK features working on the Keychron Q3. I'm sure many of the changes will also apply to the other Q-family boards, layout aside.

mfin · 2022-07-20T06:44:24Z

Is there any progress here?

i-am-logger · 2022-07-20T13:44:41Z

I worked on my own fork here and what i had now support the model with the knob

i-am-logger@909b1ea

Please let me know if you experinece any issues

i-am-logger · 2022-07-20T13:52:14Z

code is here: https://github.com/ibootstrapper/qmk_firmware/tree/playground/keyboards/keychron/q3/q3_ansi_stm32l432_ec11

sharpenedblade · 2022-08-03T16:45:56Z

The keychron fork used by default in the keyboard works properly now.

ghost · 2022-08-14T12:53:40Z

@ibootstrapper if I’m not mistaken Q3 support is being added in this PR: #16912.

Maybe the work you’ve done on your fork would be useful there? Or as a separate PR?

i-am-logger · 2022-08-14T13:34:38Z

thanks, i'll check it out

tzarc · 2022-08-29T11:57:59Z

Up to Keychron to submit a PR. Until then we can't do anything about it.

sharpenedblade · 2022-08-29T22:37:01Z

A pr was just submitted, I think this issue should be reopened, or at least changed from not planned.

quentin9696 · 2022-09-13T22:36:47Z

Hi Guys,

@tzarc Any idea on when the feature will be added? I see the PR is ready to merge.

Thank you for all your work !

whyfuture · 2022-10-02T15:22:45Z

And why is this closed if it's not in the main repo?

blalor · 2022-10-02T15:26:46Z

This is being implemented in #16912.

whyfuture · 2022-10-02T19:48:28Z

This is being implemented in #16912.

Sorry, missed the comment above. Thanks for pointing out.

i-am-logger · 2022-10-11T08:46:34Z

great, can you mark the function for me? will be easier to find when i get the keyboard. Thanks!

…

On Fri, Apr 15, 2022 at 10:06 AM IBNobody ***@***.***> wrote: That's good to know. I've troubleshot the problem down to the pin sampling level in encoder.c and witnessed the missing A and B line transition states, but I'm not sure how to increase the sampling rate. Is the culprit the overall matrix scan frequency of 188-191 for my board? — Reply to this email directly, view it on GitHub <#16812 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAK7YVE6VZOWQCZIJ24TAQLVFGAWPANCNFSM5SXZIMKA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

i-am-logger added the enhancement label Apr 7, 2022

i-am-logger changed the title ~~Add Keychron Q1 [Feature Request]~~ [Feature Request] Add Keychron Q1 Apr 7, 2022

i-am-logger changed the title ~~[Feature Request] Add Keychron Q1~~ [Feature Request] Add Keychron Q3 Apr 7, 2022

yanfali transferred this issue from qmk/qmk_configurator Apr 7, 2022

FWest98 mentioned this issue Jun 5, 2022

Add new function for encode module #16954

Closed

14 tasks

tzarc closed this as not planned Won't fix, can't repro, duplicate, stale Aug 29, 2022

[Feature Request] Add Keychron Q3 #16812

[Feature Request] Add Keychron Q3 #16812

Comments

i-am-logger commented Apr 7, 2022 • edited Loading

Support for KeyChron Q3 Keyboard

yanfali commented Apr 7, 2022

IBNobody commented Apr 15, 2022

i-am-logger commented Apr 15, 2022

IBNobody commented Apr 15, 2022

i-am-logger commented Apr 15, 2022

IBNobody commented Apr 15, 2022

IBNobody commented Apr 19, 2022

IBNobody commented Apr 19, 2022

i-am-logger commented Apr 19, 2022 • edited Loading

IBNobody commented Apr 19, 2022

i-am-logger commented Apr 19, 2022

mwyborski commented Apr 25, 2022 • edited Loading

lokher commented Apr 30, 2022 • edited Loading

IBNobody commented May 3, 2022

lokher commented May 3, 2022 • edited Loading

damianesteban commented May 11, 2022

Cr8zyIvan commented May 25, 2022

mwyborski commented May 25, 2022

mwyborski commented May 25, 2022

Cr8zyIvan commented May 25, 2022

FWest98 commented Jun 5, 2022

pandages commented Jun 14, 2022

pandages commented Jun 16, 2022

mfin commented Jul 20, 2022 • edited Loading

i-am-logger commented Jul 20, 2022

i-am-logger commented Jul 20, 2022

sharpenedblade commented Aug 3, 2022

ghost commented Aug 14, 2022 • edited by ghost Loading

i-am-logger commented Aug 14, 2022

tzarc commented Aug 29, 2022

sharpenedblade commented Aug 29, 2022

quentin9696 commented Sep 13, 2022

whyfuture commented Oct 2, 2022 • edited Loading

blalor commented Oct 2, 2022

whyfuture commented Oct 2, 2022

i-am-logger commented Oct 11, 2022 via email

i-am-logger commented Apr 7, 2022 •

edited

Loading

i-am-logger commented Apr 19, 2022 •

edited

Loading

mwyborski commented Apr 25, 2022 •

edited

Loading

lokher commented Apr 30, 2022 •

edited

Loading

lokher commented May 3, 2022 •

edited

Loading

mfin commented Jul 20, 2022 •

edited

Loading

ghost commented Aug 14, 2022 •

edited by ghost

Loading

whyfuture commented Oct 2, 2022 •

edited

Loading