fern/sensor-watch
1
0
Fork 0
mirror of https://github.com/firewalkwithm3/Sensor-Watch.git synced 2024-11-22 11:10:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

document return value of watch_face_loop

Browse source
This commit is contained in:
joeycastillo 2022-10-11 23:53:02 -05:00
parent 957f97ffad
commit f89cecc56a
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
movement/movement.h
View file

@ -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