movement: add moon phase complication

4 files changed, 234 insertions, 0 deletions

diff --git a/movement/make/Makefile b/movement/make/Makefile
index b70d7092..cc543a93 100755
--- a/movement/make/Makefile
+++ b/movement/make/Makefile
@@ -50,6 +50,7 @@ SRCS += \
   ../watch_faces/complication/sunrise_sunset_face.c \
   ../watch_faces/complication/countdown_face.c \
   ../watch_faces/complication/blinky_face.c \
+  ../watch_faces/complication/moon_phase_face.c \
 # New watch faces go above this line.
 
 # Leave this line at the bottom of the file; it has all the targets for making your project.
diff --git a/movement/movement_faces.h b/movement/movement_faces.h
index ce810b83..ae94efa7 100644
--- a/movement/movement_faces.h
+++ b/movement/movement_faces.h
@@ -44,6 +44,7 @@
 #include "sunrise_sunset_face.h"
 #include "countdown_face.h"
 #include "blinky_face.h"
+#include "moon_phase_face.h"
 // New includes go above this line.
 
 #endif // MOVEMENT_FACES_H_
diff --git a/movement/watch_faces/complication/moon_phase_face.c b/movement/watch_faces/complication/moon_phase_face.c
new file mode 100644
index 00000000..0ff7b254
--- /dev/null
+++ b/movement/watch_faces/complication/moon_phase_face.c
@@ -0,0 +1,184 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022 Joey Castillo
+ *
+ * Based on Phase of Moon App for Tidbyt
+ * https://github.com/tidbyt/community/blob/main/apps/phaseofmoon/phase_of_moon.star
+ * Copyright (c) 2022 Alan Fleming
+ *
+ *
+ * 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 <string.h>
+#include <stdio.h>
+#include <math.h>
+#include "moon_phase_face.h"
+#include "watch_utility.h"
+
+#define LUNAR_DAYS 29.53058770576
+#define LUNAR_SECONDS (LUNAR_DAYS * (24 * 60 * 60))
+#define FIRST_MOON 947182440 // Saturday, 6 January 2000 18:14:00 in unix epoch time
+#define NUM_PHASES 8
+
+static const float phase_changes[] = {0, 1, 6.38264692644, 8.38264692644, 13.76529385288, 15.76529385288, 21.14794077932, 23.14794077932, 28.53058770576, 29.53058770576};
+
+void moon_phase_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(moon_phase_state_t));
+        memset(*context_ptr, 0, sizeof(moon_phase_state_t));
+    }
+}
+
+void moon_phase_face_activate(movement_settings_t *settings, void *context) {
+    (void) settings;
+    (void) context;
+}
+
+static void _update(movement_settings_t *settings, moon_phase_state_t *state, uint32_t offset) {
+    (void)state;
+    char buf[11];
+    watch_date_time date_time = watch_rtc_get_date_time();
+    uint32_t now = watch_utility_date_time_to_unix_time(date_time, movement_timezone_offsets[settings->bit.time_zone] * 60) + offset;
+    date_time = watch_utility_date_time_from_unix_time(now, movement_timezone_offsets[settings->bit.time_zone] * 60);
+    double currentfrac = fmod(now - FIRST_MOON, LUNAR_SECONDS) / LUNAR_SECONDS;
+    double currentday = currentfrac * LUNAR_DAYS;
+    uint8_t phase_index = 0;
+
+    for(phase_index = 0; phase_index <= NUM_PHASES; phase_index++) {
+        if (currentday > phase_changes[phase_index] && currentday <= phase_changes[phase_index + 1]) break;
+    }
+
+    watch_display_string(" ", 0);
+    switch (phase_index) {
+        case 0:
+        case 8:
+            sprintf(buf, "%2d Neu  ", date_time.unit.day);
+            break;
+        case 1:
+            sprintf(buf, "%2dCresnt", date_time.unit.day);
+            watch_set_pixel(2, 13);
+            watch_set_pixel(2, 15);
+            if (currentfrac > 0.125) watch_set_pixel(1, 13);
+            break;
+        case 2:
+            sprintf(buf, "%2d 1st q", date_time.unit.day);
+            watch_set_pixel(2, 13);
+            watch_set_pixel(2, 15);
+            watch_set_pixel(1, 13);
+            watch_set_pixel(1, 14);
+            break;
+        case 3:
+            sprintf(buf, "%2d Gibb ", date_time.unit.day);
+            watch_set_pixel(2, 13);
+            watch_set_pixel(2, 15);
+            watch_set_pixel(1, 14);
+            watch_set_pixel(1, 13);
+            watch_set_pixel(1, 15);
+            break;
+        case 4:
+            sprintf(buf, "%2d FULL ", date_time.unit.day);
+            watch_set_pixel(2, 13);
+            watch_set_pixel(2, 15);
+            watch_set_pixel(1, 14);
+            watch_set_pixel(2, 14);
+            watch_set_pixel(1, 15);
+            watch_set_pixel(0, 14);
+            watch_set_pixel(0, 13);
+            watch_set_pixel(1, 13);
+            break;
+        case 5:
+            sprintf(buf, "%2d Gibb ", date_time.unit.day);
+            watch_set_pixel(1, 14);
+            watch_set_pixel(2, 14);
+            watch_set_pixel(1, 15);
+            watch_set_pixel(0, 14);
+            watch_set_pixel(0, 13);
+            break;
+        case 6:
+            sprintf(buf, "%2d 3rd q", date_time.unit.day);
+            watch_set_pixel(1, 14);
+            watch_set_pixel(2, 14);
+            watch_set_pixel(0, 14);
+            watch_set_pixel(0, 13);
+            break;
+        case 7:
+            sprintf(buf, "%2dCresnt", date_time.unit.day);
+            watch_set_pixel(0, 14);
+            watch_set_pixel(0, 13);
+            if (currentfrac < 0.875) watch_set_pixel(2, 14);
+            break;
+    }
+    watch_display_string(buf, 2);
+}
+
+bool moon_phase_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
+    moon_phase_state_t *state = (moon_phase_state_t *)context;
+    watch_date_time date_time;
+
+    switch (event.event_type) {
+        case EVENT_ACTIVATE:
+            _update(settings, state, state->offset);
+            break;
+        case EVENT_TICK:
+            // only update once an hour
+            date_time = watch_rtc_get_date_time();
+            if ((date_time.unit.minute == 0) && (date_time.unit.second == 0)) _update(settings, state, state->offset);
+            break;
+        case EVENT_LOW_ENERGY_UPDATE:
+            // update at the top of the hour OR if we're entering sleep mode with an offset.
+            // also, in sleep mode, always show the current moon phase (offset = 0).
+            if (state->offset || (watch_rtc_get_date_time().unit.minute == 0)) _update(settings, state, 0);
+            // and kill the offset so when the wearer wakes up, it matches what's on screen.
+            state->offset = 0;
+            // finally: clear out the last two digits and replace them with the sleep mode indicator
+            watch_display_string("  ", 8);
+            if (!watch_tick_animation_is_running()) watch_start_tick_animation(1000);
+            break;
+        case EVENT_MODE_BUTTON_UP:
+            movement_move_to_next_face();
+            break;
+        case EVENT_LIGHT_BUTTON_UP:
+            movement_illuminate_led();
+            break;
+        case EVENT_ALARM_BUTTON_UP:
+            // Pressing the alarm adds an offset of one day to the displayed value,
+            // so you can see moon phases in the future.
+            state->offset += 86400;
+            _update(settings, state, state->offset);
+            break;
+        case EVENT_TIMEOUT:
+            // QUESTION: Should timeout reset offset to 0?
+            break;
+        default:
+            break;
+    }
+
+    return true;
+}
+
+void moon_phase_face_resign(movement_settings_t *settings, void *context) {
+    (void) settings;
+    moon_phase_state_t *state = (moon_phase_state_t *)context;
+    state->offset = 0;
+}
diff --git a/movement/watch_faces/complication/moon_phase_face.h b/movement/watch_faces/complication/moon_phase_face.h
new file mode 100644
index 00000000..35d63183
--- /dev/null
+++ b/movement/watch_faces/complication/moon_phase_face.h
@@ -0,0 +1,48 @@
+/*
+ * 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.
+ */
+
+#ifndef MOON_PHASE_FACE_H_
+#define MOON_PHASE_FACE_H_
+
+#include "movement.h"
+
+typedef struct {
+    uint32_t offset;
+} moon_phase_state_t;
+
+void moon_phase_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
+void moon_phase_face_activate(movement_settings_t *settings, void *context);
+bool moon_phase_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
+void moon_phase_face_resign(movement_settings_t *settings, void *context);
+
+#define moon_phase_face ((const watch_face_t){ \
+    moon_phase_face_setup, \
+    moon_phase_face_activate, \
+    moon_phase_face_loop, \
+    moon_phase_face_resign, \
+    NULL, \
+})
+
+#endif // MOON_PHASE_FACE_H_
+