Merge lp:~sammyshp/flashlight-firmware/moon-dont-ramp-up into lp:~toykeeper/flashlight-firmware/anduril2

[Sven Greiner]

Add option to stop ramping up from moon

With `#undef MOON_START_RAMPING` entering moon from off by holding the switch will not automatically start ramping up. This ensures that moon is entered reliably when the switch is held long enough.

Timings still apply (you can release the switch when the light turns on or when it blips, depending on the configured timing).

With `#define USE_MOON_START_RAMPING_CONFIG` this can be configured during runtime with the global configuration menu.

This contains the changes of lp:~sammyshp/flashlight-firmware/2c-turbo-config because they were necessary for the configuration menu.

[Selene ToyKeeper (toykeeper)]

We took very similar approaches here, mostly differing in whether the boolean means "ramp" or "don't ramp". Also, yours has the nice property that the user can select either behavior at compile time, or add a menu item... while mine only offers the old behavior or a menu item.

I'm hoping to merge other branches at the moment, but I left a note in the code pointing back to this as a possible improvement for later, because it's a good idea.

Unmerged revisions

621. By Sven Greiner on 2021-08-30

Make moon ramping behavior configurable during runtime

620. By Sven Greiner on 2021-08-30

Add option to stop ramping up from moon

With `#undef MOON_START_RAMPING` entering moon from off by holding the
switch will not automatically start ramping up. This ensures that moon
is entered reliably when the switch is held long enough.

Timings still apply (you can release the switch when the light turns on
or when it blips, depending on the configured timing).

619. By Sven Greiner on 2021-08-30

Add runtime configuration of 2C turbo style

This adds a new configuration option to the global configuration menu if
`USE_2C_STYLE_CONFIG` is defined. The user can select between 0 (no
change), 1 (Anduril 1 behavior) and 2 (Anduril 2) behavior. The default
is taken from `USE_2C_MAX_TURBO` if it is defined.

If `USE_2C_STYLE_CONFIG` is not defined, this creates the same output as
before (no increase in code size).

Also add dynamic setup of the global configuration menu.

=== modified file 'ToyKeeper/spaghetti-monster/anduril/anduril-manual.txt'
--- ToyKeeper/spaghetti-monster/anduril/anduril-manual.txt	2021-08-23 10:37:15 +0000
+++ ToyKeeper/spaghetti-monster/anduril/anduril-manual.txt	2021-08-30 13:29:06 +0000
@@ -645,7 +645,7 @@
 Some models may have an extra config menu for settings which don't fit 
 anywhere else.  These settings are, in order:
 
-  - 2C style:  (not yet implemented)
+  - 2C style:
 
     1: 2C goes to turbo         (Anduril V1 style)
     2: 2C goes to ramp ceiling  (Anduril V2 style)
@@ -659,6 +659,14 @@
 
     The value can be from 1 to 150, but is usually between 10 and 30.
 
+  - Start ramping up from moon:
+
+    When entering moon from off by holding the button and then keep 
+    holding it ...
+
+    0: stay at moon
+    1: start to ramp up
+
 Some settings are hardware-specific and may not be present on all 
 lights.  The number of settings in the global menu depends on the 
 hardware model and the firmware version.

=== modified file 'ToyKeeper/spaghetti-monster/anduril/config-default.h'
--- ToyKeeper/spaghetti-monster/anduril/config-default.h	2021-07-13 23:44:08 +0000
+++ ToyKeeper/spaghetti-monster/anduril/config-default.h	2021-08-30 13:29:06 +0000
@@ -106,6 +106,11 @@
 // timer is available in regular ramp mode and candle mode
 #define USE_SUNSET_TIMER
 
+// automatically start ramping up when entering moon from off
+#define MOON_START_RAMPING
+// make this configurable at runtime
+//#define USE_MOON_START_RAMPING_CONFIG
+
 
 ///// What to do when power is connected /////
 // factory reset function erases user's runtime configuration in eeprom

=== modified file 'ToyKeeper/spaghetti-monster/anduril/load-save-config-fsm.h'
--- ToyKeeper/spaghetti-monster/anduril/load-save-config-fsm.h	2021-08-23 10:24:08 +0000
+++ ToyKeeper/spaghetti-monster/anduril/load-save-config-fsm.h	2021-08-30 13:29:06 +0000
@@ -82,6 +82,12 @@
     #ifdef USE_AUTOLOCK
     autolock_time_e,
     #endif
+    #ifdef USE_2C_STYLE_CONFIG
+    use_2c_max_turbo_e,
+    #endif
+    #ifdef USE_MOON_START_RAMPING_CONFIG
+    moon_start_ramping_e,
+    #endif
     eeprom_indexes_e_END
 } eeprom_indexes_e;
 #define EEPROM_BYTES eeprom_indexes_e_END

=== modified file 'ToyKeeper/spaghetti-monster/anduril/load-save-config.c'
--- ToyKeeper/spaghetti-monster/anduril/load-save-config.c	2021-08-23 10:24:08 +0000
+++ ToyKeeper/spaghetti-monster/anduril/load-save-config.c	2021-08-30 13:29:06 +0000
@@ -82,6 +82,12 @@
         #ifdef USE_AUTOLOCK
         autolock_time = eeprom[autolock_time_e];
         #endif
+        #ifdef USE_2C_STYLE_CONFIG
+        use_2c_max_turbo = eeprom[use_2c_max_turbo_e];
+        #endif
+        #ifdef USE_MOON_START_RAMPING_CONFIG
+        moon_start_ramping = eeprom[moon_start_ramping_e];
+        #endif
     }
     #ifdef START_AT_MEMORIZED_LEVEL
     if (load_eeprom_wl()) {
@@ -148,6 +154,12 @@
     #ifdef USE_AUTOLOCK
     eeprom[autolock_time_e] = autolock_time;
     #endif
+    #ifdef USE_2C_STYLE_CONFIG
+    eeprom[use_2c_max_turbo_e] = use_2c_max_turbo,
+    #endif
+    #ifdef USE_MOON_START_RAMPING_CONFIG
+    eeprom[moon_start_ramping_e] = moon_start_ramping;
+    #endif
 
     save_eeprom();
 }

=== modified file 'ToyKeeper/spaghetti-monster/anduril/off-mode.c'
--- ToyKeeper/spaghetti-monster/anduril/off-mode.c	2021-08-27 13:33:01 +0000
+++ ToyKeeper/spaghetti-monster/anduril/off-mode.c	2021-08-30 13:29:06 +0000
@@ -109,7 +109,7 @@
         // don't start ramping immediately;
         // give the user time to release at moon level
         //if (arg >= HOLD_TIMEOUT) {  // smaller
