#define SAVE_STATE not present; Presets.ini still used

Cyroceon · October 31, 2022, 4:43pm

On the Presets.ini GitHub page it says that the define SAVE_STATE has to be included in the upload to trigger Presets.ini to be looked at.

I don’t have that define, and yet I am using the presets.ini file constantly and as expected. Is the SAVE_STATE define included in any others I’ve listed below? If not, can someone explain this behavior?

#ifdef CONFIG_TOP
#include "proffieboard_v2_config.h"
#define NUM_BLADES 1
#define NUM_BUTTONS 2
#define VOLUME 1750
const unsigned int maxLedsPerStrip = 144;
#define CLASH_THRESHOLD_G 4.0
#define ENABLE_AUDIO
#define ENABLE_MOTION
#define ENABLE_WS2811
#define ENABLE_SD
#define COLOR_CHANGE_DIRECT
#define IDLE_OFF_TIME 60*2*1000
#define MOTION_TIMEOUT 60*10*1000
#define SHARED_POWER_PINS
#define DISABLE_DIAGNOSTIC_COMMANDS
#define BLADE_DETECT_PIN 17
#define SAVE_PRESET
#define NO_REPEAT_RANDOM
#define KEEP_SAVEFILES_WHEN_PROGRAMMING
#define FETT263_SAY_COLOR_LIST
#define FETT263_SAY_COLOR_LIST_CC
#define ENABLE_ALL_EDIT_OPTIONS
#define FETT263_EDIT_MODE_MENU
#define DISABLE_BASIC_PARSER_STYLES
#define FETT263_SAY_BATTERY_PERCENT
#define FETT263_MULTI_PHASE
#define FETT263_HOLD_BUTTON_OFF
#define FETT263_HOLD_BUTTON_LOCKUP
#define FETT263_TWIST_OFF
#define FETT263_TWIST_ON
#define FETT263_TWIST_ON_NO_BM
#define FETT263_STAB_ON
#define FETT263_STAB_ON_NO_BM
#define FETT263_THRUST_ON
#define FETT263_THRUST_ON_NO_BM
#endif

NoSloppy · October 31, 2022, 5:17pm

#define SAVE_STATE causes the presets.ini file to be written to.
If you remove that define, you wont have current stuff saved new,
but there’s nothing preventing the OS from still using what’s already been written.

You also have #define KEEP_SAVEFILES_WHEN_PROGRAMMING
which is going to have the board ignore any new uploaded changes and read from the presets.ini file instead.

It sounds like you just want to delete presets.ini/tmp from the SD.

Read this:

OS6 & OS7 PSA - Using #define KEEP SAVEFILES WHEN PROGRAMMING ProffieOS

NOTE FOR ALL USERS updating to OS6 or OS7. Be sure to read the wiki page for this define before adding to your config. #define KEEP_SAVEFILES_WHEN_PROGRAMMING Once this define is added to your config, the intended use is to make all future updates to your saber via Edit Mode or ProffieOS Workbench and NOT by uploading changes to your config. This define tells the OS to use the .ini files on your SD for all presets and settings so if you have new styles, changes to fonts, colors, etc. or changes to volume, clash threshold, brightness, blade length or other settings that are editable in Edit Mode or ProffieOS Workbench that you’re trying to make via a change to your config you will not see those changes on your saber if the .ini files have different values. This can be confusing, particularly for new users, as you may have a successful upload but not see the changes on your saber. You also have to be mindful when adding, removing or updating presets in your config once this define is enabled (refer to below wiki article). I recommend only adding this define AFTER you have your saber dialed in to where you want it with all styles and settings for your “baseline” set. Then once you add this define, all future changes should only be made via Edit Mode or ProffieOS Workbench. If you need to add a style or upload other changes via your config, you should remove or comment out this define first and then only add it once you have the saber’s default set.

Fett263 · October 31, 2022, 5:34pm

This saves everything

As Brian noted remove this and read that link he provided before reenabling.

Cyroceon · October 31, 2022, 5:54pm

Thanks @Fett263 and @NoSloppy.

The only piece of missing information I didn’t have is that “ENABLE_ALL_EDIT_OPTIONS” includes everything. I was referencing this page at the bottom. If “SAVE_STATE” was called out there, I’d have never made the thread.

Thanks again to both!

NoSloppy · October 31, 2022, 5:59pm

I just updated the Wiki to clarify

Cyroceon · October 31, 2022, 7:08pm

