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