|
| 1 | +# 电池功能模块 用户指导手册 |
| 2 | + |
| 3 | +## 简介 |
| 4 | + |
| 5 | +> 该模块用于查询当前设备的电池电量与电压, 设备的充电状态。 |
| 6 | +
|
| 7 | +## API说明 |
| 8 | + |
| 9 | +### 实例化对象 |
| 10 | + |
| 11 | +**示例:** |
| 12 | + |
| 13 | +```python |
| 14 | +from battery import Battery |
| 15 | + |
| 16 | +adc_args = (adc_num, adc_period, factor) |
| 17 | +chrg_gpion = 0 |
| 18 | +stdby_gpion = 1 |
| 19 | + |
| 20 | +battery = Battery(adc_args=adc_args, chrg_gpion=chrg_gpion, stdby_gpion=stdby_gpion) |
| 21 | +``` |
| 22 | + |
| 23 | +**参数:** |
| 24 | + |
| 25 | +|参数|类型|说明| |
| 26 | +|:---|---|---| |
| 27 | +|adc_args|tuple|元素1: [ADC通道](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.ADC.html#%E5%B8%B8%E9%87%8F), 元素2: ADC循环读取次数, 元素3: 计算系数, 可选| |
| 28 | +|chrg_gpion|int|CHRG (引脚 1):漏极开路输出的充电状态指示端。可选| |
| 29 | +|stdby_gpion|int|STDBY (引脚 5):电池充电完成指示端。可选| |
| 30 | + |
| 31 | +### set_charge_callback |
| 32 | + |
| 33 | +> 充电事件回调函数 |
| 34 | +
|
| 35 | +**示例:** |
| 36 | + |
| 37 | +```python |
| 38 | +def charge_callback(charge_status): |
| 39 | + print(charge_status) |
| 40 | + |
| 41 | +res = battery.set_charge_callback(charge_callback) |
| 42 | +``` |
| 43 | + |
| 44 | +**参数:** |
| 45 | + |
| 46 | +|参数|类型|说明| |
| 47 | +|:---|---|---| |
| 48 | +|charge_callback|function|充电事件回调函数, 回调函数参数为设备充电状态: 0-未充电;1-充电中;2-充电完成| |
| 49 | + |
| 50 | +**返回值:** |
| 51 | + |
| 52 | +|数据类型|说明| |
| 53 | +|:---|---| |
| 54 | +|bool|`True`成功, `False`失败| |
| 55 | + |
| 56 | +### set_temp |
| 57 | + |
| 58 | +> 设置当前设备所处工作环境温度, 用于计算设备电池电量 |
| 59 | +
|
| 60 | +**示例:** |
| 61 | + |
| 62 | +```python |
| 63 | +res = battery.set_temp(20) |
| 64 | +``` |
| 65 | + |
| 66 | +**参数:** |
| 67 | + |
| 68 | +|参数|类型|说明| |
| 69 | +|:---|---|---| |
| 70 | +|temp|int/float|温度值, 单位:摄氏度 | |
| 71 | + |
| 72 | +**返回值:** |
| 73 | + |
| 74 | +|数据类型|说明| |
| 75 | +|:---|---| |
| 76 | +|bool|`True`成功, `False`失败| |
| 77 | + |
| 78 | +### voltage |
| 79 | + |
| 80 | +> 查询电池电压 |
| 81 | +
|
| 82 | +**示例:** |
| 83 | + |
| 84 | +```python |
| 85 | +battery.voltage |
| 86 | +# 523 |
| 87 | +``` |
| 88 | + |
| 89 | +**返回值:** |
| 90 | + |
| 91 | +|数据类型|说明| |
| 92 | +|:---|---| |
| 93 | +|int|电池电压, 单位mV。| |
| 94 | + |
| 95 | +### energy |
| 96 | + |
| 97 | +> 查询电池电量 |
| 98 | +
|
| 99 | +**示例:** |
| 100 | + |
| 101 | +```python |
| 102 | +res = battery.energy |
| 103 | +# 100 |
| 104 | +``` |
| 105 | + |
| 106 | +**返回值:** |
| 107 | + |
| 108 | +|数据类型|说明| |
| 109 | +|:---|---| |
| 110 | +|int|电池电量百分比, 0~100。| |
| 111 | + |
| 112 | +### charge_status |
| 113 | + |
| 114 | +> 查询充电状态 |
| 115 | +
|
| 116 | +**示例:** |
| 117 | + |
| 118 | +```python |
| 119 | +battery.charge_status |
| 120 | +# 1 |
| 121 | +``` |
| 122 | + |
| 123 | +**返回值:** |
| 124 | + |
| 125 | +|数据类型|说明| |
| 126 | +|:---|---| |
| 127 | +|int|0-未充电<br>1-充电中<br>2-充电完成| |
| 128 | + |
| 129 | +## 使用示例 |
| 130 | + |
| 131 | +```python |
| 132 | +from battery import Battery |
| 133 | + |
| 134 | +# 实例化对象 |
| 135 | +adc_args = (adc_num, adc_period, factor) |
| 136 | +chrg_gpion = 0 |
| 137 | +stdby_gpion = 1 |
| 138 | +battery = Battery(adc_args=adc_args, chrg_gpion=chrg_gpion, stdby_gpion=stdby_gpion) |
| 139 | + |
| 140 | +def charge_callback(charge_status): |
| 141 | + print(charge_status) |
| 142 | + |
| 143 | +# 设置充电状态回调函数 |
| 144 | +battery.set_charge_callback(charge_callback) |
| 145 | +# True |
| 146 | + |
| 147 | +# 设置当前设备温度 |
| 148 | +temp = 30 |
| 149 | +battery.set_temp(temp) |
| 150 | +# True |
| 151 | + |
| 152 | +# 获取当前电池电压 |
| 153 | +battery.voltage |
| 154 | +# 3000 |
| 155 | + |
| 156 | +# 获取当前电池电量 |
| 157 | +battery.energy |
| 158 | +# 100 |
| 159 | + |
| 160 | +# 获取当前充电状态 |
| 161 | +battery.charge_status |
| 162 | +# 1 |
| 163 | + |
| 164 | +``` |
0 commit comments