zmk/app/Kconfig

mainmenu "ZMK Firmware"

config ZMK_KEYBOARD_NAME
	string "Keyboard Name"

config USB_DEVICE_PRODUCT
	default ZMK_KEYBOARD_NAME

config BT_DEVICE_NAME
	default ZMK_KEYBOARD_NAME

config ZMK_KSCAN_EVENT_QUEUE_SIZE
	int "Size of the event queue for KSCAN events to buffer events"
	default 4

menu "HID Output Types"

menuconfig ZMK_USB
	bool "USB"
	select USB
	select USB_DEVICE_STACK
	select USB_DEVICE_HID

if ZMK_USB

config ZMK_USB_INIT_PRIORITY
	int "Init Priority"
	default 50

config USB_NUMOF_EP_WRITE_RETRIES
	default 10

endif

menuconfig ZMK_BLE
	bool "BLE (HID over GATT)"
	select BT
	select BT_SMP
	select BT_SMP_SC_PAIR_ONLY
	select BT_PERIPHERAL
	select BT_GATT_DIS
	select BT_GATT_BAS
	select SETTINGS
	select BT_SETTINGS

if ZMK_BLE

config ZMK_BLE_UNPAIR_COMBO
	bool "Enable BT unpair combo"
	help
		Adds a magic key combo that can be held on startup to remove all paired devices
	default n

config ZMK_BLE_INIT_PRIORITY
	int "Init Priority"
	default 50

config SYSTEM_WORKQUEUE_STACK_SIZE
	default 2048

# HID GATT notifications sent this way are *not* picked up by Linux, and possibly others.
config BT_GATT_NOTIFY_MULTIPLE
	default n

config BT_DEVICE_APPEARANCE
	default 961

config ZMK_BLE_PASSKEY_ENTRY
	bool "Experimental: Requiring typing passkey from host to pair BLE connection"
	default n

endif

endmenu

config ZMK_DISPLAY
	bool "ZMK display support"
	default n
	select DISPLAY
	select LVGL
	select LVGL_THEMES
	select LVGL_THEME_MONO
	select LVGL_OBJ_LABEL

menu "Split Support"

config ZMK_SPLIT
	bool "Split keyboard support"
	default n

if ZMK_SPLIT

config ZMK_SPLIT_BLE
	bool "Split keyboard support via BLE transport"
	depends on ZMK_BLE
	default y
	select BT_USER_PHY_UPDATE

if ZMK_SPLIT_BLE

choice ZMK_SPLIT_BLE_ROLE
	bool "BLE Role For Split Communication"
	default ZMK_SPLIT_BLE_ROLE_CENTRAL

config ZMK_SPLIT_BLE_ROLE_CENTRAL
	bool "Central"
	select BT_CENTRAL
	select BT_GATT_CLIENT

if ZMK_SPLIT_BLE_ROLE_CENTRAL

config BT_MAX_CONN
	default 5

config BT_MAX_PAIRED
	# Bump this everywhere once we support switching active connections!
	default 2

endif

config ZMK_SPLIT_BLE_ROLE_PERIPHERAL
	bool "Peripheral"

if ZMK_SPLIT_BLE_ROLE_PERIPHERAL

config ZMK_USB
	default n


config BT_MAX_CONN
	default 5

config BT_GAP_AUTO_UPDATE_CONN_PARAMS
	default n

endif

endchoice

endif

endif 

endmenu


config ZMK_KSCAN_MOCK_DRIVER
	bool "Enable mock kscan driver to simulate key presses"
	default n


config ZMK_KSCAN_COMPOSITE_DRIVER
	bool "Enable composite kscan driver to combine kscan devices"
	default n

menu "ZMK Actions"

config ZMK_ACTION_MOD_TAP
	bool "Enable the Mod-Tap Action"
	
endmenu

menu "ZMK Lighting"

menuconfig ZMK_RGB_UNDERGLOW
	bool "RGB Adressable LED Underglow"
	select LED_STRIP

if ZMK_RGB_UNDERGLOW

config ZMK_RGB_UNDERGLOW_HUE_STEP
	int "RGB underglow hue step in degrees of 360"
	default 10

config ZMK_RGB_UNDERGLOW_SAT_STEP
	int "RGB underglow sturation step in percent"
	default 10

