/* * 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 #include #include #include "watch.h" #include "movement.h" #ifndef MOVEMENT_FIRMWARE #include "movement_config.h" #elif MOVEMENT_FIRMWARE == MOVEMENT_FIRMWARE_STANDARD #include "alt_fw/standard.h" #elif MOVEMENT_FIRMWARE == MOVEMENT_FIRMWARE_ALT_TIME #include "alt_fw/alt_time.h" #elif MOVEMENT_FIRMWARE == MOVEMENT_FIRMWARE_FOCUS #include "alt_fw/focus.h" #elif MOVEMENT_FIRMWARE == MOVEMENT_FIRMWARE_THE_BACKPACKER #include "alt_fw/the_backpacker.h" #elif MOVEMENT_FIRMWARE == MOVEMENT_FIRMWARE_THE_ATHLETE #include "alt_fw/the_athlete.h" #elif MOVEMENT_FIRMWARE == MOVEMENT_FIRMWARE_THE_STARGAZER #include "alt_fw/the_stargazer.h" #elif MOVEMENT_FIRMWARE == MOVEMENT_FIRMWARE_DEEP_SPACE_NOW #include "alt_fw/deep_space_now.h" #endif #if __EMSCRIPTEN__ #include #endif movement_state_t movement_state; void * watch_face_contexts[MOVEMENT_NUM_FACES]; watch_date_time scheduled_tasks[MOVEMENT_NUM_FACES]; const int32_t movement_le_inactivity_deadlines[8] = {INT_MAX, 3600, 7200, 21600, 43200, 86400, 172800, 604800}; const int16_t movement_timeout_inactivity_deadlines[4] = {60, 120, 300, 1800}; movement_event_t event; const int16_t movement_timezone_offsets[] = { 0, // 0 : 0:00:00 (UTC) 60, // 1 : 1:00:00 (Central European Time) 120, // 2 : 2:00:00 (South African Standard Time) 180, // 3 : 3:00:00 (Arabia Standard Time) 210, // 4 : 3:30:00 (Iran Standard Time) 240, // 5 : 4:00:00 (Georgia Standard Time) 270, // 6 : 4:30:00 (Afghanistan Time) 300, // 7 : 5:00:00 (Pakistan Standard Time) 330, // 8 : 5:30:00 (Indian Standard Time) 345, // 9 : 5:45:00 (Nepal Time) 360, // 10 : 6:00:00 (Kyrgyzstan time) 390, // 11 : 6:30:00 (Myanmar Time) 420, // 12 : 7:00:00 (Thailand Standard Time) 480, // 13 : 8:00:00 (China Standard Time, Australian Western Standard Time) 525, // 14 : 8:45:00 (Australian Central Western Standard Time) 540, // 15 : 9:00:00 (Japan Standard Time, Korea Standard Time) 570, // 16 : 9:30:00 (Australian Central Standard Time) 600, // 17 : 10:00:00 (Australian Eastern Standard Time) 630, // 18 : 10:30:00 (Lord Howe Standard Time) 660, // 19 : 11:00:00 (Solomon Islands Time) 720, // 20 : 12:00:00 (New Zealand Standard Time) 765, // 21 : 12:45:00 (Chatham Standard Time) 780, // 22 : 13:00:00 (Tonga Time) 825, // 23 : 13:45:00 (Chatham Daylight Time) 840, // 24 : 14:00:00 (Line Islands Time) -720, // 25 : -12:00:00 (Baker Island Time) -660, // 26 : -11:00:00 (Niue Time) -600, // 27 : -10:00:00 (Hawaii-Aleutian Standard Time) -570, // 28 : -9:30:00 (Marquesas Islands Time) -540, // 29 : -9:00:00 (Alaska Standard Time) -480, // 30 : -8:00:00 (Pacific Standard Time) -420, // 31 : -7:00:00 (Mountain Standard Time) -360, // 32 : -6:00:00 (Central Standard Time) -300, // 33 : -5:00:00 (Eastern Standard Time) -270, // 34 : -4:30:00 (Venezuelan Standard Time) -240, // 35 : -4:00:00 (Atlantic Standard Time) -210, // 36 : -3:30:00 (Newfoundland Standard Time) -180, // 37 : -3:00:00 (Brasilia Time) -150, // 38 : -2:30:00 (Newfoundland Daylight Time) -120, // 39 : -2:00:00 (Fernando de Noronha Time) -60, // 40 : -1:00:00 (Azores Standard Time) }; const char movement_valid_position_0_chars[] = " AaBbCcDdEeFGgHhIiJKLMNnOoPQrSTtUuWXYZ-='+\\/0123456789"; const char movement_valid_position_1_chars[] = " ABCDEFHlJLNORTtUX-='01378"; void cb_mode_btn_interrupt(void); void cb_light_btn_interrupt(void); void cb_alarm_btn_interrupt(void); void cb_alarm_btn_extwake(void); void cb_alarm_fired(void); void cb_fast_tick(void); void cb_tick(void); static inline void _movement_reset_inactivity_countdown(void) { movement_state.le_mode_ticks = movement_le_inactivity_deadlines[movement_state.settings.bit.le_interval]; movement_state.timeout_ticks = movement_timeout_inactivity_deadlines[movement_state.settings.bit.to_interval]; } static inline void _movement_enable_fast_tick_if_needed(void) { if (!movement_state.fast_tick_enabled) { movement_state.fast_ticks = 0; watch_rtc_register_periodic_callback(cb_fast_tick, 128); } } static inline void _movement_disable_fast_tick_if_possible(void) { if ((movement_state.light_ticks == -1) && (movement_state.alarm_ticks == -1) && ((movement_state.light_down_timestamp + movement_state.mode_down_timestamp + movement_state.alarm_down_timestamp) == 0)) { movement_state.fast_tick_enabled = false; watch_rtc_disable_periodic_callback(128); } } static void _movement_handle_background_tasks(void) { for(uint8_t i = 0; i < MOVEMENT_NUM_FACES; i++) { // For each face, if the watch face wants a background task... if (watch_faces[i].wants_background_task != NULL && watch_faces[i].wants_background_task(&movement_state.settings, watch_face_contexts[i])) { // ...we give it one. pretty straightforward! movement_event_t background_event = { EVENT_BACKGROUND_TASK, 0 }; watch_faces[i].loop(background_event, &movement_state.settings, watch_face_contexts[i]); } } movement_state.needs_background_tasks_handled = false; } static void _movement_handle_scheduled_tasks(void) { watch_date_time date_time = watch_rtc_get_date_time(); uint8_t num_active_tasks = 0; for(uint8_t i = 0; i < MOVEMENT_NUM_FACES; i++) { if (scheduled_tasks[i].reg) { if (scheduled_tasks[i].reg == date_time.reg) { scheduled_tasks[i].reg = 0; movement_event_t background_event = { EVENT_BACKGROUND_TASK, 0 }; watch_faces[i].loop(background_event, &movement_state.settings, watch_face_contexts[i]); } else { num_active_tasks++; } } } if (num_active_tasks == 0) { movement_state.has_scheduled_background_task = false; } else { _movement_reset_inactivity_countdown(); } } void movement_request_tick_frequency(uint8_t freq) { // Movement uses the 128 Hz tick internally if (freq == 128) return; // Movement requires at least a 1 Hz tick. // If we are asked for an invalid frequency, default back to 1 Hz. if (freq == 0 || __builtin_popcount(freq) != 1) freq = 1; // disable all callbacks except the 128 Hz one watch_rtc_disable_matching_periodic_callbacks(0xFE); movement_state.subsecond = 0; movement_state.tick_frequency = freq; watch_rtc_register_periodic_callback(cb_tick, freq); } void movement_illuminate_led(void) { if (movement_state.settings.bit.led_duration) { watch_set_led_color(movement_state.settings.bit.led_red_color ? (0xF | movement_state.settings.bit.led_red_color << 4) : 0, movement_state.settings.bit.led_green_color ? (0xF | movement_state.settings.bit.led_green_color << 4) : 0); movement_state.light_ticks = (movement_state.settings.bit.led_duration * 2 - 1) * 128; _movement_enable_fast_tick_if_needed(); } } void movement_move_to_face(uint8_t watch_face_index) { movement_state.watch_face_changed = true; movement_state.next_watch_face = watch_face_index; } void movement_move_to_next_face(void) { movement_move_to_face((movement_state.current_watch_face + 1) % MOVEMENT_NUM_FACES); } void movement_schedule_background_task(watch_date_time date_time) { watch_date_time now = watch_rtc_get_date_time(); if (date_time.reg > now.reg) { movement_state.has_scheduled_background_task = true; scheduled_tasks[movement_state.current_watch_face].reg = date_time.reg; } } void movement_cancel_background_task(void) { scheduled_tasks[movement_state.current_watch_face].reg = 0; bool other_tasks_scheduled = false; for(uint8_t i = 0; i < MOVEMENT_NUM_FACES; i++) { if (scheduled_tasks[i].reg != 0) { other_tasks_scheduled = true; break; } } movement_state.has_scheduled_background_task = other_tasks_scheduled; } void movement_play_signal(void) { watch_buzzer_play_note(BUZZER_NOTE_C8, 75); watch_buzzer_play_note(BUZZER_NOTE_REST, 100); watch_buzzer_play_note(BUZZER_NOTE_C8, 100); } void movement_play_alarm(void) { movement_state.alarm_ticks = 128 * 5 - 80; // 80 ticks short of 5 seconds, or 4.375 seconds (our beep is 0.375 seconds) _movement_enable_fast_tick_if_needed(); } uint8_t movement_claim_backup_register(void) { if (movement_state.next_available_backup_register >= 8) return 0; return movement_state.next_available_backup_register++; } void app_init(void) { memset(&movement_state, 0, sizeof(movement_state)); movement_state.settings.bit.led_green_color = 0xF; movement_state.settings.bit.button_should_sound = true; movement_state.settings.bit.le_interval = 1; movement_state.settings.bit.led_duration = 1; movement_state.light_ticks = -1; movement_state.alarm_ticks = -1; movement_state.next_available_backup_register = 4; _movement_reset_inactivity_countdown(); #if __EMSCRIPTEN__ int32_t time_zone_offset = EM_ASM_INT({ return -new Date().getTimezoneOffset(); }); for (int i = 0, count = sizeof(movement_timezone_offsets) / sizeof(movement_timezone_offsets[0]); i < count; i++) { if (movement_timezone_offsets[i] == time_zone_offset) { movement_state.settings.bit.time_zone = i; break; } } #endif } void app_wake_from_backup(void) { movement_state.settings.reg = watch_get_backup_data(0); } void app_setup(void) { watch_store_backup_data(movement_state.settings.reg, 0); static bool is_first_launch = true; if (is_first_launch) { #ifdef MOVEMENT_CUSTOM_BOOT_COMMANDS MOVEMENT_CUSTOM_BOOT_COMMANDS() #endif for(uint8_t i = 0; i < MOVEMENT_NUM_FACES; i++) { watch_face_contexts[i] = NULL; scheduled_tasks[i].reg = 0; is_first_launch = false; } // set up the 1 minute alarm (for background tasks and low power updates) watch_date_time alarm_time; alarm_time.reg = 0; alarm_time.unit.second = 59; // after a match, the alarm fires at the next rising edge of CLK_RTC_CNT, so 59 seconds lets us update at :00 watch_rtc_register_alarm_callback(cb_alarm_fired, alarm_time, ALARM_MATCH_SS); } if (movement_state.le_mode_ticks != -1) { watch_disable_extwake_interrupt(BTN_ALARM); watch_enable_external_interrupts(); watch_register_interrupt_callback(BTN_MODE, cb_mode_btn_interrupt, INTERRUPT_TRIGGER_BOTH); watch_register_interrupt_callback(BTN_LIGHT, cb_light_btn_interrupt, INTERRUPT_TRIGGER_BOTH); watch_register_interrupt_callback(BTN_ALARM, cb_alarm_btn_interrupt, INTERRUPT_TRIGGER_BOTH); watch_enable_buzzer(); watch_enable_leds(); watch_enable_display(); movement_request_tick_frequency(1); for(uint8_t i = 0; i < MOVEMENT_NUM_FACES; i++) { watch_faces[i].setup(&movement_state.settings, i, &watch_face_contexts[i]); } watch_faces[movement_state.current_watch_face].activate(&movement_state.settings, watch_face_contexts[movement_state.current_watch_face]); event.subsecond = 0; event.event_type = EVENT_ACTIVATE; } } void app_prepare_for_standby(void) { } void app_wake_from_standby(void) { } bool app_loop(void) { if (movement_state.watch_face_changed) { if (movement_state.settings.bit.button_should_sound) { // low note for nonzero case, high note for return to watch_face 0 watch_buzzer_play_note(movement_state.next_watch_face ? BUZZER_NOTE_C7 : BUZZER_NOTE_C8, 50); } watch_faces[movement_state.current_watch_face].resign(&movement_state.settings, watch_face_contexts[movement_state.current_watch_face]); movement_state.current_watch_face = movement_state.next_watch_face; watch_clear_display(); movement_request_tick_frequency(1); watch_faces[movement_state.current_watch_face].activate(&movement_state.settings, watch_face_contexts[movement_state.current_watch_face]); event.subsecond = 0; event.event_type = EVENT_ACTIVATE; movement_state.watch_face_changed = false; } // if the LED should be off, turn it off if (movement_state.light_ticks == 0) { // unless the user is holding down the LIGHT button, in which case, give them more time. if (watch_get_pin_level(BTN_LIGHT)) { movement_state.light_ticks = 1; } else { watch_set_led_off(); movement_state.light_ticks = -1; _movement_disable_fast_tick_if_possible(); } } // handle background tasks, if the alarm handler told us we need to if (movement_state.needs_background_tasks_handled) _movement_handle_background_tasks(); // if we have a scheduled background task, handle that here: if (event.event_type == EVENT_TICK && movement_state.has_scheduled_background_task) _movement_handle_scheduled_tasks(); // if we have timed out of our low energy mode countdown, enter low energy mode. if (movement_state.le_mode_ticks == 0) { movement_state.le_mode_ticks = -1; watch_register_extwake_callback(BTN_ALARM, cb_alarm_btn_extwake, true); event.event_type = EVENT_NONE; event.subsecond = 0; // this is a little mini-runloop. // as long as le_mode_ticks is -1 (i.e. we are in low energy mode), we wake up here, update the screen, and go right back to sleep. while (movement_state.le_mode_ticks == -1) { // we also have to handle background tasks here in the mini-runloop if (movement_state.needs_background_tasks_handled) _movement_handle_background_tasks(); event.event_type = EVENT_LOW_ENERGY_UPDATE; watch_faces[movement_state.current_watch_face].loop(event, &movement_state.settings, watch_face_contexts[movement_state.current_watch_face]); watch_enter_sleep_mode(); } // as soon as le_mode_ticks is reset by the extwake handler, we bail out of the loop and reactivate ourselves. event.event_type = EVENT_ACTIVATE; // this is a hack tho: waking from sleep mode, app_setup does get called, but it happens before we have reset our ticks. // need to figure out if there's a better heuristic for determining how we woke up. app_setup(); } static bool can_sleep = true; if (event.event_type) { event.subsecond = movement_state.subsecond; can_sleep = watch_faces[movement_state.current_watch_face].loop(event, &movement_state.settings, watch_face_contexts[movement_state.current_watch_face]); // escape hatch: a watch face may not resign on EVENT_MODE_BUTTON_DOWN. In that case, a long press of MODE should let them out. if (event.event_type == EVENT_MODE_LONG_PRESS) { movement_move_to_next_face(); can_sleep = false; } event.event_type = EVENT_NONE; } // if we have timed out of our timeout countdown, give the app a hint that they can resign. if (movement_state.timeout_ticks == 0) { movement_state.timeout_ticks = -1; if (movement_state.settings.bit.to_always == false) { // if "timeout always" is false, give the current watch face a chance to exit gracefully... event.event_type = EVENT_TIMEOUT; } event.subsecond = movement_state.subsecond; watch_faces[movement_state.current_watch_face].loop(event, &movement_state.settings, watch_face_contexts[movement_state.current_watch_face]); event.event_type = EVENT_NONE; if (movement_state.settings.bit.to_always && movement_state.current_watch_face != 0) { // ...but if the user has "timeout always" set, give it the boot. movement_move_to_face(0); } } // Now that we've handled all display update tasks, handle the alarm. if (movement_state.alarm_ticks >= 0) { uint8_t buzzer_phase = (movement_state.alarm_ticks + 80) % 128; if(buzzer_phase == 127) { for(uint8_t i = 0; i < 4; i++) { // TODO: This method of playing the buzzer blocks the UI while it's beeping. // It might be better to time it with the fast tick. watch_buzzer_play_note(BUZZER_NOTE_C8, (i != 3) ? 50 : 75); if (i != 3) watch_buzzer_play_note(BUZZER_NOTE_REST, 50); } } if (movement_state.alarm_ticks == 0) { movement_state.alarm_ticks = -1; _movement_disable_fast_tick_if_possible(); } } event.subsecond = 0; return can_sleep && (movement_state.light_ticks == -1) && !movement_state.is_buzzing; } static movement_event_type_t _figure_out_button_event(bool pin_level, movement_event_type_t button_down_event_type, uint8_t *down_timestamp) { // force alarm off if the user pressed a button. if (movement_state.alarm_ticks) movement_state.alarm_ticks = 0; if (pin_level) { // handle rising edge _movement_enable_fast_tick_if_needed(); *down_timestamp = movement_state.fast_ticks + 1; return button_down_event_type; } else { // this line is hack but it handles the situation where the light button was held for more than 10 seconds. // fast tick is disabled by then, and the LED would get stuck on since there's no one left decrementing light_ticks. if (movement_state.light_ticks == 1) movement_state.light_ticks = 0; // now that that's out of the way, handle falling edge uint16_t diff = movement_state.fast_ticks - *down_timestamp; *down_timestamp = 0; _movement_disable_fast_tick_if_possible(); // any press over a half second is considered a long press. if (diff > 64) return button_down_event_type + 2; else return button_down_event_type + 1; } } void cb_light_btn_interrupt(void) { bool pin_level = watch_get_pin_level(BTN_LIGHT); _movement_reset_inactivity_countdown(); event.event_type = _figure_out_button_event(pin_level, EVENT_LIGHT_BUTTON_DOWN, &movement_state.light_down_timestamp); } void cb_mode_btn_interrupt(void) { bool pin_level = watch_get_pin_level(BTN_MODE); _movement_reset_inactivity_countdown(); event.event_type = _figure_out_button_event(pin_level, EVENT_MODE_BUTTON_DOWN, &movement_state.mode_down_timestamp); } void cb_alarm_btn_interrupt(void) { bool pin_level = watch_get_pin_level(BTN_ALARM); _movement_reset_inactivity_countdown(); event.event_type = _figure_out_button_event(pin_level, EVENT_ALARM_BUTTON_DOWN, &movement_state.alarm_down_timestamp); } void cb_alarm_btn_extwake(void) { // wake up! _movement_reset_inactivity_countdown(); } void cb_alarm_fired(void) { movement_state.needs_background_tasks_handled = true; } void cb_fast_tick(void) { movement_state.fast_ticks++; if (movement_state.light_ticks > 0) movement_state.light_ticks--; if (movement_state.alarm_ticks > 0) movement_state.alarm_ticks--; // this is just a fail-safe; fast tick should be disabled as soon as the button is up, the LED times out, and/or the alarm finishes. // but if for whatever reason it isn't, this forces the fast tick off after 10 seconds. if (movement_state.fast_ticks >= 1280) watch_rtc_disable_periodic_callback(128); } void cb_tick(void) { event.event_type = EVENT_TICK; watch_date_time date_time = watch_rtc_get_date_time(); if (date_time.unit.second != movement_state.last_second) { // TODO: can we consolidate these two ticks? if (movement_state.settings.bit.le_interval && movement_state.le_mode_ticks > 0) movement_state.le_mode_ticks--; if (movement_state.timeout_ticks > 0) movement_state.timeout_ticks--; movement_state.last_second = date_time.unit.second; movement_state.subsecond = 0; } else { movement_state.subsecond++; } }