7178cba204
This adds an optional feature to trigger an action if a specific key is held when the keyboard is powered on. It can be configured to jump to the bootloader and/or clear settings. This is inspired by QMK's "bootmagic lite" feature, and it is primarily intended as a way to recover a keyboard which doesn't have a physical reset button in case it is flashed with firmware that doesn't have a &bootloader key in its keymap. It can also be used to clear BLE bonds on the peripheral side of a split keyboard without needing to flash special firmware.
23 lines
746 B
YAML
23 lines
746 B
YAML
# Copyright (c) 2023, The ZMK Contributors
|
|
# SPDX-License-Identifier: MIT
|
|
|
|
description: |
|
|
Triggers one or more actions if a specific key is held while the keyboard boots.
|
|
This is typically used for recovering a keyboard in cases such as &bootloader
|
|
being missing from the keymap or a split peripheral which isn't connected to
|
|
the central, and therefore can't process th ekeymap.
|
|
|
|
compatible: "zmk,boot-magic-key"
|
|
|
|
properties:
|
|
key-position:
|
|
type: int
|
|
default: 0
|
|
description: Zero-based index of the key which triggers the action(s).
|
|
# Boot magic actions:
|
|
jump-to-bootloader:
|
|
type: boolean
|
|
description: Reboots into the bootloader.
|
|
reset-settings:
|
|
type: boolean
|
|
description: Clears settings and reboots.
|