summaryrefslogtreecommitdiffstats
path: root/watch-library/watch
diff options
context:
space:
mode:
authorJoey Castillo <jose.castillo@gmail.com>2021-08-08 15:12:12 -0400
committerJoey Castillo <jose.castillo@gmail.com>2021-08-08 15:12:12 -0400
commitac7807d9f562925402a6ae40ecc9d2d3b074dcb8 (patch)
tree5c1ff1495a447464434c5694e9ce9bdf7bbb6ed2 /watch-library/watch
parente45fdf15afc2803b67d7a0bff15922315c1e11e7 (diff)
downloadSensor-Watch-ac7807d9f562925402a6ae40ecc9d2d3b074dcb8.tar.gz
Sensor-Watch-ac7807d9f562925402a6ae40ecc9d2d3b074dcb8.tar.bz2
Sensor-Watch-ac7807d9f562925402a6ae40ecc9d2d3b074dcb8.zip
document indicator segments
Diffstat (limited to 'watch-library/watch')
-rw-r--r--watch-library/watch/watch.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/watch-library/watch/watch.h b/watch-library/watch/watch.h
index 29881292..2c3f9fad 100644
--- a/watch-library/watch/watch.h
+++ b/watch-library/watch/watch.h
@@ -112,12 +112,13 @@ void _watch_init();
*/
/// @{
+/// An enum listing the icons and indicators available on the watch.
typedef enum WatchIndicatorSegment {
- WATCH_INDICATOR_SIGNAL = 0,
- WATCH_INDICATOR_BELL,
- WATCH_INDICATOR_PM,
- WATCH_INDICATOR_24H,
- WATCH_INDICATOR_LAP
+ WATCH_INDICATOR_SIGNAL = 0, ///< The hourly signal indicator; also useful for indicating that sensors are on.
+ WATCH_INDICATOR_BELL, ///< The small bell indicating that an alarm is set.
+ WATCH_INDICATOR_PM, ///< The PM indicator, indicating that a time is in the afternoon.
+ WATCH_INDICATOR_24H, ///< The 24H indicator, indicating that the watch is in a 24-hour mode.
+ WATCH_INDICATOR_LAP ///< The LAP indicator; the F-91W uses this in its stopwatch UI.
} WatchIndicatorSegment;
/** @brief Enables the Segment LCD display.