FreeRTOS: Common I/O
AWS IoT Common I/O library
Return to main page ↑
IotBatteryInfo_t Struct Reference

Battery information. More...

#include <iot_battery.h>

Data Fields

IotBatteryType_t xBatteryType
 
uint16_t usMinVoltage
 
uint16_t usMaxVoltage
 
int16_t sMinTemperature
 
int16_t sMaxTemperature
 
uint8_t usMaxCapacity
 
uint8_t ucAsyncSupported
 

Detailed Description

Battery information.

Field Documentation

◆ xBatteryType

IotBatteryType_t IotBatteryInfo_t::xBatteryType

Battery type. chargeable or non-chargeable

◆ usMinVoltage

uint16_t IotBatteryInfo_t::usMinVoltage

minimum designed voltage battery can be used at

◆ usMaxVoltage

uint16_t IotBatteryInfo_t::usMaxVoltage

maximum designed voltage battery can be used at

◆ sMinTemperature

int16_t IotBatteryInfo_t::sMinTemperature

lowest temperature the battery can be used at by design

◆ sMaxTemperature

int16_t IotBatteryInfo_t::sMaxTemperature

max temperature the battery can be used at by design

◆ usMaxCapacity

uint8_t IotBatteryInfo_t::usMaxCapacity

max capacity of battery by design

◆ ucAsyncSupported

uint8_t IotBatteryInfo_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


The documentation for this struct was generated from the following file: