Merge branch 'advanced-clock+24h' into advanced

Completely refactors the simple clock face
and lays the foundations for new features.

Also adds a compile time 24 hour mode only feature.

Tested-by: Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com>
Tested-on-hardware-by: Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com>
Signed-off-by: Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com>
GitHub-Pull-Request: https://github.com/joeycastillo/Sensor-Watch/pull/373

7 files changed, 324 insertions, 190 deletions

diff --git a/make.mk b/make.mk
index 891f9363..bb2d1537 100644
--- a/make.mk
+++ b/make.mk
@@ -230,3 +230,9 @@ endif
 ifeq ($(BOARD), OSO-FEAL-A1-00)
 CFLAGS += -DCRYSTALLESS
 endif
+
+# Build options to customize movement and faces
+
+ifdef CLOCK_FACE_24H_ONLY
+CFLAGS += -DCLOCK_FACE_24H_ONLY
+endif
diff --git a/movement/make/Makefile b/movement/make/Makefile
index faeaa6b8..5d53ff7b 100644
--- a/movement/make/Makefile
+++ b/movement/make/Makefile
@@ -51,7 +51,7 @@ SRCS += \
   ../filesystem.c \
   ../shell.c \
   ../shell_cmd_list.c \
-  ../watch_faces/clock/simple_clock_face.c \
+  ../watch_faces/clock/clock_face.c \
   ../watch_faces/clock/world_clock_face.c \
   ../watch_faces/clock/beats_face.c \
   ../watch_faces/clock/weeknumber_clock_face.c \
