New watch face: Tally counter (tally_face) (#160)

* Add tally face

* Fix copyright block to reflect real author

* Fix indentation

* More style editing, edited comments

* silence warning in tally_face

Co-authored-by: Andrew Mike <andrew@7thmagic.net>
Co-authored-by: joeycastillo <joeycastillo@utexas.edu>

4 files changed, 154 insertions, 0 deletions

diff --git a/movement/make/Makefile b/movement/make/Makefile
index 680aa42c..a11f49f3 100644
--- a/movement/make/Makefile
+++ b/movement/make/Makefile
@@ -83,6 +83,7 @@ SRCS += \
   ../watch_faces/settings/finetune_face.c \
   ../watch_faces/complication/databank_face.c \
   ../watch_faces/complication/tempchart_face.c \
+  ../watch_faces/complication/tally_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 3ab32064..2506671f 100644
--- a/movement/movement_faces.h
+++ b/movement/movement_faces.h
@@ -68,6 +68,7 @@
 #include "finetune_face.h"
 #include "databank_face.h"
 #include "tempchart_face.h"
+#include "tally_face.h"
 // New includes go above this line.
 
 #endif // MOVEMENT_FACES_H_
diff --git a/movement/watch_faces/complication/tally_face.c b/movement/watch_faces/complication/tally_face.c
new file mode 100644
index 00000000..86e97ab0
--- /dev/null
+++ b/movement/watch_faces/complication/tally_face.c
@@ -0,0 +1,98 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022 Andrew Mike
+ *
+ * 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 "tally_face.h"
+#include "watch.h"
+
+void tally_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(tally_state_t));
+        memset(*context_ptr, 0, sizeof(tally_state_t));
+    }
+}
+
+void tally_face_activate(movement_settings_t *settings, void *context) {
+    (void) settings;
+    (void) context;
+}
+
+bool tally_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
+    (void) settings;
+    tally_state_t *state = (tally_state_t *)context;
+    
+    switch (event.event_type) {
+        case EVENT_MODE_BUTTON_UP:
+            movement_move_to_next_face();
+            break;
+        case EVENT_LIGHT_BUTTON_DOWN:
+            movement_illuminate_led();
+	        break;
+        case EVENT_ALARM_BUTTON_UP:
+            // increment tally index
+            state->tally_idx++;
+            if (state->tally_idx > 999999) { //0-999,999
+                //reset tally index and play a reset tune
+                state->tally_idx = 0;
+                watch_buzzer_play_note(BUZZER_NOTE_G6, 30);
+                watch_buzzer_play_note(BUZZER_NOTE_REST, 30);
+            }
+            print_tally(state);
+            watch_buzzer_play_note(BUZZER_NOTE_E6, 30);
+            break;
+        case EVENT_ALARM_LONG_PRESS:
+            state->tally_idx = 0; // reset tally index
+            //play a reset tune
+            watch_buzzer_play_note(BUZZER_NOTE_G6, 30);
+            watch_buzzer_play_note(BUZZER_NOTE_REST, 30);
+            watch_buzzer_play_note(BUZZER_NOTE_E6, 30);
+            print_tally(state);
+            break;
+        case EVENT_ACTIVATE:
+            print_tally(state);
+            break;
+        case EVENT_TIMEOUT:
+            // ignore timeout
+            break;
+        default:
+            break;
+    }
+
+    return true;
+}
+
+// print tally index at the center of display.
+void print_tally(tally_state_t *state) {
+    char buf[14];
+    sprintf(buf, "TA  %06d", (int)(state->tally_idx)); // center of LCD display
+    watch_display_string(buf, 0);
+}
+
+void tally_face_resign(movement_settings_t *settings, void *context) {
+    (void) settings;
+    (void) context;
+}
diff --git a/movement/watch_faces/complication/tally_face.h b/movement/watch_faces/complication/tally_face.h
new file mode 100644
index 00000000..6584e87d
--- /dev/null
+++ b/movement/watch_faces/complication/tally_face.h
@@ -0,0 +1,54 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022 Andrew Mike
+ *
+ * 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 TALLY_FACE_H_
+#define TALLY_FACE_H_
+
+#include "movement.h"
+
+// Tally face is designed to act as a tally counter.
+// Based on the counter_face watch face by Shogo Okamoto.
+// To advance the counter, press the Alarm button. To reset, long press the Alarm button.
+
+typedef struct {
+    uint32_t tally_idx;
+} tally_state_t;
+
+
+void tally_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
+void tally_face_activate(movement_settings_t *settings, void *context);
+bool tally_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
+void tally_face_resign(movement_settings_t *settings, void *context);
+
+void print_tally(tally_state_t *state);
+
+#define tally_face ((const watch_face_t){ \
+    tally_face_setup, \
+    tally_face_activate, \
+    tally_face_loop, \
+    tally_face_resign, \
+    NULL, \
+})
+
+#endif // TALLY_FACE_H_