diff Common/Inc/settings.h @ 38:5f11787b4f42

include in ostc4 repository
author heinrichsweikamp
date Sat, 28 Apr 2018 11:52:34 +0200
parents
children be35821a4974 fdf0272e9213
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Common/Inc/settings.h	Sat Apr 28 11:52:34 2018 +0200
@@ -0,0 +1,294 @@
+///////////////////////////////////////////////////////////////////////////////
+/// -*- coding: UTF-8 -*-
+///
+/// \file   Common/Inc/settings.h
+/// \brief
+/// \author Heinrichs Weikamp
+/// \date   2018
+///
+/// $Id$
+///////////////////////////////////////////////////////////////////////////////
+/// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
+///
+///     This program is free software: you can redistribute it and/or modify
+///     it under the terms of the GNU General Public License as published by
+///     the Free Software Foundation, either version 3 of the License, or
+///     (at your option) any later version.
+///
+///     This program is distributed in the hope that it will be useful,
+///     but WITHOUT ANY WARRANTY; without even the implied warranty of
+///     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+///     GNU General Public License for more details.
+///
+///     You should have received a copy of the GNU General Public License
+///     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//////////////////////////////////////////////////////////////////////////////
+
+#ifndef SETTINGS_H
+#define SETTINGS_H
+
+// From Common/Inc:
+#include "FirmwareData.h"
+
+//#include "data_central.h"
+
+// From Common/Drivers/
+#include "stm32f4xx_hal.h"
+
+#include <stdint.h>
+
+#define NUM_GASES 5
+#define NUM_OFFSET_DILUENT 5
+#define SPECIAL_GAS_ID 0
+
+#define ERROR_ 0xFF
+
+#define CCRMODE_FixedSetpoint 0
+#define CCRMODE_Sensors 1
+
+#define DIVEMODE_OC 0
+#define DIVEMODE_CCR 1
+#define DIVEMODE_Gauge 2
+#define DIVEMODE_Apnea 3
+
+#define GF_MODE 1
+#define VPM_MODE 2
+
+#define VPM_FROM_FORTRAN 0
+#define VPM_BACHELORWORK 1
+
+#define BUEHLMANN_OSTC4	0
+#define BUEHLMANN_hwOS	1
+
+#define MMDDYY 0
+#define DDMMYY 1
+#define YYMMDD 2
+
+#define LICENCEBONEX 0xFE
+
+
+/*	2015 Jan 30, hw, deco and travel added for MenuEditGas
+	* can be used for buehlmann, vpm, etc. later but be carefull
+	*	with current implemenation */
+typedef struct{
+uint8_t active:1;
+uint8_t first:1;
+uint8_t deco:1;
+uint8_t travel:1;
+uint8_t senderCode:4;
+} gasubit8_t;
+
+typedef union{
+gasubit8_t ub;
+uint8_t uw;
+} gasbit8_Type;
+
+typedef struct{
+uint8_t standard:4;
+uint8_t alternative:4;
+} ubit2x4_t;
+
+typedef union{
+ubit2x4_t ub;
+uint8_t uw;
+} split2x4_Type;
+
+typedef union{
+uint8_t u8[4];
+uint32_t u32;
+} general32to8_Type;
+
+typedef struct
+{
+	uint8_t oxygen_percentage;
+	uint8_t helium_percentage;
+	gasbit8_Type note;
+	uint8_t depth_meter;
+	uint8_t depth_meter_travel;
+	uint8_t bottle_size_liter;
+//	uint8_t bottle_wireless_status;
+	uint16_t bottle_wireless_id;
+} SGasLine;
+
+typedef struct
+{
+	uint8_t setpoint_cbar;
+	uint8_t depth_meter;
+	gasbit8_Type note;
+} SSetpointLine;
+
+/* SSettings
+	 * gas[0] and setpoint[0] are the special ones configurable during the dive
+	 */
+typedef struct
+{
+	uint32_t header;
+	uint8_t warning_blink_dsec;
+	uint8_t lastDiveLogId;
+	uint32_t logFlashNextSampleStartAddress;
+	SGasLine gas[1 + (2*NUM_GASES)];
+	SSetpointLine setpoint[1 + NUM_GASES];
+	uint8_t CCR_Mode;
+	uint8_t dive_mode;
+	split2x4_Type deco_type;
+	uint8_t ppO2_max_deco;
+	uint8_t ppO2_max_std;
+	uint8_t ppO2_min;
+	uint8_t CNS_max;
+	uint8_t ascent_MeterPerMinute_max;
+	uint8_t ascent_MeterPerMinute_showGraph;
+	uint8_t future_TTS;
+	uint8_t GF_high;
+	uint8_t GF_low;
+	uint8_t aGF_high;
+	uint8_t aGF_low;
+	split2x4_Type VPM_conservatism;
+	uint8_t safetystopDuration;
+	uint8_t AtemMinutenVolumenLiter;
+	uint8_t ReserveFractionDenominator;
+	uint8_t salinity;
+	uint8_t last_stop_depth_meter;
+	uint8_t stop_increment_depth_meter;
+	uint8_t brightness;
+	uint8_t date_format;
+	uint8_t selected_language;
+	char customtext[60];
+	uint16_t timeoutSurfacemode;
+	uint8_t timeoutMenuSurface;
+	uint8_t timeoutMenuDive;
+	uint8_t timeoutMenuEdit;
+	uint8_t timeoutInfo;
+	uint8_t timeoutInfoCompass;
+	uint8_t design;
+	uint16_t timeoutDiveReachedZeroDepth;
+	uint16_t divetimeToCreateLogbook;
+	uint8_t  serialHigh;
+	uint8_t  serialLow;
+//	SUFirmware  firmwareVersion16to32bit;
+	uint32_t backup_localtime_rtc_tr;
+	uint32_t backup_localtime_rtc_dr;
+	uint16_t totalDiveCounter;
+	uint16_t	personalDiveCount;
+	uint8_t showDebugInfo;
+	uint8_t ButtonResponsiveness[4];// changed content in 0xFFFF0016
+	uint8_t nonMetricalSystem;
+	uint8_t fallbackToFixedSetpoint;
+	uint8_t bluetoothActive; /* will be set to zero on each startup at the moment */
+	uint8_t safetystopDepth;
+	uint32_t updateSettingsAllowedFromHeader;
+	uint8_t scooterControl;
+	uint8_t scooterDrag;
+	uint8_t scooterLoad;
+	uint8_t scooterNumberOfBatteries;
+	uint16_t scooterBattSize;
+	uint8_t scooterSPARE1[7];
+	uint8_t scooterSPARE2[19];
+	// new in 0xFFFF0006
+	uint8_t ppo2sensors_deactivated;
+	uint8_t tX_colorscheme;
+	uint8_t tX_userselectedLeftLowerCornerPrimary;
+	uint8_t tX_userselectedLeftLowerCornerTimeout;
+	uint8_t tX_customViewPrimary;
+	uint8_t tX_customViewTimeout;
+	uint8_t timeoutEnterButtonSelectDive;
+	uint16_t logbookOffset;
+	uint8_t alwaysShowPPO2;
+	uint8_t extraDisplay;
+	uint16_t display_toogle_desc;
+	int8_t offsetPressure_mbar;
+	int8_t offsetTemperature_centigrad;
+	uint8_t gasConsumption_travel_l_min;
+	uint8_t gasConsumption_bottom_l_min;
+	uint8_t gasConsumption_deco_l_min;
+	uint8_t debugModeOnStart;
+	uint8_t IAmStolenPleaseKillMe;
+	int16_t compassBearing;
+	uint8_t lastKnownBatteryPercentage;
+	uint8_t buttonBalance[3]; // 0 = right, 1 = center, 2 = left
+	uint8_t firmwareVersion[4];
+	uint16_t timeoutSurfacemodeWithSensors;
+	// new in 0xFFFF0016
+	uint8_t VPM_model;
+	uint8_t	GF_model;
+	// new in 0xFFFF0017
+	uint8_t FactoryButtonBase;
+	uint8_t FactoryButtonBalance[3];
+
+//to be continued
+} SSettings;
+
+typedef struct
+{
+	// 8 bytes
+	uint16_t primarySerial;
+	uint8_t primaryLicence;
+	uint8_t revision8bit;
+	uint8_t production_year;
+	uint8_t production_month;
+	uint8_t production_day;
+	uint8_t production_bluetooth_name_set;
+
+	// 44 bytes
+	char production_info[44];
+
+	// 8 bytes
+	uint16_t secondarySerial;
+	uint8_t secondaryLicence;
+	uint8_t secondaryReason8bit;
+	uint8_t secondary_year;
+	uint8_t secondary_month;
+	uint8_t secondary_day;
+	uint8_t secondary_bluetooth_name_set;
+
+	// 4 bytes
+	char secondary_info[4];
+} SHardwareData;
+
+uint8_t writeData(uint8_t *);
+uint8_t readData(uint8_t what,uint8_t *);
+uint8_t readDataLimits__8and16BitValues_4and7BytesOutput(uint8_t what, uint8_t * data);
+
+uint8_t getPPO2Max(void);
+uint8_t getPPO2Min(void);
+uint8_t getDiveMode(void);
+uint8_t getCCRMode(void);
+uint8_t getDecoType(void);
+uint8_t getFutureTTS(void);
+
+SSettings* settingsGetPointer(void);
+const SSettings* settingsGetPointerStandard(void);
+void set_settings_to_Standard(void);
+void mod_settings_for_first_start_with_empty_ext_flash(void);
+const SFirmwareData* firmwareDataGetPointer(void);
+const SHardwareData* hardwareDataGetPointer(void);
+uint8_t firmwareVersion_16bit_high(void);
+uint8_t firmwareVersion_16bit_low(void);
+void hardwareBatchCode(uint8_t *high, uint8_t *low);
+
+uint8_t RTEminimum_required_high(void);
+uint8_t RTEminimum_required_low(void);
+uint8_t FONTminimum_required_high(void);
+uint8_t FONTminimum_required_low(void);
+
+void setActualRTEversion(uint8_t high, uint8_t low);
+void getActualRTEandFONTversion(uint8_t *RTEhigh, uint8_t *RTElow, uint8_t *FONThigh, uint8_t *FONTlow);
+
+void set_new_settings_missing_in_ext_flash(void);
+uint8_t check_and_correct_settings(void);
+uint8_t newFirmwareVersionCheckViaSettings(void);
+void set_settings_button_to_standard_with_individual_buttonBalance(void);
+uint8_t getLicence(void);
+void firmwareGetDate(RTC_DateTypeDef *SdateOutput);
+
+void settingsHelperButtonSens_original_translate_to_hwOS_values(const uint32_t inputValueRaw, uint8_t *outArray4Values);
+
+uint8_t buttonBalanceTranslatorHexToArray(uint8_t hexValue, uint8_t* outputArray);
+uint8_t buttonBalanceTranslateArrayOutHex(const uint8_t* inputArray);
+void getButtonFactorDefaults(uint8_t* basePercentage, uint8_t* buttonBalanceArray);
+void settingsWriteFactoryDefaults(uint8_t inputValueRaw, uint8_t *inputBalanceArray);
+
+void settingsHelperButtonSens_keepPercentageValues(uint32_t inputValueRaw, uint8_t *outArray4Values);
+uint8_t settingsHelperButtonSens_translate_percentage_to_hwOS_values(uint8_t inputValuePercentage);
+uint8_t settingsHelperButtonSens_translate_hwOS_values_to_percentage(uint8_t inputValuePIC);
+
+#endif // SETTINGS_H