annotate Discovery/Inc/tComm.h @ 874:fbb6f8f41e0a Evo_2_23

minor
author heinrichsweikamp
date Wed, 14 Aug 2024 16:50:55 +0200
parents 5e027b0f7475
children fe955104901c
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,
872
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
45 BM_CONFIG_RETRY,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
46 #ifdef BOOTLOADER_STANDALONE
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
47 BM_INIT_TRIGGER_ON = 100,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
48 BM_INIT_TRIGGER_OFF,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
49 BM_INIT_FACTORY,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
50 BM_INIT_MODE,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
51 BM_INIT_BLE,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
52 BM_INIT_NAME,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
53 BM_INIT_SSP_IDO_OFF,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
54 BM_INIT_SSP_IDO_ON,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
55 BM_INIT_SSP_ID1_OFF,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
56 BM_INIT_SSP_ID1_ON,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
57 BM_INIT_STORE,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
58 BM_INIT_RESTART,
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
59 BM_INIT_DONE
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
60 #endif
397
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
61 } BlueModTmpConfig_t;
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
62
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
63 /* Exported functions --------------------------------------------------------*/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
64
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
65 void tComm_init(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
66 uint8_t tComm_control(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
67 void tComm_refresh(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
68 void tComm_exit(void);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
69 void tComm_verlauf(uint8_t percentage_complete);
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
70 uint8_t tComm_Set_Bluetooth_Name(uint8_t force);
872
5e027b0f7475 Added first time initialization for new bluetooth module:
Ideenmodellierer
parents: 400
diff changeset
71 void tComm_StartBlueModBaseInit(void);
397
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
72 void tComm_StartBlueModConfig(void);
1db721dda682 Added missing enum for configuration states
ideenmodellierer
parents: 38
diff changeset
73 void tComm_RequestBluetoothStrength(void);
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
74
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
75 #endif /* TCOMM_H */