diff options
-rw-r--r-- | movement/make/Makefile | 1 | ||||
-rw-r--r-- | movement/movement_faces.h | 1 | ||||
-rw-r--r-- | movement/watch_faces/clock/weeknumber_clock_face.c | 171 | ||||
-rw-r--r-- | movement/watch_faces/clock/weeknumber_clock_face.h | 53 | ||||
-rw-r--r-- | watch-library/shared/watch/watch_utility.c | 67 | ||||
-rw-r--r-- | watch-library/shared/watch/watch_utility.h | 27 |
6 files changed, 310 insertions, 10 deletions
diff --git a/movement/make/Makefile b/movement/make/Makefile index bf9351eb..52ecbe43 100644 --- a/movement/make/Makefile +++ b/movement/make/Makefile @@ -43,6 +43,7 @@ SRCS += \ ../watch_faces/clock/simple_clock_face.c \ ../watch_faces/clock/world_clock_face.c \ ../watch_faces/clock/beats_face.c \ + ../watch_faces/clock/weeknumber_clock_face.c \ ../watch_faces/settings/preferences_face.c \ ../watch_faces/settings/set_time_face.c \ ../watch_faces/sensor/thermistor_readout_face.c \ diff --git a/movement/movement_faces.h b/movement/movement_faces.h index 282be0e6..c0e765ea 100644 --- a/movement/movement_faces.h +++ b/movement/movement_faces.h @@ -58,6 +58,7 @@ #include "frequency_correction_face.h" #include "alarm_face.h" #include "ratemeter_face.h" +#include "weeknumber_clock_face.h" // New includes go above this line. #endif // MOVEMENT_FACES_H_ diff --git a/movement/watch_faces/clock/weeknumber_clock_face.c b/movement/watch_faces/clock/weeknumber_clock_face.c new file mode 100644 index 00000000..e49e5abf --- /dev/null +++ b/movement/watch_faces/clock/weeknumber_clock_face.c @@ -0,0 +1,171 @@ +/* + * 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 "weeknumber_clock_face.h" +#include "watch.h" +#include "watch_utility.h" + +static void _update_alarm_indicator(bool settings_alarm_enabled, weeknumber_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 weeknumber_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(weeknumber_clock_state_t)); + weeknumber_clock_state_t *state = (weeknumber_clock_state_t *)*context_ptr; + state->signal_enabled = false; + state->watch_face_index = watch_face_index; + } +} + +void weeknumber_clock_face_activate(movement_settings_t *settings, void *context) { + weeknumber_clock_state_t *state = (weeknumber_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 weeknumber_clock_face_loop(movement_event_t event, movement_settings_t *settings, void *context) { + weeknumber_clock_state_t *state = (weeknumber_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 >> 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, watch_utility_get_weeknumber(date_time.unit.year, date_time.unit.month, date_time.unit.day)); + } 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, watch_utility_get_weeknumber(date_time.unit.year, date_time.unit.month, date_time.unit.day)); + } + } + 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_MODE_BUTTON_UP: + movement_move_to_next_face(); + return false; + case EVENT_LIGHT_BUTTON_DOWN: + movement_illuminate_led(); + 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); + if (watch_is_buzzer_or_led_enabled()) { + // if we are in the foreground, we can just beep. + movement_play_signal(); + } else { + // if we were in the background, we need to enable the buzzer peripheral first, + watch_enable_buzzer(); + // beep quickly (this call blocks for 275 ms), + movement_play_signal(); + // and then turn the buzzer peripheral off again. + watch_disable_buzzer(); + } + break; + default: + break; + } + + return true; +} + +void weeknumber_clock_face_resign(movement_settings_t *settings, void *context) { + (void) settings; + (void) context; +} + +bool weeknumber_clock_face_wants_background_task(movement_settings_t *settings, void *context) { + (void) settings; + weeknumber_clock_state_t *state = (weeknumber_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; +} diff --git a/movement/watch_faces/clock/weeknumber_clock_face.h b/movement/watch_faces/clock/weeknumber_clock_face.h new file mode 100644 index 00000000..f0298ea8 --- /dev/null +++ b/movement/watch_faces/clock/weeknumber_clock_face.h @@ -0,0 +1,53 @@ +/* + * 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 WEEKNUMBER_CLOCK_FACE_H_ +#define WEEKNUMBER_CLOCK_FACE_H_ + +#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; +} weeknumber_clock_state_t; + +void weeknumber_clock_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr); +void weeknumber_clock_face_activate(movement_settings_t *settings, void *context); +bool weeknumber_clock_face_loop(movement_event_t event, movement_settings_t *settings, void *context); +void weeknumber_clock_face_resign(movement_settings_t *settings, void *context); +bool weeknumber_clock_face_wants_background_task(movement_settings_t *settings, void *context); + +#define weeknumber_clock_face ((const watch_face_t){ \ + weeknumber_clock_face_setup, \ + weeknumber_clock_face_activate, \ + weeknumber_clock_face_loop, \ + weeknumber_clock_face_resign, \ + weeknumber_clock_face_wants_background_task, \ +}) + +#endif // SIMPLE_CLOCK_FACE_H_ diff --git a/watch-library/shared/watch/watch_utility.c b/watch-library/shared/watch/watch_utility.c index 252624b3..6a8b408a 100644 --- a/watch-library/shared/watch/watch_utility.c +++ b/watch-library/shared/watch/watch_utility.c @@ -26,16 +26,60 @@ #include "watch_utility.h" const char * watch_utility_get_weekday(watch_date_time date_time) { - static const char weekdays[7][3] = {"SA", "SU", "MO", "TU", "WE", "TH", "FR"}; - date_time.unit.year += 20; - if (date_time.unit.month <= 2) { - date_time.unit.month += 12; - date_time.unit.year--; + static const char weekdays[7][3] = {"MO", "TU", "WE", "TH", "FR", "SA", "SU"}; + return weekdays[watch_utility_get_iso8601_weekday_number(date_time.unit.year + WATCH_RTC_REFERENCE_YEAR, date_time.unit.month, date_time.unit.day) - 1]; +} + +// Per ISO8601 week starts on Monday with index 1 +uint8_t watch_utility_get_iso8601_weekday_number(uint16_t year, uint8_t month, uint8_t day) { + year -= WATCH_RTC_REFERENCE_YEAR; + year += 20; + if (month <= 2) { + month += 12; + year--; } - return weekdays[(date_time.unit.day + 13 * (date_time.unit.month + 1) / 5 + date_time.unit.year + date_time.unit.year / 4 + 525) % 7]; + return ((day + (13 * (month + 1) / 5) + year + (year / 4) + 5) % 7) + 1; } -uint32_t watch_utility_convert_to_unix_time(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint32_t utc_offset) { +// this function is from the excellent musl c library +uint8_t watch_utility_get_weeknumber(uint16_t year, uint8_t month, uint8_t day) { + uint8_t weekday; + uint16_t days; + + weekday = watch_utility_get_iso8601_weekday_number(year, month, day) % 7; + days = watch_utility_days_since_new_year(year, month, day); + + int val = (days + 7U - (weekday+6U)%7) / 7; + /* If 1 Jan is just 1-3 days past Monday, + * the previous week is also in this year. */ + if ((weekday + 371U - days - 2) % 7 <= 2) + val++; + if (!val) { + val = 52; + /* If 31 December of prev year a Thursday, + * or Friday of a leap year, then the + * prev year has 53 weeks. */ + int dec31 = (weekday + 7U - days - 1) % 7; + if (dec31 == 4 || (dec31 == 5 && is_leap(year%400-1))) + val++; + } else if (val == 53) { + /* If 1 January is not a Thursday, and not + * a Wednesday of a leap year, then this + * year has only 52 weeks. */ + int jan1 = (weekday + 371U - days) % 7; + if (jan1 != 4 && (jan1 != 3 || !is_leap(year))) + val = 1; + } + return val; +} + +uint8_t is_leap(uint16_t y) +{ + y += 1900; + return !(y%4) && ((y%100) || !(y%400)); +} + +uint16_t watch_utility_days_since_new_year(uint16_t year, uint8_t month, uint8_t day) { uint16_t DAYS_SO_FAR[] = { 0, // Jan 31, // Feb @@ -51,10 +95,13 @@ uint32_t watch_utility_convert_to_unix_time(uint16_t year, uint8_t month, uint8_ 334 // December }; + return (is_leap(year) && (month > 2) ? 1 : 0) + DAYS_SO_FAR[month - 1] + day; +} + +uint32_t watch_utility_convert_to_unix_time(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint32_t utc_offset) { uint32_t year_adj = year + 4800; - uint32_t febs = year_adj - (month <= 2 ? 1 : 0); /* Februaries since base. */ - uint32_t leap_days = 1 + (febs / 4) - (febs / 100) + (febs / 400); - uint32_t days = 365 * year_adj + leap_days + DAYS_SO_FAR[month - 1] + day - 1; + uint32_t leap_days = 1 + (year_adj / 4) - (year_adj / 100) + (year_adj / 400); + uint32_t days = 365 * year_adj + leap_days + watch_utility_days_since_new_year(year, month, day) - 1; days -= 2472692; /* Adjust to Unix epoch. */ uint32_t timestamp = days * 86400; diff --git a/watch-library/shared/watch/watch_utility.h b/watch-library/shared/watch/watch_utility.h index 57bcbed7..f96bd8c1 100644 --- a/watch-library/shared/watch/watch_utility.h +++ b/watch-library/shared/watch/watch_utility.h @@ -46,6 +46,33 @@ typedef struct { */ const char * watch_utility_get_weekday(watch_date_time date_time); +/** @brief Returns a number between 1-7 representing the weekday according to ISO8601 : week starts on Monday and has index 1, Sunday has index 7 + * @param year The year of the date + * @param month The month of the date (1-12) + * @param day The day of the date (1-31) + */ +uint8_t watch_utility_get_iso8601_weekday_number(uint16_t year, uint8_t month, uint8_t day); + + +/** @brief Returns a number between 1-53 representing the weeknumber according to ISO8601 : First week of the year always contains Thursday. If it overlaps on previous year, current year has 53 weeks + * @param year The year of the date + * @param month The month of the date (1-12) + * @param day The day of the date (1-31) + */ +uint8_t watch_utility_get_weeknumber(uint16_t year, uint8_t month, uint8_t day); + +/** @brief Returns a number between 1-366 representing the elapsed days since January 1st the same year. + * @param year The year of the date + * @param month The month of the date (1-12) + * @param day The day of the date (1-31) + */ +uint16_t watch_utility_days_since_new_year(uint16_t year, uint8_t month, uint8_t day); + +/** @brief Returns 1 if year is leap and 0 otherwise + * @param year The year (ex. 2022) + */ +uint8_t is_leap(uint16_t year); + /** @brief Returns the UNIX time (seconds since 1970) for a given date/time in UTC. * @param date_time The watch_date_time that you wish to convert. * @param year The year of the date you wish to convert. |