annotate Discovery/Inc/tComm.h @ 429:7f351c25608a ImprovmentNVM_2

Marked possible code improvment for future activities: parameters stored in the settings were not trusted. LastDive ID and Sample index are usually calculated at startup. This calculation could be avoided, nevertheless the implementation works => only TODO Removed function without effect: Calling writeblock with legth 0 has no effect
author ideenmodellierer
date Mon, 17 Feb 2020 19:43:09 +0100
parents 7bcbbaa42cbf
children 5e027b0f7475
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
1 ///////////////////////////////////////////////////////////////////////////////
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
2 /// -*- coding: UTF-8 -*-
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
3 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
4 /// \file Discovery/Inc/tComm.h
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
5 /// \brief Header file communication with PC
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
6 /// \author heinrichs weikamp gmbh
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
7 /// \date 08-Aug-2014
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
8 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
9 /// $Id$
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
10 ///////////////////////////////////////////////////////////////////////////////
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
11 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
12 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
13 /// This program is free software: you can redistribute it and/or modify
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
14 /// it under the terms of the GNU General Public License as published by
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
15 /// the Free Software Foundation, either version 3 of the License, or
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
16 /// (at your option) any later version.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
17 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
18 /// This program is distributed in the hope that it will be useful,
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
19 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
20 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
21 /// GNU General Public License for more details.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
22 ///
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
23 /// You should have received a copy of the GNU General Public License
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
24 /// along with this program. If not, see <http://www.gnu.org/licenses/>.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
25 //////////////////////////////////////////////////////////////////////////////
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
26
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
27 /* Define to prevent recursive inclusion -------------------------------------*/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
28 #ifndef TCOMM_H
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
29 #define TCOMM_H
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
30
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
31 /* Includes ------------------------------------------------------------------*/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
32 #include <stdint.h>
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
33
397
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
34
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
35 /* types */
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
36 typedef enum
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
37 {
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
38 BM_CONFIG_OFF = 0,
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
39 BM_CONFIG_ECHO,
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
40 BM_CONFIG_ESCAPE_DELAY,
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
41 BM_CONFIG_SIGNAL_POLL,
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
42 BM_CONFIG_BAUD,
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
43 BM_CONFIG_SILENCE,
400
7bcbbaa42cbf Added retry through power off/on cycle:
ideenmodellierer
parents: 397
diff changeset
44 BM_CONFIG_DONE,
7bcbbaa42cbf Added retry through power off/on cycle:
ideenmodellierer
parents: 397
diff changeset
45 BM_CONFIG_RETRY
397
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
46 } BlueModTmpConfig_t;
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
47
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
48 /* Exported functions --------------------------------------------------------*/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
49
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
50 void tComm_init(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
51 uint8_t tComm_control(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
52 void tComm_refresh(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
53 void tComm_exit(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
54 void tComm_verlauf(uint8_t percentage_complete);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
55 uint8_t tComm_Set_Bluetooth_Name(uint8_t force);
397
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
56 void tComm_StartBlueModConfig(void);
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
57 void tComm_RequestBluetoothStrength(void);
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
58
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
59 #endif /* TCOMM_H */