Adding Breathing complication (#220)

* Added complication

* Including complication in build configuration

* Clean up

* restore default watch face selection

* Fixed comment

* Remove unused

* Made functions internal

---------

Co-authored-by: Bernd Plontsch <bernd@plontsch@gmail.com>
Co-authored-by: joeycastillo <joeycastillo@utexas.edu>

4 files changed, 253 insertions, 0 deletions

diff --git a/movement/make/Makefile b/movement/make/Makefile
index 255d4ae9..d403045d 100644
--- a/movement/make/Makefile
+++ b/movement/make/Makefile
@@ -103,6 +103,7 @@ SRCS += \
   ../watch_faces/complication/ships_bell_face.c \
   ../watch_faces/complication/discgolf_face.c \
   ../watch_faces/complication/habit_face.c \
+  ../watch_faces/complication/breathing_face.c \
   ../watch_faces/clock/repetition_minute_face.c \
   ../watch_faces/complication/timer_face.c \
   ../watch_faces/complication/invaders_face.c \
diff --git a/movement/movement_faces.h b/movement/movement_faces.h
index bd41c499..b8584756 100644
--- a/movement/movement_faces.h
+++ b/movement/movement_faces.h
@@ -78,6 +78,7 @@
 #include "ships_bell_face.h"
 #include "discgolf_face.h"
 #include "habit_face.h"
+#include "breathing_face.h"
 #include "repetition_minute_face.h"
 #include "timer_face.h"
 #include "invaders_face.h"
diff --git a/movement/watch_faces/complication/breathing_face.c b/movement/watch_faces/complication/breathing_face.c
new file mode 100644
index 00000000..8c1fdec7
--- /dev/null
+++ b/movement/watch_faces/complication/breathing_face.c
@@ -0,0 +1,208 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 Bernd Plontsch
+ *
+ * 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 "breathing_face.h"
+#include "watch.h"
+
+typedef struct {
+    uint8_t current_stage;
+    bool sound_on;
+} breathing_state_t;
+
+static void beep_in (void);
+static void beep_in_hold (void);
+static void beep_out (void);
+static void beep_out_hold (void);
+
+void breathing_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr) {
+    // These next two lines just silence the compiler warnings associated with unused parameters.
+    // We have no use for the settings or the watch_face_index, so we make that explicit here.
+    (void) settings;
+    (void) watch_face_index;
+    // At boot, context_ptr will be NULL indicating that we don't have anyplace to store our context.
+    if (*context_ptr == NULL) {
+        // in this case, we allocate an area of memory sufficient to store the stuff we need to track.
+        *context_ptr = malloc(sizeof(breathing_state_t));
+    }
+}
+
+void breathing_face_activate(movement_settings_t *settings, void *context) {
+    // same as above: silence the warning, we don't need to check the settings.
+    (void) settings;
+    // we do however need to set some things in our context. Here we cast it to the correct type...
+    breathing_state_t *state = (breathing_state_t *)context;
+    // ...and set the initial state of our watch face.
+    state->current_stage = 0;
+    state->sound_on = true;
+}
+
+const int NOTE_LENGTH = 80;
+
+void beep_in (void) {
+        const BuzzerNote notes[] = {
+            BUZZER_NOTE_C4,
+            BUZZER_NOTE_D4,
+            BUZZER_NOTE_E4,
+        };
+        const uint16_t durations[] = {
+            NOTE_LENGTH,
+            NOTE_LENGTH,
+            NOTE_LENGTH
+        };
+        for(size_t i = 0, count = sizeof(notes) / sizeof(notes[0]); i < count; i++) {
+            watch_buzzer_play_note(notes[i], durations[i]);
+        }
+}
+
+void beep_in_hold (void) {
+        const BuzzerNote notes[] = {
+            BUZZER_NOTE_E4,
+            BUZZER_NOTE_REST,
+            BUZZER_NOTE_E4,
+        };
+        const uint16_t durations[] = {
+            NOTE_LENGTH,
+            NOTE_LENGTH * 2,
+            NOTE_LENGTH,
+        };
+        for(size_t i = 0, count = sizeof(notes) / sizeof(notes[0]); i < count; i++) {
+            watch_buzzer_play_note(notes[i], durations[i]);
+        }
+}
+
+void beep_out (void) {
+        const BuzzerNote notes[] = {
+            BUZZER_NOTE_E4,
+            BUZZER_NOTE_D4,
+            BUZZER_NOTE_C4,
+        };
+        const uint16_t durations[] = {
+            NOTE_LENGTH,
+            NOTE_LENGTH,
+            NOTE_LENGTH,
+        };
+        for(size_t i = 0, count = sizeof(notes) / sizeof(notes[0]); i < count; i++) {
+            watch_buzzer_play_note(notes[i], durations[i]);
+        }
+}
+
+void beep_out_hold (void) {
+        const BuzzerNote notes[] = {
+            BUZZER_NOTE_C4,
+            BUZZER_NOTE_REST * 2,
+            BUZZER_NOTE_C4,
+        };
+        const uint16_t durations[] = {
+            NOTE_LENGTH,
+            NOTE_LENGTH,
+            NOTE_LENGTH,
+        };
+        for(size_t i = 0, count = sizeof(notes) / sizeof(notes[0]); i < count; i++) {
+            watch_buzzer_play_note(notes[i], durations[i]);
+        }
+}
+
+bool breathing_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
+    (void) settings;
+    breathing_state_t *state = (breathing_state_t *)context;
+
+    switch (event.event_type) {
+        case EVENT_ACTIVATE:
+        case EVENT_TICK:
+
+            if (state->sound_on == true) {
+                watch_set_indicator(WATCH_INDICATOR_BELL); 
+            } else {
+                watch_clear_indicator(WATCH_INDICATOR_BELL); 
+            }
+
+            switch (state->current_stage)
+            {
+            case 0: { watch_display_string("Breath", 4); if (state->sound_on) beep_in(); } break;
+            case 1: watch_display_string("In   3", 4); break;
+            case 2: watch_display_string("In   2", 4); break;
+            case 3: watch_display_string("In   1", 4); break;
+            
+            case 4: { watch_display_string("Hold 4", 4); if (state->sound_on) beep_in_hold(); } break;
+            case 5: watch_display_string("Hold 3", 4); break;
+            case 6: watch_display_string("Hold 2", 4); break;               
+            case 7:  watch_display_string("Hold 1", 4); break;
+
+            case 8: { watch_display_string("Ou t 4", 4); if (state->sound_on) beep_out(); } break;
+            case 9: watch_display_string("Ou t 3", 4); break;
+            case 10: watch_display_string("Ou t 2", 4); break;
+            case 11: watch_display_string("Ou t 1", 4); break;         
+            
+            case 12: { watch_display_string("Hold 4", 4); if (state->sound_on) beep_out_hold(); } break;
+            case 13: watch_display_string("Hold 3", 4); break;
+            case 14: watch_display_string("Hold 2", 4); break;     
+            case 15: watch_display_string("Hold 1", 4); break;     
+            default:
+                break;
+            }
+
+            // and increment it so that it will update on the next tick.
+            state->current_stage = (state->current_stage + 1) % 16;
+
+            break;
+        case EVENT_ALARM_BUTTON_UP:
+            state->sound_on = !state->sound_on;            
+             if (state->sound_on == true) {
+                watch_set_indicator(WATCH_INDICATOR_BELL); 
+            } else {
+                watch_clear_indicator(WATCH_INDICATOR_BELL); 
+            }
+            break;
+        case EVENT_LOW_ENERGY_UPDATE:
+            // This low energy mode update occurs once a minute, if the watch face is in the
+            // foreground when Movement enters low energy mode. We have the option of supporting
+            // this mode, but since our watch face animates once a second, the "Hello there" face
+            // isn't very useful in this mode. So we choose not to support it. (continued below)
+            break;
+        case EVENT_TIMEOUT:
+            // ... Instead, we respond to the timeout event. This event happens after a configurable
+            // interval on screen (1-30 minutes). The watch will give us this event as a chance to
+            // resign control if we want to, and in this case, we do.
+            // This function will return the watch to the first screen (usually a simple clock),
+            // and it will do it long before the watch enters low energy mode. This ensures we
+            // won't be on screen, and thus opts us out of getting the EVENT_LOW_ENERGY_UPDATE above.
+            
+            // movement_move_to_face(0);
+            break;
+        default:
+            movement_default_loop_handler(event, settings);
+            break;
+    }
+
+    return true;
+}
+
+void breathing_face_resign(movement_settings_t *settings, void *context) {
+    // our watch face, like most watch faces, has nothing special to do when resigning.
+    // watch faces that enable a peripheral or interact with a sensor may want to turn it off here.
+    (void) settings;
+    (void) context;
+}
diff --git a/movement/watch_faces/complication/breathing_face.h b/movement/watch_faces/complication/breathing_face.h
new file mode 100644
index 00000000..2ff947a2
--- /dev/null
+++ b/movement/watch_faces/complication/breathing_face.h
@@ -0,0 +1,43 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 Bernd Plontsch
+ *
+ * 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 BREATHING_FACE_H_
+#define BREATHING_FACE_H_
+
+#include "movement.h"
+
+void breathing_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
+void breathing_face_activate(movement_settings_t *settings, void *context);
+bool breathing_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
+void breathing_face_resign(movement_settings_t *settings, void *context);
+
+#define breathing_face ((const watch_face_t){ \
+    breathing_face_setup, \
+    breathing_face_activate, \
+    breathing_face_loop, \
+    breathing_face_resign, \
+    NULL, \
+})
+
+#endif // BREATHING_FACE_H_