summaryrefslogtreecommitdiffhomepage
path: root/digital/zigbit/bitcloud/stack/Components/BSP/MESHBEAN/include/battery.h
diff options
context:
space:
mode:
authorFlorent Duchon2012-12-26 17:36:00 +0100
committerFlorent Duchon2013-02-13 21:21:12 +0100
commitb24866225a6301d3a663f874725e83c012dc25d3 (patch)
treeca527a2aab9abcdfbaf244c53ca63f0c531892b0 /digital/zigbit/bitcloud/stack/Components/BSP/MESHBEAN/include/battery.h
parent2ba279f4eb2f23fa08a7c13465d16ae6ba5d0f96 (diff)
digital/beacon: add bitcloud stack into common directory digital/zigbit
Diffstat (limited to 'digital/zigbit/bitcloud/stack/Components/BSP/MESHBEAN/include/battery.h')
-rw-r--r--digital/zigbit/bitcloud/stack/Components/BSP/MESHBEAN/include/battery.h63
1 files changed, 63 insertions, 0 deletions
diff --git a/digital/zigbit/bitcloud/stack/Components/BSP/MESHBEAN/include/battery.h b/digital/zigbit/bitcloud/stack/Components/BSP/MESHBEAN/include/battery.h
new file mode 100644
index 00000000..5bdc91fe
--- /dev/null
+++ b/digital/zigbit/bitcloud/stack/Components/BSP/MESHBEAN/include/battery.h
@@ -0,0 +1,63 @@
+/**************************************************************************//**
+\file battery.h
+
+\brief Interface to the battery sensor.
+
+\author
+ Atmel Corporation: http://www.atmel.com \n
+ Support email: avr@atmel.com
+
+ Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
+ Licensed under Atmel's Limited License Agreement (BitCloudTM).
+
+\internal
+ History:
+ 29/06/07 E. Ivanov - Created
+******************************************************************************/
+
+#ifndef _BATTERY_H
+#define _BATTERY_H
+
+/******************************************************************************
+ Includes section
+******************************************************************************/
+// \cond
+#include <types.h>
+#include <sensors.h>
+// \endcond
+
+/******************************************************************************
+ Prototypes section
+******************************************************************************/
+/**************************************************************************//**
+\brief Opens the component to use.
+\return
+ BC_SUCCESS - the component is ready to been use. \n
+ BC_FAIL - otherwise.
+******************************************************************************/
+result_t openBattery(void);
+
+/**************************************************************************//**
+\brief Closes component.
+\return
+ BC_SUCCESS - always.
+******************************************************************************/
+result_t closeBattery(void);
+
+/**************************************************************************//**
+\brief Starts ADC request on battery channel.
+\param[in]
+ callback - callback method.
+\param[in]
+ data - battery data.
+ Can use (4ul * data * 125ul * 3ul) / (1024ul * 100ul) formula to count \n
+ battery data in Volts.
+\return
+ BC_FAIL - battery component was not opened.
+ BC_SUCCESS - other case.
+******************************************************************************/
+result_t readBatteryData(BspBatteryCb_t);
+
+#endif /* _BATTERY_H */
+// eof battery.h
+