History

Michael Richters cf5c19dd6c Standardize namespace block closing comments This standardizes namespace closing brackets for namespace blocks. Each one is on its own line, with a comment clearly marking which namespace it closes. Consecutive lines closing namespace blocks have no whitespace between them, but there is one blank line before and after a set of namespace block closing lines. To generate the namespace comments, I used clang-format, with `FixNamespaceComments: true`. But since clang-format can't exactly duplicate our astyle formatting, it made lots of other changes, too. To isolate the namespace comments from the other formatting changes, I first ran clang-format with `FixNamespaceComments: false`, committed those changes, then ran it again to generate the namespace comments. Then I stashed the namespace comments, reset `HEAD` to remove the other changes, applied the stashed namespace comments, and committed the results (after examining them and making a few minor adjustments by hand). Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>		3 years ago
..
src	Standardize namespace block closing comments	3 years ago
README.md	Cleanups for typos and broken links across the documentation	4 years ago
library.properties	More library tweaking to comply with arduino requirements	4 years ago

README.md

HostPowerManagement

Support performing custom actions whenever the host suspends, resumes, or is sleeping.

Using the plugin

To use the plugin, one needs to include the header, and activate it. No further configuration is necessary, unless one wants to perform custom actions.

#include <Kaleidoscope.h>
#include <Kaleidoscope-HostPowerManagement.h>

KALEIDOSCOPE_INIT_PLUGINS(HostPowerManagement);

void setup () {
  Kaleidoscope.setup ();
}

Plugin methods

The plugin provides the HostPowerManagement object, with no public methods.

Overridable methods

`hostPowerManagementEventHandler(event)`

The hostPowerManagementEventHandler method is the brain of the plugin: this function tells it what action to perform in response to the various events.

Currently supported events are: kaleidoscope::plugin::HostPowerManagement::Suspend is fired once when the host suspends; kaleidoscope::plugin::HostPowerManagement::Sleep is fired every cycle while the host is suspended; kaleidoscope::plugin::HostPowerManagement::Resume is fired once when the host wakes up.

The default implementation is empty.

Caveats

On some systems, there can be a long delay between suspending/sleeping the host and the firmware responding to it and calling hostPowerManagementEventHandler(). In particular, on macOS, it can take 30 seconds or more after invoking "sleep" mode on the host before the keyboard responds. One user reports that it can take more than a minute, so if this plugin doesn't appear to be working, please wait a few minutes and check again.