Appreciate that. Just a suggestion after re-reading w/ the edit…perhaps specify that SAVE_STATE is nothing more than those defines, as the collective exhaustion aspect of the equation is what’s missing to me.

In other words, it is clear that the four defines referenced are included in SAVE_STATE, but not that SAVE_STATE can be replaced by those four included in the ENABLE_ALL_EDIT_OPTIONS define. I hope that is helpful.

Fett263 · October 31, 2022, 7:56pm

They’re not “identical” both are referenced right in the .ino

ENABLE_ALL_EDIT_OPTIONS is needed for Edit Mode and has all of the editable defines in place, SAVE_STATE doesn’t and also adds SAVE_PRESET which keeps last active preset, that is not needed (or desired) for Edit Mode.

github.com

profezzorn/ProffieOS/blob/01b41cf2f86d101b78748e93fd8ef9ad067f55cf/ProffieOS.ino#L63


      
          #endif
          
          
#define CONFIG_TOP
          #include CONFIG_FILE
          #undef CONFIG_TOP
          
          
#ifndef BOOT_VOLUME
          #define BOOT_VOLUME VOLUME
          #endif
          
          
#ifdef SAVE_STATE
          #define SAVE_VOLUME
          #define SAVE_PRESET
          #define SAVE_COLOR_CHANGE
          #define SAVE_DYNAMIC_DIMMING
          #endif
          
          
#ifdef ENABLE_ALL_EDIT_OPTIONS
          #define DYNAMIC_BLADE_LENGTH
          #define DYNAMIC_BLADE_DIMMING
          #define DYNAMIC_CLASH_THRESHOLD

github.com

profezzorn/ProffieOS/blob/01b41cf2f86d101b78748e93fd8ef9ad067f55cf/ProffieOS.ino#L70


      
          #define BOOT_VOLUME VOLUME
          #endif
          
          
#ifdef SAVE_STATE
          #define SAVE_VOLUME
          #define SAVE_PRESET
          #define SAVE_COLOR_CHANGE
          #define SAVE_DYNAMIC_DIMMING
          #endif
          
          
#ifdef ENABLE_ALL_EDIT_OPTIONS
          #define DYNAMIC_BLADE_LENGTH
          #define DYNAMIC_BLADE_DIMMING
          #define DYNAMIC_CLASH_THRESHOLD
          #define SAVE_VOLUME
          #define SAVE_BLADE_DIMMING
          #define SAVE_CLASH_THRESHOLD
          #define SAVE_COLOR_CHANGE
          #endif
          
          
// #define ENABLE_DEBUG

NoSloppy · October 31, 2022, 8:07pm

ok how about now
The CONFIG_TOP section

Cyroceon · November 1, 2022, 12:55am

Thanks @NoSloppy! Looks clear as day now.

@Fett263, got it loud and clear. Cheers.

Cyroceon · November 1, 2022, 1:18am

Sorry, one more question.

So, which define(s) trigger(s) the board to look at presets.ini for preset information, SAVE_STATE i.e., the underlying 4 defines; ENABLE_ALL_EDIT_OPTIONS i.e., the underlying 7 defines; or something else?

Judging on the overlapping defines between the two referenced in the .ino, it seems it is, at minimum, SAVE_VOLUME and SAVE_COLOR_CHANGE, but isn’t there more to it than that?

Thanks again.

profezzorn · November 1, 2022, 7:13am

There is currently no define that makes ProffieOS ignore presets.ini completely.

Cyroceon · November 1, 2022, 7:29am

I’m asking the opposite of that. Which trigger the board to seek/use, not ignore, presets.ini?

profezzorn · November 1, 2022, 7:32am

There is also no define for that.
It always[1] does that.

[1] unless the install date doesn’t match and KEEP_SAVEFILES_WHEN_PROGRAMMING is not defined.

Cyroceon · November 1, 2022, 1:38pm

Perhaps an update to the GitHub re: Presets.ini pre-requisites is in order? Specifically, the below callout, located at this GitHub page.

IMPORTANT: to use presets.ini, you have to flash the saber with the #define SAVE_STATE in your config file, so the saber knows to look at the SD card for preset information.

NoSloppy · November 1, 2022, 6:57pm

How about now?

Cyroceon · November 1, 2022, 9:20pm

If I am reading it correctly, then that means it is SAVE_PRESET that triggers the Presets.ini writing/reading. I was under a different impression based on @profezzorn’s last post. However, if that’s accurate, it is clear as day.

Thanks again.