iot_battery.h

Go to the documentation of this file.

/*
 * FreeRTOS Common IO V1.0.0
 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * 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:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * 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 AUTHORS 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 IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

/*******************************************************************************
 * @file iot_battery.h
 *
 * @brief HAL APIs for Battery
 *******************************************************************************
 */

#ifndef _IOT_BATTERY_H_
#define _IOT_BATTERY_H_

#define IOT_BATTERY_SUCCESS                 ( 0 )    
#define IOT_BATTERY_INVALID_VALUE           ( 1 )    
#define IOT_BATTERY_NOT_EXIST               ( 2 )    
#define IOT_BATTERY_READ_FAILED             ( 3 )    
#define IOT_BATTERY_FUNCTION_NOT_SUPPORTED  ( 4 )    
typedef enum
{
    eBatteryChargeable,     
    eBatteryNotChargeable   
} IotBatteryType_t;

typedef enum
{
    eBatteryChargeNone,         
    eBatteryChargeUSB,          
    eBatteryChargePowerSupply,  
    erBatteryChargeWireless,    
} IotBatteryChargeSource_t;

typedef enum
{
    eBatteryCharging,           
    eBatteryDischarging,        
    eBatteryNotCharging,        
    eBatteryChargeFull,         
    eBatteryChargeLow,          
    eBatteryOverVoltage,        
    eBatteryUnderVoltage,       
    eBatteryOverTemp,           
    eBatteryUnderTemp,          
    eBatteryOverChargingTemp,   
    eBatteryUnderhargingTemp,   
    eBatteryChargeTimeExpired,  
    eBatteryUnknown             
} IotBatteryStatus_t;

typedef struct IotBatteryInfo
{
    IotBatteryType_t    xBatteryType;       
    uint16_t            usMinVoltage;       
    uint16_t            usMaxVoltage;       
    int16_t             sMinTemperature;    
    int16_t             sMaxTemperature;    
    uint8_t             usMaxCapacity;      
    uint8_t             ucAsyncSupported;   
} IotBatteryInfo_t;

typedef enum IotBatteryIoctlRequest
{
    eSetBatteryMinVoltageThreshold,     
    eSetBatteryMaxVoltageThreshold,     
    eSetBatteryMinBatteryTempThreshold, 
    eSetBatteryMaxBatteryTempThreshold, 
    eSetBatteryMinChargeTempThreshold,  
    eSetBatteryMaxChargeTempThreshold,  
    eSetBatteryMaxOutputCurrent,        
    eSetBatteryMaxInputChargeCurrent,   
    eSetBatteryChargeTimer,             
    eGetBatteryMinVoltageThreshold,     
    eGetBatteryMaxVoltageThreshold,     
    eGetBatteryOCV,                     
    eGetBatteryBootVoltage,             
    eGetBatteryMinBatteryTempThreshold, 
    eGetBatteryMaxBatteryTempThreshold, 
    eGetBatteryMinChargeTempThreshold,  
    eGetBatteryMaxChargeTempThreshold,  
    eGetBatteryMaxOutputCurrent,        
    eGetBatteryMaxInputChargeCurrent,   
    eGetBatteryChargeTimer,             
    eGetBatteryChargeSource,            
    eGetBatteryStatus                   
} IotBatteryIoctlRequest_t;

struct  IotBatteryDescriptor_t;

typedef struct IotBatteryDescriptor_t * IotBatteryHandle_t;

typedef void ( * IotBatteryCallback_t)( IotBatteryStatus_t xStatus, void * pvUserContext );

IotBatteryHandle_t iot_battery_open( int32_t lBatteryInstance );

void iot_battery_set_callback( IotBatteryHandle_t const pxBatteryHandle,
                                IotBatteryCallback_t xCallback,
                                void * pvUserContext );

IotBatteryInfo_t * iot_battery_getInfo( IotBatteryHandle_t const pxBatteryHandle);

int32_t iot_battery_current( IotBatteryHandle_t const pxBatteryHandle,
                            uint16_t * pusCurrent);

int32_t iot_battery_voltage( IotBatteryHandle_t const pxBatteryHandle,
                            uint16_t * pusVoltage);

int32_t iot_battery_chargeLevel( IotBatteryHandle_t const pxBatteryHandle,
                                    uint8_t * pucChargeLevel);


int32_t iot_battery_capacity( IotBatteryHandle_t const pxBatteryHandle,
                                    uint16_t * pusCapacity);

int32_t iot_battery_temp( IotBatteryHandle_t const pxBatteryHandle,
                        int16_t * psTemp);

int32_t iot_battery_enable_charging( IotBatteryHandle_t const pxBatteryHandle,
                                    uint8_t * pucEnable);

int32_t iot_battery_is_charging( IotBatteryHandle_t const pxBatteryHandle,
                                uint8_t * pucCharging);

int32_t iot_battery_ioctl( IotBatteryHandle_t const pxBatteryHandle,
                            IotBatteryIoctlRequest_t xRequest,
                            void * const pvBuffer );

int32_t iot_battery_close( IotBatteryHandle_t const pxBatteryHandle );

#endif /* ifndef _IOT_BATTERY_H_ */