buttons.c: setup mode rework

See the comment near the top of buttons.c for the description of how
the setup mode works.

diff --git a/firmware/buttons.c b/firmware/buttons.c
index 15c70e28f5b594eb983bc4fbc4b379b7f3aeac0a..d839e8dcdfcba73cf785cc065eebbd3e91c4a652 100644 (file)
--- a/firmware/buttons.c
+++ b/firmware/buttons.c
@@ -10,6 +10,8 @@
 #define SHORT_PRESS_MIN 2       // in jiffies (16 Hz ticks)
 #define SHORT_PRESS_MAX 5
 #define LONG_PRESS_MIN  10
+#define SETUP_TIMEOUT  255     // 15 seconds in jiffies
+// #define USER_PARAMS_WRAPPING 1
 
 static uint16_t button_start[3];
 union {
@@ -23,17 +25,43 @@ union {
        };
 } button_state, prev_state;
 
-static unsigned char user_params[MAX_USER_PARAMS] = { 0, 0, 0 };
-static unsigned char user_params_max[MAX_USER_PARAMS] = { 3, 2, 2 };
+/*
+ * How does the user_params setup mode work:
+ *
+ * There is an array of user-settable parameters user_params[N_USER_PARAMS],
+ * each of which has its own maximum value (user_params_max[N_USER_PARAMS].
+ * These parameters can be modified in the following way:
+ *
+ * Long press of button 1 enters the setup mode.
+ * In the setup mode, status and illumination LEDs both blink in inversion
+ * number mode.
+ * The # of blinks of the illumination LED shows which user_param is
+ * being modified now,
+ * and the # of blinks of the status LED shows the value of this particular
+ * user_param.
+ *
+ * Long press of button 1 selects the next user_param,
+ * short press of button 0 decrements this particular user_param value,
+ * short press of button 1 increments this particular user_param value.
+ *
+ * If USER_PARAMS_WRAPPING is #defined, decrementing the zero leads to
+ * the maximum value - 1, and incrementing the maximum value - 1 leads
+ * to zero.
+ *
+ * After the SETUP_TIMEOUT with no button press, the system leaves the setup
+ * mode.
+ */
+static unsigned char user_params[N_USER_PARAMS] = { 0, 0, 0 };
+static unsigned char user_params_max[N_USER_PARAMS] = { 3, 2, 2 };
 
 static unsigned char user_params_state = 0;
        /*
         * Here 0 means "no setup currently in progress",
-        * 1 .. MAX_USER_PARAMS means "now short presses increase or decrease
+        * 1 .. N_USER_PARAMS means "now short presses increase or decrease
         *           the value of user_params[user_params_state-1]"
         */
 
-static uint16_t user_params_starttime;
+static unsigned char user_params_timeout;
 
 static void inline set_status_led(unsigned char n, pattern_t *pattern)
 {
@@ -42,15 +70,12 @@ static void inline set_status_led(unsigned char n, pattern_t *pattern)
 
 unsigned char buttons_setup_in_progress()
 {
-       if (user_params_state // setup in progress ...
-               // or at least one button is pressed:
-               || prev_state.btn1
-               || prev_state.btn2)
+       if (user_params_state) // setup in progress ...
                return 1;
        return 0;
 }
 
-pattern_t *buttons_setup_status0_pattern_select()
+pattern_t *buttons_setup_status1_pattern_select()
 {
        if (user_params_state) // Setup in progress
                return number_pattern(user_params_state, 1);
@@ -58,7 +83,7 @@ pattern_t *buttons_setup_status0_pattern_select()
                return NULL;
 }
 
-pattern_t *buttons_setup_status1_pattern_select()
+pattern_t *buttons_setup_status0_pattern_select()
 {
        if (user_params_state) // Setup in progress
                return number_pattern(
@@ -71,7 +96,7 @@ pattern_t *buttons_setup_status1_pattern_select()
 
 unsigned char get_user_param(unsigned char param)
 {
-       if (param < MAX_USER_PARAMS)
+       if (param < N_USER_PARAMS)
                return user_params[param];
        return 0; // FIXME: internal error?
 }
@@ -92,20 +117,26 @@ static inline void short_press(unsigned char button)
 
        if (button == 0) {
                if (user_params[param])
-                       user_params[param]--;
+                       --user_params[param];
+#if SETUP_VALUES_WRAPPING
                else
                        user_params[param] = user_params_max[param]-1;
+#endif
        } else {
-               user_params[param]++;
+               ++user_params[param];
 
                if (user_params[param] >= user_params_max[param])
+#if SETUP_VALUES_WRAPPING
                        user_params[param] = 0;
+#else
+                       user_params[param] = user_params_max[param]-1;
+#endif
        }
        // FIXME: notify somebody about user_params change?
 
        set_status_led(1, buttons_setup_status1_pattern_select());
 
-       user_params_starttime = jiffies;
+       user_params_timeout = SETUP_TIMEOUT;
 }
 
 static inline void long_press(unsigned char button)
@@ -118,12 +149,12 @@ static inline void long_press(unsigned char button)
        // button 1 - cycle through states
        user_params_state++;
 
-       if (user_params_state > MAX_USER_PARAMS)
+       if (user_params_state > N_USER_PARAMS)
                user_params_state = 1;
 
        set_status_led(0, buttons_setup_status0_pattern_select());
        set_status_led(1, buttons_setup_status1_pattern_select());
-       user_params_starttime = jiffies;
+       user_params_timeout = SETUP_TIMEOUT;
 }
 
 void init_buttons()
@@ -165,7 +196,8 @@ static void handle_button(unsigned char button, unsigned char cur,
 {
        if (cur && !prev) {                   // --- just pressed ---
                button_start[button] = jiffies;
-               set_status_led(button, NULL);
+               if (!user_params_state)
+                       set_status_led(button, NULL);
 
        } else if (cur && prev) {           // --- is still pressed ---
                uint16_t duration = jiffies - button_start[button];
@@ -245,7 +277,10 @@ void timer_check_buttons()
                prev_state.all = button_state.all;
        }
 
-       if (user_params_state && jiffies - user_params_starttime > 1000) {
+       if (user_params_timeout)
+               --user_params_timeout;
+
+       if (user_params_state && !user_params_timeout) {
                user_params_state = 0;
                set_status_led(0, buttons_setup_status0_pattern_select());
                set_status_led(1, buttons_setup_status1_pattern_select());

diff --git a/firmware/control.c b/firmware/control.c
index c5ba92fe2c2e79b42fe150df6a08769cce305f02..d8cd698fb0a11f2a8f158b08fb377be97e6a7cc2 100644 (file)
--- a/firmware/control.c
+++ b/firmware/control.c
@@ -148,6 +148,9 @@ pattern_t *status_led_pattern_select()
 
 pattern_t *illumination_led_pattern_select()
 {
+       if (buttons_setup_in_progress())
+               return buttons_setup_status1_pattern_select();
+
        if (battery_critical)
                return NULL;
 

diff --git a/firmware/lights.h b/firmware/lights.h
index 9d0386878bf9b79ff774a1e6de929ee74f6cb2f2..081237bc5859152793460ea4e161c043ad44b096 100644 (file)
--- a/firmware/lights.h
+++ b/firmware/lights.h
@@ -111,7 +111,7 @@ void pattern_reload();
 void pwmleds_update_mode();
 
 /* buttons.c */
-#define MAX_USER_PARAMS 3
+#define N_USER_PARAMS 3
 void init_buttons();
 void susp_buttons();
 void timer_check_buttons();