Mercurial > public > ostc4
annotate Common/Inc/data_exchange.h @ 839:061174d88af9 Evo_2_23
Code cleanup: UART protocol definitions
In the first external interface implementation the discovery part took care for the uart protocol selection. Since the introduction of the automatic detection the protocol handling has been moved into the RTE. However the definitions were still in the in the exchange header (Discovery <=> RTE). To avoid confusions the definitions have been moved into RTE scope only.
| author | Ideenmodellierer |
|---|---|
| date | Sun, 07 Jan 2024 21:20:15 +0100 |
| parents | aa6006975e76 |
| children |
| rev | line source |
|---|---|
| 38 | 1 /////////////////////////////////////////////////////////////////////////////// |
| 2 /// -*- coding: UTF-8 -*- | |
| 3 /// | |
| 4 /// \file Common/Inc/data_exchange.h | |
| 5 /// \brief Data exchange between RTE and Discovery processors. | |
| 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 DATA_EXCHANGE_H | |
| 28 #define DATA_EXCHANGE_H | |
| 29 | |
| 30 #include "data_central.h" | |
| 31 #include "settings.h" | |
| 32 #include "stm32f4xx_hal.h" | |
| 33 | |
| 691 | 34 /* Command definitions for control of external interface */ |
| 35 /* 1st nibble binary on/off states */ | |
| 36 /* 2nd nibble UART protocol selection */ | |
| 37 /* 3rd nibble reserve */ | |
| 38 /* 4th nibble command channel */ | |
| 39 #define EXT_INTERFACE_33V_ON (0x8000u) /* Bit set to enable 3.3V power interface */ | |
| 40 #define EXT_INTERFACE_ADC_ON (0x4000u) /* Bit set to enable ADC conversion */ | |
|
702
6d7c812fc173
Added digital o2 sensor to settings and data exchange:
Ideenmodellierer
parents:
691
diff
changeset
|
41 |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
42 /* Command subset */ |
|
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
43 #define EXT_INTERFACE_AUTODETECT (0x0001u) /* Start auto detection of connected sensors */ |
|
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
44 #define EXT_INTERFACE_COPY_SENSORMAP (0x0002u) /* Use the sensor map provided by master for internal operations */ |
|
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
45 #define EXT_INTERFACE_CO2_CALIB (0x0010u) /* Request calibration of CO2Sensor */ |
|
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
46 #define EXT_INTERFACE_O2_INDICATE (0x0020u) /* Request LED to blink*/ |
|
702
6d7c812fc173
Added digital o2 sensor to settings and data exchange:
Ideenmodellierer
parents:
691
diff
changeset
|
47 |
| 691 | 48 #define DATA_BUFFER_ADC (0x01u) |
| 49 #define DATA_BUFFER_CO2 (0x02u) | |
| 662 | 50 |
|
714
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
51 #define EXTIF_SENSOR_INFO_SIZE (32u) /* size of data array reserved for extended sensor data from external interface */ |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
52 |
| 756 | 53 #define CO2_WARNING_LEVEL_PPM (2000u) /* Early warning to indicate unexpected high co2 concentration (yellow) */ |
| 54 #define CO2_ALARM_LEVEL_PPM (5000u) /* starting by this level CO2 has a negative impact on health (long exposure) */ | |
| 55 | |
| 38 | 56 enum MODE |
| 57 { | |
| 58 MODE_SURFACE = 0, | |
| 59 MODE_DIVE = 1, | |
| 60 MODE_CALIB = 2, | |
| 61 MODE_SLEEP = 3, | |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
62 MODE_SHUTDOWN = 4, |
| 38 | 63 MODE_ENDDIVE = 5, |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
64 MODE_BOOT = 6, |
| 38 | 65 MODE_CHARGESTART = 7, |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
66 MODE_TEST = 8, |
| 38 | 67 MODE_POWERUP = 9, |
| 68 }; | |
| 69 | |
| 70 enum ACCIDENT_BITS | |
| 71 { | |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
72 ACCIDENT_DECOSTOP = 0x01, |
|
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
73 ACCIDENT_CNS = 0x02, |
| 38 | 74 ACCIDENT_CNSLVL2 = 0x02 + 0x04, |
| 75 ACCIDENT_SPARE2 = 0x08, | |
| 76 ACCIDENT_SPARE3 = 0x10, | |
| 77 ACCIDENT_SPARE4 = 0x20, | |
| 78 ACCIDENT_SPARE5 = 0x40, | |
| 79 ACCIDENT_SPARE6 = 0x80 | |
| 80 }; | |
| 81 | |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
82 |
| 38 | 83 typedef struct{ |
| 84 uint8_t button:1; | |
| 85 uint8_t date:1; | |
| 86 uint8_t time:1; | |
| 87 uint8_t clearDeco:1; | |
| 88 uint8_t compass:1; | |
| 89 uint8_t devicedata:1; | |
| 90 uint8_t batterygauge:1; | |
| 91 uint8_t accident:1; | |
| 92 } confirmbit8_t; | |
| 93 | |
|
555
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
94 typedef struct{ |
| 559 | 95 uint8_t checkCompass:1; |
| 96 uint8_t checkADC:1; | |
| 97 uint8_t reserve:5; | |
|
555
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
98 uint8_t extADC:1; |
|
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
99 uint8_t compass:8; |
|
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
100 } hw_Info_t; |
|
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
101 |
|
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
102 |
| 38 | 103 #define CRBUTTON (0x01) |
| 104 #define CRDATE (0x02) | |
| 105 #define CRTIME (0x04) | |
| 662 | 106 #define CRCLEARDECO (0x08) |
| 107 #define CRCOMPASS (0x10) | |
| 108 #define CRDEVICEDATA (0x20) | |
| 109 #define CRBATTERY (0x40) | |
| 110 #define CRACCIDENT (0x80) | |
| 38 | 111 |
| 112 typedef union{ | |
| 113 confirmbit8_t ub; | |
| 114 uint8_t uw; | |
| 115 } confirmbit8_Type; | |
| 116 | |
| 117 typedef struct | |
| 118 { | |
| 119 uint8_t checkCode[4]; | |
| 120 | |
| 121 } SDataExchangeHeader; | |
| 122 | |
| 123 typedef struct | |
| 124 { | |
| 125 uint8_t checkCode[4]; | |
| 126 | |
| 127 } SDataExchangeFooter; | |
| 128 | |
| 129 typedef struct | |
| 130 { | |
| 131 SDataExchangeHeader header; | |
| 132 SLifeData lifeData; | |
| 133 } SDataExchangeMasterToSlave; | |
| 134 | |
| 135 typedef struct | |
| 136 { | |
|
714
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
137 int32_t temperature; |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
138 uint32_t status; |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
139 uint64_t sensorId; |
| 723 | 140 int32_t intensity; |
| 141 int32_t ambient; | |
| 142 int32_t pressure; | |
| 143 int32_t humidity; | |
|
714
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
144 } SSensorDataDiveO2; |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
145 |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
146 typedef struct |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
147 { |
| 38 | 148 //pressure |
| 149 float temperature; | |
| 150 float pressure_mbar; | |
| 151 float surface_mbar; | |
| 152 float ascent_rate_meter_per_min; | |
| 153 //toxic | |
| 154 float otu; | |
| 155 float cns; | |
| 156 uint16_t desaturation_time_minutes; | |
| 157 uint16_t no_fly_time_minutes; | |
| 158 //tisssue | |
| 159 float tissue_nitrogen_bar[16]; | |
| 160 float tissue_helium_bar[16]; | |
| 161 //maxcrushingpressure | |
| 162 float max_crushing_pressure_he[16]; | |
| 163 float max_crushing_pressure_n2[16]; | |
| 164 float adjusted_critical_radius_he[16]; | |
| 165 float adjusted_critical_radius_n2[16]; | |
| 166 // Compass | |
| 167 float compass_heading; | |
| 168 float compass_roll; | |
| 169 float compass_pitch; | |
| 170 int16_t compass_DX_f; | |
| 171 int16_t compass_DY_f; | |
| 172 int16_t compass_DZ_f; | |
| 173 //time | |
| 174 uint16_t counterSecondsShallowDepth; | |
| 175 uint32_t localtime_rtc_tr; | |
| 176 uint32_t localtime_rtc_dr; | |
| 177 uint32_t divetime_seconds; | |
| 178 uint32_t surfacetime_seconds; | |
| 179 uint32_t dive_time_seconds_without_surface_time; | |
| 180 //battery /* take care of uint8_t count to be in multiplies of 4 */ | |
| 181 float battery_voltage; | |
| 182 float battery_charge; | |
| 183 //ambient light | |
| 184 uint16_t ambient_light_level; | |
|
555
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
185 uint16_t SPARE_ALIGN32; |
|
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
186 float extADC_voltage[3]; |
| 662 | 187 uint16_t CO2_ppm; |
| 188 uint16_t CO2_signalStrength; | |
| 189 uint16_t externalInterface_CmdAnswer; | |
|
714
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
190 uint8_t alignmentdummy; |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
191 uint8_t externalInterface_SensorID; /* Used to identify how to read the sensor data array */ |
|
045ff7800501
Added customizable data area for specific sensor data:
Ideenmodellierer
parents:
702
diff
changeset
|
192 uint8_t sensor_data[EXTIF_SENSOR_INFO_SIZE]; /* sensor specific data array. Content may vary from sensor type to sensor type */ |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
193 uint8_t sensor_map[EXT_INTERFACE_SENSOR_CNT]; |
|
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
194 uint8_t SPARE_OldWireless[5]; /* 64 - 12 for extADC - 6 for CO2 - 34 for sensor (+dummmy) - sensor map*/ |
| 38 | 195 // PIC data |
|
763
aa6006975e76
increase HAL_Delay to 10ms for cold-start-button reset
heinrichsweikamp
parents:
756
diff
changeset
|
196 uint8_t button_setting[4]; /* see dependency to SlaveData->buttonPICdata */ |
| 38 | 197 uint8_t SPARE1; |
| 198 //debug | |
| 199 uint32_t pressure_uTick; | |
| 200 uint32_t compass_uTick; | |
| 201 | |
| 202 } SExchangeData; | |
| 203 | |
| 204 typedef struct | |
| 205 { | |
| 206 uint8_t VPMconservatism; | |
| 207 SGas actualGas; | |
| 208 | |
| 209 int8_t offsetPressureSensor_mbar; | |
| 210 int8_t offsetTemperatureSensor_centiDegree; | |
| 211 | |
| 662 | 212 uint16_t externalInterface_Cmd; |
| 38 | 213 |
|
728
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
214 uint8_t externalInterface_SensorMap[EXT_INTERFACE_SENSOR_CNT]; |
|
5143e927219f
Added sensor map to Firmware <=> RTE inferface:
Ideenmodellierer
parents:
723
diff
changeset
|
215 |
| 38 | 216 float UNUSED1[16-1];//VPM_adjusted_critical_radius_he[16]; |
| 217 float UNUSED2[16];//VPM_adjusted_critical_radius_n2[16]; | |
| 218 float UNUSED3[16];//VPM_adjusted_crushing_pressure_he[16]; | |
| 219 float UNUSED4[16];//VPM_adjusted_crushing_pressure_n2[16]; | |
| 220 float UNUSED5[16];//VPM_initial_allowable_gradient_he[16]; | |
| 221 float UNUSED6[16];//VPM_initial_allowable_gradient_n2[16]; | |
| 222 float UNUSED7[16];//VPM_max_actual_gradient[16]; | |
| 223 | |
| 224 RTC_TimeTypeDef newTime; | |
| 225 RTC_DateTypeDef newDate; | |
| 226 | |
| 227 float ambient_pressure_mbar_ceiling; | |
| 228 float descend_rate_bar_per_minute; | |
| 229 float ascend_rate_bar_per_minute; | |
| 230 | |
| 231 uint16_t timeoutDiveReachedZeroDepth; | |
| 232 uint16_t divetimeToCreateLogbook; | |
| 233 | |
| 234 uint8_t buttonResponsiveness[4]; | |
| 235 | |
| 236 SDevice DeviceData; | |
| 237 | |
| 238 float newBatteryGaugePercentageFloat; | |
| 239 | |
| 240 } SReceiveData; | |
| 241 | |
| 242 | |
| 243 typedef struct | |
| 244 { | |
| 245 SDataExchangeHeader header; | |
| 246 | |
| 247 uint8_t mode; | |
| 248 uint8_t power_on_reset; | |
| 249 uint8_t RTE_VERSION_high; | |
| 250 uint8_t RTE_VERSION_low; | |
| 251 | |
| 252 uint8_t chargeStatus; | |
| 253 uint8_t boolPICdata; | |
| 254 confirmbit8_Type confirmRequest; // confirmbit8_Type | |
| 691 | 255 uint8_t boolADCO2Data; |
| 38 | 256 |
| 257 uint8_t boolPressureData; | |
| 258 uint8_t boolCompassData; | |
| 259 uint8_t boolTisssueData; | |
| 260 uint8_t boolCrushingData; | |
| 261 | |
| 262 uint8_t boolToxicData; | |
| 263 uint8_t boolTimeData; | |
| 264 uint8_t boolBatteryData; | |
| 265 uint8_t boolAmbientLightData; | |
| 266 | |
| 267 uint8_t accidentFlags; | |
| 268 uint8_t sensorErrors; | |
| 269 uint8_t spare2; | |
| 270 uint8_t spare3; | |
| 271 | |
| 272 SExchangeData data[2]; | |
| 273 SDataExchangeFooter footer; | |
| 274 uint8_t CRC_feature_by_SPI[4]; | |
| 275 } SDataExchangeSlaveToMaster; | |
| 276 | |
| 277 | |
| 278 typedef struct | |
| 279 { | |
| 280 SDataExchangeHeader header; | |
| 281 | |
| 282 uint8_t mode; | |
| 283 uint8_t power_on_reset; | |
| 284 uint8_t RTE_VERSION_high; | |
| 285 uint8_t RTE_VERSION_low; | |
| 286 | |
| 287 uint8_t chargeStatus; | |
|
555
573a2bc796c8
Added HW_Info to Discovery <=> RTE data exchange:
Ideenmodellierer
parents:
51
diff
changeset
|
288 hw_Info_t hw_Info; |
| 38 | 289 uint8_t spare1; |
| 290 | |
| 291 uint8_t boolDeviceData; | |
| 292 uint8_t boolVpmRepetitiveDataValid; | |
| 293 uint8_t bool3; | |
| 294 uint8_t bool4; | |
| 295 | |
| 296 uint8_t spare1_1; | |
| 297 uint8_t spare1_2; | |
| 298 uint8_t spare1_3; | |
| 299 uint8_t spare1_4; | |
| 300 | |
| 301 uint8_t spare2_1; | |
| 302 uint8_t spare2_2; | |
| 303 uint8_t spare2_3; | |
| 304 uint8_t spare2_4; | |
| 305 | |
| 306 SDevice DeviceData[2]; | |
| 307 SVpmRepetitiveData VpmRepetitiveData; | |
| 308 | |
| 309 uint8_t arraySizeOfMinimumSExChangeDate[(2 * sizeof(SExchangeData)) - ((2 * sizeof(SDevice)) + sizeof(SVpmRepetitiveData))]; | |
| 310 SDataExchangeFooter footer; | |
| 311 uint8_t CRC_feature_by_SPI[4]; | |
| 312 } SDataExchangeSlaveToMasterDeviceData; | |
| 313 | |
| 314 | |
| 315 typedef struct | |
| 316 { | |
| 317 SDataExchangeHeader header; | |
| 318 | |
| 319 uint8_t mode; | |
| 320 uint8_t getDeviceDataNow; | |
| 321 uint8_t diveModeInfo; | |
| 322 uint8_t setEndDive; | |
| 323 | |
| 324 uint8_t bool4; | |
| 325 uint8_t setButtonSensitivityNow; | |
| 326 uint8_t setDateNow; | |
| 327 uint8_t setTimeNow; | |
| 328 | |
| 329 uint8_t calibrateCompassNow; | |
| 330 uint8_t clearDecoNow; | |
| 331 uint8_t setBatteryGaugeNow; | |
| 332 uint8_t bool9; | |
| 333 | |
| 334 uint8_t revisionHardware; | |
| 335 uint8_t revisionCRCx0x7A; | |
| 336 uint8_t spare1_3; | |
| 337 uint8_t spare1_4; | |
| 338 | |
| 339 uint8_t setAccidentFlag; | |
| 340 uint8_t spare2_1; | |
| 341 uint8_t spare2_2; | |
| 342 uint8_t spare2_3; | |
| 343 | |
| 344 SReceiveData data; | |
| 345 uint8_t arraySizeOfMinimumSExChangeDate[(2 * sizeof(SExchangeData)) - sizeof(SReceiveData)]; | |
| 346 SDataExchangeFooter footer; | |
| 347 uint8_t CRC_feature_by_SPI[4]; | |
| 348 } SDataReceiveFromMaster; | |
| 349 | |
| 350 | |
| 351 /* Size of Transmission buffer */ | |
| 352 #define EXCHANGE_BUFFERSIZE (sizeof(SDataExchangeSlaveToMaster) - 2) | |
| 353 #define EXCHANGE_BUFFERSIZE2 (sizeof(SDataReceiveFromMaster) - 2) | |
| 354 // header: 5 | |
| 355 // mode+bool: 5 | |
| 356 // data 552 ( 69 * float/4 * 2 ) | |
| 357 // footer: 4 | |
| 358 // ______________ | |
| 359 // SUM 566 | |
| 360 // CRC_feature does not count into BUFFERSIZE! | |
| 361 | |
| 362 //(COUNTOF(struct SDataExchangeSlaveToMaster) + 1) | |
| 363 | |
| 364 /* Exported macro ------------------------------------------------------------*/ | |
| 365 //#define COUNTOF(__BUFFER__) (sizeof(__BUFFER__) / sizeof(*(__BUFFER__))) | |
| 366 | |
| 367 #endif /* DATA_EXCHANGE_H */ | |
| 368 |