MT2523 API Reference  LinkIt SDK v4

Overview

Enumerations

enum  battery_management_status_t {
  BATTERY_MANAGEMENT_STATUS_INVALID_PARAMETER = -2,
  BATTERY_MANAGEMENT_STATUS_ERROR = -1,
  BATTERY_MANAGEMENT_STATUS_OK = 0
}
 This enum defines the return status of the battery management functions. More...
 
enum  battery_property_t {
  BATTERY_PROPERTY_CAPACITY = 0,
  BATTERY_PROPERTY_CHARGING_CURRENT,
  BATTERY_PROPERTY_CHARGER_EXIST,
  BATTERY_PROPERTY_CHARGER_TYPE,
  BATTERY_PROPERTY_TEMPERATURE,
  BATTERY_PROPERTY_VOLTAGE,
  BATTERY_PROPERTY_CAPACITY_LEVEL
}
 Battery properties. More...
 
enum  battery_management_event_t { BATTERY_MANAGEMENT_EVENT_BATTERY_UPDATE = 0x00000001 }
 Battery management events. More...
 

Enumeration Type Documentation

Battery management events.

Enumerator
BATTERY_MANAGEMENT_EVENT_BATTERY_UPDATE 

Battery update event.

This enum defines the return status of the battery management functions.

Enumerator
BATTERY_MANAGEMENT_STATUS_INVALID_PARAMETER 

An invalid parameter.

BATTERY_MANAGEMENT_STATUS_ERROR 

An error occurred during the function call.

BATTERY_MANAGEMENT_STATUS_OK 

The function call was successful.

Battery properties.

Enumerator
BATTERY_PROPERTY_CAPACITY 

Remaining battery capacity in an integer percentage form.

BATTERY_PROPERTY_CHARGING_CURRENT 

Average charging current.

BATTERY_PROPERTY_CHARGER_EXIST 

Charger existence status.

BATTERY_PROPERTY_CHARGER_TYPE 

Charger type.

BATTERY_PROPERTY_TEMPERATURE 

Battery temperature.

BATTERY_PROPERTY_VOLTAGE 

Battery's average voltage.

BATTERY_PROPERTY_CAPACITY_LEVEL 

Remaining battery capacity from 0 to 5 levels.