Merge lp:~sammyshp/flashlight-firmware/2c-turbo-config into lp:~toykeeper/flashlight-firmware/anduril2

[Sven Greiner]

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.

[lp:~sammyshp/flashlight-firmware/2c-turbo-config]

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.

[Selene ToyKeeper (toykeeper)]

Looks like we were working on the same thing at similar times.

I used a somewhat different approach though...

- retained the USE_2C_MAX_TURBO compile option, for backward compatibility and a smaller binary
- made turbo config apply to more places, not just double-click-from-ramp
- made simple and advanced modes use independent turbo configs
- added a third style: no turbo (to retain simple UI's no-turbo policy)
- put the turbo config into ramp menus instead of the misc/globals menu

It'd be nice to remove some of the older code at some point, but for now it's still available as a compile option.

I really like the tricks you did to handle counting depending on which options are compiled in, and will have to keep it in mind for cases where it's needed. I'm debating how to handle variable features in menus though, since things get confusing when the UI has different items at different menu indexes in different builds. So for now I've tried to keep the menu item number consistent, even if prior items were compiled out. On the one hand, this leaves a gap in the menu where the user can change a setting but it has no effect. On the other hand, it means the documentation can give accurate info about which item is which, even when some items are missing.

Also, you make a good point about being able to use global variables instead of preprocessor symbols sometimes... since the compiler can detect when it never gets changed, and compile it out. I'm hoping to replace the entire set of config vars with a struct though, and I'm not sure yet if the same method will work there. Will have to test if the compiler can retain the same granular detection, or if it leaves redundant vars in since the container struct gets modified. Regardless, refactoring the config vars is going to be a bit messy, and requires some deeper changes, so I'm putting it off for now.

Unmerged revisions

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/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 11:26:43 +0000
@@ -82,6 +82,9 @@
     #ifdef USE_AUTOLOCK
     autolock_time_e,
     #endif
+    #ifdef USE_2C_STYLE_CONFIG
+    use_2c_max_turbo_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 11:26:43 +0000
@@ -82,6 +82,9 @@
         #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 START_AT_MEMORIZED_LEVEL
     if (load_eeprom_wl()) {
@@ -148,6 +151,9 @@
     #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
 
     save_eeprom();
 }
 
=== 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 11:26:43 +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,32 @@
 
 #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
 }
 
 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
+        ;
+    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 11:26:43 +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