pm - 电源管理#
已适配 Air101/Air103 Air105 ESP32C3 Air780
备注
本页文档由这个文件自动生成。如有错误,请提交issue或帮忙修改后pr,谢谢!
小技巧
本库有专属demo,点此链接查看pm的demo例子
常量#
常量 |
类型 |
解释 |
---|---|---|
pm.NONE |
number |
不休眠模式 |
pm.IDLE |
number |
IDLE模式 |
pm.LIGHT |
number |
LIGHT模式 |
pm.DEEP |
number |
DEEP模式 |
pm.HIB |
number |
HIB模式 |
pm.USB |
number |
USB电源 |
pm.GPS |
number |
GPS电源 |
pm.GPS_ANT |
number |
GPS的天线电源,有源天线才需要 |
pm.DAC_EN |
number |
Air780E和Air600E的DAC_EN,注意audio的默认配置会自动使用这个脚来控制CODEC的使能 |
pm.request(mode)#
请求进入指定的休眠模式
参数
传入值类型 |
解释 |
---|---|
int |
休眠模式,例如pm.IDLE/LIGHT/DEEP/HIB. |
返回值
返回值类型 |
解释 |
---|---|
boolean |
处理结果,即使返回成功,也不一定会进入, 也不会马上进入 |
例子
-- 请求进入休眠模式
--[[
IDLE 正常运行,就是无休眠
LIGHT 轻休眠, CPU停止, RAM保持, 外设保持, 可中断唤醒. 部分型号支持从休眠处继续运行
DEEP 深休眠, CPU停止, RAM掉电, 仅特殊引脚保持的休眠前的电平, 大部分管脚不能唤醒设备.
HIB 彻底休眠, CPU停止, RAM掉电, 仅复位/特殊唤醒管脚可唤醒设备.
]]
pm.request(pm.HIB)
pm.dtimerStart(id, timeout)#
启动底层定时器,在休眠模式下依然生效. 只触发一次
参数
传入值类型 |
解释 |
---|---|
int |
定时器id,通常是0-3 |
int |
定时时长,单位毫秒 |
返回值
返回值类型 |
解释 |
---|---|
boolean |
处理结果 |
例子
-- 添加底层定时器
pm.dtimerStart(0, 300 * 1000) -- 5分钟后唤醒
pm.dtimerStop(id)#
关闭底层定时器
参数
传入值类型 |
解释 |
---|---|
int |
定时器id |
返回值
无
例子
-- 关闭底层定时器
pm.dtimerStop(0) -- 关闭id=0的底层定时器
pm.dtimerCheck(id)#
检查底层定时器是不是在运行
参数
传入值类型 |
解释 |
---|---|
int |
定时器id |
返回值
返回值类型 |
解释 |
---|---|
boolean |
处理结果,true还在运行,false不在运行 |
例子
-- 检查底层定时器是不是在运行
pm.dtimerCheck(0) -- 检查id=0的底层定时器
pm.lastReson()#
开机原因,用于判断是从休眠模块开机,还是电源/复位开机
参数
无
返回值
返回值类型 |
解释 |
---|---|
int |
0-上电/复位开机, 1-RTC开机, 2-WakeupIn/Pad/IO开机, 3-Wakeup/RTC开机 |
int |
0-普通开机(上电/复位),3-深睡眠开机,4-休眠开机,3和4说明程序已经复位了 |
int |
复位开机详细原因:0-powerkey或者上电开机 1-充电或者AT指令下载完成后开机 2-闹钟开机 3-软件重启 4-未知原因 5-RESET键 6-异常重启 7-工具控制重启 8-内部看门狗重启 9-外部重启 10-充电开机 |
例子
-- 是哪种方式开机呢
log.info("pm", "last power reson", pm.lastReson())
pm.force(mode)#
强制进入指定的休眠模式,忽略某些外设的影响,比如USB
参数
传入值类型 |
解释 |
---|---|
int |
休眠模式 |
返回值
返回值类型 |
解释 |
---|---|
boolean |
处理结果,若返回成功,大概率会马上进入该休眠模式 |
例子
-- 请求进入休眠模式
pm.force(pm.HIB)
pm.check()#
检查休眠状态,仅air302适用.
参数
无
返回值
返回值类型 |
解释 |
---|---|
boolean |
处理结果,如果能顺利进入休眠,返回true,否则返回false |
int |
底层返回值,0代表能进入最底层休眠,其他值代表最低可休眠级别 |
例子
-- 请求进入休眠模式,然后检查是否能真的休眠
pm.request(pm.HIB)
if pm.check() then
log.info("pm", "it is ok to hib")
else
pm.force(pm.HIB) -- 强制休眠
end
pm.shutdown()#
关机
参数
无
返回值
返回值类型 |
解释 |
---|---|
nil |
无返回值 |
例子
-- 当前仅EC618系列(Air780E/Air600E/Air700E/Air780EG支持)
-- 需要2022-12-22之后编译的固件
pm.shutdown()
pm.reboot()#
重启
参数
无
返回值
返回值类型 |
解释 |
---|---|
nil |
无返回值 |
例子
无
pm.power(id, onoff)#
开启内部的电源控制,注意不是所有的平台都支持,可能部分平台支持部分选项,看硬件
参数
传入值类型 |
解释 |
---|---|
int |
电源控制id,pm.USB pm.GPS pm.GPS_ANT之类 |
boolean |
开关true开,false关,默认关 |
返回值
返回值类型 |
解释 |
---|---|
boolean |
处理结果true成功,false失败 |
例子
pm.power(pm.USB, false) --关闭USB电源