ketCube_batMeas.h File Reference

This file contains definitions for the KETCube batMeas module. More...

#include "ketCube_cfg.h"

Go to the source code of this file.

Data Structures
struct	ketCube_batMeas_battery_t
	KETCube battery deffinition. More...
struct	ketCube_batMeas_moduleCfg_t
	KETCube batMeas module configuration. More...

Typedefs
typedef struct ketCube_batMeas_battery_t	ketCube_batMeas_battery_t
	KETCube battery deffinition. More...
typedef struct ketCube_batMeas_moduleCfg_t	ketCube_batMeas_moduleCfg_t
	KETCube batMeas module configuration. More...

Enumerations
enum	ketCube_batMeas_cfgAdr_t { KETCUBE_BATMEAS_CFGADR_CFG = 0, KETCUBE_BATMEAS_CFGADR_BAT = 1 }
	enumerator of M-BUS configuration options addresses More...
enum	ketCube_batMeas_cfgLen_t { KETCUBE_BATMEAS_CFGLEN_CFG = 1, KETCUBE_BATMEAS_CFGLEN_BAT = 1 }
	enumerator of M-BUS configuration options lengths More...
enum	ketCube_batMeas_battList_t { KETCUBE_BATMEAS_BATLIST_CR2032 = 0, KETCUBE_BATMEAS_BATLIST_LS33600, KETCUBE_BATMEAS_BATLIST_LAST }
	List of available S0 errors. More...

Functions
ketCube_cfg_ModError_t	ketCube_batMeas_Init (ketCube_InterModMsg_t ***msg)
	Initializes Battery Measurement. More...
ketCube_cfg_ModError_t	ketCube_batMeas_ReadData (uint8_t *buffer, uint8_t *len)
	Read battery data. More...
uint8_t	ketCube_batMeas_GetBatteryByte (void)
	This function returns the battery level. More...

Variables
ketCube_batMeas_moduleCfg_t	ketCube_batMeas_moduleCfg
ketCube_batMeas_battery_t	ketCube_batMeas_batList []
	List of supported batteries. More...
uint8_t	ketCube_batMeas_selectedBattery

Detailed Description

This file contains definitions for the KETCube batMeas module.

Author

Jan Belohoubek

Version

0.1

Date

2018-08-09

Attention

© Copyright (c) 2018 University of West Bohemia in Pilsen All rights reserved.

Developed by: The SmartCampus Team Department of Technologies and Measurement www.smartcampus.cz | www.zcu.cz

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal with the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimers in the documentation and/or other materials provided with the distribution.
• Neither the names of The SmartCampus Team, Department of Technologies and Measurement and Faculty of Electrical Engineering University of West Bohemia in Pilsen, nor the names of its contributors may be used to endorse or promote products derived from this Software without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.