HostPowerManagement: add documentation about sleep delay on macOS

Some systems (I've confirmed this on an iMac and a MacBook Escape) have a long delay after
the host begins to "sleep" and the keyboard responding to the HostPowerManagement
plugin (i.e. turning off LEDs).

Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
pull/599/head
Michael Richters 6 years ago
parent 9772f3d9ad
commit d1daf9ec96
No known key found for this signature in database
GPG Key ID: C40C181A55000EF6

@ -45,3 +45,12 @@ Starting from the [example][plugin:example] is the recommended way of getting
started with the plugin.
[plugin:example]: ../../examples/Features/HostPowerManagement/HostPowerManagement.ino
## 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.

Loading…
Cancel
Save