-        if (arg >= (!ramp_style) * HOLD_TIMEOUT) {  // more consistent
+        if (moon_start_ramping && arg >= (!ramp_style) * HOLD_TIMEOUT) {  // more consistent
             set_state(steady_state, 1);
         }
         return MISCHIEF_MANAGED;

=== modified file 'ToyKeeper/spaghetti-monster/anduril/off-mode.h'
--- ToyKeeper/spaghetti-monster/anduril/off-mode.h	2020-07-22 22:50:22 +0000
+++ ToyKeeper/spaghetti-monster/anduril/off-mode.h	2021-08-30 13:29:06 +0000
@@ -23,5 +23,11 @@
 // when the light is "off" or in standby
 uint8_t off_state(Event event, uint16_t arg);
 
+#ifdef MOON_START_RAMPING
+uint8_t moon_start_ramping = 1;
+#else
+uint8_t moon_start_ramping = 0;
+#endif
+
 
 #endif

=== modified file 'ToyKeeper/spaghetti-monster/anduril/ramp-mode-fsm.h'
--- ToyKeeper/spaghetti-monster/anduril/ramp-mode-fsm.h	2021-08-23 10:24:08 +0000
+++ ToyKeeper/spaghetti-monster/anduril/ramp-mode-fsm.h	2021-08-30 13:29:06 +0000
@@ -47,7 +47,7 @@
 #endif
 
 // include an extra config mode for random stuff which doesn't fit elsewhere
-#if defined(USE_JUMP_START) || defined(USE_2C_STYLE_CONFIG)
+#if defined(USE_JUMP_START) || defined(USE_2C_STYLE_CONFIG) || defined(USE_MOON_START_RAMPING_CONFIG)
 #define USE_GLOBALS_CONFIG
 #endif
 

=== modified file 'ToyKeeper/spaghetti-monster/anduril/ramp-mode.c'
--- ToyKeeper/spaghetti-monster/anduril/ramp-mode.c	2021-08-23 10:24:08 +0000
+++ ToyKeeper/spaghetti-monster/anduril/ramp-mode.c	2021-08-30 13:29:06 +0000
@@ -101,7 +101,7 @@
     // 2 clicks: go to/from highest level
     else if (event == EV_2clicks) {
         uint8_t turbo_level;
-        #ifdef USE_2C_MAX_TURBO
+        if (use_2c_max_turbo) {
             // simple UI: to/from ceiling
             // full UI: to/from turbo (Anduril1 behavior)
             #ifdef USE_SIMPLE_UI
@@ -109,7 +109,7 @@
             else
             #endif
             turbo_level = MAX_LEVEL;
-        #else
+        } else {
             // simple UI: to/from ceiling
             // full UI: to/from ceiling if mem < ceiling,
             //          or to/from turbo if mem >= ceiling
@@ -119,7 +119,7 @@
                 #endif
                ) { turbo_level = mode_max; }
             else { turbo_level = MAX_LEVEL; }
-        #endif
+        }
 
         if (actual_level < turbo_level) {
             set_level_and_therm_target(turbo_level);
@@ -475,19 +475,40 @@
 
 #ifdef USE_GLOBALS_CONFIG
 void globals_config_save(uint8_t step, uint8_t value) {
+    uint8_t step_index = 0;
     if (0) {}
     #ifdef USE_2C_STYLE_CONFIG
-    // TODO: make double-click style configurable (turbo or ceil)
-    else if (1 == step) {}
+    else if (++step_index == step) {
+        if (value > 0) {
+            use_2c_max_turbo = (value == 1);
+        }
+    }
     #endif
     #ifdef USE_JUMP_START
-    else { jump_start_level = value; }
+    else if (++step_index == step) {
+        jump_start_level = value;
+    }
+    #endif
+    #ifdef USE_MOON_START_RAMPING_CONFIG
+    else if (++step_index == step) {
+        moon_start_ramping = value;
+    }
     #endif
 }
 
 uint8_t globals_config_state(Event event, uint16_t arg) {
-    // TODO: set number of steps based on how many configurable options
-    return config_state_base(event, arg, 1, globals_config_save);
+    const uint8_t step_count = 0
+        #ifdef USE_2C_STYLE_CONFIG
+        +1
+        #endif
+        #ifdef USE_JUMP_START
+        +1
+        #endif
+        #ifdef USE_MOON_START_RAMPING_CONFIG
+        +1
+        #endif
+        ;
+    return config_state_base(event, arg, step_count, globals_config_save);
 }
 #endif
 

=== modified file 'ToyKeeper/spaghetti-monster/anduril/ramp-mode.h'
--- ToyKeeper/spaghetti-monster/anduril/ramp-mode.h	2021-08-23 10:24:08 +0000
+++ ToyKeeper/spaghetti-monster/anduril/ramp-mode.h	2021-08-30 13:29:06 +0000
@@ -197,5 +197,11 @@
 uint8_t globals_config_state(Event event, uint16_t arg);
 #endif
 
+#ifdef USE_2C_MAX_TURBO
+uint8_t use_2c_max_turbo = 1;
+#else
+uint8_t use_2c_max_turbo = 0;
+#endif
+
 
 #endif