summaryrefslogtreecommitdiffstats
path: root/watch-library/watch/watch.h
diff options
context:
space:
mode:
Diffstat (limited to 'watch-library/watch/watch.h')
-rw-r--r--watch-library/watch/watch.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/watch-library/watch/watch.h b/watch-library/watch/watch.h
index 8c207ddb..5cd45a6c 100644
--- a/watch-library/watch/watch.h
+++ b/watch-library/watch/watch.h
@@ -65,4 +65,12 @@
#include "watch_private.h"
+/** @brief Returns true when the battery voltage dips below 2.5V.
+ * @details A CR2016 battery will have a nominal voltage between 2.9 and 3 volts for most of its lifespan. Once the battery
+ * discharges to about 60%, the voltage will drift slightly lower; this may manifest as a dimmer LED. By the time
+ * the battery voltage has fallen to 2.5 volts, it will have probably less than 10% of its capacity remaining, and
+ * you can expect the voltage to drop relatively quickly as the battery dies.
+ */
+bool watch_is_battery_low();
+
#endif /* WATCH_H_ */ \ No newline at end of file