config ZMK_RGB_UNDERGLOW_BRT_STEP
	int "RGB underglow brightness step in percent"
	default 10

config ZMK_RGB_UNDERGLOW_HUE_START
	int "RGB underglow start hue value from 0-359"
	default 0

config ZMK_RGB_UNDERGLOW_SAT_START
	int "RGB underglow start saturations value from 0-100"
	default 100

config ZMK_RGB_UNDERGLOW_BRT_START
	int "RGB underglow start brightness value from 0-100"
	default 100

config ZMK_RGB_UNDERGLOW_SPD_START
	int "RGB underglow start animation speed value from 1-5"
	default 3

config ZMK_RGB_UNDERGLOW_EFF_START
	int "RGB underglow start effect int value related to the effect enum list"
	default 0

config ZMK_RGB_UNDERGLOW_ON_START
	bool "Whether RGB underglow starts on by default"
	default y

endif

endmenu

config HEAP_MEM_POOL_SIZE
	default 8192

config KERNEL_BIN_NAME
	default "zmk"

config REBOOT
	default y

module = ZMK
module-str = zmk
source "subsys/logging/Kconfig.template.log_config"

rsource "boards/Kconfig"
rsource "boards/shields/*/Kconfig.defconfig"

source "Kconfig.zephyr"
Message queue and work item for process scan events. * Prep for using ISR for kscan GPIO, by moving event process into a work item. 5 years ago			`mainmenu "ZMK Firmware"`

Refactor where ZMK KConfigs come from. 5 years ago			`config ZMK_KEYBOARD_NAME`
			`string "Keyboard Name"`

			`config USB_DEVICE_PRODUCT`
			`default ZMK_KEYBOARD_NAME`

			`config BT_DEVICE_NAME`
			`default ZMK_KEYBOARD_NAME`

Message queue and work item for process scan events. * Prep for using ISR for kscan GPIO, by moving event process into a work item. 5 years ago			`config ZMK_KSCAN_EVENT_QUEUE_SIZE`
			`int "Size of the event queue for KSCAN events to buffer events"`
			`default 4`

Refactor where ZMK KConfigs come from. 5 years ago			`menu "HID Output Types"`

Use SYS_INIT for BLE and USB init. 5 years ago			`menuconfig ZMK_USB`
Refactor where ZMK KConfigs come from. 5 years ago			`bool "USB"`
			`select USB`
			`select USB_DEVICE_STACK`
			`select USB_DEVICE_HID`

Use SYS_INIT for BLE and USB init. 5 years ago			`if ZMK_USB`

			`config ZMK_USB_INIT_PRIORITY`
			`int "Init Priority"`
			`default 50`

Bump the default USB EP write retries. 5 years ago			`config USB_NUMOF_EP_WRITE_RETRIES`
			`default 10`

Use SYS_INIT for BLE and USB init. 5 years ago			`endif`

Refactor where ZMK KConfigs come from. 5 years ago			`menuconfig ZMK_BLE`
			`bool "BLE (HID over GATT)"`
Refactor build/config/keymaps. * Move all headers to `include/zmk` directory. * Update includes to reference them properly. * Add `keymap.c` file from keymap, if found. * Toplevel CONFIG_ZMK_BLE aggregate config setting. 5 years ago			`select BT`
			`select BT_SMP`
			`select BT_SMP_SC_PAIR_ONLY`
			`select BT_PERIPHERAL`
			`select BT_GATT_DIS`
			`select BT_GATT_BAS`
feeature(bt): Add "unpair combo" on startup. * Especially for splits, we need the ability to unpair all paired devices as sledgehammer if we need to "reset things", and doing so via keymaps isn't suitable. * Allows shields to define a collection of key positions that if all held 2 seconds after startup, will unpair all existing pairs for the device. 4 years ago			`select SETTINGS`
			`select BT_SETTINGS`
Full NKRO support, fixes for keymap key selection. 5 years ago
Move BLE passkey entry behind config flag. 5 years ago			`if ZMK_BLE`

