ccNOos  v0.0.0
Build Portable Microcontroller Applications!
TPMmodule.h
Go to the documentation of this file.
1 /** \file TPMmodule.h
2 * \brief <a href="https://www.inmechasol.org/" target="_blank">IMS</a>:
3  <a href="https://github.com/InMechaSol/ccNOos" target="_blank">ccNOos</a>,
4  Declarations for straight C and C++
5 
6  Copyright 2021 <a href="https://www.inmechasol.org/" target="_blank">InMechaSol, Inc</a>
7 
8  Licensed under the Apache License, Version 2.0(the "License");
9  you may not use this file except in compliance with the License.
10  You may obtain a copy of the License at
11 
12  http://www.apache.org/licenses/LICENSE-2.0
13 
14  Unless required by applicable law or agreed to in writing, software
15  distributed under the License is distributed on an "AS IS" BASIS,
16  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  See the License for the specific language governing permissions and
18  limitations under the License.
19 
20 Notes:
21  (.c includes .h) - for straight C or
22  (.cpp includes .c which includes .h) - for C++ wrapped straight C
23  *Always compiled to a single compilation unit, either C or CPP, not both
24 
25 */
26 
27 #ifndef __TPM_MOD_H__
28 #define __TPM_MOD_H__
29 
30 #include "ADRF6650.h"
31 #include "LTC2360.h"
32 
33 
34 // TPM Module Data Structure
36 {
38  struct ADRF6650DataStruct data;
40 };
42 void readFreqConv(struct freqConvStruct* freqConvStructPtrIn);
43 void writeFreqConv(struct freqConvStruct* freqConvStructPtrIn);
44 
46 {
48  struct LTC2360DataStruct data;
50 };
52 void readPowerMeter(struct powerMeterStruct* powerMeterStructPtrIn);
53 void writePowerMeter(struct powerMeterStruct* powerMeterStructPtrIn);
54 
55 struct tpmStruct
56 {
59 };
60 struct tpmStruct createtpmStruct();
61 void tryReadTPMData(struct tpmStruct* tpmStructPtrIn);
62 void tryWriteTPMData(struct tpmStruct* tpmStructPtrIn);
63 
64 
65 #ifdef __USINGCONSOLEMENU
66 
67 void parseTPMMenuAPI(struct tpmStruct* tpmStructPtrIn, struct uiStruct* uiStructPtrIn);
68 void writeTPMMenuScreen(struct tpmStruct* tpmStructPtrIn, struct uiStruct* uiStructPtrIn);
69 void writeTPMLogLine(struct tpmStruct* tpmStructPtrIn, struct logStruct* logStructPtrIn);
70 void parseTPMConfigLine(struct tpmStruct* tpmStructPtrIn, struct configStruct* configStructPtrIn);
71 
72 #endif
73 
74 #ifdef __cplusplus
75 
76 
77 
78 #endif // !__cplusplus
79 #endif // !__TPM_MOD_H__
parseTPMMenuAPI
void parseTPMMenuAPI(struct tpmStruct *tpmStructPtrIn, struct uiStruct *uiStructPtrIn)
Definition: MenuAPI.c:464
freqConvStruct::newFreqConvData
UI_8 newFreqConvData
Definition: TPMmodule.h:39
readFreqConv
void readFreqConv(struct freqConvStruct *freqConvStructPtrIn)
Definition: Application_Platform_Main.c:75
tryReadTPMData
void tryReadTPMData(struct tpmStruct *tpmStructPtrIn)
Definition: TPMmodule.c:55
writeFreqConv
void writeFreqConv(struct freqConvStruct *freqConvStructPtrIn)
Definition: Application_Platform_Main.c:76
ADRF6650.h
IMS: ccNOos, Declarations for straight C and C++
LTC2360DataStruct
Definition: LTC2360.h:34
writePowerMeter
void writePowerMeter(struct powerMeterStruct *powerMeterStructPtrIn)
Definition: Application_Platform_Main.c:78
createPowerMeterStruct
struct powerMeterStruct createPowerMeterStruct()
Definition: TPMmodule.c:37
ADRF6650DataStruct
Definition: ADRF6650.h:35
parseTPMConfigLine
void parseTPMConfigLine(struct tpmStruct *tpmStructPtrIn, struct configStruct *configStructPtrIn)
Definition: PlatformApp_Serialization.c:43
LTC2360.h
IMS: ccNOos, Declarations for straight C and C++
tryWriteTPMData
void tryWriteTPMData(struct tpmStruct *tpmStructPtrIn)
Definition: TPMmodule.c:61
createfreqConvStruct
struct freqConvStruct createfreqConvStruct()
Definition: TPMmodule.c:30
powerMeterStruct::devptr
struct devicedatastruct * devptr
Definition: TPMmodule.h:47
powerMeterStruct
Definition: TPMmodule.h:46
tpmStruct
Definition: TPMmodule.h:56
tpmStruct::freqConverter
struct freqConvStruct freqConverter
Definition: TPMmodule.h:57
readPowerMeter
void readPowerMeter(struct powerMeterStruct *powerMeterStructPtrIn)
Definition: Application_Platform_Main.c:77
writeTPMLogLine
void writeTPMLogLine(struct tpmStruct *tpmStructPtrIn, struct logStruct *logStructPtrIn)
Definition: PlatformApp_Serialization.c:42
freqConvStruct
Definition: TPMmodule.h:36
tpmStruct::powerMeter
struct powerMeterStruct powerMeter
Definition: TPMmodule.h:58
powerMeterStruct::data
struct LTC2360DataStruct data
Definition: TPMmodule.h:48
createtpmStruct
struct tpmStruct createtpmStruct()
Definition: TPMmodule.c:47
writeTPMMenuScreen
void writeTPMMenuScreen(struct tpmStruct *tpmStructPtrIn, struct uiStruct *uiStructPtrIn)
Definition: MenuAPI.c:519
freqConvStruct::data
struct ADRF6650DataStruct data
Definition: TPMmodule.h:38
freqConvStruct::devptr
struct devicedatastruct * devptr
Definition: TPMmodule.h:37
devicedatastruct
the common data struct of io devices
Definition: io_device.h:62
powerMeterStruct::newPowerMeterValue
UI_8 newPowerMeterValue
Definition: TPMmodule.h:49