You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.4 KiB
2.4 KiB
title | sidebar_label |
---|---|
Display Configuration | Displays |
See the displays feature page for more details.
See Configuration Overview for instructions on how to change these settings.
Kconfig
Definition files:
Config | Type | Description | Default |
---|---|---|---|
CONFIG_ZMK_DISPLAY |
bool | Enable support for displays | n |
CONFIG_ZMK_WIDGET_LAYER_STATUS |
bool | Enable a widget to show the highest, active layer | y |
CONFIG_ZMK_WIDGET_BATTERY_STATUS |
bool | Enable a widget to show battery charge information | y |
CONFIG_ZMK_WIDGET_OUTPUT_STATUS |
bool | Enable a widget to show the current output (USB/BLE) | y |
CONFIG_ZMK_WIDGET_WPM_STATUS |
bool | Enable a widget to show words per minute | n |
If CONFIG_ZMK_DISPLAY
is enabled, exactly one of the following options must be set to y
:
Config | Type | Description | Default |
---|---|---|---|
CONFIG_ZMK_DISPLAY_STATUS_SCREEN_BUILT_IN |
bool | Use the built-in status screen | y |
CONFIG_ZMK_DISPLAY_STATUS_SCREEN_CUSTOM |
bool | Use a custom status screen | n |
You must also configure the Zephyr driver for your display. Here are the Kconfig options for common displays.
Devicetree
See the Zephyr Devicetree bindings for your display. Here are the bindings for common displays:
A full list of supported drivers can be found in Zephyr's Devicetree bindings index.