summaryrefslogtreecommitdiffstats
path: root/movement/watch_faces
diff options
context:
space:
mode:
Diffstat (limited to 'movement/watch_faces')
-rw-r--r--movement/watch_faces/clock/clock_face.c291
-rw-r--r--movement/watch_faces/clock/clock_face.h60
-rw-r--r--movement/watch_faces/complication/moon_phase_face.c4
-rw-r--r--movement/watch_faces/complication/pulsometer_face.c183
-rw-r--r--movement/watch_faces/complication/pulsometer_face.h69
-rw-r--r--movement/watch_faces/complication/randonaut_face.c2
-rw-r--r--movement/watch_faces/complication/sunrise_sunset_face.c2
-rw-r--r--movement/watch_faces/complication/toss_up_face.c3
-rw-r--r--movement/watch_faces/complication/totp_face.c194
-rw-r--r--movement/watch_faces/complication/totp_face.h15
-rw-r--r--movement/watch_faces/complication/totp_face_lfs.c15
-rw-r--r--movement/watch_faces/complication/totp_face_lfs.h2
12 files changed, 723 insertions, 117 deletions
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/clock_face.h b/movement/watch_faces/clock/clock_face.h
new file mode 100644
index 00000000..c4209e3b
--- /dev/null
+++ b/movement/watch_faces/clock/clock_face.h
@@ -0,0 +1,60 @@
+/* SPDX-License-Identifier: MIT */
+
+/*
+ * MIT License
+ *
+ * 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
+ * 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 CLOCK_FACE_H_
+#define CLOCK_FACE_H_
+
+/*
+ * CLOCK FACE
+ *
+ * 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"
+
+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 clock_face ((const watch_face_t) { \
+ clock_face_setup, \
+ clock_face_activate, \
+ clock_face_loop, \
+ clock_face_resign, \
+ clock_face_wants_background_task, \
+})
+
+#endif // CLOCK_FACE_H_
diff --git a/movement/watch_faces/complication/moon_phase_face.c b/movement/watch_faces/complication/moon_phase_face.c
index 9aac374a..f74de647 100644
--- a/movement/watch_faces/complication/moon_phase_face.c
+++ b/movement/watch_faces/complication/moon_phase_face.c
@@ -161,6 +161,10 @@ bool moon_phase_face_loop(movement_event_t event, movement_settings_t *settings,
state->offset += 86400;
_update(settings, state, state->offset);
break;
+ case EVENT_ALARM_LONG_PRESS:
+ state->offset = 0;
+ _update(settings, state, state->offset);
+ break;
case EVENT_TIMEOUT:
// QUESTION: Should timeout reset offset to 0?
break;
diff --git a/movement/watch_faces/complication/pulsometer_face.c b/movement/watch_faces/complication/pulsometer_face.c
index 2247421c..3c04aa1a 100644
--- a/movement/watch_faces/complication/pulsometer_face.c
+++ b/movement/watch_faces/complication/pulsometer_face.c
@@ -1,7 +1,11 @@
+/* SPDX-License-Identifier: MIT */
+
/*
* MIT License
*
- * Copyright (c) 2022 Joey Castillo
+ * Copyright © 2021-2022 Joey Castillo <joeycastillo@utexas.edu> <jose.castillo@gmail.com>
+ * Copyright © 2023 Jeremy O'Brien <neutral@fastmail.com>
+ * Copyright © 2024 Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com> (https://www.matheusmoreira.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
@@ -24,73 +28,162 @@
#include <stdlib.h>
#include <string.h>
+
#include "pulsometer_face.h"
#include "watch.h"
-#define PULSOMETER_FACE_FREQUENCY_FACTOR (4ul) // refresh rate will be 2 to this power Hz (0 for 1 Hz, 2 for 4 Hz, etc.)
+#ifndef PULSOMETER_FACE_TITLE
+#define PULSOMETER_FACE_TITLE "PL"
+#endif
+
+#ifndef PULSOMETER_FACE_CALIBRATION_DEFAULT
+#define PULSOMETER_FACE_CALIBRATION_DEFAULT (30)
+#endif
+
+#ifndef PULSOMETER_FACE_CALIBRATION_INCREMENT
+#define PULSOMETER_FACE_CALIBRATION_INCREMENT (10)
+#endif
+
+// tick frequency will be 2 to this power Hz (0 for 1 Hz, 2 for 4 Hz, etc.)
+#ifndef PULSOMETER_FACE_FREQUENCY_FACTOR
+#define PULSOMETER_FACE_FREQUENCY_FACTOR (4ul)
+#endif
+
#define PULSOMETER_FACE_FREQUENCY (1 << PULSOMETER_FACE_FREQUENCY_FACTOR)
+typedef struct {
+ bool measuring;
+ int16_t pulses;
+ int16_t ticks;
+ int8_t calibration;
+} pulsometer_state_t;
+
+static void pulsometer_display_title(pulsometer_state_t *pulsometer) {
+ watch_display_string(PULSOMETER_FACE_TITLE, 0);
+}
+
+static void pulsometer_display_calibration(pulsometer_state_t *pulsometer) {
+ char buf[3];
+ snprintf(buf, sizeof(buf), "%2hhd", pulsometer->calibration);
+ watch_display_string(buf, 2);
+}
+
+static void pulsometer_display_measurement(pulsometer_state_t *pulsometer) {
+ char buf[7];
+ snprintf(buf, sizeof(buf), "%-6hd", pulsometer->pulses);
+ watch_display_string(buf, 4);
+}
+
+static void pulsometer_indicate(pulsometer_state_t *pulsometer) {
+ if (pulsometer->measuring) {
+ watch_set_indicator(WATCH_INDICATOR_LAP);
+ } else {
+ watch_clear_indicator(WATCH_INDICATOR_LAP);
+ }
+}
+
+static void pulsometer_start_measurement(pulsometer_state_t *pulsometer) {
+ pulsometer->measuring = true;
+ pulsometer->pulses = INT16_MAX;
+ pulsometer->ticks = 0;
+
+ pulsometer_indicate(pulsometer);
+
+ movement_request_tick_frequency(PULSOMETER_FACE_FREQUENCY);
+}
+
+static void pulsometer_measure(pulsometer_state_t *pulsometer) {
+ if (!pulsometer->measuring) { return; }
+
+ pulsometer->ticks++;
+
+ float ticks_per_minute = 60 << PULSOMETER_FACE_FREQUENCY_FACTOR;
+ float pulses_while_button_held = ticks_per_minute / pulsometer->ticks;
+ float calibrated_pulses = pulses_while_button_held * pulsometer->calibration;
+ calibrated_pulses += 0.5f;
+
+ pulsometer->pulses = (int16_t) calibrated_pulses;
+
+ pulsometer_display_measurement(pulsometer);
+}
+
+static void pulsometer_stop_measurement(pulsometer_state_t *pulsometer) {
+ movement_request_tick_frequency(1);
+
+ pulsometer->measuring = false;
+
+ pulsometer_display_measurement(pulsometer);
+ pulsometer_indicate(pulsometer);
+}
+
+static void pulsometer_cycle_calibration(pulsometer_state_t *pulsometer, int8_t increment) {
+ if (pulsometer->measuring) { return; }
+
+ if (pulsometer->calibration <= 0) {
+ pulsometer->calibration = 1;
+ }
+
+ int8_t last = pulsometer->calibration;
+ pulsometer->calibration += increment;
+
+ if (pulsometer->calibration > 39) {
+ pulsometer->calibration = last == 39? 1 : 39;
+ }
+
+ pulsometer_display_calibration(pulsometer);
+}
+
void pulsometer_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(pulsometer_state_t));
+
+ if (*context_ptr == NULL) {
+ pulsometer_state_t *pulsometer = malloc(sizeof(pulsometer_state_t));
+
+ pulsometer->calibration = PULSOMETER_FACE_CALIBRATION_DEFAULT;
+ pulsometer->pulses = 0;
+ pulsometer->ticks = 0;
+
+ *context_ptr = pulsometer;
+ }
}
void pulsometer_face_activate(movement_settings_t *settings, void *context) {
(void) settings;
- memset(context, 0, sizeof(pulsometer_state_t));
+
+ pulsometer_state_t *pulsometer = context;
+
+ pulsometer->measuring = false;
+
+ pulsometer_display_title(pulsometer);
+ pulsometer_display_calibration(pulsometer);
+ pulsometer_display_measurement(pulsometer);
}
bool pulsometer_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
(void) settings;
- pulsometer_state_t *pulsometer_state = (pulsometer_state_t *)context;
- char buf[14];
+
+ pulsometer_state_t *pulsometer = (pulsometer_state_t *) context;
+
switch (event.event_type) {
case EVENT_ALARM_BUTTON_DOWN:
- pulsometer_state->measuring = true;
- pulsometer_state->pulse = 0xFFFF;
- pulsometer_state->ticks = 0;
- movement_request_tick_frequency(PULSOMETER_FACE_FREQUENCY);
+ pulsometer_start_measurement(pulsometer);
break;
case EVENT_ALARM_BUTTON_UP:
case EVENT_ALARM_LONG_UP:
- pulsometer_state->measuring = false;
- movement_request_tick_frequency(1);
+ pulsometer_stop_measurement(pulsometer);
break;
case EVENT_TICK:
- if (pulsometer_state->pulse == 0 && !pulsometer_state->measuring) {
- switch (pulsometer_state->ticks % 5) {
- case 0:
- watch_display_string(" Hold ", 2);
- break;
- case 1:
- watch_display_string(" Alarn", 4);
- break;
- case 2:
- watch_display_string("* Count ", 0);
- break;
- case 3:
- watch_display_string(" 30Beats ", 0);
- break;
- case 4:
- watch_clear_display();
- break;
- }
- pulsometer_state->ticks = (pulsometer_state->ticks + 1) % 5;
- } else {
- if (pulsometer_state->measuring && pulsometer_state->ticks) {
- pulsometer_state->pulse = (int16_t)((30.0 * ((float)(60 << PULSOMETER_FACE_FREQUENCY_FACTOR) / (float)pulsometer_state->ticks)) + 0.5);
- }
- if (pulsometer_state->pulse > 240) {
- watch_display_string(" Hi", 0);
- } else if (pulsometer_state->pulse < 40) {
- watch_display_string(" Lo", 0);
- } else {
- sprintf(buf, " %-3dbpn", pulsometer_state->pulse);
- watch_display_string(buf, 0);
- }
- if (pulsometer_state->measuring) pulsometer_state->ticks++;
- }
+ pulsometer_measure(pulsometer);
+ break;
+ case EVENT_LIGHT_BUTTON_UP:
+ pulsometer_cycle_calibration(pulsometer, 1);
+ break;
+ case EVENT_LIGHT_LONG_UP:
+ pulsometer_cycle_calibration(pulsometer, PULSOMETER_FACE_CALIBRATION_INCREMENT);
+ break;
+ case EVENT_LIGHT_BUTTON_DOWN:
+ // Inhibit the LED
break;
case EVENT_TIMEOUT:
movement_move_to_face(0);
diff --git a/movement/watch_faces/complication/pulsometer_face.h b/movement/watch_faces/complication/pulsometer_face.h
index 288b62c4..5c1dae91 100644
--- a/movement/watch_faces/complication/pulsometer_face.h
+++ b/movement/watch_faces/complication/pulsometer_face.h
@@ -1,7 +1,12 @@
+/* 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 © 2023 Alex Utter <ooterness@gmail.com>
+ * Copyright © 2024 Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com> (https://www.matheusmoreira.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
@@ -28,38 +33,44 @@
/*
* PULSOMETER face
*
- * The Pulsometer is an implementation of a sort of a classic mechanical
- * watch complication. A classic pulsometer complication involves a
- * chronograph with a scale calibrated for counting a certain number of
- * heartbeats (often 30). You start it and begin counting heartbeats, and
- * stop it after counting the specified number of beats. Once stopped,
- * the needle will point to your heart rate.
- *
- * The pulsometer on Sensor Watch flashes its instructions at launch:
- * “Hold Alarm + count 30 beats.” Using the hand on the side where you wear
- * your watch, touch your carotid artery (in your neck) and feel for your
- * pulse. Once you find it, use your other hand to press and hold the Alarm
- * button, and count your heartbeats. When you reach 30 beats, release the
- * Alarm button. The display will show a number such as “60 bpm”; this is
- * your heart rate in beats per minute.
- *
- * Two notes:
- * o For the first few seconds of a measurement, the display will read “Hi”.
- * This indicates that it’s too early for the measured value to be a valid
- * heart rate. Once the measurement is below 240 bpm, the display will update.
- * o If you hold the button down for more than 45 seconds, the display will
- * read “Lo”. If it took this long for you to count 30 heartbeats, this
- * indicates that your heart rate is below 40 beats per minute.
+ * The pulsometer implements a classic mechanical watch complication.
+ * A mechanical pulsometer involves a chronograph with a scale that
+ * allows the user to compute the number of heart beats per minute
+ * in less time. The scale is calibrated, or graduated, for a fixed
+ * number of heart beats, most often 30. The user starts the chronograph
+ * and simultaneously begins counting the heart beats. The movement of
+ * the chronograph's seconds hand over time automatically performs the
+ * computations required. When the calibrated number of heart beats
+ * is reached, the chronograph is stopped and the seconds hand shows
+ * the heart rate.
+ *
+ * The Sensor Watch pulsometer improves this design with user calibration:
+ * it can be graduated to any value between 1 and 39 pulsations per minute.
+ * The default is still 30, mirroring the classic pulsometer calibration.
+ * This feature allows the user to reconfigure the pulsometer to count
+ * many other types of periodic minutely events, making it more versatile.
+ * For example, it can be set to 5 respirations per minute to turn it into
+ * an asthmometer, a nearly identical mechanical watch complication
+ * that doctors might use to quickly measure respiratory rate.
+ *
+ * To use the pulsometer, hold the ALARM button and count the pulses.
+ * When the calibrated number of pulses is reached, release the button.
+ * The display will show the number of pulses per minute.
+ *
+ * In order to measure heart rate, feel for a pulse using the hand with
+ * the watch while holding the button down with the other.
+ * The pulse can be easily felt on the carotid artery of the neck.
+ *
+ * In order to measure breathing rate, simply hold the ALARM button
+ * and count the number of breaths.
+ *
+ * To calibrate the pulsometer, press LIGHT
+ * to cycle to the next integer calibration.
+ * Long press LIGHT to cycle it by 10.
*/
#include "movement.h"
-typedef struct {
- bool measuring;
- int16_t pulse;
- int16_t ticks;
-} pulsometer_state_t;
-
void pulsometer_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
void pulsometer_face_activate(movement_settings_t *settings, void *context);
bool pulsometer_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
diff --git a/movement/watch_faces/complication/randonaut_face.c b/movement/watch_faces/complication/randonaut_face.c
index bca334fb..3bbc147f 100644
--- a/movement/watch_faces/complication/randonaut_face.c
+++ b/movement/watch_faces/complication/randonaut_face.c
@@ -357,7 +357,7 @@ static uint32_t _get_true_entropy(void) {
while (!hri_trng_get_INTFLAG_reg(TRNG, TRNG_INTFLAG_DATARDY)); // Wait for TRNG data to be ready
- hri_trng_clear_CTRLA_ENABLE_bit(TRNG);
+ watch_disable_TRNG();
hri_mclk_clear_APBCMASK_TRNG_bit(MCLK);
return hri_trng_read_DATA_reg(TRNG); // Read a single 32-bit word from TRNG and return it
#endif
diff --git a/movement/watch_faces/complication/sunrise_sunset_face.c b/movement/watch_faces/complication/sunrise_sunset_face.c
index 82de9c6e..7330c42c 100644
--- a/movement/watch_faces/complication/sunrise_sunset_face.c
+++ b/movement/watch_faces/complication/sunrise_sunset_face.c
@@ -197,6 +197,8 @@ static void _sunrise_sunset_face_update_settings_display(movement_event_t event,
char buf[12];
switch (state->page) {
+ case 0:
+ return;
case 1:
sprintf(buf, "LA %c %04d", state->working_latitude.sign ? '-' : '+', abs(_sunrise_sunset_face_latlon_from_struct(state->working_latitude)));
break;
diff --git a/movement/watch_faces/complication/toss_up_face.c b/movement/watch_faces/complication/toss_up_face.c
index 08dd0052..cf6ca680 100644
--- a/movement/watch_faces/complication/toss_up_face.c
+++ b/movement/watch_faces/complication/toss_up_face.c
@@ -255,7 +255,8 @@ uint32_t get_true_entropy(void) {
while (!hri_trng_get_INTFLAG_reg(TRNG, TRNG_INTFLAG_DATARDY)); // Wait for TRNG data to be ready
- hri_trng_clear_CTRLA_ENABLE_bit(TRNG);
+ watch_disable_TRNG();
+
hri_mclk_clear_APBCMASK_TRNG_bit(MCLK);
return hri_trng_read_DATA_reg(TRNG); // Read a single 32-bit word from TRNG and return it
#endif
diff --git a/movement/watch_faces/complication/totp_face.c b/movement/watch_faces/complication/totp_face.c
index 242820d7..a593e9c9 100644
--- a/movement/watch_faces/complication/totp_face.c
+++ b/movement/watch_faces/complication/totp_face.c
@@ -1,7 +1,16 @@
+/* SPDX-License-Identifier: MIT */
+
/*
* MIT License
*
- * Copyright (c) 2022 Wesley Ellis (https://github.com/tahnok)
+ * Copyright © 2021 Wesley Ellis (https://github.com/tahnok)
+ * Copyright © 2021-2023 Joey Castillo <joeycastillo@utexas.edu>
+ * Copyright © 2022 Jack Bond-Preston <jackbondpreston@outlook.com>
+ * Copyright © 2023 Alex Utter <ooterness@gmail.com>
+ * Copyright © 2023 Emilien Court <emilien.court@telecomnancy.net>
+ * Copyright © 2023 Jeremy O'Brien <neutral@fastmail.com>
+ * Copyright © 2024 Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com> (https://www.matheusmoreira.com/)
+ * Copyright © 2024 Max Zettlmeißl <max@zettlmeissl.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@@ -28,92 +37,201 @@
#include "watch.h"
#include "watch_utility.h"
#include "TOTP.h"
+#include "base32.h"
+
+#ifndef TOTP_FACE_MAX_KEY_LENGTH
+#define TOTP_FACE_MAX_KEY_LENGTH 128
+#endif
+
+typedef struct {
+ unsigned char labels[2];
+ hmac_alg algorithm;
+ uint32_t period;
+ size_t encoded_key_length;
+ unsigned char *encoded_key;
+} totp_t;
+
+#define CREDENTIAL(label, key_array, algo, timestep) \
+ (const totp_t) { \
+ .encoded_key = ((unsigned char *) key_array), \
+ .encoded_key_length = sizeof(key_array) - 1, \
+ .period = (timestep), \
+ .labels = (#label), \
+ .algorithm = (algo), \
+ }
////////////////////////////////////////////////////////////////////////////////
// Enter your TOTP key data below
-static const uint8_t num_keys = 2;
-static uint8_t keys[] = {
- 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x21, 0xde, 0xad, 0xbe, 0xef, // 1 - JBSWY3DPEHPK3PXP
- 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x21, 0xde, 0xad, 0xbe, 0xef, // 2 - JBSWY3DPEHPK3PXP
-};
-static const uint8_t key_sizes[] = {
- 10,
- 10,
-};
-static const uint32_t timesteps[] = {
- 30,
- 30,
-};
-static const char labels[][2] = {
- { '2', 'F' },
- { 'A', 'C' },
-};
-static const hmac_alg algorithms[] = {
- SHA1,
- SHA1,
+
+static totp_t credentials[] = {
+ CREDENTIAL(2F, "JBSWY3DPEHPK3PXP", SHA1, 30),
+ CREDENTIAL(AC, "JBSWY3DPEHPK3PXP", SHA1, 30),
};
+
// END OF KEY DATA.
////////////////////////////////////////////////////////////////////////////////
-static void _update_display(totp_state_t *totp_state) {
+static inline totp_t *totp_at(size_t i) {
+ return &credentials[i];
+}
+
+static inline totp_t *totp_current(totp_state_t *totp_state) {
+ return totp_at(totp_state->current_index);
+}
+
+static inline size_t totp_total(void) {
+ return sizeof(credentials) / sizeof(*credentials);
+}
+
+static void totp_validate_key_lengths(void) {
+ for (size_t n = totp_total(), i = 0; i < n; ++i) {
+ totp_t *totp = totp_at(i);
+
+ if (UNBASE32_LEN(totp->encoded_key_length) > TOTP_FACE_MAX_KEY_LENGTH) {
+ // Key exceeds static limits, turn it off by zeroing the length
+ totp->encoded_key_length = 0;
+ }
+ }
+}
+
+static void totp_generate(totp_state_t *totp_state) {
+ totp_t *totp = totp_current(totp_state);
+
+ if (totp->encoded_key_length <= 0) {
+ // Key exceeded static limits and was turned off
+ totp_state->current_decoded_key_length = 0;
+ return;
+ }
+
+ totp_state->current_decoded_key_length = base32_decode(totp->encoded_key, totp_state->current_decoded_key);
+
+ if (totp_state->current_decoded_key_length == 0) {
+ // Decoding failed for some reason
+ // Not a base 32 string?
+ return;
+ }
+
+ TOTP(
+ totp_state->current_decoded_key,
+ totp_state->current_decoded_key_length,
+ totp->period,
+ totp->algorithm
+ );
+}
+
+static void totp_display_error(totp_state_t *totp_state) {
+ char buf[10 + 1];
+ totp_t *totp = totp_current(totp_state);
+
+ snprintf(buf, sizeof(buf), "%c%c ERROR ", totp->labels[0], totp->labels[1]);
+ watch_display_string(buf, 0);
+}
+
+static void totp_display_code(totp_state_t *totp_state) {
char buf[14];
div_t result;
uint8_t valid_for;
+ totp_t *totp = totp_current(totp_state);
- result = div(totp_state->timestamp, timesteps[totp_state->current_index]);
+ result = div(totp_state->timestamp, totp->period);
if (result.quot != totp_state->steps) {
totp_state->current_code = getCodeFromTimestamp(totp_state->timestamp);
totp_state->steps = result.quot;
}
- valid_for = timesteps[totp_state->current_index] - result.rem;
- sprintf(buf, "%c%c%2d%06lu", labels[totp_state->current_index][0], labels[totp_state->current_index][1], valid_for, totp_state->current_code);
+ valid_for = totp->period - result.rem;
+ sprintf(buf, "%c%c%2d%06lu", totp->labels[0], totp->labels[1], valid_for, totp_state->current_code);
watch_display_string(buf, 0);
}
+static void totp_display(totp_state_t *totp_state) {
+ if (totp_state->current_decoded_key_length > 0) {
+ totp_display_code(totp_state);
+ } else {
+ totp_display_error(totp_state);
+ }
+}
+
+static void totp_generate_and_display(totp_state_t *totp_state) {
+ totp_generate(totp_state);
+ totp_display(totp_state);
+}
+
+static inline uint32_t totp_compute_base_timestamp(movement_settings_t *settings) {
+ return watch_utility_date_time_to_unix_time(watch_rtc_get_date_time(), movement_timezone_offsets[settings->bit.time_zone] * 60);
+}
+
void totp_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(totp_state_t));
+
+ totp_validate_key_lengths();
+
+ if (*context_ptr == NULL) {
+ totp_state_t *totp = malloc(sizeof(totp_state_t));
+ totp->current_decoded_key = malloc(TOTP_FACE_MAX_KEY_LENGTH);
+ *context_ptr = totp;
+ }
}
void totp_face_activate(movement_settings_t *settings, void *context) {
(void) settings;
- memset(context, 0, sizeof(totp_state_t));
- totp_state_t *totp_state = (totp_state_t *)context;
- TOTP(keys, key_sizes[0], timesteps[0], algorithms[0]);
- totp_state->timestamp = watch_utility_date_time_to_unix_time(watch_rtc_get_date_time(), movement_timezone_offsets[settings->bit.time_zone] * 60);
- totp_state->current_code = getCodeFromTimestamp(totp_state->timestamp);
+
+ totp_state_t *totp = (totp_state_t *) context;
+
+ totp->timestamp = totp_compute_base_timestamp(settings);
+ totp->steps = 0;
+ totp->current_code = 0;
+ totp->current_index = 0;
+ totp->current_decoded_key_length = 0;
+ // totp->current_decoded_key is already initialized in setup
+
+ totp_generate_and_display(totp);
}
bool totp_face_loop(movement_event_t event, movement_settings_t *settings, void *context) {
(void) settings;
- totp_state_t *totp_state = (totp_state_t *)context;
+
+ totp_state_t *totp_state = (totp_state_t *) context;
switch (event.event_type) {
case EVENT_TICK:
totp_state->timestamp++;
// fall through
case EVENT_ACTIVATE:
- _update_display(totp_state);
+ totp_display(totp_state);
break;
case EVENT_TIMEOUT:
movement_move_to_face(0);
break;
case EVENT_ALARM_BUTTON_UP:
- if (totp_state->current_index + 1 < num_keys) {
- totp_state->current_key_offset += key_sizes[totp_state->current_index];
+ if (totp_state->current_index + 1 < totp_total()) {
totp_state->current_index++;
} else {
// wrap around to first key
- totp_state->current_key_offset = 0;
totp_state->current_index = 0;
}
- TOTP(keys + totp_state->current_key_offset, key_sizes[totp_state->current_index], timesteps[totp_state->current_index], algorithms[totp_state->current_index]);
- _update_display(totp_state);
+
+ totp_generate_and_display(totp_state);
+
+ break;
+ case EVENT_LIGHT_BUTTON_UP:
+ if (totp_state->current_index == 0) {
+ // Wrap around to the last credential.
+ totp_state->current_index = totp_total() - 1;
+ } else {
+ totp_state->current_index--;
+ }
+
+ totp_generate_and_display(totp_state);
+
break;
case EVENT_ALARM_BUTTON_DOWN:
case EVENT_ALARM_LONG_PRESS:
+ case EVENT_LIGHT_BUTTON_DOWN:
+ break;
+ case EVENT_LIGHT_LONG_PRESS:
+ movement_illuminate_led();
break;
default:
movement_default_loop_handler(event, settings);
diff --git a/movement/watch_faces/complication/totp_face.h b/movement/watch_faces/complication/totp_face.h
index 1248f716..19a2cd45 100644
--- a/movement/watch_faces/complication/totp_face.h
+++ b/movement/watch_faces/complication/totp_face.h
@@ -1,7 +1,15 @@
+/* SPDX-License-Identifier: MIT */
+
/*
* MIT License
*
- * Copyright (c) 2022 Wesley Ellis (https://github.com/tahnok)
+ * Copyright © 2021 Wesley Ellis (https://github.com/tahnok)
+ * Copyright © 2021-2022 Joey Castillo <joeycastillo@utexas.edu>
+ * Copyright © 2022 Alexsander Akers <me@a2.io>
+ * Copyright © 2022 Jack Bond-Preston <jackbondpreston@outlook.com>
+ * Copyright © 2023 Alex Utter <ooterness@gmail.com>
+ * Copyright © 2024 Matheus Afonso Martins Moreira <matheus.a.m.moreira@gmail.com> (https://www.matheusmoreira.com/)
+ * Copyright © 2024 Max Zettlmeißl <max@zettlmeissl.de>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
@@ -51,6 +59,8 @@
* o Once finished, remove the two provided examples.
*
* If you have more than one secret key, press ALARM to cycle through them.
+ * Press LIGHT to cycle in the other direction or keep it pressed longer to
+ * activate the light.
*/
#include "movement.h"
@@ -60,7 +70,8 @@ typedef struct {
uint8_t steps;
uint32_t current_code;
uint8_t current_index;
- uint8_t current_key_offset;
+ uint8_t *current_decoded_key;
+ size_t current_decoded_key_length;
} totp_state_t;
void totp_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
diff --git a/movement/watch_faces/complication/totp_face_lfs.c b/movement/watch_faces/complication/totp_face_lfs.c
index 4066ac48..820ad52e 100644
--- a/movement/watch_faces/complication/totp_face_lfs.c
+++ b/movement/watch_faces/complication/totp_face_lfs.c
@@ -163,7 +163,7 @@ static void totp_face_lfs_read_file(char *filename) {
continue;
}
- // If we found a probably valid TOTP record, keep it.
+ // If we found a probably valid TOTP record, keep it.
if (totp_records[num_totp_records].secret_size) {
num_totp_records += 1;
} else {
@@ -255,8 +255,21 @@ bool totp_face_lfs_loop(movement_event_t event, movement_settings_t *settings, v
totp_face_set_record(totp_state, (totp_state->current_index + 1) % num_totp_records);
totp_face_display(totp_state);
break;
+ case EVENT_LIGHT_BUTTON_UP:
+ if (totp_state->current_index - 1 >= 0) {
+ totp_face_set_record(totp_state, totp_state->current_index - 1);
+ } else {
+ // Wrap around to the last record.
+ totp_face_set_record(totp_state, num_totp_records - 1);
+ }
+ totp_face_display(totp_state);
+ break;
case EVENT_ALARM_BUTTON_DOWN:
case EVENT_ALARM_LONG_PRESS:
+ case EVENT_LIGHT_BUTTON_DOWN:
+ break;
+ case EVENT_LIGHT_LONG_PRESS:
+ movement_illuminate_led();
break;
default:
movement_default_loop_handler(event, settings);
diff --git a/movement/watch_faces/complication/totp_face_lfs.h b/movement/watch_faces/complication/totp_face_lfs.h
index 64c6ce15..72ae2460 100644
--- a/movement/watch_faces/complication/totp_face_lfs.h
+++ b/movement/watch_faces/complication/totp_face_lfs.h
@@ -47,6 +47,8 @@
* to modify the URI.
*
* If you have more than one secret key, press ALARM to cycle through them.
+ * Press LIGHT to cycle in the other direction or keep it pressed longer to
+ * activate the light.
*/
#include "movement.h"