Basic alarm app

src/CMakeLists.txt

@@ -418,6 +418,7 @@ list(APPEND SOURCE_FILES
         displayapp/screens/BatteryInfo.cpp
         displayapp/screens/Steps.cpp
         displayapp/screens/Timer.cpp
+        displayapp/screens/Alarm.cpp
         displayapp/Colors.cpp
 
         ## Settings
@@ -474,6 +475,7 @@ list(APPEND SOURCE_FILES
         components/motor/MotorController.cpp
         components/settings/Settings.cpp
         components/timer/TimerController.cpp
+        components/alarm/AlarmController.cpp
         components/fs/FS.cpp
         drivers/Cst816s.cpp
         FreeRTOS/port.c
@@ -540,6 +542,7 @@ list(APPEND RECOVERY_SOURCE_FILES
         components/firmwarevalidator/FirmwareValidator.cpp
         components/settings/Settings.cpp
         components/timer/TimerController.cpp
+        components/alarm/AlarmController.cpp
         drivers/Cst816s.cpp
         FreeRTOS/port.c
         FreeRTOS/port_cmsis_systick.c
@@ -612,6 +615,7 @@ set(INCLUDE_FILES
         displayapp/screens/Metronome.h
         displayapp/screens/Motion.h
         displayapp/screens/Timer.h
+        displayapp/screens/Alarm.h
         displayapp/Colors.h
         drivers/St7789.h
         drivers/SpiNorFlash.h
@@ -643,6 +647,7 @@ set(INCLUDE_FILES
         components/ble/HeartRateService.h
         components/settings/Settings.h
         components/timer/TimerController.h
+        components/alarm/AlarmController.h
         drivers/Cst816s.h
         FreeRTOS/portmacro.h
         FreeRTOS/portmacro_cmsis.h

src/components/alarm/AlarmController.cpp

@@ -0,0 +1,114 @@
+/*  Copyright (C) 2021 mruss77, Florian
+
+    This file is part of InfiniTime.
+
+    InfiniTime is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    InfiniTime is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+#include "AlarmController.h"
+#include "systemtask/SystemTask.h"
+#include "app_timer.h"
+#include "task.h"
+#include <chrono>
+
+using namespace Pinetime::Controllers;
+using namespace std::chrono_literals;
+
+AlarmController::AlarmController(Controllers::DateTime& dateTimeController) : dateTimeController {dateTimeController} {
+}
+
+APP_TIMER_DEF(alarmAppTimer);
+
+namespace {
+  void SetOffAlarm(void* p_context) {
+    auto* controller = static_cast<Pinetime::Controllers::AlarmController*>(p_context);
+    if (controller != nullptr) {
+      controller->SetOffAlarmNow();
+    }
+  }
+}
+
+void AlarmController::Init(System::SystemTask* systemTask) {
+  app_timer_create(&alarmAppTimer, APP_TIMER_MODE_SINGLE_SHOT, SetOffAlarm);
+  this->systemTask = systemTask;
+}
+
+void AlarmController::SetAlarm(uint8_t alarmHr, uint8_t alarmMin) {
+  hours = alarmHr;
+  minutes = alarmMin;
+  state = AlarmState::Set;
+  ScheduleAlarm();
+}
+
+void AlarmController::ScheduleAlarm() {
+  // Determine the next time the alarm needs to go off and set the app_timer
+  app_timer_stop(alarmAppTimer);
+
+  auto now = dateTimeController.CurrentDateTime();
+  alarmTime = now;
+  time_t ttAlarmTime = std::chrono::system_clock::to_time_t(alarmTime);
+  tm* tmAlarmTime = std::localtime(&ttAlarmTime);
+
+  // If the time being set has already passed today,the alarm should be set for tomorrow
+  if (hours < dateTimeController.Hours() || (hours == dateTimeController.Hours() && minutes <= dateTimeController.Minutes())) {
+    tmAlarmTime->tm_mday += 1;
+    // tm_wday doesn't update automatically
+    tmAlarmTime->tm_wday = (tmAlarmTime->tm_wday + 1) % 7;
+  }
+
+  tmAlarmTime->tm_hour = hours;
+  tmAlarmTime->tm_min = minutes;
+  tmAlarmTime->tm_sec = 0;
+
+  // if alarm is in weekday-only mode, make sure it shifts to the next weekday
+  if (recurrence == RecurType::Weekdays) {
+    if (tmAlarmTime->tm_wday == 0) { // Sunday, shift 1 day
+      tmAlarmTime->tm_mday += 1;
+    } else if (tmAlarmTime->tm_wday == 6) { // Saturday, shift 2 days
+      tmAlarmTime->tm_mday += 2;
+    }
+  }
+  tmAlarmTime->tm_isdst = -1; // use system timezone setting to determine DST
+
+  // now can convert back to a time_point
+  alarmTime = std::chrono::system_clock::from_time_t(std::mktime(tmAlarmTime));
+  auto mSecToAlarm = std::chrono::duration_cast<std::chrono::milliseconds>(alarmTime - now).count();
+  app_timer_start(alarmAppTimer, APP_TIMER_TICKS(mSecToAlarm), this);
+}
+
+uint32_t AlarmController::SecondsToAlarm() {
+  return std::chrono::duration_cast<std::chrono::seconds>(alarmTime - dateTimeController.CurrentDateTime()).count();
+}
+
+void AlarmController::DisableAlarm() {
+  app_timer_stop(alarmAppTimer);
+  state = AlarmState::Not_Set;
+}
+
+void AlarmController::SetOffAlarmNow() {
+  state = AlarmState::Alerting;
+  systemTask->PushMessage(System::Messages::SetOffAlarm);
+}
+
+void AlarmController::StopAlerting() {
+  systemTask->PushMessage(System::Messages::StopRinging);
+
+  // Alarm state is off unless this is a recurring alarm
+  if (recurrence == RecurType::None) {
+    state = AlarmState::Not_Set;
+  } else {
+    state = AlarmState::Set;
+    // set next instance
+    ScheduleAlarm();
+  }
+}

src/components/alarm/AlarmController.h

@@ -0,0 +1,68 @@
+/*  Copyright (C) 2021 mruss77, Florian
+
+    This file is part of InfiniTime.
+
+    InfiniTime is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    InfiniTime is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+#pragma once
+
+#include <cstdint>
+#include "app_timer.h"
+#include "components/datetime/DateTimeController.h"
+
+namespace Pinetime {
+  namespace System {
+    class SystemTask;
+  }
+  namespace Controllers {
+    class AlarmController {
+    public:
+      AlarmController(Controllers::DateTime& dateTimeController);
+
+      void Init(System::SystemTask* systemTask);
+      void SetAlarm(uint8_t alarmHr, uint8_t alarmMin);
+      void DisableAlarm();
+      void SetOffAlarmNow();
+      uint32_t SecondsToAlarm();
+      void StopAlerting();
+      enum class AlarmState { Not_Set, Set, Alerting };
+      enum class RecurType { None, Daily, Weekdays };
+      uint8_t Hours() const {
+        return hours;
+      }
+      uint8_t Minutes() const {
+        return minutes;
+      }
+      AlarmState State() const {
+        return state;
+      }
+      RecurType Recurrence() const {
+        return recurrence;
+      }
+      void SetRecurrence(RecurType recurType) {
+        recurrence = recurType;
+      }
+
+    private:
+      Controllers::DateTime& dateTimeController;
+      System::SystemTask* systemTask = nullptr;
+      uint8_t hours;
+      uint8_t minutes;
+      std::chrono::time_point<std::chrono::system_clock, std::chrono::nanoseconds> alarmTime;
+      AlarmState state = AlarmState::Not_Set;
+      RecurType recurrence = RecurType::None;
+      void ScheduleAlarm();
+    };
+  }
+}

src/components/motor/MotorController.cpp

@@ -42,6 +42,12 @@ void MotorController::StartRinging() {
   app_timer_start(longVibTimer, APP_TIMER_TICKS(1000), this);
 }
 
+// This function is the same as StartRinging(), but will ring even if notifications are turned off in Settings
+void MotorController::StartRingingDisregardSettings() {
+  Ring(this);
+  app_timer_start(longVibTimer, APP_TIMER_TICKS(1000), this);
+}
+
 void MotorController::StopRinging() {
   app_timer_stop(longVibTimer);
   nrf_gpio_pin_set(pinMotor);

src/components/motor/MotorController.h

@@ -15,6 +15,7 @@ namespace Pinetime {
       void RunForDuration(uint8_t motorDuration);
       void StartRinging();
       static void StopRinging();
+      void StartRingingDisregardSettings();
 
     private:
       static void Ring(void* p_context);

src/displayapp/Apps.h

@@ -12,6 +12,7 @@ namespace Pinetime {
       NotificationsPreview,
       Notifications,
       Timer,
+      Alarm,
       FlashLight,
       BatteryInfo,
       Music,

src/displayapp/DisplayApp.cpp

@@ -3,6 +3,7 @@
 #include <displayapp/screens/HeartRate.h>
 #include <displayapp/screens/Motion.h>
 #include <displayapp/screens/Timer.h>
+#include <displayapp/screens/Alarm.h>
 #include "components/battery/BatteryController.h"
 #include "components/ble/BleController.h"
 #include "components/datetime/DateTimeController.h"
@@ -90,6 +91,7 @@ DisplayApp::DisplayApp(Drivers::St7789& lcd,
                        Pinetime::Controllers::MotorController& motorController,
                        Pinetime::Controllers::MotionController& motionController,
                        Pinetime::Controllers::TimerController& timerController,
+                       Pinetime::Controllers::AlarmController& alarmController,
                        Pinetime::Controllers::TouchHandler& touchHandler)
   : lcd {lcd},
     lvgl {lvgl},
@@ -104,6 +106,7 @@ DisplayApp::DisplayApp(Drivers::St7789& lcd,
     motorController {motorController},
     motionController {motionController},
     timerController {timerController},
+    alarmController {alarmController},
     touchHandler {touchHandler} {
 }
 
@@ -208,6 +211,13 @@ void DisplayApp::Refresh() {
           LoadApp(Apps::Timer, DisplayApp::FullRefreshDirections::Down);
         }
         break;
+      case Messages::AlarmTriggered:
+        if (currentApp == Apps::Alarm) {
+          auto* alarm = static_cast<Screens::Alarm*>(currentScreen.get());
+          alarm->SetAlerting();
+        } else {
+          LoadApp(Apps::Alarm, DisplayApp::FullRefreshDirections::None);
+        }
       case Messages::TouchEvent: {
         if (state != States::Running) {
           break;
@@ -340,6 +350,9 @@ void DisplayApp::LoadApp(Apps app, DisplayApp::FullRefreshDirections direction)
     case Apps::Timer:
       currentScreen = std::make_unique<Screens::Timer>(this, timerController);
       break;
+    case Apps::Alarm:
+      currentScreen = std::make_unique<Screens::Alarm>(this, alarmController);
+      break;
 
     // Settings
     case Apps::QuickSettings:

src/displayapp/DisplayApp.h

@@ -14,7 +14,9 @@
 #include "components/settings/Settings.h"
 #include "displayapp/screens/Screen.h"
 #include "components/timer/TimerController.h"
+#include "components/alarm/AlarmController.h"
 #include "touchhandler/TouchHandler.h"
+
 #include "Messages.h"
 
 namespace Pinetime {
@@ -57,6 +59,7 @@ namespace Pinetime {
                  Pinetime::Controllers::MotorController& motorController,
                  Pinetime::Controllers::MotionController& motionController,
                  Pinetime::Controllers::TimerController& timerController,
+                 Pinetime::Controllers::AlarmController& alarmController,
                  Pinetime::Controllers::TouchHandler& touchHandler);
       void Start();
       void PushMessage(Display::Messages msg);
@@ -82,6 +85,7 @@ namespace Pinetime {
       Pinetime::Controllers::MotorController& motorController;
       Pinetime::Controllers::MotionController& motionController;
       Pinetime::Controllers::TimerController& timerController;
+      Pinetime::Controllers::AlarmController& alarmController;
       Pinetime::Controllers::TouchHandler& touchHandler;
 
       Pinetime::Controllers::FirmwareValidator validator;

src/displayapp/Messages.h

@@ -15,7 +15,8 @@ namespace Pinetime {
         BleFirmwareUpdateStarted,
         UpdateTimeOut,
         DimScreen,
-        RestoreBrightness
+        RestoreBrightness,
+        AlarmTriggered
       };
     }
   }