Mercurial > public > ostc4

annotate Small_CPU/Inc/externalInterface.h @ 765:da8126d5ea9f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
After a firmware update, use the factory settings for button sensitivity if these exist, the default settings otherwise. The factory settings for the buttons can be updated in the System menu / Reset menu / Maintenance / 'Store button factory defaults'.
author heinrichsweikamp
date Wed, 12 Apr 2023 09:24:44 +0200
parents e23fe82cbf8c
children 0b5f45448eb6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
554
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
1 /**
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
2 ******************************************************************************
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
3 * @file externalInterface.h
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
4 * @author heinrichs weikamp gmbh
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
5 * @version V0.0.1
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
6 * @date 07-Nov-2020
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
7 * @brief Interface functionality to proceed external analog signal via i2c connection
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
8 *
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
9 @verbatim
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
10 ==============================================================================
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
11 ##### How to use #####
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
12 ==============================================================================
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
13 @endverbatim
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
14 ******************************************************************************
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
15 * @attention
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
16 *
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
17 * <h2><center>&copy; COPYRIGHT(c) 2014 heinrichs weikamp</center></h2>
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
18 *
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
19 ******************************************************************************
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
20 */
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
21
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
22 /* Define to prevent recursive inclusion -------------------------------------*/
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
23 #ifndef EXTERNAL_INTERFACE_H
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
24 #define EXTERNAL_INTERFACE_H
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
25
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
26 #ifdef __cplusplus
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
27 extern "C" {
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
28 #endif
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
29
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
30 /* Includes ------------------------------------------------------------------*/
742
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
31 #include "configuration.h"
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
32
554
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
33
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
34 #define MAX_ADC_CHANNEL (3u) /* number of channels to be read */
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
35 #define EXTERNAL_ADC_NO_DATA 0xFF
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
36
662
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
37 #define EXT33V_CONTROL_PIN GPIO_PIN_7 /* PortC */
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
38
729
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
39 #define MIN_ADC_VOLTAGE_MV (5.0f) /* miminal voltage to rate an ADC channel as active */
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
40
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
41
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
42 typedef enum
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
43 {
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
44 DETECTION_OFF = 0, /* no detection requested */
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
45 DETECTION_INIT, /* prepare external interface for operation if not already activated */
731
2a801cfe23ab Improvment sensor Autodetection:
Ideenmodellierer
parents: 729
diff changeset
46 DETECTION_START,
2a801cfe23ab Improvment sensor Autodetection:
Ideenmodellierer
parents: 729
diff changeset
47 DETECTION_ANALOG1, /* check ADC channels for connected sensors */
2a801cfe23ab Improvment sensor Autodetection:
Ideenmodellierer
parents: 729
diff changeset
48 DETECTION_ANALOG2,
729
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
49 DETECTION_DIGO2, /* check UART channel for connected DigO2 sensor */
742
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
50 #ifdef ENABLE_CO2_SUPPORT
729
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
51 DETECTION_CO2, /* check UART channel for connected CO2 sensor */
742
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
52 #endif
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
53 #ifdef ENABLE_SENTINEL_MODE
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
54 DETECTION_SENTINEL, /* check UART channel for connected Sentinel */
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
55 DETECTION_SENTINEL2,
e23fe82cbf8c Update Sentinel protocol:
Ideenmodellierer
parents: 738
diff changeset
56 #endif
729
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
57 DETECTION_DONE
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
58 } externalInterfaceAutoDetect_t;
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
59
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
60
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
61
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
62
554
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
63 void externalInterface_Init(void);
662
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
64 void externalInterface_InitPower33(void);
738
30717de00f3a Added data init function for external interface:
Ideenmodellierer
parents: 731
diff changeset
65 void externalInterface_InitDatastruct(void);
554
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
66 uint8_t externalInterface_StartConversion(uint8_t channel);
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
67 uint8_t externalInterface_ReadAndSwitch();
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
68 float externalInterface_CalculateADCValue(uint8_t channel);
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
69 float getExternalInterfaceChannel(uint8_t channel);
691
52d68cf9994c Improvment external interface usage:
Ideenmodellierer
parents: 662
diff changeset
70 uint8_t setExternalInterfaceChannel(uint8_t channel, float value);
662
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
71 void externalInterface_SwitchPower33(uint8_t state);
691
52d68cf9994c Improvment external interface usage:
Ideenmodellierer
parents: 662
diff changeset
72 void externalInterface_SwitchADC(uint8_t state);
704
f1b40364b0af Added protocol functions for UART DiveO2 sensor:
Ideenmodellierer
parents: 691
diff changeset
73 void externalInterface_SwitchUART(uint8_t protocol);
691
52d68cf9994c Improvment external interface usage:
Ideenmodellierer
parents: 662
diff changeset
74 uint8_t externalInterface_isEnabledPower33(void);
52d68cf9994c Improvment external interface usage:
Ideenmodellierer
parents: 662
diff changeset
75 uint8_t externalInterface_isEnabledADC(void);
704
f1b40364b0af Added protocol functions for UART DiveO2 sensor:
Ideenmodellierer
parents: 691
diff changeset
76 uint8_t externalInterface_GetUARTProtocol();
662
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
77
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
78 void externalInterface_SetCO2Value(uint16_t CO2_ppm);
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
79 void externalInterface_SetCO2SignalStrength(uint16_t LED_qa);
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
80 uint16_t externalInterface_GetCO2Value(void);
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
81 uint16_t externalInterface_GetCO2SignalStrength(void);
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
82 void externalInterface_SetCO2State(uint16_t state);
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
83 uint16_t externalInterface_GetCO2State(void);
714
045ff7800501 Added customizable data area for specific sensor data:
Ideenmodellierer
parents: 704
diff changeset
84 uint8_t externalInterface_GetSensorData(uint8_t* pDataStruct);
045ff7800501 Added customizable data area for specific sensor data:
Ideenmodellierer
parents: 704
diff changeset
85 void externalInterface_SetSensorData(uint8_t dataId, uint8_t* pDataStruct);
729
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
86 void externalInface_SetSensorMap(uint8_t* pMap);
731
2a801cfe23ab Improvment sensor Autodetection:
Ideenmodellierer
parents: 729
diff changeset
87 uint8_t* externalInterface_GetSensorMapPointer(uint8_t finalMap);
729
d646a0f724a7 Added auto detection functionality for sensors connected to the external interface:
Ideenmodellierer
parents: 714
diff changeset
88 void externalInterface_AutodetectSensor(void);
662
1b995079c045 PSCR Mode
heinrichs weikamp
parents: 554
diff changeset
89 void externalInterface_ExecuteCmd(uint16_t Cmd);
554
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
90
3328189786e7 Added external ADC interface functionality (MCP3424):
Ideenmodellierer
parents:
diff changeset
91 #endif /* EXTERNAL_INTERFACE_H */