Mercurial > public > ostc4
annotate Common/Inc/settings.h @ 654:890440ab993a
Introduced new menu tab for addition CCR options:
The Xtra menu tab was only used in dive mode before. The tab is now enabled in surface mode and provide access to scrubber timer functionality. To enables this infrastructure (structure, multilanguage strings etc.) have been added to the sourcecode.
| author | Ideenmodellierer |
|---|---|
| date | Sun, 25 Apr 2021 20:41:19 +0200 |
| parents | f6212495f34f |
| children | 1b995079c045 |
| rev | line source |
|---|---|
| 38 | 1 /////////////////////////////////////////////////////////////////////////////// |
| 2 /// -*- coding: UTF-8 -*- | |
| 3 /// | |
| 4 /// \file Common/Inc/settings.h | |
| 5 /// \brief | |
| 6 /// \author Heinrichs Weikamp | |
| 7 /// \date 2018 | |
| 8 /// | |
| 9 /// $Id$ | |
| 10 /////////////////////////////////////////////////////////////////////////////// | |
| 11 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh | |
| 12 /// | |
| 13 /// This program is free software: you can redistribute it and/or modify | |
| 14 /// it under the terms of the GNU General Public License as published by | |
| 15 /// the Free Software Foundation, either version 3 of the License, or | |
| 16 /// (at your option) any later version. | |
| 17 /// | |
| 18 /// This program is distributed in the hope that it will be useful, | |
| 19 /// but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 20 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 21 /// GNU General Public License for more details. | |
| 22 /// | |
| 23 /// You should have received a copy of the GNU General Public License | |
| 24 /// along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 25 ////////////////////////////////////////////////////////////////////////////// | |
| 26 | |
| 27 #ifndef SETTINGS_H | |
| 28 #define SETTINGS_H | |
| 29 | |
| 30 // From Common/Inc: | |
| 31 #include "FirmwareData.h" | |
| 32 | |
| 33 //#include "data_central.h" | |
| 34 | |
|
92
be35821a4974
Stable to test. button sensitiveness fix. + global_constants.
Dmitry Romanov <kitt@bk.ru>
parents:
38
diff
changeset
|
35 #include "global_constants.h" |
| 38 | 36 // From Common/Drivers/ |
| 37 #include "stm32f4xx_hal.h" | |
| 38 | |
| 39 #include <stdint.h> | |
| 40 | |
|
92
be35821a4974
Stable to test. button sensitiveness fix. + global_constants.
Dmitry Romanov <kitt@bk.ru>
parents:
38
diff
changeset
|
41 |
| 38 | 42 #define NUM_GASES 5 |
| 43 #define NUM_OFFSET_DILUENT 5 | |
| 44 #define SPECIAL_GAS_ID 0 | |
| 45 | |
| 46 #define ERROR_ 0xFF | |
| 47 | |
| 48 #define CCRMODE_FixedSetpoint 0 | |
| 49 #define CCRMODE_Sensors 1 | |
| 50 | |
| 51 #define DIVEMODE_OC 0 | |
| 52 #define DIVEMODE_CCR 1 | |
| 53 #define DIVEMODE_Gauge 2 | |
| 54 #define DIVEMODE_Apnea 3 | |
| 55 | |
| 56 #define GF_MODE 1 | |
| 57 #define VPM_MODE 2 | |
| 58 | |
| 59 #define VPM_FROM_FORTRAN 0 | |
| 60 #define VPM_BACHELORWORK 1 | |
| 61 | |
| 62 #define BUEHLMANN_OSTC4 0 | |
| 63 #define BUEHLMANN_hwOS 1 | |
| 64 | |
| 65 #define MMDDYY 0 | |
| 66 #define DDMMYY 1 | |
| 67 #define YYMMDD 2 | |
| 68 | |
|
337
38367bb982b8
Set Max value for pressure offset to 50mBar (20mBar before)
ideenmodellierer
parents:
210
diff
changeset
|
69 #define PRESSURE_OFFSET_LIMIT_MBAR 50 |
|
38367bb982b8
Set Max value for pressure offset to 50mBar (20mBar before)
ideenmodellierer
parents:
210
diff
changeset
|
70 |
|
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
71 #define MAX_COMPASS_COMP (2u) |
| 640 | 72 #define MAX_VIEWPORT_MODE (0x7F) |
|
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
73 |
| 650 | 74 #define MAX_SCRUBBER_TIME (500u) |
| 652 | 75 #define MIN_PPO2_SP_CBAR (40u) |
| 650 | 76 |
|
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
77 typedef enum |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
78 { |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
79 O2_SENSOR_SOURCE_OPTIC = 0, |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
80 O2_SENSOR_SOURCE_ANALOG, |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
81 O2_SENSOR_SOURCE_MAX |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
82 } SensorSource; |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
83 #define MAX_O2_SENSOR_SOURCE (2u) |
| 546 | 84 |
|
654
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
85 typedef enum |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
86 { |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
87 SCRUB_TIMER_OFF = 0, |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
88 SCRUB_TIMER_MINUTES, |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
89 SCRUB_TIMER_PERCENT, |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
90 SCRUB_TIMER_END |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
91 } ScrubTimerMode_e; |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
92 |
| 38 | 93 /* 2015 Jan 30, hw, deco and travel added for MenuEditGas |
| 94 * can be used for buehlmann, vpm, etc. later but be carefull | |
| 95 * with current implemenation */ | |
| 96 typedef struct{ | |
| 97 uint8_t active:1; | |
| 98 uint8_t first:1; | |
| 99 uint8_t deco:1; | |
| 100 uint8_t travel:1; | |
|
526
88c626d01ee5
Added new option to gas configuration: "Off":
Ideenmodellierer
parents:
505
diff
changeset
|
101 uint8_t off:1; |
|
88c626d01ee5
Added new option to gas configuration: "Off":
Ideenmodellierer
parents:
505
diff
changeset
|
102 uint8_t spare:3; |
| 38 | 103 } gasubit8_t; |
| 104 | |
| 105 typedef union{ | |
| 106 gasubit8_t ub; | |
| 107 uint8_t uw; | |
| 108 } gasbit8_Type; | |
| 109 | |
| 110 typedef struct{ | |
| 111 uint8_t standard:4; | |
| 112 uint8_t alternative:4; | |
| 113 } ubit2x4_t; | |
| 114 | |
| 115 typedef union{ | |
| 116 ubit2x4_t ub; | |
| 117 uint8_t uw; | |
| 118 } split2x4_Type; | |
| 119 | |
| 120 typedef union{ | |
| 121 uint8_t u8[4]; | |
| 122 uint32_t u32; | |
| 123 } general32to8_Type; | |
| 124 | |
| 125 typedef struct | |
| 126 { | |
| 127 uint8_t oxygen_percentage; | |
| 128 uint8_t helium_percentage; | |
| 129 gasbit8_Type note; | |
| 130 uint8_t depth_meter; | |
| 131 uint8_t depth_meter_travel; | |
| 132 uint8_t bottle_size_liter; | |
| 133 // uint8_t bottle_wireless_status; | |
| 134 uint16_t bottle_wireless_id; | |
| 135 } SGasLine; | |
| 136 | |
| 137 typedef struct | |
| 138 { | |
| 139 uint8_t setpoint_cbar; | |
| 140 uint8_t depth_meter; | |
| 141 gasbit8_Type note; | |
| 142 } SSetpointLine; | |
| 143 | |
|
654
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
144 |
|
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
145 |
| 38 | 146 /* SSettings |
| 147 * gas[0] and setpoint[0] are the special ones configurable during the dive | |
| 148 */ | |
| 149 typedef struct | |
| 150 { | |
| 151 uint32_t header; | |
| 152 uint8_t warning_blink_dsec; | |
| 153 uint8_t lastDiveLogId; | |
| 154 uint32_t logFlashNextSampleStartAddress; | |
| 155 SGasLine gas[1 + (2*NUM_GASES)]; | |
| 156 SSetpointLine setpoint[1 + NUM_GASES]; | |
| 157 uint8_t CCR_Mode; | |
| 158 uint8_t dive_mode; | |
| 159 split2x4_Type deco_type; | |
| 160 uint8_t ppO2_max_deco; | |
| 161 uint8_t ppO2_max_std; | |
| 162 uint8_t ppO2_min; | |
| 163 uint8_t CNS_max; | |
| 164 uint8_t ascent_MeterPerMinute_max; | |
| 165 uint8_t ascent_MeterPerMinute_showGraph; | |
| 166 uint8_t future_TTS; | |
| 167 uint8_t GF_high; | |
| 168 uint8_t GF_low; | |
| 169 uint8_t aGF_high; | |
| 170 uint8_t aGF_low; | |
| 171 split2x4_Type VPM_conservatism; | |
| 172 uint8_t safetystopDuration; | |
| 173 uint8_t AtemMinutenVolumenLiter; | |
| 174 uint8_t ReserveFractionDenominator; | |
| 175 uint8_t salinity; | |
| 176 uint8_t last_stop_depth_meter; | |
| 177 uint8_t stop_increment_depth_meter; | |
| 178 uint8_t brightness; | |
| 179 uint8_t date_format; | |
| 180 uint8_t selected_language; | |
| 181 char customtext[60]; | |
| 182 uint16_t timeoutSurfacemode; | |
| 183 uint8_t timeoutMenuSurface; | |
| 184 uint8_t timeoutMenuDive; | |
| 185 uint8_t timeoutMenuEdit; | |
| 186 uint8_t timeoutInfo; | |
| 187 uint8_t timeoutInfoCompass; | |
| 188 uint8_t design; | |
| 189 uint16_t timeoutDiveReachedZeroDepth; | |
| 190 uint16_t divetimeToCreateLogbook; | |
| 191 uint8_t serialHigh; | |
| 192 uint8_t serialLow; | |
| 193 // SUFirmware firmwareVersion16to32bit; | |
| 194 uint32_t backup_localtime_rtc_tr; | |
| 195 uint32_t backup_localtime_rtc_dr; | |
| 196 uint16_t totalDiveCounter; | |
|
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
197 uint16_t personalDiveCount; |
| 38 | 198 uint8_t showDebugInfo; |
| 199 uint8_t ButtonResponsiveness[4];// changed content in 0xFFFF0016 | |
| 200 uint8_t nonMetricalSystem; | |
| 201 uint8_t fallbackToFixedSetpoint; | |
| 202 uint8_t bluetoothActive; /* will be set to zero on each startup at the moment */ | |
| 203 uint8_t safetystopDepth; | |
| 204 uint32_t updateSettingsAllowedFromHeader; | |
| 205 uint8_t scooterControl; | |
| 206 uint8_t scooterDrag; | |
| 207 uint8_t scooterLoad; | |
| 208 uint8_t scooterNumberOfBatteries; | |
| 209 uint16_t scooterBattSize; | |
| 210 uint8_t scooterSPARE1[7]; | |
| 211 uint8_t scooterSPARE2[19]; | |
| 212 // new in 0xFFFF0006 | |
| 213 uint8_t ppo2sensors_deactivated; | |
| 214 uint8_t tX_colorscheme; | |
| 215 uint8_t tX_userselectedLeftLowerCornerPrimary; | |
| 216 uint8_t tX_userselectedLeftLowerCornerTimeout; | |
| 217 uint8_t tX_customViewPrimary; | |
| 218 uint8_t tX_customViewTimeout; | |
| 219 uint8_t timeoutEnterButtonSelectDive; | |
| 220 uint16_t logbookOffset; | |
| 221 uint8_t alwaysShowPPO2; | |
| 222 uint8_t extraDisplay; | |
| 223 uint16_t display_toogle_desc; | |
| 224 int8_t offsetPressure_mbar; | |
| 225 int8_t offsetTemperature_centigrad; | |
| 226 uint8_t gasConsumption_travel_l_min; | |
| 227 uint8_t gasConsumption_bottom_l_min; | |
| 228 uint8_t gasConsumption_deco_l_min; | |
| 229 uint8_t debugModeOnStart; | |
| 230 uint8_t IAmStolenPleaseKillMe; | |
| 231 int16_t compassBearing; | |
| 232 uint8_t lastKnownBatteryPercentage; | |
| 233 uint8_t buttonBalance[3]; // 0 = right, 1 = center, 2 = left | |
| 234 uint8_t firmwareVersion[4]; | |
| 235 uint16_t timeoutSurfacemodeWithSensors; | |
| 236 // new in 0xFFFF0016 | |
| 237 uint8_t VPM_model; | |
| 238 uint8_t GF_model; | |
| 239 // new in 0xFFFF0017 | |
| 240 uint8_t FactoryButtonBase; | |
| 241 uint8_t FactoryButtonBalance[3]; | |
|
112
fdf0272e9213
Added new nvm parameter"FlipDisplay" indicating the screen orientation
Ideenmodellierer
parents:
38
diff
changeset
|
242 /* new in 0xFFFF0018 */ |
|
fdf0272e9213
Added new nvm parameter"FlipDisplay" indicating the screen orientation
Ideenmodellierer
parents:
38
diff
changeset
|
243 uint8_t FlipDisplay; |
|
210
b2a9e9b02df0
New feature: make selected customviews persistent
Jan Mulder <jlmulder@xs4all.nl>
parents:
138
diff
changeset
|
244 /* new in 0xFFFF0019 */ |
|
b2a9e9b02df0
New feature: make selected customviews persistent
Jan Mulder <jlmulder@xs4all.nl>
parents:
138
diff
changeset
|
245 uint32_t cv_configuration; |
|
368
50ea68c7a153
Added menu item for motion detection. There are several possibility to use motion detection for user action input. To select of the a new menu entry has been added to the Sys2 =>Custom View Menu (Variables in german)
ideenmodellierer
parents:
210
diff
changeset
|
246 /* new in 0xFFFF001A */ |
|
50ea68c7a153
Added menu item for motion detection. There are several possibility to use motion detection for user action input. To select of the a new menu entry has been added to the Sys2 =>Custom View Menu (Variables in german)
ideenmodellierer
parents:
210
diff
changeset
|
247 uint8_t MotionDetection; |
|
498
4811f3dfaa52
Added dew parameter to enable selection of customer BigFont screens to be displayed
Ideenmodellierer
parents:
372
diff
changeset
|
248 /* new in 0xFFFF001B */ |
|
4811f3dfaa52
Added dew parameter to enable selection of customer BigFont screens to be displayed
Ideenmodellierer
parents:
372
diff
changeset
|
249 uint32_t cv_config_BigScreen; |
|
539
d784f281833a
Added inertia simulation for compass heading:
Ideenmodellierer
parents:
526
diff
changeset
|
250 /* new in 0xFFFF001C */ |
|
d784f281833a
Added inertia simulation for compass heading:
Ideenmodellierer
parents:
526
diff
changeset
|
251 uint8_t compassInertia; |
|
542
6960df7ddb09
Added new t3 view showing first deco stop and tts in parallel:
Ideenmodellierer
parents:
539
diff
changeset
|
252 uint8_t tX_customViewPrimaryBF; |
| 546 | 253 /* new in 0xFFFF001D */ |
|
626
3e1a0e267f38
Added option to select sensitivity of focus detection:
Ideenmodellierer
parents:
567
diff
changeset
|
254 uint8_t viewPortMode; /* 7-Reserve| 6..5 - Focus spot size | 4-Focusframe | 3-Reserve | 2..0-BacklightBoost */ |
| 546 | 255 uint16_t viewRoll; |
| 256 uint16_t viewPitch; | |
| 257 uint16_t viewYaw; | |
|
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
258 /* new in 0xFFFF001E */ |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
259 uint8_t ppo2sensors_source; |
|
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
260 float ppo2sensors_calibCoeff[3]; |
| 567 | 261 uint8_t amPMTime; |
| 650 | 262 /* new in 0xFFFF001F */ |
| 263 uint8_t autoSetpoint; | |
| 264 uint16_t scrubTimerMax; | |
| 265 uint16_t scrubTimerCur; | |
|
654
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
266 uint8_t scrubTimerMode; |
| 38 | 267 } SSettings; |
| 268 | |
| 269 typedef struct | |
| 270 { | |
| 271 // 8 bytes | |
| 272 uint16_t primarySerial; | |
| 273 uint8_t primaryLicence; | |
| 274 uint8_t revision8bit; | |
| 275 uint8_t production_year; | |
| 276 uint8_t production_month; | |
| 277 uint8_t production_day; | |
| 278 uint8_t production_bluetooth_name_set; | |
| 279 | |
| 280 // 44 bytes | |
| 281 char production_info[44]; | |
| 282 | |
| 283 // 8 bytes | |
| 284 uint16_t secondarySerial; | |
| 285 uint8_t secondaryLicence; | |
| 286 uint8_t secondaryReason8bit; | |
| 287 uint8_t secondary_year; | |
| 288 uint8_t secondary_month; | |
| 289 uint8_t secondary_day; | |
| 290 uint8_t secondary_bluetooth_name_set; | |
| 291 | |
| 292 // 4 bytes | |
| 293 char secondary_info[4]; | |
| 294 } SHardwareData; | |
| 295 | |
| 296 uint8_t writeData(uint8_t *); | |
| 297 uint8_t readData(uint8_t what,uint8_t *); | |
| 298 uint8_t readDataLimits__8and16BitValues_4and7BytesOutput(uint8_t what, uint8_t * data); | |
| 299 | |
| 300 uint8_t getPPO2Max(void); | |
| 301 uint8_t getPPO2Min(void); | |
| 302 uint8_t getDiveMode(void); | |
| 303 uint8_t getCCRMode(void); | |
| 304 uint8_t getDecoType(void); | |
| 305 uint8_t getFutureTTS(void); | |
| 306 | |
| 307 SSettings* settingsGetPointer(void); | |
| 308 const SSettings* settingsGetPointerStandard(void); | |
| 309 void set_settings_to_Standard(void); | |
| 310 void mod_settings_for_first_start_with_empty_ext_flash(void); | |
| 311 const SFirmwareData* firmwareDataGetPointer(void); | |
| 312 const SHardwareData* hardwareDataGetPointer(void); | |
| 313 uint8_t firmwareVersion_16bit_high(void); | |
| 314 uint8_t firmwareVersion_16bit_low(void); | |
| 315 void hardwareBatchCode(uint8_t *high, uint8_t *low); | |
| 316 | |
| 317 uint8_t RTEminimum_required_high(void); | |
| 318 uint8_t RTEminimum_required_low(void); | |
| 319 uint8_t FONTminimum_required_high(void); | |
| 320 uint8_t FONTminimum_required_low(void); | |
| 321 | |
| 322 void setActualRTEversion(uint8_t high, uint8_t low); | |
| 323 void getActualRTEandFONTversion(uint8_t *RTEhigh, uint8_t *RTElow, uint8_t *FONThigh, uint8_t *FONTlow); | |
| 324 | |
| 325 void set_new_settings_missing_in_ext_flash(void); | |
| 326 uint8_t check_and_correct_settings(void); | |
| 327 uint8_t newFirmwareVersionCheckViaSettings(void); | |
| 328 void set_settings_button_to_standard_with_individual_buttonBalance(void); | |
| 329 uint8_t getLicence(void); | |
| 330 void firmwareGetDate(RTC_DateTypeDef *SdateOutput); | |
| 331 | |
| 332 void settingsHelperButtonSens_original_translate_to_hwOS_values(const uint32_t inputValueRaw, uint8_t *outArray4Values); | |
| 333 | |
| 334 uint8_t buttonBalanceTranslatorHexToArray(uint8_t hexValue, uint8_t* outputArray); | |
| 335 uint8_t buttonBalanceTranslateArrayOutHex(const uint8_t* inputArray); | |
| 336 void getButtonFactorDefaults(uint8_t* basePercentage, uint8_t* buttonBalanceArray); | |
| 337 void settingsWriteFactoryDefaults(uint8_t inputValueRaw, uint8_t *inputBalanceArray); | |
| 338 | |
| 339 void settingsHelperButtonSens_keepPercentageValues(uint32_t inputValueRaw, uint8_t *outArray4Values); | |
| 340 uint8_t settingsHelperButtonSens_translate_percentage_to_hwOS_values(uint8_t inputValuePercentage); | |
| 341 uint8_t settingsHelperButtonSens_translate_hwOS_values_to_percentage(uint8_t inputValuePIC); | |
| 342 | |
| 343 #endif // SETTINGS_H |