diff --git a/movement/movement_config.h b/movement/movement_config.h
index 10a30af7..72203ebd 100644
--- a/movement/movement_config.h
+++ b/movement/movement_config.h
@@ -28,7 +28,7 @@
 #include "movement_faces.h"
 
 const watch_face_t watch_faces[] = {
-    simple_clock_face,
+    clock_face,
     world_clock_face,
     sunrise_sunset_face,
     moon_phase_face,
diff --git a/movement/movement_faces.h b/movement/movement_faces.h
index 7feb0f40..949a071a 100644
--- a/movement/movement_faces.h
+++ b/movement/movement_faces.h
@@ -25,7 +25,7 @@
 #ifndef MOVEMENT_FACES_H_
 #define MOVEMENT_FACES_H_
 
-#include "simple_clock_face.h"
+#include "clock_face.h"
 #include "world_clock_face.h"
 #include "preferences_face.h"
 #include "set_time_face.h"
diff --git a/movement/watch_faces/clock/clock_face.c b/movement/watch_faces/clock/clock_face.c
new file mode 100644
index 00000000..eab5cd8d
--- /dev/null
+++ b/movement/watch_faces/clock/clock_face.c
@@ -0,0 +1,291 @@
+/* SPDX-License-Identifier: MIT */
+
+/*
+ * MIT License
+ *
+ * Copyright © 2021-2023 Joey Castillo <joeycastillo@utexas.edu> <jose.castillo@gmail.com>
+ * Copyright © 2022 David Keck <davidskeck@users.noreply.github.com>
+ * Copyright © 2022 TheOnePerson <a.nebinger@web.de>
+ * Copyright © 2023 Jeremy O'Brien <neutral@fastmail.com>
+ * Copyright © 2023 Mikhail Svarichevsky <3@14.by>
+ * Copyright © 2023 Wesley Aptekar-Cassels <me@wesleyac.com>
+ * Copyright © 2024 Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include <stdlib.h>
+#include "clock_face.h"
+#include "watch.h"
+#include "watch_utility.h"
+#include "watch_private_display.h"
+
+// 2.2 volts will happen when the battery has maybe 5-10% remaining?
+// we can refine this later.
+#ifndef CLOCK_FACE_LOW_BATTERY_VOLTAGE_THRESHOLD
+#define CLOCK_FACE_LOW_BATTERY_VOLTAGE_THRESHOLD 2200
+#endif
+
+#ifndef CLOCK_FACE_24H_ONLY
+#define CLOCK_FACE_24H_ONLY 0
+#endif
+
+typedef struct {
+    struct {
+        watch_date_time previous;
+    } date_time;
+    uint8_t last_battery_check;
+    uint8_t watch_face_index;
+    bool time_signal_enabled;
+    bool battery_low;
+} clock_state_t;
+
+static bool clock_is_in_24h_mode(movement_settings_t *settings) {
+    if (CLOCK_FACE_24H_ONLY) { return true; }
+    return settings->bit.clock_mode_24h;
+}
+
+static void clock_indicate(WatchIndicatorSegment indicator, bool on) {
+    if (on) {
+        watch_set_indicator(indicator);
+    } else {
+        watch_clear_indicator(indicator);
+    }
+}
+
+static void clock_indicate_alarm(movement_settings_t *settings) {
+    clock_indicate(WATCH_INDICATOR_BELL, settings->bit.alarm_enabled);
+}
+
+static void clock_indicate_time_signal(clock_state_t *clock) {
+    clock_indicate(WATCH_INDICATOR_SIGNAL, clock->time_signal_enabled);
+}
+
+static void clock_indicate_24h(movement_settings_t *settings) {
+    clock_indicate(WATCH_INDICATOR_24H, clock_is_in_24h_mode(settings));
+}
+
+static bool clock_is_pm(watch_date_time date_time) {
+    return date_time.unit.hour >= 12;
+}
+
+static void clock_indicate_pm(movement_settings_t *settings, watch_date_time date_time) {
+    if (settings->bit.clock_mode_24h) { return; }
+    clock_indicate(WATCH_INDICATOR_PM, clock_is_pm(date_time));
+}
+
+static void clock_indicate_low_available_power(clock_state_t *clock) {
+    // Set the LAP indicator if battery power is low
+    clock_indicate(WATCH_INDICATOR_LAP, clock->battery_low);
+}
+
+static watch_date_time clock_24h_to_12h(watch_date_time date_time) {
+    date_time.unit.hour %= 12;
+
+    if (date_time.unit.hour == 0) {
+        date_time.unit.hour = 12;
+    }
+
+    return date_time;
+}
+
+static void clock_check_battery_periodically(clock_state_t *clock, watch_date_time date_time) {
+    // check the battery voltage once a day
+    if (date_time.unit.day == clock->last_battery_check) { return; }
+
+    clock->last_battery_check = date_time.unit.day;
+
+    watch_enable_adc();
+    uint16_t voltage = watch_get_vcc_voltage();
+    watch_disable_adc();
+
+    clock->battery_low = voltage < CLOCK_FACE_LOW_BATTERY_VOLTAGE_THRESHOLD;
+
+    clock_indicate_low_available_power(clock);
+}
+
+static void clock_toggle_time_signal(clock_state_t *clock) {
+    clock->time_signal_enabled = !clock->time_signal_enabled;
+    clock_indicate_time_signal(clock);
+}
+
+static void clock_display_all(watch_date_time date_time) {
+    char buf[10 + 1];
+
+    snprintf(
+        buf,
+        sizeof(buf),
+        "%s%2d%2d%02d%02d",
+        watch_utility_get_weekday(date_time),
+        date_time.unit.day,
+        date_time.unit.hour,
+        date_time.unit.minute,
+        date_time.unit.second
+    );
+
+    watch_display_string(buf, 0);
+}
+
+static bool clock_display_some(watch_date_time current, watch_date_time previous) {
+    if ((current.reg >> 6) == (previous.reg >> 6)) {
+        // everything before seconds is the same, don't waste cycles setting those segments.
+
+        watch_display_character_lp_seconds('0' + current.unit.second / 10, 8);
+        watch_display_character_lp_seconds('0' + current.unit.second % 10, 9);
+
+        return true;
+
+    } else if ((current.reg >> 12) == (previous.reg >> 12)) {
+        // everything before minutes is the same.
+
+        char buf[4 + 1];
+
+        snprintf(
+            buf,
+            sizeof(buf),
+            "%02d%02d",
+            current.unit.minute,
+            current.unit.second
+        );
+
+        watch_display_string(buf, 6);
+
+        return true;
+
+    } else {
+        // other stuff changed; let's do it all.
+        return false;
+    }
+}
+
+static void clock_display_clock(movement_settings_t *settings, clock_state_t *clock, watch_date_time current) {
+    if (!clock_display_some(current, clock->date_time.previous)) {
+        if (!clock_is_in_24h_mode(settings)) {
+            // if we are in 12 hour mode, do some cleanup.
+            clock_indicate_pm(settings, current);
+            current = clock_24h_to_12h(current);
+        }
+        clock_display_all(current);
+    }
+}
+
+static void clock_display_low_energy(watch_date_time date_time) {
+    char buf[10 + 1];
+
+    snprintf(
+        buf,
+        sizeof(buf),
+        "%s%2d%2d%02d  ",
+        watch_utility_get_weekday(date_time),
+        date_time.unit.day,
+        date_time.unit.hour,
+        date_time.unit.minute
+    );
+
+    watch_display_string(buf, 0);
+}
+
+static void clock_start_tick_tock_animation(void) {
+    if (!watch_tick_animation_is_running()) {
+        watch_start_tick_animation(500);
+    }
+}
+
+static void clock_stop_tick_tock_animation(void) {
+    if (watch_tick_animation_is_running()) {
+        watch_stop_tick_animation();
+    }
+}
+
+void clock_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr) {
+    (void) settings;
+    (void) watch_face_index;
+
+    if (*context_ptr == NULL) {
+        *context_ptr = malloc(sizeof(clock_state_t));
+        clock_state_t *state = (clock_state_t *) *context_ptr;
+        state->time_signal_enabled = false;
+        state->watch_face_index = watch_face_index;
+    }
+}
+
+void clock_face_activate(movement_settings_t *settings, void *context) {
+    clock_state_t *clock = (clock_state_t *) context;
+
+    clock_stop_tick_tock_animation();
+
+    clock_indicate_time_signal(clock);
+    clock_indicate_alarm(settings);
+    clock_indicate_24h(settings);
+
+    watch_set_colon();
+
+    // this ensures that none of the timestamp fields will match, so we can re-render them all.
+    clock->date_time.previous.reg = 0xFFFFFFFF;
+}
+
+bool clock_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
+    clock_state_t *state = (clock_state_t *) context;
+    watch_date_time current;
+
+    switch (event.event_type) {
+        case EVENT_LOW_ENERGY_UPDATE:
+            clock_start_tick_tock_animation();
+            clock_display_low_energy(watch_rtc_get_date_time());
+            break;
+        case EVENT_TICK:
+        case EVENT_ACTIVATE:
+            current = watch_rtc_get_date_time();
+
+            clock_display_clock(settings, state, current);
+
+            clock_check_battery_periodically(state, current);
+
+            state->date_time.previous = current;
+
+            break;
+        case EVENT_ALARM_LONG_PRESS:
+            clock_toggle_time_signal(state);
+            break;
+        case EVENT_BACKGROUND_TASK:
+            // uncomment this line to snap back to the clock face when the hour signal sounds:
+            // movement_move_to_face(state->watch_face_index);
+            movement_play_signal();
+            break;
+        default:
+            return movement_default_loop_handler(event, settings);
+    }
+
+    return true;
+}
+
+void clock_face_resign(movement_settings_t *settings, void *context) {
+    (void) settings;
+    (void) context;
+}
+
+bool clock_face_wants_background_task(movement_settings_t *settings, void *context) {
+    (void) settings;
+    clock_state_t *state = (clock_state_t *) context;
+    if (!state->time_signal_enabled) return false;
+
+    watch_date_time date_time = watch_rtc_get_date_time();
+
+    return date_time.unit.minute == 0;
+}
diff --git a/movement/watch_faces/clock/simple_clock_face.h b/movement/watch_faces/clock/clock_face.h
index e74a6e86..c4209e3b 100644
--- a/movement/watch_faces/clock/simple_clock_face.h
+++ b/movement/watch_faces/clock/clock_face.h
@@ -1,7 +1,13 @@
+/* SPDX-License-Identifier: MIT */
+
 /*
  * MIT License
  *
- * Copyright (c) 2022 Joey Castillo
+ * Copyright © 2021-2022 Joey Castillo <joeycastillo@utexas.edu> <jose.castillo@gmail.com>
+ * Copyright © 2022 Alexsander Akers <me@a2.io>
+ * Copyright © 2022 TheOnePerson <a.nebinger@web.de>
+ * Copyright © 2023 Alex Utter <ooterness@gmail.com>
+ * Copyright © 2024 Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -22,41 +28,33 @@
  * SOFTWARE.
  */
 
-#ifndef SIMPLE_CLOCK_FACE_H_
-#define SIMPLE_CLOCK_FACE_H_
+#ifndef CLOCK_FACE_H_
+#define CLOCK_FACE_H_
 
 /*
- * SIMPLE CLOCK FACE
+ * CLOCK FACE
  *
- * Displays the current time, matching the original operation of the watch.
+ * Displays the current local time, just like the original watch.
  * This is the default display mode in most watch configurations.
  *
  * Long-press ALARM to toggle the hourly chime.
+ *
  */
 
 #include "movement.h"
 
-typedef struct {
-    uint32_t previous_date_time;
-    uint8_t last_battery_check;
-    uint8_t watch_face_index;
-    bool signal_enabled;
-    bool battery_low;
-    bool alarm_enabled;
-} simple_clock_state_t;
-
-void simple_clock_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
-void simple_clock_face_activate(movement_settings_t *settings, void *context);
-bool simple_clock_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
-void simple_clock_face_resign(movement_settings_t *settings, void *context);
-bool simple_clock_face_wants_background_task(movement_settings_t *settings, void *context);
+void clock_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
+void clock_face_activate(movement_settings_t *settings, void *context);
+bool clock_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
+void clock_face_resign(movement_settings_t *settings, void *context);
+bool clock_face_wants_background_task(movement_settings_t *settings, void *context);
 
-#define simple_clock_face ((const watch_face_t){ \
-    simple_clock_face_setup, \
-    simple_clock_face_activate, \
-    simple_clock_face_loop, \
-    simple_clock_face_resign, \
-    simple_clock_face_wants_background_task, \
+#define clock_face ((const watch_face_t) { \
+    clock_face_setup, \
+    clock_face_activate, \
+    clock_face_loop, \
+    clock_face_resign, \
+    clock_face_wants_background_task, \
 })
 
