From d1daf9ec9664b2d2df3ec408ea39bbd391665e24 Mon Sep 17 00:00:00 2001 From: Michael Richters Date: Tue, 12 Mar 2019 12:45:35 -0500 Subject: [PATCH] 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 --- doc/plugin/HostPowerManagement.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/plugin/HostPowerManagement.md b/doc/plugin/HostPowerManagement.md index e5035a13..87098b74 100644 --- a/doc/plugin/HostPowerManagement.md +++ b/doc/plugin/HostPowerManagement.md @@ -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. +