rgblight idle timeout feature #6450
Conversation
|
The previous PR is here: #5475 The code for this feature has been integrated with the existing rgb light code. |
| @@ -267,6 +267,7 @@ void rgblight_timer_toggle(void); | |||
| // if timeout is set, enable the rgblight idle feature | |||
| #ifdef RGBLIGHT_IDLE_TIMEOUT | |||
| #define RGBLIGHT_IDLE_ENABLE | |||
| #define RGBLIGHT_IDLE_MULTIPLIER 60000 | |||
There was a problem hiding this comment.
Maybe something like RGB_IDLE_MULTIPLIER_MILLIS
There was a problem hiding this comment.
How about RGB_DISABLE_AFTER_TIMEOUT, as we're using that with RGB Matrix:
https://docs.qmk.fm/#/feature_rgb_matrix?id=additional-configh-options
There was a problem hiding this comment.
I'm ok with that, is just like to know what the unit of measurement is
There was a problem hiding this comment.
I'm ... not exactly sure, but the code is called:
qmk_firmware/quantum/rgb_matrix.c
Line 373 in cd7bc03
There was a problem hiding this comment.
@XScorpion2 what is the unit in, for RGB_DISABLE_AFTER_TIMEOUT (my brain is failing me)
There was a problem hiding this comment.
Technically it's 1.2s units. No idea why it was coded like that. Never bothered changing it so it made sense.
There was a problem hiding this comment.
This should be changed to seconds or minutes. Documentation says "ticks" which doesn't really mean anything
There was a problem hiding this comment.
I just submitted a pr for RGB Matrix to clean up it's idle timeout and change it to seconds: #6480
| @@ -797,6 +805,15 @@ void rgblight_task(void) { | |||
| // static light mode, do nothing here | |||
| if ( 1 == 0 ) { //dummy | |||
| } | |||
| #ifdef RGBLIGHT_IDLE_ENABLE | |||
There was a problem hiding this comment.
There's no need for multiple defines for this feature as you can just used #if RGBLIGHT_IDLE_TIMEOUT > 0
There was a problem hiding this comment.
Fair enough. Should I just use the rgb matrix variable or still use a separate one.
There was a problem hiding this comment.
I would keep the RGB Light define for this feature separate as there has been interest in running both RGB Light & Matrix at the same time.
| if (record->event.pressed) { | ||
| if (rgblight_idle_timedout) { | ||
| rgblight_idle_timedout = false; | ||
| rgblight_enable_noeeprom(); |
There was a problem hiding this comment.
Don't change the enable/disable state, as a user could have previously disabled the rgblight, and this would turn it back on against the users wishes. Use a similar pattern to what rgb matrix uses to turn off the LEDs without changing user state.
There was a problem hiding this comment.
That makes sense. I will look at the rgb matrix code.
There was a problem hiding this comment.
the rgb_matrix code uses a g_suspend_state boolean locally to determine if it's suspended or not, and renders based on that.
|
There are a number of merge conflicts here. If you could update the PR to fix these? |
|
Thank you for your contribution! |
|
Thank you for your contribution! |
Description
This adds an idle timeout features (independent of your PC's sleep settings). In simple terms: if there are no keystrokes after X minutes, turn off the underglow. All you need to do is add
#define RGBLIGHT_IDLE_TIMEOUT 10(any number in minutes) inconfig.hto enable the feature.A couple notable things were added as side effects:
quantum.hinrgblight.h.process_rgblightfunction toprocess_record_quantuminquantum.c. Could also be useful if other future features need to hook into this loop. I couldn't find anywhere in rgblight.c where it was already being called.Types of Changes
Issues Fixed or Closed by This PR
Checklist