Skip to content

Commit

Permalink
Adding some additional clarity around soft-off
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick-Munnich committed Aug 23, 2024
1 parent 5f056f7 commit 42cdca5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/docs/config/power.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ 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.
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. To allow a device to wake from deep sleep, the `wakeup-source` property needs to be applied to the `kscan` driver of said device. See [soft off](../features/soft-off.md#wakeup-sources) for an example.

### Kconfig

Expand Down
13 changes: 9 additions & 4 deletions docs/docs/features/soft-off.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Soft Off Feature
sidebar_label: Soft Off
---

Similar to the deep sleep feature that sends the keyboard into a low power state after a certain period of inactivity, the soft off feature is used to turn the keyboard on and off explicitly. Depending on the keyboard, this may be through a dedicated on/off push button, or merely through an additional binding in the keymap to turn the device off and the existing reset button to turn the device back on.
Similar to the deep sleep feature that sends the keyboard into a low power state after a certain period of inactivity, the soft off feature is used to turn the keyboard on and off explicitly. Depending on the keyboard, this may be through a dedicated on/off push button defined in hardware, or merely through an additional binding in the keymap to turn the device off and an existing reset button to turn the device back on.

The feature is intended as an alternative to using a hardware switch to physically cut power from the battery to the keyboard. This can be useful for existing PCBs not designed for wireless that don't have a power switch, or for new designs that favor a push button on/off like found on other devices.

Expand All @@ -13,10 +13,15 @@ The power off is accomplished by putting the MCU into a "soft off" state. Power

:::

Once powered off, the keyboard will only wake up when:
Causing a device to enter the soft-off state is done by:

- You press the same button/sequence that you pressed to power off the keyboard, or
- You press a reset button found on the keyboard.
- Triggering a hardware-defined dedicated GPIO pin, if one exists;
- Triggering the [Soft Off Behavior](../behaviors/soft-off.md) from the keymap.

Once in the soft-off state, the device will only wake up when:

- A hardware-defined dedicated GPIO pin is triggered, if one exists;
- A reset button found on the device is pressed.

## Config

Expand Down

0 comments on commit 42cdca5

Please sign in to comment.