KETCube
ketCube_batMeas.h
Go to the documentation of this file.
1 
45 /* Define to prevent recursive inclusion -------------------------------------*/
46 #ifndef __KETCUBE_BATMEAS_H
47 #define __KETCUBE_BATMEAS_H
48 
49 #include "ketCube_cfg.h"
50 
60 typedef enum {
64 
68 typedef enum {
72 
76 typedef enum {
82 
86 typedef struct ketCube_batMeas_battery_t {
87  char *batName;
88  char *batDescr;
89  uint16_t batCharged;
90  uint16_t batDischarged;
92 
101 
103 
105 extern uint8_t ketCube_batMeas_selectedBattery;
106 
107 
113  *** msg);
114 extern ketCube_cfg_ModError_t ketCube_batMeas_ReadData(uint8_t * buffer,
115  uint8_t * len);
116 
117 extern uint8_t ketCube_batMeas_GetBatteryByte(void);
118 
128 #endif /* __KETCUBE_BATMEAS_H */
ketCube_InterModMsg_t
KETCube inter-module message.
Definition: ketCube_cfg.h:116
ketCube_batMeas_battery_t::batDischarged
uint16_t batDischarged
Definition: ketCube_batMeas.h:90
ketCube_batMeas_moduleCfg_t::coreCfg
ketCube_cfg_ModuleCfgByte_t coreCfg
Definition: ketCube_batMeas.h:97
ketCube_batMeas_GetBatteryByte
uint8_t ketCube_batMeas_GetBatteryByte(void)
This function returns the battery level.
Definition: ketCube_batMeas.c:118
ketCube_cfg_ModuleCfgByte_t
KETCube module configuration byte.
Definition: ketCube_cfg.h:147
KETCUBE_BATMEAS_CFGLEN_CFG
@ KETCUBE_BATMEAS_CFGLEN_CFG
Definition: ketCube_batMeas.h:69
ketCube_batMeas_batList
ketCube_batMeas_battery_t ketCube_batMeas_batList[]
List of supported batteries.
Definition: ketCube_batMeas.c:65
ketCube_batMeas_battery_t
struct ketCube_batMeas_battery_t ketCube_batMeas_battery_t
KETCube battery deffinition.
ketCube_batMeas_battery_t::batCharged
uint16_t batCharged
Definition: ketCube_batMeas.h:89
KETCUBE_BATMEAS_CFGLEN_BAT
@ KETCUBE_BATMEAS_CFGLEN_BAT
Definition: ketCube_batMeas.h:70
ketCube_batMeas_battery_t::batName
char * batName
Definition: ketCube_batMeas.h:87
KETCUBE_BATMEAS_CFGADR_CFG
@ KETCUBE_BATMEAS_CFGADR_CFG
Definition: ketCube_batMeas.h:61
ketCube_batMeas_ReadData
ketCube_cfg_ModError_t ketCube_batMeas_ReadData(uint8_t *buffer, uint8_t *len)
Read battery data.
Definition: ketCube_batMeas.c:154
ketCube_batMeas_Init
ketCube_cfg_ModError_t ketCube_batMeas_Init(ketCube_InterModMsg_t ***msg)
Initializes Battery Measurement.
Definition: ketCube_batMeas.c:83
KETCUBE_BATMEAS_BATLIST_CR2032
@ KETCUBE_BATMEAS_BATLIST_CR2032
Definition: ketCube_batMeas.h:77
ketCube_batMeas_moduleCfg
ketCube_batMeas_moduleCfg_t ketCube_batMeas_moduleCfg
Definition: ketCube_batMeas.c:58
ketCube_batMeas_cfgLen_t
ketCube_batMeas_cfgLen_t
enumerator of M-BUS configuration options lengths
Definition: ketCube_batMeas.h:68
ketCube_batMeas_battery_t::batDescr
char * batDescr
Definition: ketCube_batMeas.h:88
KETCUBE_BATMEAS_BATLIST_LS33600
@ KETCUBE_BATMEAS_BATLIST_LS33600
Definition: ketCube_batMeas.h:78
ketCube_batMeas_moduleCfg_t
struct ketCube_batMeas_moduleCfg_t ketCube_batMeas_moduleCfg_t
KETCube batMeas module configuration.
KETCUBE_BATMEAS_BATLIST_LAST
@ KETCUBE_BATMEAS_BATLIST_LAST
Definition: ketCube_batMeas.h:80
ketCube_batMeas_battery_t
KETCube battery deffinition.
Definition: ketCube_batMeas.h:86
ketCube_batMeas_selectedBattery
uint8_t ketCube_batMeas_selectedBattery
ketCube_batMeas_cfgAdr_t
ketCube_batMeas_cfgAdr_t
enumerator of M-BUS configuration options addresses
Definition: ketCube_batMeas.h:60
KETCUBE_BATMEAS_CFGADR_BAT
@ KETCUBE_BATMEAS_CFGADR_BAT
Definition: ketCube_batMeas.h:62
ketCube_batMeas_moduleCfg_t
KETCube batMeas module configuration.
Definition: ketCube_batMeas.h:96
ketCube_cfg.h
This file contains definitions for the KETCube configuration.
ketCube_cfg_ModError_t
ketCube_cfg_ModError_t
Error code type.
Definition: ketCube_cfg.h:100
ketCube_batMeas_battList_t
ketCube_batMeas_battList_t
List of available S0 errors.
Definition: ketCube_batMeas.h:76
ketCube_batMeas_moduleCfg_t::selectedBattery
ketCube_batMeas_battList_t selectedBattery
Definition: ketCube_batMeas.h:99