feeature(bt): Add "unpair combo" on startup. * Especially for splits, we need the ability to unpair all paired devices as sledgehammer if we need to "reset things", and doing so via keymaps isn't suitable. * Allows shields to define a collection of key positions that if all held 2 seconds after startup, will unpair all existing pairs for the device. 4 years ago			`config ZMK_BLE_UNPAIR_COMBO`
			`bool "Enable BT unpair combo"`
			`help`
			`Adds a magic key combo that can be held on startup to remove all paired devices`
			`default n`

Use SYS_INIT for BLE and USB init. 5 years ago			`config ZMK_BLE_INIT_PRIORITY`
			`int "Init Priority"`
			`default 50`

Working BT settings. 5 years ago			`config SYSTEM_WORKQUEUE_STACK_SIZE`
			`default 2048`

Refactor where ZMK KConfigs come from. 5 years ago			`# HID GATT notifications sent this way are not picked up by Linux, and possibly others.`
			`config BT_GATT_NOTIFY_MULTIPLE`
			`default n`

			`config BT_DEVICE_APPEARANCE`
			`default 961`

Move BLE passkey entry behind config flag. 5 years ago			`config ZMK_BLE_PASSKEY_ENTRY`
			`bool "Experimental: Requiring typing passkey from host to pair BLE connection"`
			`default n`

			`endif`

Refactor where ZMK KConfigs come from. 5 years ago			`endmenu`

Initial display support. 4 years ago			`config ZMK_DISPLAY`
			`bool "ZMK display support"`
			`default n`
			`select DISPLAY`
			`select LVGL`
			`select LVGL_THEMES`
			`select LVGL_THEME_MONO`
			`select LVGL_OBJ_LABEL`
Initial exploration of split BLE service. * Service for split peripheral to report position state to split central. * Updated advertising info. * Behavior for split BT until we have a proper event system. 5 years ago
			`menu "Split Support"`

			`config ZMK_SPLIT`
			`bool "Split keyboard support"`
			`default n`

			`if ZMK_SPLIT`

			`config ZMK_SPLIT_BLE`
			`bool "Split keyboard support via BLE transport"`
			`depends on ZMK_BLE`
			`default y`
Fix interval update, add PHY update 4 years ago			`select BT_USER_PHY_UPDATE`
Initial exploration of split BLE service. * Service for split peripheral to report position state to split central. * Updated advertising info. * Behavior for split BT until we have a proper event system. 5 years ago
Lots of work on split peripheral/central logic. 5 years ago			`if ZMK_SPLIT_BLE`

			`choice ZMK_SPLIT_BLE_ROLE`
			`bool "BLE Role For Split Communication"`
			`default ZMK_SPLIT_BLE_ROLE_CENTRAL`

			`config ZMK_SPLIT_BLE_ROLE_CENTRAL`
			`bool "Central"`
Kconfig fixes for split roles. 5 years ago			`select BT_CENTRAL`
			`select BT_GATT_CLIENT`
Lots of work on split peripheral/central logic. 5 years ago
Working BT settings. 5 years ago			`if ZMK_SPLIT_BLE_ROLE_CENTRAL`

			`config BT_MAX_CONN`
Bump max BT connections for testing. 5 years ago			`default 5`
Working BT settings. 5 years ago
Bump max paired connections to 2 for central. 4 years ago			`config BT_MAX_PAIRED`
			`# Bump this everywhere once we support switching active connections!`
			`default 2`

Working BT settings. 5 years ago			`endif`

Lots of work on split peripheral/central logic. 5 years ago			`config ZMK_SPLIT_BLE_ROLE_PERIPHERAL`
			`bool "Peripheral"`

Tweaks for turning off USB for split peripherals. 5 years ago			`if ZMK_SPLIT_BLE_ROLE_PERIPHERAL`

			`config ZMK_USB`
			`default n`

Bump max BT connections for testing. 5 years ago
			`config BT_MAX_CONN`
			`default 5`

Create proper fix for split default conn bug 4 years ago			`config BT_GAP_AUTO_UPDATE_CONN_PARAMS`
			`default n`

Tweaks for turning off USB for split peripherals. 5 years ago			`endif`

Lots of work on split peripheral/central logic. 5 years ago			`endchoice`

			`endif`

Initial exploration of split BLE service. * Service for split peripheral to report position state to split central. * Updated advertising info. * Behavior for split BT until we have a proper event system. 5 years ago			`endif`

			`endmenu`


