summaryrefslogtreecommitdiffstats
path: root/movement/movement.h
diff options
context:
space:
mode:
authorjoeycastillo <joeycastillo@utexas.edu>2022-10-15 08:52:34 -0500
committerGitHub <noreply@github.com>2022-10-15 08:52:34 -0500
commit5bd0aafc24afffe33d4a014bc9af9865f708a65b (patch)
tree67fb27fc62681eb4ebeed186a87e8a7ba9e2056f /movement/movement.h
parent4d860f482e68f125788248ec63bd2b9a9120183d (diff)
parent1bb656db91c6b5b9bc4a5cf60c49b14d346731df (diff)
downloadSensor-Watch-5bd0aafc24afffe33d4a014bc9af9865f708a65b.tar.gz
Sensor-Watch-5bd0aafc24afffe33d4a014bc9af9865f708a65b.tar.bz2
Sensor-Watch-5bd0aafc24afffe33d4a014bc9af9865f708a65b.zip
Merge pull request #94 from wryun/long-press-home-default
Long press mode button to return to first watch face + fix lag when watch face changes
Diffstat (limited to 'movement/movement.h')
-rw-r--r--movement/movement.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/movement/movement.h b/movement/movement.h
index 0442f607..a013a861 100644
--- a/movement/movement.h
+++ b/movement/movement.h
@@ -174,7 +174,11 @@ typedef void (*watch_face_activate)(movement_settings_t *settings, void *context
* for a list of all possible event types.
* @param settings A pointer to the global Movement settings. @see watch_face_setup.
* @param context A pointer to your application's context. @see watch_face_setup.
- * @return true if Movement can enter STANDBY mode; false to keep it awake. You should almost always return true.
+ * @return true if your watch face is prepared for the system to enter STANDBY mode; false to keep the system awake.
+ * You should almost always return true.
+ * Note that this return value has no effect if your loop function has called movement_move_to_next_face
+ * or movement_move_to_face; in that case, your watch face will resign immediately, and the next watch
+ * face will make the decision on entering standby mode.
* @note There are two event types that require some extra thought:
The EVENT_LOW_ENERGY_UPDATE event type is a special case. If you are in the foreground when the watch
goes into low energy mode, you will receive this tick once a minute (at the top of the minute) so that