e78249ee06
* Move to explicit enable of `ZMK_PM_SOFT_OFF` to turn on the feature and use the behaviors, which matches how other features work, and helps with split and testing schemes.
3.0 KiB
title, sidebar_label
| title | sidebar_label |
|---|---|
| Power Management Configuration | Power Management |
See Configuration Overview for instructions on how to change these settings.
Idle/Sleep
Configuration for entering low power modes when the keyboard is idle.
In the idle state, peripherals such as displays and lighting are disabled, but the keyboard remains connected to Bluetooth so it can immediately respond when you press a key.
In the deep sleep state, the keyboard additionally disconnects from Bluetooth and any external power output is disabled. This state uses very little power, but it may take a few seconds to reconnect after waking.
Kconfig
Definition file: zmk/app/Kconfig
| Config | Type | Description | Default |
|---|---|---|---|
CONFIG_ZMK_IDLE_TIMEOUT |
int | Milliseconds of inactivity before entering idle state | 30000 |
CONFIG_ZMK_SLEEP |
bool | Enable deep sleep support | n |
CONFIG_ZMK_IDLE_SLEEP_TIMEOUT |
int | Milliseconds of inactivity before entering deep sleep | 900000 |
Soft Off
The soft off feature allows turning the keyboard on/off from either dedicated hardware of using the &soft_off behavior to turn off and a reset button to turn back on again.
Kconfig
Definition file: zmk/app/Kconfig
| Config | Type | Description | Default |
|---|---|---|---|
CONFIG_ZMK_PM_SOFT_OFF |
bool | Enable soft off functionality from the keymap of dedicated hardware | n |
External Power Control
Driver for enabling or disabling power to peripherals such as displays and lighting. This driver must be configured to use power management behaviors.
Kconfig
Definition file: zmk/app/Kconfig
| Config | Type | Description | Default |
|---|---|---|---|
CONFIG_ZMK_EXT_POWER |
bool | Enable support to control external power output | y |
Devicetree
Applies to: compatible = "zmk,ext-power-generic"
| Property | Type | Description |
|---|---|---|
control-gpios |
GPIO array | List of GPIOs which should be active to enable external power |
init-delay-ms |
int | number of milliseconds to delay after initializing the driver |