ostc4: Small_CPU/Inc/uartProtocol

annotate Small_CPU/Inc/uartProtocol_GNSS.h @ 1027:158100a84ebd GasConsumption

New profile feature: In the past the OSTC provide just one instance for settings. If for example a diver switched from OC to CCR configuration several settings had to be modified. To improve this and to be more flexible in adapting the OSTC to differend dive scenarions the usage of up to 4 profiles has beem introduced. The profiles are copies of the common settings but stored in a separate, previously not used, flash section => no impact to existings settings handling. For access to the profiles the existing setting flash functions are reused. To enable this a parameter war introduced which defines the target of the operation (common settings or profiles).

author	Ideenmodellierer
date	Sun, 07 Sep 2025 19:03:44 +0200
parents	efb7d18cc564
children

rev	line source
899 2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	1 /**
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	2 ******************************************************************************
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	3 * @file uartProtocol_GNSS.h
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	4 * @author heinrichs weikamp gmbh
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	5 * @version V0.0.1
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	6 * @date 30-Sep-2024
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	7 * @brief Interface functionality for operation of gnss devices
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	8 *
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	9 @verbatim
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	10 ==============================================================================
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	11 ##### How to use #####
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	12 ==============================================================================
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	13 @endverbatim
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	14 ******************************************************************************
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	15 * @attention
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	16 *
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	17 * <h2><center>© COPYRIGHT(c) 2014 heinrichs weikamp</center></h2>
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	18 *
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	19 ******************************************************************************
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	20 */
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	21
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	22 /* Define to prevent recursive inclusion -------------------------------------*/
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	23 #ifndef UART_PROTOCOL_GNSS_H
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	24 #define UART_PROTOCOL_GNSS_H
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	25
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	26 #ifdef __cplusplus
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	27 extern "C" {
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	28 #endif
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	29
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	30 /* Includes ------------------------------------------------------------------*/
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	31 #include "configuration.h"
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	32 #include "stm32f4xx_hal.h"
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	33
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	34 typedef enum
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	35 {
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	36 UART_GNSS_INIT = 0, /* Default Status for every sensor type */
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	37 UART_GNSS_IDLE, /* sensor detected and no communication pending */
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	38 UART_GNSS_ERROR, /* Error message received from sensor */
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	39 UART_GNSS_WARMUP = 10,
936 3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	40 UART_GNSS_INACTIVE, /* no requests to the receiver */
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	41 UART_GNSS_LOADCONF_0,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	42 UART_GNSS_LOADCONF_1,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	43 UART_GNSS_LOADCONF_2,
939 f41974734268 Resume UART com with gnss after sleep: Ideenmodellierer parents: 936 diff changeset	44 UART_GNSS_SETMODE_MOBILE,
1000 c386ae6635e4 Improve GNSS operation: Ideenmodellierer parents: 939 diff changeset	45 UART_GNSS_SETDATE_TIME,
1004 efb7d18cc564 DevelopmentOption: added the possibility to provide a fixed position info to the gnss module. Code is deactivated at the moment. Ideenmodellierer parents: 1000 diff changeset	46 UART_GNSS_SET_POSITION,
936 3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	47 UART_GNSS_PWRDOWN,
3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	48 UART_GNSS_PWRUP,
3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	49 UART_GNSS_SETCONF, /* save configuration */
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	50 UART_GNSS_GET_PVT,
931 5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	51 UART_GNSS_GET_SAT
899 2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	52 } uartGnssStatus_t;
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	53
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	54 typedef enum
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	55 {
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	56 GNSSRX_READY = 0, /* Initial state */
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	57 GNSSRX_DETECT_HEADER_0,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	58 GNSSRX_DETECT_HEADER_1,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	59 GNSSRX_DETECT_HEADER_2,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	60 GNSSRX_DETECT_HEADER_3,
931 5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	61 GNSSRX_DETECT_LENGTH_0,
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	62 GNSSRX_DETECT_LENGTH_1,
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	63 GNSSRX_DETECT_ACK_0,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	64 GNSSRX_DETECT_ACK_1,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	65 GNSSRX_DETECT_ACK_2,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	66 GNSSRX_DETECT_ACK_3,
931 5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	67 GNSSRX_READ_DATA,
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	68 GNSSRX_READ_CK_A,
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	69 GNSSRX_READ_CK_B,
899 2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	70 } receiveStateGnss_t;
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	71
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	72
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	73 typedef enum
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	74 {
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	75 GNSSCMD_LOADCONF_0 = 0,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	76 GNSSCMD_LOADCONF_1,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	77 GNSSCMD_LOADCONF_2,
939 f41974734268 Resume UART com with gnss after sleep: Ideenmodellierer parents: 936 diff changeset	78 GNSSCMD_SETMOBILE,
1000 c386ae6635e4 Improve GNSS operation: Ideenmodellierer parents: 939 diff changeset	79 GNSSCMD_SETDATETIME,
1004 efb7d18cc564 DevelopmentOption: added the possibility to provide a fixed position info to the gnss module. Code is deactivated at the moment. Ideenmodellierer parents: 1000 diff changeset	80 GNSSCMD_SET_POSITION,
936 3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	81 GNSSCMD_MODE_PWS,
3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	82 GNSSCMD_MODE_NORMAL,
3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	83 GNSSCMD_SET_CONFIG,
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	84 GNSSCMD_GET_NAV_DATA,
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	85 GNSSCMD_GET_PVT_DATA,
931 5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	86 GNSSCMD_GET_POSLLH_DATA,
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	87 GNSSCMD_GET_NAVSAT_DATA
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	88 } gnssSensorCmd_t;
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	89
931 5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	90 typedef struct
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	91 {
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	92 uint8_t class;
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	93 uint8_t id;
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	94 } gnssRequest_s;
5a9bc2e6112d Added Sat Status Overview: Ideenmodellierer parents: 919 diff changeset	95
936 3029f0332f4f GNSS introduced power saving mode: Ideenmodellierer parents: 932 diff changeset	96 void uartGnss_ReqPowerDown(uint8_t request);
939 f41974734268 Resume UART com with gnss after sleep: Ideenmodellierer parents: 936 diff changeset	97 uint8_t uartGnss_isPowerDownRequested(void);
932 effadaa3a1f7 Cleanup Gnss UART implementation: Ideenmodellierer parents: 931 diff changeset	98 uartGnssStatus_t uartGnss_GetState(void);
effadaa3a1f7 Cleanup Gnss UART implementation: Ideenmodellierer parents: 931 diff changeset	99 void uartGnss_SetState(uartGnssStatus_t newState);
899 2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	100 void uartGnss_Control(void);
919 c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	101 void uartGnss_ProcessData(uint8_t data);
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	102 uint8_t uartGnss_isSensorConnected();
c0553dd70608 GNSS support for external UART interface: Ideenmodellierer parents: 899 diff changeset	103 void uartGnss_SendCmd(uint8_t GnssCmd);
899 2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	104
2225c467f1e9 Added data path and visualization for position data: Ideenmodellierer parents: diff changeset	105 #endif /* UART_PROTOCOL_GNSS_H */

Mercurial > public > ostc4

annotate Small_CPU/Inc/uartProtocol_GNSS.h @ 1027:158100a84ebd GasConsumption