Battery.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  External battery status and settings (Only available on specific models)
 *
 *  Use the function GetBattery() to get a handle to pass on to the other functions.
 *  Use the method Battery_release(BATTERYHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include battery_example.cpp
 *
 ************************************************/
 
#ifndef CC_BATTERY_H_
#define CC_BATTERY_H_
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
/*
 * Diagnostic timer data
 */
typedef struct
{
    uint32_t TotRunTimeMain;    
    uint32_t TotRunTimeBattery; 
    uint32_t RunTime_m20;       
    uint32_t RunTime_m20_0;     
    uint32_t RunTime_0_40;      
    uint32_t RunTime_40_60;     
    uint32_t RunTime_60_70;     
    uint32_t RunTime_70_80;     
    uint32_t RunTime_Above80;   
} BatteryTimerType;
 
typedef enum
{
    ChargingStatus_NoCharge     = 0, 
    ChargingStatus_Charging     = 1, 
    ChargingStatus_FullyCharged = 2, 
    ChargingStatus_TempLow      = 3, 
    ChargingStatus_TempHigh     = 4, 
    ChargingStatus_Unknown      = 5  
} ChargingStatus;
 
typedef enum
{
    PowerSource_Battery       = 0, 
    PowerSource_ExternalPower = 1  
} PowerSource;
 
typedef enum
{
    ErrorStatus_NoError              = 0, 
    ErrorStatus_ThermistorTempSensor = 1, 
    ErrorStatus_SecondaryTempSensor  = 2, 
    ErrorStatus_ChargeFail           = 3, 
    ErrorStatus_Overcurrent          = 4, 
    ErrorStatus_Init                 = 5  
} ErrorStatus;
 
typedef void *BATTERYHANDLE;
 
EXTERN_C
CCAUXDLL_API
BATTERYHANDLE
CCAUXDLL_CALLING_CONV
GetBattery(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV Battery_release(BATTERYHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_isBatteryPresent(BATTERYHANDLE, bool *batteryIsPresent);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getBatteryVoltageStatus(BATTERYHANDLE, uint8_t *batteryVoltagePercent);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getBatteryChargingStatus(BATTERYHANDLE, ChargingStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getPowerSource(BATTERYHANDLE, PowerSource *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getBatteryTemp(BATTERYHANDLE, int16_t *temperature);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getHwErrorStatus(BATTERYHANDLE, ErrorStatus *errorCode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getTimer(BATTERYHANDLE, BatteryTimerType *times);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getMinMaxTemp(BATTERYHANDLE, int16_t *minTemp, int16_t *maxTemp);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getBatteryHWversion(BATTERYHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getBatterySwVersion(BATTERYHANDLE, uint16_t *major, uint16_t *minor,
                                                       uint16_t *release, uint16_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Battery_getBatterySerial(BATTERYHANDLE, char_t *buff, int32_t len);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_BATTERY_H_ */