Power

class Power

重要

Power Class 的方法依赖于 M5.begin() M5.begin.png

所有调用 Power 对象的方法都需要放在 M5.begin() 之后 M5.begin.png

Methods

Power.setExtOutput(enable: bool, port: int = 0xFF) None

设置外部端口的电源输出。

enable 为 True 时,外部端口的电源输出为输出模式。当 enable 为 False 时,外部端口的电源输出为输入模式。

port 是端口号,可选值见 class PORT,仅对 M5Stack Station 有效。

UIFLOW2:

setExtOutput1.png setExtOutput2.png

Power.getExtOutput() bool

获取外部端口的电源输出。

如果外部端口的电源输出处于输出模式,则返回 True。如果外部端口的电源输出处于输入模式,则返回 False

UIFLOW2:

getExtOutput.png

Power.setUsbOutput(enable: bool) None

设置主 USB 端口的电源输出。

enable 为 True 时,主 USB 口的电源输出处于输出模式。当 enable 为 False 时,主 USB 口的电源输出处于输入模式。

UIFLOW2:

setUsbOutput.png

Power.getUsbOutput() bool

获取主 USB 端口的电源输出。

如果主 USB 端口的电源输出处于输出模式,则返回 True。如果主 USB 端口的电源输出处于输入模式,则返回 False

UIFLOW2:

getUsbOutput.png

Power.setLed(brightness=255) None

打开或关闭电源 LED。

brightness 是亮度值,范围为 0 到 255。0 表示关闭,255 表示最大亮度。

UIFLOW2:

setLed.png

Power.powerOff()

关闭所有电源。

UIFLOW2:

powerOff.png

Power.timerSleep(seconds) None
Power.timerSleep(minutes, hours) None
Power.timerSleep(minutes, hours, date, weekDay) None

睡眠与定时器启动。启动条件可通过参数指定。

seconds:范围为 1 - 15300,单位为秒。

minutes:范围为 0 - 59,单位为分钟。

hours:范围为 0 - 23,单位为小时。

date:范围为 1 - 31,单位为天。

weekDay:范围为 0 - 6。

UIFLOW2:

timerSleep1.png timerSleep2.png timerSleep3.png

Power.deepSleep(micro_seconds: int = 0, wakeup: bool = True)

ESP32 深度睡眠。

micro_seconds:唤醒所需的微秒数。

wakeup:是否唤醒。

UIFLOW2:

deepSleep.png

Power.lightSleep(micro_seconds: int = 0, wakeup: bool = True)

ESP32 lightsleep。

micro_seconds:唤醒所需的微秒数。

wakeup:是否唤醒。

UIFLOW2:

lightSleep.png

Power.getBatteryLevel() int

获取剩余电池电量百分比。返回一个介于 0-100 之间的值。

UIFLOW2:

getBatteryLevel.png

Power.setBatteryCharge(enable: bool) None

设置电池充电使能。

UIFLOW2:

setBatteryCharge.png

Power.setChargeCurrent(max_mA: int) None

设置电池充电电流。

max_mA:范围为 0-2000,单位为毫安。

UIFLOW2:

setChargeCurrent.png

Power.setChargeVoltage(max_mV: int) None

设置电池充电电压。

max_mV:范围为 4100-4600,单位为毫伏。

UIFLOW2:

setChargeVoltage.png

Power.isCharging() bool

获取当前电池是否正在充电。

UIFLOW2:

isCharging.png

Power.getBatteryVoltage() int

获取电池电压。单位为毫伏。

UIFLOW2:

getBatteryVoltage.png

Power.getBatteryCurrent() int

获取电池电流。单位为毫安。

UIFLOW2:

getBatteryCurrent.png

Power.getKeyState() int

获取电源键按下状态条件。

UIFLOW2:

getKeyState.png

Power.setVibration(level: int) None

操作振动电机。

level:振动强度,范围为 0-255。

UIFLOW2:

setVibration.png

class PORT

Constants

PORT.A

A 口。

PORT.B1

B1 端口。

PORT.B2

B2 端口。

PORT.C1

C1 端口。

PORT.C2

C2 端口。

PORT.USB

USB 端口。

PORT.HAT

HAT 端口。

PORT.ALL

所有端口。