StopWatch: add persistence

src/CMakeLists.txt

@@ -466,6 +466,7 @@ list(APPEND SOURCE_FILES
         components/motor/MotorController.cpp
         components/settings/Settings.cpp
         components/timer/Timer.cpp
+        components/stopwatch/StopWatchController.cpp
         components/alarm/AlarmController.cpp
         components/fs/FS.cpp
         drivers/Cst816s.cpp
@@ -535,6 +536,7 @@ list(APPEND RECOVERY_SOURCE_FILES
         components/firmwarevalidator/FirmwareValidator.cpp
         components/settings/Settings.cpp
         components/timer/Timer.cpp
+        components/stopwatch/StopWatchController.cpp
         components/alarm/AlarmController.cpp
         drivers/Cst816s.cpp
         FreeRTOS/port.c
@@ -654,6 +656,7 @@ set(INCLUDE_FILES
         components/ble/SimpleWeatherService.h
         components/settings/Settings.h
         components/timer/Timer.h
+        components/stopwatch/StopWatchController.h
         components/alarm/AlarmController.h
         drivers/Cst816s.h
         FreeRTOS/portmacro.h

src/FreeRTOSConfig.h

@@ -62,7 +62,7 @@
 #define configTICK_RATE_HZ                      1024
 #define configMAX_PRIORITIES                    (3)
 #define configMINIMAL_STACK_SIZE                (120)
-#define configTOTAL_HEAP_SIZE                   (1024 * 40)
+#define configTOTAL_HEAP_SIZE                   (1024 * 39)
 #define configMAX_TASK_NAME_LEN                 (4)
 #define configUSE_16_BIT_TICKS                  0
 #define configIDLE_SHOULD_YIELD                 1

src/components/stopwatch/StopWatchController.cpp

@@ -0,0 +1,72 @@
+#include "components/stopwatch/StopWatchController.h"
+
+using namespace Pinetime::Controllers;
+
+StopWatchController::StopWatchController() {
+  Clear();
+}
+
+// State Change
+
+void StopWatchController::Start() {
+  currentState = StopWatchStates::Running;
+  startTime = xTaskGetTickCount();
+}
+
+void StopWatchController::Pause() {
+  timeElapsedPreviously = GetElapsedTime();
+  currentState = StopWatchStates::Paused;
+}
+
+void StopWatchController::Clear() {
+  currentState = StopWatchStates::Cleared;
+  timeElapsedPreviously = 0;
+
+  for (int i = 0; i < histSize; i++) {
+    history[i].number = 0;
+    history[i].timeSinceStart = 0;
+  }
+  maxLapNumber = 0;
+}
+
+// Lap
+
+void StopWatchController::AddLapToHistory() {
+  TickType_t lapEnd = GetElapsedTime();
+  history--;
+  history[0].timeSinceStart = lapEnd;
+  history[0].number = ++maxLapNumber % lapNumberBoundary;
+}
+
+int StopWatchController::GetMaxLapNumber() {
+  return maxLapNumber;
+}
+
+std::optional<LapInfo> StopWatchController::GetLapFromHistory(int index) {
+  if (index < 0 || index >= histSize || history[index].number == 0) {
+    return {};
+  }
+  return history[index];
+}
+
+// Data / State acess
+
+TickType_t StopWatchController::GetElapsedTime() {
+  if (!IsRunning()) {
+    return timeElapsedPreviously;
+  }
+  TickType_t delta = xTaskGetTickCount() - startTime;
+  return (timeElapsedPreviously + delta) % elapsedTimeBoundary;
+}
+
+bool StopWatchController::IsRunning() {
+  return currentState == StopWatchStates::Running;
+}
+
+bool StopWatchController::IsCleared() {
+  return currentState == StopWatchStates::Cleared;
+}
+
+bool StopWatchController::IsPaused() {
+  return currentState == StopWatchStates::Paused;
+}

src/components/stopwatch/StopWatchController.h

@@ -0,0 +1,68 @@
+#pragma once
+
+#include <FreeRTOS.h>
+#include <optional>
+#include <timers.h>
+#include "utility/CircularBuffer.h"
+
+namespace Pinetime {
+  namespace System {
+    class SystemTask;
+  }
+
+  namespace Controllers {
+
+    enum class StopWatchStates { Cleared, Running, Paused };
+
+    struct LapInfo {
+      int number = 0;                // Used to label the lap
+      TickType_t timeSinceStart = 0; // Excluding pauses
+    };
+
+    class StopWatchController {
+    public:
+      StopWatchController();
+
+      // StopWatch functionality and data
+      void Start();
+      void Pause();
+      void Clear();
+
+      TickType_t GetElapsedTime();
+
+      // Lap functionality
+
+      /// Only the latest histSize laps are stored
+      void AddLapToHistory();
+
+      /// Returns maxLapNumber
+      int GetMaxLapNumber();
+
+      /// Indexes into lap history, with 0 being the latest lap.
+      std::optional<LapInfo> GetLapFromHistory(int index);
+
+      bool IsRunning();
+      bool IsCleared();
+      bool IsPaused();
+
+    private:
+      // Time at which stopwatch wraps around to zero (1000 hours)
+      static constexpr TickType_t elapsedTimeBoundary = (TickType_t) configTICK_RATE_HZ * 60 * 60 * 1000;
+      // Current state of stopwatch
+      StopWatchStates currentState = StopWatchStates::Cleared;
+      // Start time of current duration
+      TickType_t startTime;
+      // How much time was elapsed before current duration
+      TickType_t timeElapsedPreviously;
+
+      // Maximum number of stored laps
+      static constexpr int histSize = 4;
+      // Value at which lap numbers wrap around to zero
+      static constexpr int lapNumberBoundary = 1000;
+      // Lap storage
+      Utility::CircularBuffer<LapInfo, histSize> history;
+      // Highest lap number; less than lapNumberBoundary, may exceed histSize
+      int maxLapNumber;
+    };
+  }
+}

src/displayapp/Controllers.h

@@ -18,6 +18,7 @@ namespace Pinetime {
     class Settings;
     class MotorController;
     class MotionController;
+    class StopWatchController;
     class AlarmController;
     class BrightnessController;
     class SimpleWeatherService;
@@ -41,6 +42,7 @@ namespace Pinetime {
       Pinetime::Controllers::Settings& settingsController;
       Pinetime::Controllers::MotorController& motorController;
       Pinetime::Controllers::MotionController& motionController;
+      Pinetime::Controllers::StopWatchController& stopWatchController;
       Pinetime::Controllers::AlarmController& alarmController;
       Pinetime::Controllers::BrightnessController& brightnessController;
       Pinetime::Controllers::SimpleWeatherService* weatherController;

src/displayapp/DisplayApp.cpp

@@ -78,6 +78,7 @@ DisplayApp::DisplayApp(Drivers::St7789& lcd,
                        Controllers::Settings& settingsController,
                        Pinetime::Controllers::MotorController& motorController,
                        Pinetime::Controllers::MotionController& motionController,
+                       Pinetime::Controllers::StopWatchController& stopWatchController,
                        Pinetime::Controllers::AlarmController& alarmController,
                        Pinetime::Controllers::BrightnessController& brightnessController,
                        Pinetime::Controllers::TouchHandler& touchHandler,
@@ -94,6 +95,7 @@ DisplayApp::DisplayApp(Drivers::St7789& lcd,
     settingsController {settingsController},
     motorController {motorController},
     motionController {motionController},
+    stopWatchController {stopWatchController},
     alarmController {alarmController},
     brightnessController {brightnessController},
     touchHandler {touchHandler},
@@ -109,6 +111,7 @@ DisplayApp::DisplayApp(Drivers::St7789& lcd,
                  settingsController,
                  motorController,
                  motionController,
+                 stopWatchController,
                  alarmController,
                  brightnessController,
                  nullptr,

src/displayapp/DisplayApp.h

@@ -13,6 +13,7 @@
 #include "components/settings/Settings.h"
 #include "displayapp/screens/Screen.h"
 #include "components/timer/Timer.h"
+#include "components/stopwatch/StopWatchController.h"
 #include "components/alarm/AlarmController.h"
 #include "touchhandler/TouchHandler.h"
 
@@ -63,6 +64,7 @@ namespace Pinetime {
                  Controllers::Settings& settingsController,
                  Pinetime::Controllers::MotorController& motorController,
                  Pinetime::Controllers::MotionController& motionController,
+                 Pinetime::Controllers::StopWatchController& stopWatchController,
                  Pinetime::Controllers::AlarmController& alarmController,
                  Pinetime::Controllers::BrightnessController& brightnessController,
                  Pinetime::Controllers::TouchHandler& touchHandler,
@@ -93,6 +95,7 @@ namespace Pinetime {
       Pinetime::Controllers::Settings& settingsController;
       Pinetime::Controllers::MotorController& motorController;
       Pinetime::Controllers::MotionController& motionController;
+      Pinetime::Controllers::StopWatchController& stopWatchController;
       Pinetime::Controllers::AlarmController& alarmController;
       Pinetime::Controllers::BrightnessController& brightnessController;
       Pinetime::Controllers::TouchHandler& touchHandler;

src/displayapp/DisplayAppRecovery.cpp

@@ -21,6 +21,7 @@ DisplayApp::DisplayApp(Drivers::St7789& lcd,
                        Controllers::Settings& /*settingsController*/,
                        Pinetime::Controllers::MotorController& /*motorController*/,
                        Pinetime::Controllers::MotionController& /*motionController*/,
+                       Pinetime::Controllers::StopWatchController& /*stopWatchController*/,
                        Pinetime::Controllers::AlarmController& /*alarmController*/,
                        Pinetime::Controllers::BrightnessController& /*brightnessController*/,
                        Pinetime::Controllers::TouchHandler& /*touchHandler*/,

src/displayapp/DisplayAppRecovery.h

@@ -31,6 +31,7 @@ namespace Pinetime {
     class MotionController;
     class TouchHandler;
     class MotorController;
+    class StopWatchController;
     class AlarmController;
     class BrightnessController;
     class FS;
@@ -57,6 +58,7 @@ namespace Pinetime {
                  Controllers::Settings& settingsController,
                  Pinetime::Controllers::MotorController& motorController,
                  Pinetime::Controllers::MotionController& motionController,
+                 Pinetime::Controllers::StopWatchController& stopWatchController,
                  Pinetime::Controllers::AlarmController& alarmController,
                  Pinetime::Controllers::BrightnessController& brightnessController,
                  Pinetime::Controllers::TouchHandler& touchHandler,