sv/IronOS
1
0
Fork 0
forked from me/IronOS
Code Pull Requests Activity

Rework settings to be min-max inclusive

Browse Source
This commit is contained in:
Ben V. Brown
2021-12-19 10:21:19 +11:00
parent 6d7fc2f689
commit e33b900cff
1 changed files with 46 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
source/Core/Src/Settings.cpp
View File

@@ -26,6 +26,7 @@ bool sanitiseSettings();
* flash in uint16_t chunks * flash in uint16_t chunks
*/ */
typedef struct { typedef struct {
uint16_t versionMarker;
uint16_t length; // Length of valid bytes following uint16_t length; // Length of valid bytes following
uint16_t settingsValues[SettingsOptionsLength]; uint16_t settingsValues[SettingsOptionsLength];
// used to make this nicely "good enough" aligned to 32 butes to make driver code trivial // used to make this nicely "good enough" aligned to 32 butes to make driver code trivial
@@ -41,48 +42,48 @@ volatile systemSettingsType systemSettings;
// For every setting we need to store the min/max/increment values // For every setting we need to store the min/max/increment values
typedef struct { typedef struct {
const uint16_t min; // Inclusive minimum value const uint16_t min; // Inclusive minimum value
const uint16_t max; // Exclusive maximum value const uint16_t max; // Inclusive maximum value
const uint16_t increment; // Standard increment const uint16_t increment; // Standard increment
const uint16_t defaultValue; // Default vaue after reset const uint16_t defaultValue; // Default vaue after reset
} SettingConstants; } SettingConstants;
static const SettingConstants settingsConstants[(int)SettingsOptions::SettingsOptionsLength] = { static const SettingConstants settingsConstants[(int)SettingsOptions::SettingsOptionsLength] = {
//{min,max,increment,default} //{min,max,increment,default}
{10, MAX_TEMP_F, 5, 320}, // SolderingTemp {MIN_TEMP_C, MAX_TEMP_F, 5, 320}, // SolderingTemp
{10, MAX_TEMP_F, 5, 150}, // SleepTemp {MIN_TEMP_C, MAX_TEMP_F, 5, 150}, // SleepTemp
{0, 16, 1, SLEEP_TIME}, // SleepTime {0, 15, 1, SLEEP_TIME}, // SleepTime
{0, 5, 1, CUT_OUT_SETTING}, // MinDCVoltageCells {0, 5, 1, CUT_OUT_SETTING}, // MinDCVoltageCells
{24, 38, 1, RECOM_VOL_CELL}, // MinVoltageCells {24, 38, 1, RECOM_VOL_CELL}, // MinVoltageCells
{90, QC_VOLTAGE_MAX, 2, 90}, // QCIdealVoltage {90, QC_VOLTAGE_MAX, 2, 90}, // QCIdealVoltage
{0, 3, 1, ORIENTATION_MODE}, // OrientationMode {0, 2, 1, ORIENTATION_MODE}, // OrientationMode
{0, 10, 1, SENSITIVITY}, // Sensitivity {0, 9, 1, SENSITIVITY}, // Sensitivity
{0, 2, 1, ANIMATION_LOOP}, // AnimationLoop {0, 1, 1, ANIMATION_LOOP}, // AnimationLoop
{0, settingOffSpeed_t::MAX_VALUE, 1, ANIMATION_SPEED}, // AnimationSpeed {0, settingOffSpeed_t::MAX_VALUE - 1, 1, ANIMATION_SPEED}, // AnimationSpeed
{0, 4, 1, AUTO_START_MODE}, // AutoStartMode {0, 3, 1, AUTO_START_MODE}, // AutoStartMode
{0, 61, 1, SHUTDOWN_TIME}, // ShutdownTime {0, 60, 1, SHUTDOWN_TIME}, // ShutdownTime
{0, 2, 1, COOLING_TEMP_BLINK}, // CoolingTempBlink {0, 1, 1, COOLING_TEMP_BLINK}, // CoolingTempBlink
{0, 2, 1, DETAILED_IDLE}, // DetailedIDLE {0, 1, 1, DETAILED_IDLE}, // DetailedIDLE
{0, 2, 1, DETAILED_SOLDERING}, // DetailedSoldering {0, 1, 1, DETAILED_SOLDERING}, // DetailedSoldering
{0, 2, 1, TEMPERATURE_INF}, // TemperatureInF {0, 1, 1, TEMPERATURE_INF}, // TemperatureInF
{0, 2, 1, DESCRIPTION_SCROLL_SPEED}, // DescriptionScrollSpeed {0, 1, 1, DESCRIPTION_SCROLL_SPEED}, // DescriptionScrollSpeed
{0, 3, 1, LOCKING_MODE}, // LockingMode {0, 2, 1, LOCKING_MODE}, // LockingMode
{0, 100, 1, POWER_PULSE_DEFAULT}, // KeepAwakePulse {0, 100, 1, POWER_PULSE_DEFAULT}, // KeepAwakePulse
{1, POWER_PULSE_WAIT_MAX, 1, POWER_PULSE_WAIT_DEFAULT}, // KeepAwakePulseWait {1, POWER_PULSE_WAIT_MAX, 1, POWER_PULSE_WAIT_DEFAULT}, // KeepAwakePulseWait
{1, POWER_PULSE_DURATION_MAX, 1, POWER_PULSE_DURATION_DEFAULT}, // KeepAwakePulseDuration {1, POWER_PULSE_DURATION_MAX, 1, POWER_PULSE_DURATION_DEFAULT}, // KeepAwakePulseDuration
{360, 900, 1, VOLTAGE_DIV}, // VoltageDiv {360, 900, 1, VOLTAGE_DIV}, // VoltageDiv
{0, MAX_TEMP_F, 10, BOOST_TEMP}, // BoostTemp {MIN_TEMP_C, MAX_TEMP_F, 10, BOOST_TEMP}, // BoostTemp
{100, 2500, 1, CALIBRATION_OFFSET}, // CalibrationOffset {100, 2500, 1, CALIBRATION_OFFSET}, // CalibrationOffset
{0, MAX_POWER_LIMIT, POWER_LIMIT_STEPS, POWER_LIMIT}, // PowerLimit {0, MAX_POWER_LIMIT, POWER_LIMIT_STEPS, POWER_LIMIT}, // PowerLimit
{0, 2, 1, REVERSE_BUTTON_TEMP_CHANGE}, // ReverseButtonTempChangeEnabled {0, 1, 1, REVERSE_BUTTON_TEMP_CHANGE}, // ReverseButtonTempChangeEnabled
{5, TEMP_CHANGE_LONG_STEP_MAX, 5, TEMP_CHANGE_LONG_STEP}, // TempChangeLongStep {5, TEMP_CHANGE_LONG_STEP_MAX, 5, TEMP_CHANGE_LONG_STEP}, // TempChangeLongStep
{1, TEMP_CHANGE_SHORT_STEP_MAX, 1, TEMP_CHANGE_SHORT_STEP}, // TempChangeShortStep {1, TEMP_CHANGE_SHORT_STEP_MAX, 1, TEMP_CHANGE_SHORT_STEP}, // TempChangeShortStep
{0, 4, 1, 1}, // HallEffectSensitivity {0, 3, 1, 1}, // HallEffectSensitivity
{0, 10, 1, 0}, // AccelMissingWarningCounter {0, 9, 1, 0}, // AccelMissingWarningCounter
{0, 10, 1, 0}, // PDMissingWarningCounter {0, 9, 1, 0}, // PDMissingWarningCounter
{0, 0xFFFF, 0, 41431 /*EN*/}, // UILanguage {0, 0xFFFF, 0, 41431 /*EN*/}, // UILanguage
{0, 51, 1, 0}, // PDNegTimeout {0, 50, 1, 0}, // PDNegTimeout
{0, 2, 1, 0}, // OLEDInversion {0, 1, 1, 0}, // OLEDInversion
{0, 100, 11, 33}, // OLEDBrightness {0, 99, 11, 33}, // OLEDBrightness
}; };
static_assert((sizeof(settingsConstants) / sizeof(SettingConstants)) == ((int)SettingsOptions::SettingsOptionsLength)); static_assert((sizeof(settingsConstants) / sizeof(SettingConstants)) == ((int)SettingsOptions::SettingsOptionsLength));
@@ -100,6 +101,10 @@ bool sanitiseSettings() {
// For all settings, need to ensure settings are in a valid range // For all settings, need to ensure settings are in a valid range
// First for any not know about due to array growth, reset them and update the length value // First for any not know about due to array growth, reset them and update the length value
bool dirty = false; bool dirty = false;
if (systemSettings.versionMarker != 0x55AA) {
memset((void *)&systemSettings, 0xFF, sizeof(systemSettings));
systemSettings.versionMarker = 0x55AA;
}
if (systemSettings.padding != 0xFFFFFFFF) { if (systemSettings.padding != 0xFFFFFFFF) {
systemSettings.padding = 0xFFFFFFFF; // Force padding to 0xFFFFFFFF so that rolling forwards / back should be easier systemSettings.padding = 0xFFFFFFFF; // Force padding to 0xFFFFFFFF so that rolling forwards / back should be easier
dirty = true; dirty = true;
@@ -113,7 +118,7 @@ bool sanitiseSettings() {
} }
for (int i = 0; i < (int)SettingsOptions::SettingsOptionsLength; i++) { for (int i = 0; i < (int)SettingsOptions::SettingsOptionsLength; i++) {
// Check min max for all settings, if outside the range, move to default // Check min max for all settings, if outside the range, move to default
if (systemSettings.settingsValues[i] < settingsConstants[i].min || systemSettings.settingsValues[i] >= settingsConstants[i].max) { if (systemSettings.settingsValues[i] < settingsConstants[i].min || systemSettings.settingsValues[i] > settingsConstants[i].max) {
systemSettings.settingsValues[i] = settingsConstants[i].defaultValue; systemSettings.settingsValues[i] = settingsConstants[i].defaultValue;
dirty = true; dirty = true;
@@ -133,26 +138,38 @@ void resetSettings() {
void setSettingValue(const enum SettingsOptions option, const uint16_t newValue) { void setSettingValue(const enum SettingsOptions option, const uint16_t newValue) {
const auto constants = settingsConstants[(int)option]; const auto constants = settingsConstants[(int)option];
systemSettings.settingsValues[(int)option] = newValue; systemSettings.settingsValues[(int)option] = newValue;
// If less than min, constrain
if (systemSettings.settingsValues[(int)option] < constants.min) { if (systemSettings.settingsValues[(int)option] < constants.min) {
systemSettings.settingsValues[(int)option] = constants.min; systemSettings.settingsValues[(int)option] = constants.min;
} }
// If hit max, constrain // If hit max, constrain
if (systemSettings.settingsValues[(int)option] >= constants.max) { if (systemSettings.settingsValues[(int)option] > constants.max) {
systemSettings.settingsValues[(int)option] = constants.max - 1; systemSettings.settingsValues[(int)option] = constants.max;
} }
} }
// Lookup wrapper for ease of use (with typing)
uint16_t getSettingValue(const enum SettingsOptions option) { return systemSettings.settingsValues[(int)option]; } uint16_t getSettingValue(const enum SettingsOptions option) { return systemSettings.settingsValues[(int)option]; }
// Increment by the step size to the next value. If past the end wrap to the minimum
// Returns true if we are on the _last_ value
bool nextSettingValue(const enum SettingsOptions option) { bool nextSettingValue(const enum SettingsOptions option) {
const auto constants = settingsConstants[(int)option]; const auto constants = settingsConstants[(int)option];
if (systemSettings.settingsValues[(int)option] >= (constants.max - constants.increment)) { if (systemSettings.settingsValues[(int)option] == (constants.max)) {
// Already at max, wrap to the start
systemSettings.settingsValues[(int)option] = constants.min; systemSettings.settingsValues[(int)option] = constants.min;
} else if (systemSettings.settingsValues[(int)option] >= (constants.max - constants.increment)) {
// If within one increment of the end, constrain to the end
systemSettings.settingsValues[(int)option] = constants.max;
} else { } else {
// Otherwise increment
systemSettings.settingsValues[(int)option] += constants.increment; systemSettings.settingsValues[(int)option] += constants.increment;
} }
return (constants.max - systemSettings.settingsValues[(int)option]) <= constants.increment; // Return if we are at the max
return constants.max == systemSettings.settingsValues[(int)option];
} }
// Step backwards on the settings item
// Return true if we are at the end (min)
bool prevSettingValue(const enum SettingsOptions option) { bool prevSettingValue(const enum SettingsOptions option) {
const auto constants = settingsConstants[(int)option]; const auto constants = settingsConstants[(int)option];
int value = systemSettings.settingsValues[(int)option]; int value = systemSettings.settingsValues[(int)option];