Power

class Power

Important

Methods of the Power Class depend on M5.begin() .

All methods calling the Power object need to be placed after M5.begin() .

Methods

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

Set power output of the external ports.

When enable is True, the power output of the external ports is in output mode. When enable is False, the power output of the external ports is in input mode.

port is the port number, optional values are available in class PORT, only valid for M5Stack Station.

UIFLOW2:

Power.getExtOutput() → bool

Get power output of the external ports.

Returns True if the power output of the external ports is in output mode. Returns False if the power output of the external ports is in input mode.

UIFLOW2:

Power.setUsbOutput(enable: bool) → None

Set power output of the main USB port.

When enable is True, the power output of the main USB port is in output mode. When enable is False, the power output of the main USB port is in input mode.

UIFLOW2:

Power.getUsbOutput() → bool

Get power output of the main USB port.

Returns True if the power output of the main USB port is in output mode. Returns False if the power output of the main USB port is in input mode.

UIFLOW2:

Power.setLed(brightness=255) → None

Turn on/off the power LED.

brightness is the brightness value, ranging from 0 to 255. 0 is off, 255 is the maximum brightness.

UIFLOW2:

Power.powerOff()

Turn off all power.

UIFLOW2:

Power.timerSleep(seconds) → None

Power.timerSleep(minutes, hours) → None

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

sleep and timer boot. The boot condition can be specified by the argument.

seconds: Range is 1 - 15300, in seconds.

minutes: Range is 0 - 59, in minutes.

hours: Range is 0 - 23, in hours.

date: Range is 1 - 31, in days.

weekDay: Range is 0 - 6.

UIFLOW2:

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

ESP32 deepsleep.

micro_seconds: Number of micro seconds to wakeup.

wakeup: Whether to wake up.

UIFLOW2:

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

ESP32 lightsleep.

micro_seconds: Number of micro seconds to wakeup.

wakeup: Whether to wake up.

UIFLOW2:

Power.getBatteryLevel() → int

Get the remaining battery power percentage. Returns a value between 0-100.

UIFLOW2:

Power.setBatteryCharge(enable: bool) → None

Set battery charging enable.

UIFLOW2:

Power.setChargeCurrent(max_mA: int) → None

Set battery charge current.

max_mA: Range is 0-2000, in milliamps.

UIFLOW2:

Power.setChargeVoltage(max_mV: int) → None

Set battery charge voltage.

max_mV: Range is 4100-4600, in millivolts.

UIFLOW2:

Power.isCharging() → bool

Get whether the battery is currently charging or not.

UIFLOW2:

Power.getBatteryVoltage() → int

Get battery voltage. Unit is millivolts.

UIFLOW2:

Power.getBatteryCurrent() → int

Get battery current. Unit is milliamps.

UIFLOW2:

Power.getKeyState() → int

Get Power Key Press condition.

UIFLOW2:

Power.setVibration(level: int) → None

Operate the vibration motor.

level: Vibration intensity, ranging from 0-255.

UIFLOW2:

class PORT

Constants

PORT.A

Port A.

PORT.B1

Port B1.

PORT.B2

Port B2.

PORT.C1

Port C1.

PORT.C2

Port C2.

PORT.USB

USB Port.

PORT.HAT

HAT Port.

PORT.ALL

All Ports.