-#endif // SIMPLE_CLOCK_FACE_H_
+#endif // CLOCK_FACE_H_
diff --git a/movement/watch_faces/clock/simple_clock_face.c b/movement/watch_faces/clock/simple_clock_face.c
deleted file mode 100644
index fbc2c4b3..00000000
--- a/movement/watch_faces/clock/simple_clock_face.c
+++ /dev/null
@@ -1,161 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2022 Joey Castillo
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-#include <stdlib.h>
-#include "simple_clock_face.h"
-#include "watch.h"
-#include "watch_utility.h"
-#include "watch_private_display.h"
-
-static void _update_alarm_indicator(bool settings_alarm_enabled, simple_clock_state_t *state) {
-    state->alarm_enabled = settings_alarm_enabled;
-    if (state->alarm_enabled) watch_set_indicator(WATCH_INDICATOR_SIGNAL);
-    else watch_clear_indicator(WATCH_INDICATOR_SIGNAL);
-}
-
-void simple_clock_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr) {
-    (void) settings;
-    (void) watch_face_index;
-
-    if (*context_ptr == NULL) {
-        *context_ptr = malloc(sizeof(simple_clock_state_t));
-        simple_clock_state_t *state = (simple_clock_state_t *)*context_ptr;
-        state->signal_enabled = false;
-        state->watch_face_index = watch_face_index;
-    }
-}
-
-void simple_clock_face_activate(movement_settings_t *settings, void *context) {
-    simple_clock_state_t *state = (simple_clock_state_t *)context;
-
-    if (watch_tick_animation_is_running()) watch_stop_tick_animation();
-
-    if (settings->bit.clock_mode_24h) watch_set_indicator(WATCH_INDICATOR_24H);
-
-    // handle chime indicator
-    if (state->signal_enabled) watch_set_indicator(WATCH_INDICATOR_BELL);
-    else watch_clear_indicator(WATCH_INDICATOR_BELL);
-
-    // show alarm indicator if there is an active alarm
-    _update_alarm_indicator(settings->bit.alarm_enabled, state);
-
-    watch_set_colon();
-
-    // this ensures that none of the timestamp fields will match, so we can re-render them all.
-    state->previous_date_time = 0xFFFFFFFF;
-}
-
-bool simple_clock_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
-    simple_clock_state_t *state = (simple_clock_state_t *)context;
-    char buf[11];
-    uint8_t pos;
-
-    watch_date_time date_time;
-    uint32_t previous_date_time;
-    switch (event.event_type) {
-        case EVENT_ACTIVATE:
-        case EVENT_TICK:
-        case EVENT_LOW_ENERGY_UPDATE:
-            date_time = watch_rtc_get_date_time();
-            previous_date_time = state->previous_date_time;
-            state->previous_date_time = date_time.reg;
-
-            // check the battery voltage once a day...
-            if (date_time.unit.day != state->last_battery_check) {
-                state->last_battery_check = date_time.unit.day;
-                watch_enable_adc();
-                uint16_t voltage = watch_get_vcc_voltage();
-                watch_disable_adc();
-                // 2.2 volts will happen when the battery has maybe 5-10% remaining?
-                // we can refine this later.
-                state->battery_low = (voltage < 2200);
-            }
-
-            // ...and set the LAP indicator if low.
-            if (state->battery_low) watch_set_indicator(WATCH_INDICATOR_LAP);
-
-            if ((date_time.reg >> 6) == (previous_date_time >> 6) && event.event_type != EVENT_LOW_ENERGY_UPDATE) {
-                // everything before seconds is the same, don't waste cycles setting those segments.
-                watch_display_character_lp_seconds('0' + date_time.unit.second / 10, 8);
-                watch_display_character_lp_seconds('0' + date_time.unit.second % 10, 9);
-                break;
-            } else if ((date_time.reg >> 12) == (previous_date_time >> 12) && event.event_type != EVENT_LOW_ENERGY_UPDATE) {
-                // everything before minutes is the same.
-                pos = 6;
-                sprintf(buf, "%02d%02d", date_time.unit.minute, date_time.unit.second);
-            } else {
-                // other stuff changed; let's do it all.
-                if (!settings->bit.clock_mode_24h) {
-                    // if we are in 12 hour mode, do some cleanup.
-                    if (date_time.unit.hour < 12) {
-                        watch_clear_indicator(WATCH_INDICATOR_PM);
-                    } else {
-                        watch_set_indicator(WATCH_INDICATOR_PM);
-                    }
-                    date_time.unit.hour %= 12;
-                    if (date_time.unit.hour == 0) date_time.unit.hour = 12;
-                }
-                pos = 0;
-                if (event.event_type == EVENT_LOW_ENERGY_UPDATE) {
-                    if (!watch_tick_animation_is_running()) watch_start_tick_animation(500);
-                    sprintf(buf, "%s%2d%2d%02d  ", watch_utility_get_weekday(date_time), date_time.unit.day, date_time.unit.hour, date_time.unit.minute);
-                } else {
-                    sprintf(buf, "%s%2d%2d%02d%02d", watch_utility_get_weekday(date_time), date_time.unit.day, date_time.unit.hour, date_time.unit.minute, date_time.unit.second);
-                }
-            }
-            watch_display_string(buf, pos);
-            // handle alarm indicator
-            if (state->alarm_enabled != settings->bit.alarm_enabled) _update_alarm_indicator(settings->bit.alarm_enabled, state);
-            break;
-        case EVENT_ALARM_LONG_PRESS:
-            state->signal_enabled = !state->signal_enabled;
-            if (state->signal_enabled) watch_set_indicator(WATCH_INDICATOR_BELL);
-            else watch_clear_indicator(WATCH_INDICATOR_BELL);
-            break;
-        case EVENT_BACKGROUND_TASK:
-            // uncomment this line to snap back to the clock face when the hour signal sounds:
-            // movement_move_to_face(state->watch_face_index);
-            movement_play_signal();
-            break;
-        default:
-            return movement_default_loop_handler(event, settings);
-    }
-
-    return true;
-}
-
-void simple_clock_face_resign(movement_settings_t *settings, void *context) {
-    (void) settings;
-    (void) context;
-}
-
-bool simple_clock_face_wants_background_task(movement_settings_t *settings, void *context) {
-    (void) settings;
-    simple_clock_state_t *state = (simple_clock_state_t *)context;
-    if (!state->signal_enabled) return false;
-
-    watch_date_time date_time = watch_rtc_get_date_time();
-
-    return date_time.unit.minute == 0;
-}