Add a mock kscan driver, working native_posix. * Unified logging to one module. * Mock kscan driver that simulates events. * Working native_posix board target for testing. 5 years ago			`config ZMK_KSCAN_MOCK_DRIVER`
			`bool "Enable mock kscan driver to simulate key presses"`
			`default n`
Full NKRO support, fixes for keymap key selection. 5 years ago
Initial composite kscan driver. * For now, to be used for FrankenKyria, where both matrix halves will be attached to the same MCU, but should be a stepping stone to proper split support once we have a kscan driver over a split transport. * Implement multiple instances for mock kscan driver. 5 years ago
			`config ZMK_KSCAN_COMPOSITE_DRIVER`
			`bool "Enable composite kscan driver to combine kscan devices"`
			`default n`

Initial exploration of mod tap action. 5 years ago			`menu "ZMK Actions"`

			`config ZMK_ACTION_MOD_TAP`
			`bool "Enable the Mod-Tap Action"`

			`endmenu`

Add base files and configuration for RGB underglow 4 years ago			`menu "ZMK Lighting"`

			`menuconfig ZMK_RGB_UNDERGLOW`
			`bool "RGB Adressable LED Underglow"`
			`select LED_STRIP`

			`if ZMK_RGB_UNDERGLOW`

			`config ZMK_RGB_UNDERGLOW_HUE_STEP`
			`int "RGB underglow hue step in degrees of 360"`
			`default 10`

			`config ZMK_RGB_UNDERGLOW_SAT_STEP`
			`int "RGB underglow sturation step in percent"`
			`default 10`

			`config ZMK_RGB_UNDERGLOW_BRT_STEP`
			`int "RGB underglow brightness step in percent"`
			`default 10`

feat(rgb): underglow state Kconfig and settings 4 years ago			`config ZMK_RGB_UNDERGLOW_HUE_START`
			`int "RGB underglow start hue value from 0-359"`
			`default 0`

			`config ZMK_RGB_UNDERGLOW_SAT_START`
			`int "RGB underglow start saturations value from 0-100"`
			`default 100`

			`config ZMK_RGB_UNDERGLOW_BRT_START`
			`int "RGB underglow start brightness value from 0-100"`
			`default 100`

			`config ZMK_RGB_UNDERGLOW_SPD_START`
			`int "RGB underglow start animation speed value from 1-5"`
			`default 3`

			`config ZMK_RGB_UNDERGLOW_EFF_START`
			`int "RGB underglow start effect int value related to the effect enum list"`
			`default 0`

			`config ZMK_RGB_UNDERGLOW_ON_START`
			`bool "Whether RGB underglow starts on by default"`
			`default y`

Add base files and configuration for RGB underglow 4 years ago			`endif`

			`endmenu`

Initial event manager work, and two first events. * Add initial event manager implementation, roughly mimicking Nordic's API. * Add `position_state_changed` and `keycode_state_changed` events. * Hook up HID and keymap to new events instead of using behaviour global event crazy. 5 years ago			`config HEAP_MEM_POOL_SIZE`
Initial display support. 4 years ago			`default 8192`
Initial event manager work, and two first events. * Add initial event manager implementation, roughly mimicking Nordic's API. * Add `position_state_changed` and `keycode_state_changed` events. * Hook up HID and keymap to new events instead of using behaviour global event crazy. 5 years ago
Fixes for building with a different .conf file. 4 years ago			`config KERNEL_BIN_NAME`
			`default "zmk"`

			`config REBOOT`
			`default y`

Add a mock kscan driver, working native_posix. * Unified logging to one module. * Mock kscan driver that simulates events. * Working native_posix board target for testing. 5 years ago			`module = ZMK`
			`module-str = zmk`
Full NKRO support, fixes for keymap key selection. 5 years ago			`source "subsys/logging/Kconfig.template.log_config"`

Fixes for multiple GPIO kscan devices as expected. 5 years ago			`rsource "boards/Kconfig"`
			`rsource "boards/shields/*/Kconfig.defconfig"`

Message queue and work item for process scan events. * Prep for using ISR for kscan GPIO, by moving event process into a work item. 5 years ago			`source "Kconfig.zephyr"`
Fixes for multiple GPIO kscan devices as expected. 5 years ago