XDK API  3.6.0
Documentation
Files | Functions
Battery Monitor

This module handles all the battery related activities. More...

+ Collaboration diagram for Battery Monitor:

Files

file  BatteryMonitor.h
 

Functions

Retcode_T BatteryMonitor_Init (void)
 Initialize the Battery monitor module. More...
 
Retcode_T BatteryMonitor_MeasureSignal (uint32_t *outputVoltage)
 Measures the specified voltage signal. More...
 

Detailed Description

This module is used to initialize battery charger & measure the battery voltage.

Function Documentation

Retcode_T BatteryMonitor_Init ( void  )

: Enables the Battery Charger & Initialize the Battery monitor to measure the battery voltage

Return values
RETCODE_OKin case of successfully Initializing the Battery monitor.
RETCODE_SEMAPHORE_ERRORin case not able to create Semaphore.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T BatteryMonitor_MeasureSignal ( uint32_t *  outputVoltage)

: the analog signals from the charger routed to the MCU could be fetched using this function

This function once called will return the value of the specified signal in millivolts.

Parameters
[out]outputVoltagemeasured battery voltage in millivolts
Return values
RETCODE_OKin case of successfully getting the battery voltage.
RETCODE_NULL_POINTERin case of NULL pointer passed.
RETCODE_BSP_CHARGER_NOT_ENABLEDin case of accessing before enabling the charger.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:50 by doxygen 1.8.8