Mercurial > public > ostc4
annotate Common/Inc/settings.h @ 699:01f40cb1057e
Cleanup warnings:
The code still contained several warnings which have now been resolved. Big thank you to Thomas :-)
author | Ideenmodellierer |
---|---|
date | Tue, 18 Oct 2022 20:56:19 +0200 |
parents | 52d68cf9994c |
children | 6d7c812fc173 |
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 | |
691 | 39 #include "configuration.h" |
40 | |
38 | 41 #include <stdint.h> |
42 | |
92
be35821a4974
Stable to test. button sensitiveness fix. + global_constants.
Dmitry Romanov <kitt@bk.ru>
parents:
38
diff
changeset
|
43 |
38 | 44 #define NUM_GASES 5 |
45 #define NUM_OFFSET_DILUENT 5 | |
46 #define SPECIAL_GAS_ID 0 | |
47 | |
48 #define ERROR_ 0xFF | |
49 | |
50 #define CCRMODE_FixedSetpoint 0 | |
51 #define CCRMODE_Sensors 1 | |
662 | 52 #define CCRMODE_Simulation 2 |
38 | 53 |
54 #define DIVEMODE_OC 0 | |
55 #define DIVEMODE_CCR 1 | |
56 #define DIVEMODE_Gauge 2 | |
57 #define DIVEMODE_Apnea 3 | |
662 | 58 #define DIVEMODE_PSCR 4 |
38 | 59 |
60 #define GF_MODE 1 | |
61 #define VPM_MODE 2 | |
62 | |
63 #define VPM_FROM_FORTRAN 0 | |
64 #define VPM_BACHELORWORK 1 | |
65 | |
66 #define BUEHLMANN_OSTC4 0 | |
67 #define BUEHLMANN_hwOS 1 | |
68 | |
69 #define MMDDYY 0 | |
70 #define DDMMYY 1 | |
71 #define YYMMDD 2 | |
72 | |
337
38367bb982b8
Set Max value for pressure offset to 50mBar (20mBar before)
ideenmodellierer
parents:
210
diff
changeset
|
73 #define PRESSURE_OFFSET_LIMIT_MBAR 50 |
38367bb982b8
Set Max value for pressure offset to 50mBar (20mBar before)
ideenmodellierer
parents:
210
diff
changeset
|
74 |
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
75 #define MAX_COMPASS_COMP (2u) |
640 | 76 #define MAX_VIEWPORT_MODE (0x7F) |
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
77 |
676 | 78 #define MAX_SCRUBBER_TIME (999u) |
652 | 79 #define MIN_PPO2_SP_CBAR (40u) |
650 | 80 |
662 | 81 #define PSCR_MAX_O2_DROP (15u) |
82 #define PSCR_MIN_LUNG_RATIO (5u) | |
83 #define PSCR_MAX_LUNG_RATIO (20u) | |
84 | |
691 | 85 #define UART_MAX_PROTOCOL (2u) |
86 | |
87 #define FUTURE_SPARE_SIZE (28u) /* Applied for reuse of old, not used, scooter block (was 32 bytes)*/ | |
662 | 88 |
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
89 typedef enum |
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
90 { |
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
91 O2_SENSOR_SOURCE_OPTIC = 0, |
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
92 O2_SENSOR_SOURCE_ANALOG, |
691 | 93 #ifdef ENABLE_SENTINEL_MODE |
94 O2_SENSOR_SOURCE_SENTINEL, | |
95 #endif | |
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
96 O2_SENSOR_SOURCE_MAX |
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
97 } SensorSource; |
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
98 #define MAX_O2_SENSOR_SOURCE (2u) |
546 | 99 |
654
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
100 typedef enum |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
101 { |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
102 SCRUB_TIMER_OFF = 0, |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
103 SCRUB_TIMER_MINUTES, |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
104 SCRUB_TIMER_PERCENT, |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
105 SCRUB_TIMER_END |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
106 } ScrubTimerMode_e; |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
107 |
38 | 108 /* 2015 Jan 30, hw, deco and travel added for MenuEditGas |
109 * can be used for buehlmann, vpm, etc. later but be carefull | |
110 * with current implemenation */ | |
111 typedef struct{ | |
112 uint8_t active:1; | |
113 uint8_t first:1; | |
114 uint8_t deco:1; | |
115 uint8_t travel:1; | |
526
88c626d01ee5
Added new option to gas configuration: "Off":
Ideenmodellierer
parents:
505
diff
changeset
|
116 uint8_t off:1; |
88c626d01ee5
Added new option to gas configuration: "Off":
Ideenmodellierer
parents:
505
diff
changeset
|
117 uint8_t spare:3; |
38 | 118 } gasubit8_t; |
119 | |
120 typedef union{ | |
121 gasubit8_t ub; | |
122 uint8_t uw; | |
123 } gasbit8_Type; | |
124 | |
125 typedef struct{ | |
126 uint8_t standard:4; | |
127 uint8_t alternative:4; | |
128 } ubit2x4_t; | |
129 | |
130 typedef union{ | |
131 ubit2x4_t ub; | |
132 uint8_t uw; | |
133 } split2x4_Type; | |
134 | |
135 typedef union{ | |
136 uint8_t u8[4]; | |
137 uint32_t u32; | |
138 } general32to8_Type; | |
139 | |
140 typedef struct | |
141 { | |
142 uint8_t oxygen_percentage; | |
143 uint8_t helium_percentage; | |
144 gasbit8_Type note; | |
145 uint8_t depth_meter; | |
146 uint8_t depth_meter_travel; | |
147 uint8_t bottle_size_liter; | |
148 // uint8_t bottle_wireless_status; | |
149 uint16_t bottle_wireless_id; | |
150 } SGasLine; | |
151 | |
152 typedef struct | |
153 { | |
154 uint8_t setpoint_cbar; | |
155 uint8_t depth_meter; | |
156 gasbit8_Type note; | |
157 } SSetpointLine; | |
158 | |
654
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
159 |
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
160 |
38 | 161 /* SSettings |
162 * gas[0] and setpoint[0] are the special ones configurable during the dive | |
163 */ | |
164 typedef struct | |
165 { | |
166 uint32_t header; | |
167 uint8_t warning_blink_dsec; | |
168 uint8_t lastDiveLogId; | |
169 uint32_t logFlashNextSampleStartAddress; | |
170 SGasLine gas[1 + (2*NUM_GASES)]; | |
171 SSetpointLine setpoint[1 + NUM_GASES]; | |
172 uint8_t CCR_Mode; | |
173 uint8_t dive_mode; | |
174 split2x4_Type deco_type; | |
175 uint8_t ppO2_max_deco; | |
176 uint8_t ppO2_max_std; | |
177 uint8_t ppO2_min; | |
178 uint8_t CNS_max; | |
179 uint8_t ascent_MeterPerMinute_max; | |
180 uint8_t ascent_MeterPerMinute_showGraph; | |
181 uint8_t future_TTS; | |
182 uint8_t GF_high; | |
183 uint8_t GF_low; | |
184 uint8_t aGF_high; | |
185 uint8_t aGF_low; | |
186 split2x4_Type VPM_conservatism; | |
187 uint8_t safetystopDuration; | |
188 uint8_t AtemMinutenVolumenLiter; | |
189 uint8_t ReserveFractionDenominator; | |
190 uint8_t salinity; | |
191 uint8_t last_stop_depth_meter; | |
192 uint8_t stop_increment_depth_meter; | |
193 uint8_t brightness; | |
194 uint8_t date_format; | |
195 uint8_t selected_language; | |
196 char customtext[60]; | |
197 uint16_t timeoutSurfacemode; | |
198 uint8_t timeoutMenuSurface; | |
199 uint8_t timeoutMenuDive; | |
200 uint8_t timeoutMenuEdit; | |
201 uint8_t timeoutInfo; | |
202 uint8_t timeoutInfoCompass; | |
203 uint8_t design; | |
204 uint16_t timeoutDiveReachedZeroDepth; | |
205 uint16_t divetimeToCreateLogbook; | |
206 uint8_t serialHigh; | |
207 uint8_t serialLow; | |
208 // SUFirmware firmwareVersion16to32bit; | |
209 uint32_t backup_localtime_rtc_tr; | |
210 uint32_t backup_localtime_rtc_dr; | |
211 uint16_t totalDiveCounter; | |
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
212 uint16_t personalDiveCount; |
38 | 213 uint8_t showDebugInfo; |
214 uint8_t ButtonResponsiveness[4];// changed content in 0xFFFF0016 | |
215 uint8_t nonMetricalSystem; | |
216 uint8_t fallbackToFixedSetpoint; | |
217 uint8_t bluetoothActive; /* will be set to zero on each startup at the moment */ | |
218 uint8_t safetystopDepth; | |
219 uint32_t updateSettingsAllowedFromHeader; | |
662 | 220 uint8_t pscr_lung_ratio; /* redefined in 0xFFFF0020 */ |
221 uint8_t pscr_o2_drop; /* redefined in 0xFFFF0020 */ | |
222 uint8_t co2_sensor_active; /* redefined in 0xFFFF0021 */ | |
691 | 223 uint8_t ext_uart_protocol; /* redefined in 0xFFFF0022 */ |
662 | 224 uint8_t Future_SPARE[FUTURE_SPARE_SIZE]; /* redefined in 0xFFFF0020 (old scooter Block was 32 byte)*/ |
38 | 225 // new in 0xFFFF0006 |
226 uint8_t ppo2sensors_deactivated; | |
227 uint8_t tX_colorscheme; | |
228 uint8_t tX_userselectedLeftLowerCornerPrimary; | |
229 uint8_t tX_userselectedLeftLowerCornerTimeout; | |
230 uint8_t tX_customViewPrimary; | |
231 uint8_t tX_customViewTimeout; | |
232 uint8_t timeoutEnterButtonSelectDive; | |
233 uint16_t logbookOffset; | |
234 uint8_t alwaysShowPPO2; | |
235 uint8_t extraDisplay; | |
236 uint16_t display_toogle_desc; | |
237 int8_t offsetPressure_mbar; | |
238 int8_t offsetTemperature_centigrad; | |
239 uint8_t gasConsumption_travel_l_min; | |
240 uint8_t gasConsumption_bottom_l_min; | |
241 uint8_t gasConsumption_deco_l_min; | |
242 uint8_t debugModeOnStart; | |
243 uint8_t IAmStolenPleaseKillMe; | |
244 int16_t compassBearing; | |
245 uint8_t lastKnownBatteryPercentage; | |
246 uint8_t buttonBalance[3]; // 0 = right, 1 = center, 2 = left | |
247 uint8_t firmwareVersion[4]; | |
248 uint16_t timeoutSurfacemodeWithSensors; | |
249 // new in 0xFFFF0016 | |
250 uint8_t VPM_model; | |
251 uint8_t GF_model; | |
252 // new in 0xFFFF0017 | |
253 uint8_t FactoryButtonBase; | |
254 uint8_t FactoryButtonBalance[3]; | |
112
fdf0272e9213
Added new nvm parameter"FlipDisplay" indicating the screen orientation
Ideenmodellierer
parents:
38
diff
changeset
|
255 /* new in 0xFFFF0018 */ |
fdf0272e9213
Added new nvm parameter"FlipDisplay" indicating the screen orientation
Ideenmodellierer
parents:
38
diff
changeset
|
256 uint8_t FlipDisplay; |
210
b2a9e9b02df0
New feature: make selected customviews persistent
Jan Mulder <jlmulder@xs4all.nl>
parents:
138
diff
changeset
|
257 /* new in 0xFFFF0019 */ |
b2a9e9b02df0
New feature: make selected customviews persistent
Jan Mulder <jlmulder@xs4all.nl>
parents:
138
diff
changeset
|
258 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
|
259 /* 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
|
260 uint8_t MotionDetection; |
498
4811f3dfaa52
Added dew parameter to enable selection of customer BigFont screens to be displayed
Ideenmodellierer
parents:
372
diff
changeset
|
261 /* new in 0xFFFF001B */ |
4811f3dfaa52
Added dew parameter to enable selection of customer BigFont screens to be displayed
Ideenmodellierer
parents:
372
diff
changeset
|
262 uint32_t cv_config_BigScreen; |
539
d784f281833a
Added inertia simulation for compass heading:
Ideenmodellierer
parents:
526
diff
changeset
|
263 /* new in 0xFFFF001C */ |
d784f281833a
Added inertia simulation for compass heading:
Ideenmodellierer
parents:
526
diff
changeset
|
264 uint8_t compassInertia; |
542
6960df7ddb09
Added new t3 view showing first deco stop and tts in parallel:
Ideenmodellierer
parents:
539
diff
changeset
|
265 uint8_t tX_customViewPrimaryBF; |
546 | 266 /* new in 0xFFFF001D */ |
626
3e1a0e267f38
Added option to select sensitivity of focus detection:
Ideenmodellierer
parents:
567
diff
changeset
|
267 uint8_t viewPortMode; /* 7-Reserve| 6..5 - Focus spot size | 4-Focusframe | 3-Reserve | 2..0-BacklightBoost */ |
546 | 268 uint16_t viewRoll; |
269 uint16_t viewPitch; | |
270 uint16_t viewYaw; | |
560
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
271 /* new in 0xFFFF001E */ |
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
272 uint8_t ppo2sensors_source; |
5d80bb8d22cb
Added O2 sensor source and calibration parameters to setting structure
Ideenmodellierer
parents:
550
diff
changeset
|
273 float ppo2sensors_calibCoeff[3]; |
567 | 274 uint8_t amPMTime; |
650 | 275 /* new in 0xFFFF001F */ |
276 uint8_t autoSetpoint; | |
277 uint16_t scrubTimerMax; | |
278 uint16_t scrubTimerCur; | |
654
890440ab993a
Introduced new menu tab for addition CCR options:
Ideenmodellierer
parents:
652
diff
changeset
|
279 uint8_t scrubTimerMode; |
38 | 280 } SSettings; |
281 | |
282 typedef struct | |
283 { | |
284 // 8 bytes | |
285 uint16_t primarySerial; | |
286 uint8_t primaryLicence; | |
287 uint8_t revision8bit; | |
288 uint8_t production_year; | |
289 uint8_t production_month; | |
290 uint8_t production_day; | |
291 uint8_t production_bluetooth_name_set; | |
292 | |
293 // 44 bytes | |
294 char production_info[44]; | |
295 | |
296 // 8 bytes | |
297 uint16_t secondarySerial; | |
298 uint8_t secondaryLicence; | |
299 uint8_t secondaryReason8bit; | |
300 uint8_t secondary_year; | |
301 uint8_t secondary_month; | |
302 uint8_t secondary_day; | |
303 uint8_t secondary_bluetooth_name_set; | |
304 | |
305 // 4 bytes | |
306 char secondary_info[4]; | |
307 } SHardwareData; | |
308 | |
309 uint8_t writeData(uint8_t *); | |
310 uint8_t readData(uint8_t what,uint8_t *); | |
311 uint8_t readDataLimits__8and16BitValues_4and7BytesOutput(uint8_t what, uint8_t * data); | |
312 | |
313 uint8_t getPPO2Max(void); | |
314 uint8_t getPPO2Min(void); | |
315 uint8_t getDiveMode(void); | |
316 uint8_t getCCRMode(void); | |
317 uint8_t getDecoType(void); | |
318 uint8_t getFutureTTS(void); | |
319 | |
320 SSettings* settingsGetPointer(void); | |
321 const SSettings* settingsGetPointerStandard(void); | |
322 void set_settings_to_Standard(void); | |
323 void mod_settings_for_first_start_with_empty_ext_flash(void); | |
324 const SFirmwareData* firmwareDataGetPointer(void); | |
325 const SHardwareData* hardwareDataGetPointer(void); | |
326 uint8_t firmwareVersion_16bit_high(void); | |
327 uint8_t firmwareVersion_16bit_low(void); | |
328 void hardwareBatchCode(uint8_t *high, uint8_t *low); | |
329 | |
330 uint8_t RTEminimum_required_high(void); | |
331 uint8_t RTEminimum_required_low(void); | |
332 uint8_t FONTminimum_required_high(void); | |
333 uint8_t FONTminimum_required_low(void); | |
334 | |
335 void setActualRTEversion(uint8_t high, uint8_t low); | |
336 void getActualRTEandFONTversion(uint8_t *RTEhigh, uint8_t *RTElow, uint8_t *FONThigh, uint8_t *FONTlow); | |
337 | |
338 void set_new_settings_missing_in_ext_flash(void); | |
339 uint8_t check_and_correct_settings(void); | |
340 uint8_t newFirmwareVersionCheckViaSettings(void); | |
341 void set_settings_button_to_standard_with_individual_buttonBalance(void); | |
342 uint8_t getLicence(void); | |
343 void firmwareGetDate(RTC_DateTypeDef *SdateOutput); | |
344 | |
345 void settingsHelperButtonSens_original_translate_to_hwOS_values(const uint32_t inputValueRaw, uint8_t *outArray4Values); | |
346 | |
347 uint8_t buttonBalanceTranslatorHexToArray(uint8_t hexValue, uint8_t* outputArray); | |
348 uint8_t buttonBalanceTranslateArrayOutHex(const uint8_t* inputArray); | |
349 void getButtonFactorDefaults(uint8_t* basePercentage, uint8_t* buttonBalanceArray); | |
350 void settingsWriteFactoryDefaults(uint8_t inputValueRaw, uint8_t *inputBalanceArray); | |
351 | |
352 void settingsHelperButtonSens_keepPercentageValues(uint32_t inputValueRaw, uint8_t *outArray4Values); | |
353 uint8_t settingsHelperButtonSens_translate_percentage_to_hwOS_values(uint8_t inputValuePercentage); | |
354 uint8_t settingsHelperButtonSens_translate_hwOS_values_to_percentage(uint8_t inputValuePIC); | |
355 | |
662 | 356 void reset_SettingWarning(); |
357 uint8_t isSettingsWarning(); | |
358 | |
38 | 359 #endif // SETTINGS_H |