gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-28 11:59:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix encoder pin configuration and enhance work timer functionality with improved state management and validation

Browse Source
This commit is contained in:
TS Design Works 2025-05-16 06:58:42 -04:00
parent 86bbf7946e
commit d13b6fd64b
4 changed files with 180 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
keyboards/tssouthpaw/keyboard.json
View File

@ -26,7 +26,7 @@
"encoder": {
"enabled": true,
"rotary": [
{"pin_a": "GP1", "pin_b": "GP0", "resolution": 4}
{"pin_a": "GP0", "pin_b": "GP1", "resolution": 4}
]
},
"features": {

0
keyboards/tssouthpaw/keymaps/default/rgb_effects.c
View File

224
keyboards/tssouthpaw/rgb_effects/work_timer.c
View File

@ -334,7 +334,7 @@ static void display_progress_bar(uint8_t num_leds, float overall_progress, float
/**
* Update the pulse active state
* This determines if the keyboard should wake from sleep for timer notification
* This determines if any pulse effect is currently active
*/
static void update_pulse_active_state(void) {
if (!work_timer.flags.active || work_timer.flags.paused) {
@ -370,7 +370,7 @@ static void update_pulse_active_state(void) {
work_timer.elapsed_time < work_timer.timer_duration);
// Set pulse active if any of these conditions are true
bool new_pulse_active = (
work_timer.flags.pulse_active = (
work_timer.flags.mid_break || // Mid-point break pulse
work_timer.flags.lunch_break || // Lunch break
work_timer.flags.end_warning_shown || // End warning
@ -380,19 +380,7 @@ static void update_pulse_active_state(void) {
end_warning // End warning for all timers
);
// Force a wakeup signal if transitioning from inactive to active pulse
if (!work_timer.flags.pulse_active && new_pulse_active) {
// Explicitly wake up keyboard by toggling suspend state
rgb_matrix_set_suspend_state(false);
// Force appropriate brightness for notifications
uint8_t val = rgb_matrix_get_val();
if (val < RGB_MATRIX_MINIMUM_BRIGHTNESS) {
rgb_matrix_sethsv_noeeprom(rgb_matrix_get_hue(), rgb_matrix_get_sat(), RGB_MATRIX_MINIMUM_BRIGHTNESS);
}
}
work_timer.flags.pulse_active = new_pulse_active;
// Removed wake functionality - no need to wake RGB matrix
}
/**
@ -412,9 +400,11 @@ void toggle_work_timer(void) {
// Save complete clean state to EEPROM
save_work_timer_state();
// Force immediate RGB refresh to restore normal LED state
rgb_matrix_mode_noeeprom(rgb_matrix_get_mode());
} else {
// If timer is inactive, just activate it with current settings
// This assumes the timer type and duration are already set
// If timer is inactive, activate it with current settings
work_timer.flags.active = 1;
work_timer.flags.paused = 0;
work_timer.flags.lunch_break = 0;
@ -424,6 +414,7 @@ void toggle_work_timer(void) {
work_timer.flags.end_warning_shown = 0;
work_timer.flags.pulse_active = 0;
// Reset all time tracking variables
work_timer.start_time = timer_read32();
work_timer.elapsed_time = 0;
work_timer.pause_time = 0;
@ -433,7 +424,6 @@ void toggle_work_timer(void) {
save_work_timer_state();
}
// Ensure timer visual updates immediately after toggle
update_pulse_active_state();
}
@ -508,26 +498,37 @@ void toggle_pause_work_timer(void) {
void update_work_timer(void) {
if (!work_timer.flags.active || work_timer.flags.paused) return;
// Calculate wall time (real-world time) elapsed since start
uint32_t wall_time_elapsed = timer_read32() - work_timer.start_time;
// Current wall time
// Current time
uint32_t current_time = timer_read32();
// Calculate work time (wall time minus breaks)
uint32_t work_time;
if (work_timer.flags.lunch_break || work_timer.flags.mid_break) {
// If in a break, calculate work time as:
// (time since start - total break time - current break elapsed time)
uint32_t current_break_elapsed = timer_elapsed32(work_timer.break_start_time);
work_time = (current_time - work_timer.start_time) - work_timer.total_break_time - current_break_elapsed;
} else {
// Not in a break, work time is wall time minus total break time
work_time = (current_time - work_timer.start_time) - work_timer.total_break_time;
}
// Store the calculated work time
work_timer.elapsed_time = work_time;
// Process different timer states based on timer type
if (work_timer.has_lunch_break) {
// For timers with lunch breaks (8HR and 10HR)
// Handle lunch break state transitions
if (!work_timer.flags.lunch_break) {
// Check if it's time to start lunch
if (!work_timer.flags.lunch_warning_shown &&
work_timer.elapsed_time >= (work_timer.mid_break_start - BREAK_WARNING_TIME) &&
work_timer.elapsed_time < work_timer.mid_break_start) {
work_time >= (work_timer.mid_break_start - BREAK_WARNING_TIME) &&
work_time < work_timer.mid_break_start) {
// Pre-lunch warning (red pulse before lunch)
work_timer.flags.lunch_warning_shown = 1;
}
else if (work_timer.elapsed_time >= work_timer.mid_break_start) {
else if (work_time >= work_timer.mid_break_start) {
// Start lunch break
work_timer.flags.lunch_break = 1;
work_timer.break_start_time = current_time;
@ -538,45 +539,36 @@ void update_work_timer(void) {
}
}
else {
// Currently in lunch break
uint32_t break_elapsed = timer_elapsed32(work_timer.break_start_time);
// Check for lunch end warning
if (!work_timer.flags.lunch_warning_shown &&
break_elapsed >= (work_timer.mid_break_duration - BREAK_WARNING_TIME)) {
// Pre-end warning (red pulse before end of lunch)
work_timer.flags.lunch_warning_shown = 1;
}
// FIX: Much more aggressive timeout - end lunch after just 5 seconds over
if (break_elapsed >= (work_timer.mid_break_duration + 5000)) {
// Break has been active for 5 seconds over its time - force exit
work_timer.flags.lunch_break = 0;
work_timer.flags.lunch_warning_shown = 0;
work_timer.total_break_time += break_elapsed; // Add actual break time
// Save state for persistence
save_work_timer_state();
}
// Normal lunch break end check
else if (break_elapsed >= work_timer.mid_break_duration) {
// End lunch break
work_timer.flags.lunch_break = 0;
work_timer.flags.lunch_warning_shown = 0; // Reset the warning flag
// Add the break time to total_break_time - use the exact elapsed time
// to ensure we account for all time accurately
work_timer.total_break_time += break_elapsed;
// Save state when exiting lunch break
save_work_timer_state();
}
// Extra validation - check if break_start_time is valid
// First validate break_start_time before any other processing
if (work_timer.break_start_time == 0) {
// Invalid break start time, force end break
work_timer.flags.lunch_break = 0;
work_timer.flags.lunch_warning_shown = 0;
save_work_timer_state();
// Skip the rest of the break processing
}
else {
// Currently in lunch break
uint32_t break_elapsed = timer_elapsed32(work_timer.break_start_time);
// Check for lunch end warning
if (!work_timer.flags.lunch_warning_shown &&
break_elapsed >= (work_timer.mid_break_duration - BREAK_WARNING_TIME)) {
// Pre-end warning (red pulse before end of lunch)
work_timer.flags.lunch_warning_shown = 1;
}
// End lunch break after specified duration (plus a small grace period)
if (break_elapsed >= (work_timer.mid_break_duration + 5000)) {
// End lunch break
work_timer.flags.lunch_break = 0;
work_timer.flags.lunch_warning_shown = 0;
// Add actual break duration to total break time
work_timer.total_break_time += break_elapsed;
save_work_timer_state();
}
}
}
}
@ -587,12 +579,12 @@ void update_work_timer(void) {
if (!work_timer.flags.mid_break) {
// Check if it's time to start mid-break
if (!work_timer.flags.mid_break_warning_shown &&
work_timer.elapsed_time >= (work_timer.mid_break_start - BREAK_WARNING_TIME) &&
work_timer.elapsed_time < work_timer.mid_break_start) {
work_time >= (work_timer.mid_break_start - BREAK_WARNING_TIME) &&
work_time < work_timer.mid_break_start) {
// Mid-break warning
work_timer.flags.mid_break_warning_shown = 1;
}
else if (work_timer.elapsed_time >= work_timer.mid_break_start) {
else if (work_time >= work_timer.mid_break_start) {
// Start mid-break
work_timer.flags.mid_break = 1;
work_timer.break_start_time = current_time;
@ -600,73 +592,56 @@ void update_work_timer(void) {
}
}
else {
// Currently in mid-break
uint32_t break_elapsed = timer_elapsed32(work_timer.break_start_time);
// FIX: More aggressive timeout - force end mid-break after 5 seconds over time
if (break_elapsed >= (work_timer.mid_break_duration + 5000)) {
// Break has been active for 5 seconds over its time - force exit
work_timer.flags.mid_break = 0;
work_timer.flags.mid_break_warning_shown = 0;
work_timer.total_break_time += break_elapsed; // Add actual break time
save_work_timer_state();
}
// Normal mid-break end check
else if (break_elapsed >= work_timer.mid_break_duration) {
// End mid-break
work_timer.flags.mid_break = 0;
work_timer.flags.mid_break_warning_shown = 0; // Reset warning flag
// Add the break time to total_break_time - use the actual elapsed time
work_timer.total_break_time += break_elapsed;
save_work_timer_state();
}
// Extra validation - check if break_start_time is valid
// First validate break_start_time before any other processing
if (work_timer.break_start_time == 0) {
// Invalid break start time, force end break
work_timer.flags.mid_break = 0;
work_timer.flags.mid_break_warning_shown = 0;
save_work_timer_state();
// Skip the rest of the break processing
}
else {
// Currently in mid-break
uint32_t break_elapsed = timer_elapsed32(work_timer.break_start_time);
// End mid-break after specified duration (plus a small grace period)
if (break_elapsed >= (work_timer.mid_break_duration + 5000)) {
// End mid-break
work_timer.flags.mid_break = 0;
work_timer.flags.mid_break_warning_shown = 0;
// Add actual break duration to total break time
work_timer.total_break_time += break_elapsed;
save_work_timer_state();
}
}
}
}
// Calculate true work time (excluding breaks)
if (work_timer.flags.lunch_break || work_timer.flags.mid_break) {
// Currently in a break, so work time is wall time minus total breaks
// minus current break elapsed time
uint32_t current_break_elapsed = timer_elapsed32(work_timer.break_start_time);
work_timer.elapsed_time = wall_time_elapsed - work_timer.total_break_time - current_break_elapsed;
} else {
// Not in a break, so work time is wall time minus total breaks
work_timer.elapsed_time = wall_time_elapsed - work_timer.total_break_time;
}
// Check for end of day warning (5 min before end)
if (!work_timer.flags.end_warning_shown &&
work_timer.elapsed_time >= (work_timer.timer_duration - BREAK_WARNING_TIME)) {
work_time >= (work_timer.timer_duration - BREAK_WARNING_TIME)) {
work_timer.flags.end_warning_shown = 1;
}
// Auto-stop after timer duration
if (work_timer.elapsed_time >= work_timer.timer_duration) {
if (work_time >= work_timer.timer_duration) {
work_timer.flags.active = 0;
// Ensure all break states are cleared when timer ends
work_timer.flags.lunch_break = 0;
work_timer.flags.mid_break = 0;
save_work_timer_state();
}
// Update the pulse active state for wakeup
// Update the pulse active state
update_pulse_active_state();
}
/**
* Check if any timer pulse is currently active
* Used for wake-from-sleep functionality
*
* @return true if any timer pulse effect is active, false otherwise
*/
* Check if any timer pulse is currently active
* Used for easier state checking
*
* @return true if any timer pulse effect is active, false otherwise
*/
bool is_timer_pulse_active(void) {
// If timer is not active or is paused, no pulse is active
if (!work_timer.flags.active || work_timer.flags.paused) {
@ -681,15 +656,21 @@ bool is_timer_pulse_active(void) {
* Handle the work timer visualization on LEDs
*/
void handle_work_timer(void) {
static bool was_active = false;
if (!work_timer.flags.active) {
// If timer is not active, ensure all timer-related LEDs are cleared
const uint8_t num_leds = WORK_TIMER_LED_END - WORK_TIMER_LED_START + 1;
for (uint8_t i = 0; i < num_leds; i++) {
rgb_matrix_set_color(WORK_TIMER_LED_START + i, 0, 0, 0);
// If the timer was just deactivated, force a complete RGB refresh
if (was_active) {
rgb_matrix_mode_noeeprom(rgb_matrix_get_mode());
was_active = false;
}
// Instead of explicitly turning off LEDs, let the RGB system handle them
return;
}
was_active = true;
// Enhanced validation checks for break states - run on every visual update
// to catch and correct any inconsistent timer states
if (work_timer.flags.lunch_break || work_timer.flags.mid_break) {
@ -722,13 +703,7 @@ void handle_work_timer(void) {
uint8_t rgb_brightness = rgb_matrix_get_val();
float brightness_factor = (float)rgb_brightness / 255.0f;
// Ensure minimum brightness during notifications
// (RGB matrix must be awake for this to have an effect)
if (work_timer.flags.pulse_active && rgb_brightness < RGB_MATRIX_MINIMUM_BRIGHTNESS) {
rgb_brightness = RGB_MATRIX_MINIMUM_BRIGHTNESS;
brightness_factor = (float)RGB_MATRIX_MINIMUM_BRIGHTNESS / 255.0f;
// Don't permanently change the RGB settings, just adjust for calculations
}
// Simplified: No need to modify brightness - use whatever the system has
// Number of LEDs in the progress bar
const uint8_t num_leds = WORK_TIMER_LED_END - WORK_TIMER_LED_START + 1;
@ -752,10 +727,11 @@ void handle_work_timer(void) {
(work_timer.elapsed_time >= (work_timer.mid_break_start - BREAK_WARNING_TIME) &&
work_timer.elapsed_time < work_timer.mid_break_start);
// Lunch-end warning (red pulse)
// Lunch-end warning (red pulse) - Add validation for break_start_time
lunch_end_warning = work_timer.flags.lunch_break &&
work_timer.break_start_time != 0 &&
(timer_elapsed32(work_timer.break_start_time) >= (work_timer.mid_break_duration - BREAK_WARNING_TIME));
// Choose appropriate display based on current state
if (lunch_warning || lunch_end_warning) {
// Pre/Post lunch red warning pulse
@ -769,8 +745,8 @@ void handle_work_timer(void) {
(uint8_t)((float)pulse_color.b * pulse_ratio * brightness_factor));
}
}
else if (work_timer.flags.lunch_break) {
// During lunch break - blue pulse
else if (work_timer.flags.lunch_break && work_timer.break_start_time != 0) {
// During lunch break - blue pulse, only if break_start_time is valid
rgb_color_t pulse_color = WORK_TIMER_LUNCH_COLOR;
// Use a slower pulse for regular lunch break
@ -821,7 +797,8 @@ void handle_work_timer(void) {
(uint8_t)((float)pulse_color.b * pulse_ratio * brightness_factor));
}
}
else if (work_timer.flags.mid_break) {
// Mid-break active - only show if break_start_time is valid
else if (work_timer.flags.mid_break && work_timer.break_start_time != 0) {
// Mid-break active - blue pulse
rgb_color_t pulse_color = WORK_TIMER_LUNCH_COLOR;
@ -862,4 +839,7 @@ void handle_work_timer(void) {
void work_timer_task(void) {
// Update work timer state
update_work_timer();
// Add explicit call to refresh RGB matrix if needed
// This might help ensure F1-F12 get proper colors after timer state changes
}

151
keyboards/tssouthpaw/rgb_effects/work_timer.h
View File

@ -14,78 +14,81 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#pragma once
#include "quantum.h"
// Work Timer type enum
typedef enum {
TIMER_TYPE_30MIN,
TIMER_TYPE_1HR,
TIMER_TYPE_4HR,
TIMER_TYPE_8HR,
TIMER_TYPE_10HR
} work_timer_type_t;
// Work Timer state enum
typedef enum {
TIMER_STATE_INACTIVE,
TIMER_STATE_ACTIVE,
TIMER_STATE_PAUSED,
TIMER_STATE_LUNCH,
TIMER_STATE_MID_BREAK,
TIMER_STATE_COMPLETED
} work_timer_state_t;
// Work Timer Color definitions - modified for more yellow/orange focus
// Start point color (green)
#define WORK_TIMER_START_R 0
#define WORK_TIMER_START_G 255
#define WORK_TIMER_START_B 0
// Mid point color (orange)
#define WORK_TIMER_MID_R 255
#define WORK_TIMER_MID_G 112
#define WORK_TIMER_MID_B 0
// End point color (red)
#define WORK_TIMER_END_R 255
#define WORK_TIMER_END_G 0
#define WORK_TIMER_END_B 0
// Lunch break color (blue)
#define WORK_TIMER_LUNCH_R 0
#define WORK_TIMER_LUNCH_G 0
#define WORK_TIMER_LUNCH_B 255
// Warning color (red)
#define WORK_TIMER_WARNING_R 255
#define WORK_TIMER_WARNING_G 0
#define WORK_TIMER_WARNING_B 0
// Standard timer durations (in milliseconds)
// IMPORTANT: These represent actual working time (excluding breaks)
#define TIMER_30MIN_DURATION 1800000 // 30 minutes
#define TIMER_1HR_DURATION 3600000 // 1 hour
#define TIMER_4HR_DURATION 14400000 // 4 hours
#define TIMER_8HR_DURATION 28800000 // 8 hours (real world 9 hours with lunch)
#define TIMER_10HR_DURATION 36000000 // 10 hours (real world 11 hours with lunch)
// Break durations
#define BREAK_WARNING_TIME 60000 // 60 seconds
#define MID_BREAK_30MIN_DURATION 30000 // 30 seconds
#define MID_BREAK_1HR_DURATION 45000 // 45 seconds
#define MID_BREAK_4HR_DURATION 60000 // 60 seconds
#define LUNCH_BREAK_DURATION 3600000 // 1 hour default
// Function declarations for work timer
void work_timer_init(void);
void start_timer(work_timer_type_t timer_type);
void toggle_pause_work_timer(void);
void update_work_timer(void);
void handle_work_timer(void);
void toggle_work_timer(void);
void work_timer_task(void);
// Functions for checking timer pulse states
bool is_timer_pulse_active(void);
#include "quantum.h"
// Work Timer type enum
typedef enum {
TIMER_TYPE_30MIN,
TIMER_TYPE_1HR,
TIMER_TYPE_4HR,
TIMER_TYPE_8HR,
TIMER_TYPE_10HR
} work_timer_type_t;
// Work Timer state enum
typedef enum {
TIMER_STATE_INACTIVE,
TIMER_STATE_ACTIVE,
TIMER_STATE_PAUSED,
TIMER_STATE_LUNCH,
TIMER_STATE_MID_BREAK,
TIMER_STATE_COMPLETED
} work_timer_state_t;
// Work Timer Color definitions - modified for more yellow/orange focus
// Start point color (green)
#define WORK_TIMER_START_R 0
#define WORK_TIMER_START_G 255
#define WORK_TIMER_START_B 0
// Mid point color (orange)
#define WORK_TIMER_MID_R 255
#define WORK_TIMER_MID_G 112
#define WORK_TIMER_MID_B 0
// End point color (red)
#define WORK_TIMER_END_R 255
#define WORK_TIMER_END_G 0
#define WORK_TIMER_END_B 0
// Lunch break color (blue)
#define WORK_TIMER_LUNCH_R 0
#define WORK_TIMER_LUNCH_G 0
#define WORK_TIMER_LUNCH_B 255
// Warning color (red)
#define WORK_TIMER_WARNING_R 255
#define WORK_TIMER_WARNING_G 0
#define WORK_TIMER_WARNING_B 0
// Standard timer durations (in milliseconds)
// IMPORTANT: These represent actual working time (excluding breaks)
#define TIMER_30MIN_DURATION 1800000 // 30 minutes
#define TIMER_1HR_DURATION 3600000 // 1 hour
#define TIMER_4HR_DURATION 14400000 // 4 hours
#define TIMER_8HR_DURATION 28800000 // 8 hours (real world 9 hours with lunch)
#define TIMER_10HR_DURATION 36000000 // 10 hours (real world 11 hours with lunch)
// Break durations
#define BREAK_WARNING_TIME 60000 // 60 seconds
#define MID_BREAK_30MIN_DURATION 30000 // 30 seconds
#define MID_BREAK_1HR_DURATION 45000 // 45 seconds
#define MID_BREAK_4HR_DURATION 60000 // 60 seconds
#define LUNCH_BREAK_DURATION 3600000 // 1 hour default
// Define maximum valid duration for sanity checking
#define TIMER_MAX_DURATION 50400000 // 14 hours - sanity check
// Function declarations for work timer
void work_timer_init(void);
void start_timer(work_timer_type_t timer_type);
void toggle_pause_work_timer(void);
void update_work_timer(void);
void handle_work_timer(void);
void toggle_work_timer(void);
void work_timer_task(void);
// Functions for checking timer states
bool is_timer_pulse_active(void);