Skip to content
This repository has been archived by the owner on Dec 8, 2022. It is now read-only.

Commit

Permalink
Correct some type defination of battery info and comments (#2275)
Browse files Browse the repository at this point in the history
  • Loading branch information
@renhongxue
renhongxue authored Jul 28, 2020
1 parent 1e3ae78 commit 1ad58f1
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions libraries/abstractions/common_io/include/iot_battery.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ typedef struct IotBatteryInfo
uint16_t usMinVoltage; /*!< minimum designed voltage battery can be used at */
uint16_t usMaxVoltage; /*!< maximum designed voltage battery can be used at */
int16_t sMinTemperature; /*!< lowest temperature the battery can be used at by design */
int16_t sMaxTemperature; /*!< max temperature the battery can be used at by design */
uint8_t usMaxCapacity; /*!< max capacity of battery by design */
int32_t lMaxTemperature; /*!< max temperature the battery can be used at by design */
uint16_t usMaxCapacity; /*!< max capacity of battery by design */
uint8_t ucAsyncSupported; /*!< Is asynchronous notifications supported by the driver. This will be
* set, if the battery/charging has an IC/battery and charging hw module that
* can atonomously monitor battery characterstics and generate interrupts */
Expand All @@ -132,19 +132,19 @@ typedef enum IotBatteryIoctlRequest
* This IOCTL takes int16_t value as input in milliCelcius units. */
eSetBatteryMaxBatteryTempThreshold, /*!< Set the maximum battery temperature threshold. When the battery temperature goes above this value,
* the registered callback will be called with the status value "eBatteryUnderTemp".
* This IOCTL takes int16_t value as input in milliCelcius units. */
* This IOCTL takes int32_t value as input in milliCelcius units. */
eSetBatteryMinChargeTempThreshold, /*!< Set the minimum charge temperature threshold. When the charging temperature goes below this value,
* the registered callback will be called with the status value "eBatteryUnderChargingTemp".
* This IOCTL takes int16_t value as input in milliCelcius units.*/
eSetBatteryMaxChargeTempThreshold, /*!< Set the maximum charge temperature threshold. When the charging temperature goes above this value,
* the registered callback will be called with the status value "eBatteryOverChargingTemp".
* This IOCTL takes int16_t value as input in milliCelcius units. */
* This IOCTL takes int32_t value as input in milliCelcius units. */
eSetBatteryMaxOutputCurrent, /*!< Set the maximum output current limit from the battery.
* This IOCTL takes uint16_t value as input in milliAmp units. */
eSetBatteryMaxInputChargeCurrent, /*!< Set the maximum input charging current limit to the battery.
* This IOCTL takes uint16_t value as input in milliAmp units. */
eSetBatteryChargeTimer, /*!< Set the battery charging timer limit. AFter the timer expires charging will stop.
* This IOCTL takes uint16_t value as input in milliSec units. */
* This IOCTL takes uint32_t value as input in milliSec units. */
eGetBatteryMinVoltageThreshold, /*!< Get the battery minimum thresold.
* This IOCTL returns uint16_t value in milliVolt units. */
eGetBatteryMaxVoltageThreshold, /*!< Get the battery maximum thresold.
Expand All @@ -156,17 +156,17 @@ typedef enum IotBatteryIoctlRequest
eGetBatteryMinBatteryTempThreshold, /*!< Get the minimum battery temperature thresholde
* This IOCTL returns int16_t value in milliCelcius units. */
eGetBatteryMaxBatteryTempThreshold, /*!< Get the maximum battery temperature threshold.
* This IOCTL returns int16_t value in milliCelcius units. */
* This IOCTL returns int32_t value in milliCelcius units. */
eGetBatteryMinChargeTempThreshold, /*!< Get the minimum charging temperature threshold.
* This IOCTL returns int16_t value in milliCelcius units. */
eGetBatteryMaxChargeTempThreshold, /*!< Get the maximum charging temperature threshold.
* This IOCTL returns int16_t value in milliCelcius units. */
* This IOCTL returns int32_t value in milliCelcius units. */
eGetBatteryMaxOutputCurrent, /*!< Get the battery output current limit.
* This IOCTL returns uint16_t value in milliAmp units. */
eGetBatteryMaxInputChargeCurrent, /*!< Get the battery input charge current limit.
* This IOCTL returns uint16_t value in milliAmp units. */
eGetBatteryChargeTimer, /*!< Get the current battery charge time limit.
* This IOCTL returns uint16_t value in milliSec units. */
* This IOCTL returns uint32_t value in milliSec units. */
eGetBatteryChargeSource, /*!< Get the current battery charge source.
* This IOCTL returns a IotBatteryChargeSource_t as it's parameter. */
eGetBatteryStatus /*!< Get the battery status. Returns one of the IotBatteryStatus_t values as it's parameter. */
Expand Down Expand Up @@ -331,7 +331,7 @@ int32_t iot_battery_capacity( IotBatteryHandle_t const pxBatteryHandle,
*
* @param[in] pxBatteryHandle handle to Battery driver returned in
* iot_battery_open()
* @param[out] psTemp battery temperature in milliCelcius
* @param[out] plTemp battery temperature in milliCelcius
*
* @return
* - IOT_BATTERY_SUCCESS on success
Expand All @@ -341,7 +341,7 @@ int32_t iot_battery_capacity( IotBatteryHandle_t const pxBatteryHandle,
* - IOT_BATTERY_FUNCTION_NOT_SUPPORTED if its not supported by the hardware.
*/
int32_t iot_battery_temp( IotBatteryHandle_t const pxBatteryHandle,
int16_t * psTemp );
int32_t * plTemp );

/*!
* @brief iot_battery_enable_charging is used to enable battery charging if charging is supported.
Expand Down

0 comments on commit 1ad58f1

Please sign in to comment.