Skip to content

Latest commit

 

History

History
166 lines (110 loc) · 3.21 KB

battery_API_Reference.md

File metadata and controls

166 lines (110 loc) · 3.21 KB

Battery Function Module API Reference Manual

中文 | English

Introduction

This module is used to query the current device's battery level and voltage, as well as the device's charging status.

API Description

Battery

Example:

from battery import Battery

adc_args = (adc_num, adc_period, factor)
chrg_gpion = 0
stdby_gpion = 1

battery = Battery(adc_args=adc_args, chrg_gpion=chrg_gpion, stdby_gpion=stdby_gpion)

Parameters:

Parameter Type Description
adc_args tuple Element 1: ADC Channel
Element 2: Number of ADC cyclic reads
Element 3: Calculation factor
Optional
chrg_gpion int CHRG (Pin 1): Open-drain output charging status indicator. Optional
stdby_gpion int STDBY (Pin 5): Battery charging completion indicator. Optional

set_charge_callback

Charging event callback function.

Example:

def charge_callback(charge_status):
    print(charge_status)

res = battery.set_charge_callback(charge_callback)

Parameters:

Parameter Type Description
charge_callback function Charging event callback function. The callback function parameter is the device charging status:
0 - Not charging
1 - Charging
2 - Charging complete

Return Value:

Data Type Description
bool True - Success
False - Failure

set_temp

Set the working environment temperature of the current device, used to calculate the device's battery level.

Example:

res = battery.set_temp(20)

Parameters:

Parameter Type Description
temp int/float Temperature value, in degrees Celsius

Return Value:

Data Type Description
bool True - Success
False - Failure

voltage

Query battery voltage.

Example:

battery.voltage
# 523

Return Value:

Data Type Description
int Battery voltage, in millivolts

energy

Query battery level.

Example:

res = battery.energy
# 100

Return Value:

Data Type Description
int Battery level percentage, 0 ~ 100

charge_status

Query charging status.

Example:

battery.charge_status
# 1

Return Value:

Data Type Description
int 0 - Not charging
1 - Charging
2 - Charging complete

Usage Example

from battery import Battery

# Instantiate object
adc_args = (adc_num, adc_period, factor)
chrg_gpion = 0
stdby_gpion = 1
battery = Battery(adc_args=adc_args, chrg_gpion=chrg_gpion, stdby_gpion=stdby_gpion)

def charge_callback(charge_status):
    print(charge_status)

# Set charging status callback function
battery.set_charge_callback(charge_callback)
# True

# Set the current device temperature
temp = 30
battery.set_temp(temp)
# True

# Get the current battery voltage
battery.voltage
# 3000

# Get the current battery level
battery.energy
# 100

# Get the current charging status
battery.charge_status
# 1