@ -10,8 +10,8 @@
[st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat& colorA=dfb317& colorB=494e52
[st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat& colorA=dfb317& colorB=494e52
Support performing custom actions whenever the host suspends, resumes, or is
Support performing custom actions whenever the host suspends, resumes, or is
sleeping. By default, the LEDs will be turned off on suspend, and the previous
sleeping. Additionally, this plugin provides optional support for the keyboard
LED mode restored on resume .
to wake the host up from suspend .
## Using the plugin
## Using the plugin
@ -41,11 +41,6 @@ The plugin provides the `HostPowerManagement` object, which has the following me
>
>
> Once enabled, it **cannot** be disabled again.
> Once enabled, it **cannot** be disabled again.
### `.toggleLEDs(event)`
> Turns LEDs off on suspend, restores the previous LED mode on resume. This is
> called by `hostPowerManagementEventHandler()` by default.
## Overrideable methods
## Overrideable methods
### `hostPowerManagementEventHandler(event)`
### `hostPowerManagementEventHandler(event)`
@ -58,12 +53,7 @@ The plugin provides the `HostPowerManagement` object, which has the following me
> cycle while the host is suspended; `kaleidoscope::HostPowerManagement::Resume` is
> cycle while the host is suspended; `kaleidoscope::HostPowerManagement::Resume` is
> fired once when the host wakes up.
> fired once when the host wakes up.
>
>
> The default implementation calls `HostPowerManagement.toggleLEDs` . When overriding the
> The default implementation is empty.
> function, the default is lost.
## Dependencies
* [Kaleidoscope-LEDControl ](https://github.com/keyboardio/Kaleidoscope-LEDControl )
## Further reading
## Further reading