aboutsummaryrefslogtreecommitdiffstats
path: root/src/heartratetask
diff options
context:
space:
mode:
Diffstat (limited to 'src/heartratetask')
-rw-r--r--src/heartratetask/HeartRateTask.cpp224
-rw-r--r--src/heartratetask/HeartRateTask.h24
2 files changed, 182 insertions, 66 deletions
diff --git a/src/heartratetask/HeartRateTask.cpp b/src/heartratetask/HeartRateTask.cpp
index 8a5a871b..d23feeda 100644
--- a/src/heartratetask/HeartRateTask.cpp
+++ b/src/heartratetask/HeartRateTask.cpp
@@ -1,12 +1,56 @@
#include "heartratetask/HeartRateTask.h"
#include <drivers/Hrs3300.h>
#include <components/heartrate/HeartRateController.h>
-#include <nrf_log.h>
using namespace Pinetime::Applications;
-HeartRateTask::HeartRateTask(Drivers::Hrs3300& heartRateSensor, Controllers::HeartRateController& controller)
- : heartRateSensor {heartRateSensor}, controller {controller} {
+namespace {
+ constexpr TickType_t backgroundMeasurementTimeLimit = 30 * configTICK_RATE_HZ;
+}
+
+std::optional<TickType_t> HeartRateTask::BackgroundMeasurementInterval() const {
+ auto interval = settings.GetHeartRateBackgroundMeasurementInterval();
+ if (!interval.has_value()) {
+ return std::nullopt;
+ }
+ return interval.value() * configTICK_RATE_HZ;
+}
+
+bool HeartRateTask::BackgroundMeasurementNeeded() const {
+ auto backgroundPeriod = BackgroundMeasurementInterval();
+ if (!backgroundPeriod.has_value()) {
+ return false;
+ }
+ return xTaskGetTickCount() - lastMeasurementTime >= backgroundPeriod.value();
+};
+
+TickType_t HeartRateTask::CurrentTaskDelay() const {
+ auto backgroundPeriod = BackgroundMeasurementInterval();
+ TickType_t currentTime = xTaskGetTickCount();
+ switch (state) {
+ case States::Disabled:
+ return portMAX_DELAY;
+ case States::Waiting:
+ // Sleep until a new event if background measuring disabled
+ if (!backgroundPeriod.has_value()) {
+ return portMAX_DELAY;
+ }
+ // Sleep until the next background measurement
+ if (currentTime - lastMeasurementTime < backgroundPeriod.value()) {
+ return backgroundPeriod.value() - (currentTime - lastMeasurementTime);
+ }
+ // If one is due now, go straight away
+ return 0;
+ case States::BackgroundMeasuring:
+ case States::ForegroundMeasuring:
+ return Pinetime::Controllers::Ppg::deltaTms;
+ }
+}
+
+HeartRateTask::HeartRateTask(Drivers::Hrs3300& heartRateSensor,
+ Controllers::HeartRateController& controller,
+ Controllers::Settings& settings)
+ : heartRateSensor {heartRateSensor}, controller {controller}, settings {settings} {
}
void HeartRateTask::Start() {
@@ -24,79 +68,68 @@ void HeartRateTask::Process(void* instance) {
}
void HeartRateTask::Work() {
- int lastBpm = 0;
+ // measurementStartTime is always initialised before use by StartMeasurement
+ // Need to initialise lastMeasurementTime so that the first background measurement happens at a reasonable time
+ lastMeasurementTime = xTaskGetTickCount();
+ valueCurrentlyShown = false;
+
while (true) {
+ TickType_t delay = CurrentTaskDelay();
Messages msg;
- uint32_t delay;
- if (state == States::Running) {
- if (measurementStarted) {
- delay = ppg.deltaTms;
- } else {
- delay = 100;
- }
- } else {
- delay = portMAX_DELAY;
- }
+ States newState = state;
- if (xQueueReceive(messageQueue, &msg, delay)) {
+ if (xQueueReceive(messageQueue, &msg, delay) == pdTRUE) {
switch (msg) {
case Messages::GoToSleep:
- StopMeasurement();
- state = States::Idle;
- break;
- case Messages::WakeUp:
- state = States::Running;
- if (measurementStarted) {
- lastBpm = 0;
- StartMeasurement();
- }
- break;
- case Messages::StartMeasurement:
- if (measurementStarted) {
+ // Ignore power state changes when disabled
+ if (state == States::Disabled) {
break;
}
- lastBpm = 0;
- StartMeasurement();
- measurementStarted = true;
+ // State is necessarily ForegroundMeasuring
+ // As previously screen was on and measurement is enabled
+ if (BackgroundMeasurementNeeded()) {
+ newState = States::BackgroundMeasuring;
+ } else {
+ newState = States::Waiting;
+ }
break;
- case Messages::StopMeasurement:
- if (!measurementStarted) {
+ case Messages::WakeUp:
+ // Ignore power state changes when disabled
+ if (state == States::Disabled) {
break;
}
- StopMeasurement();
- measurementStarted = false;
+ newState = States::ForegroundMeasuring;
+ break;
+ case Messages::Enable:
+ // Can only be enabled when the screen is on
+ // If this constraint is somehow violated, the unexpected state
+ // will self-resolve at the next screen on event
+ newState = States::ForegroundMeasuring;
+ valueCurrentlyShown = false;
+ break;
+ case Messages::Disable:
+ newState = States::Disabled;
break;
}
}
+ if (newState == States::Waiting && BackgroundMeasurementNeeded()) {
+ newState = States::BackgroundMeasuring;
+ } else if (newState == States::BackgroundMeasuring && !BackgroundMeasurementNeeded()) {
+ newState = States::Waiting;
+ }
- if (measurementStarted) {
- auto sensorData = heartRateSensor.ReadHrsAls();
- int8_t ambient = ppg.Preprocess(sensorData.hrs, sensorData.als);
- int bpm = ppg.HeartRate();
-
- // If ambient light detected or a reset requested (bpm < 0)
- if (ambient > 0) {
- // Reset all DAQ buffers
- ppg.Reset(true);
- // Force state to NotEnoughData (below)
- lastBpm = 0;
- bpm = 0;
- } else if (bpm < 0) {
- // Reset all DAQ buffers except HRS buffer
- ppg.Reset(false);
- // Set HR to zero and update
- bpm = 0;
- controller.Update(Controllers::HeartRateController::States::Running, bpm);
- }
-
- if (lastBpm == 0 && bpm == 0) {
- controller.Update(Controllers::HeartRateController::States::NotEnoughData, bpm);
- }
+ // Apply state transition (switch sensor on/off)
+ if ((newState == States::ForegroundMeasuring || newState == States::BackgroundMeasuring) &&
+ (state == States::Waiting || state == States::Disabled)) {
+ StartMeasurement();
+ } else if ((newState == States::Waiting || newState == States::Disabled) &&
+ (state == States::ForegroundMeasuring || state == States::BackgroundMeasuring)) {
+ StopMeasurement();
+ }
+ state = newState;
- if (bpm != 0) {
- lastBpm = bpm;
- controller.Update(Controllers::HeartRateController::States::Running, lastBpm);
- }
+ if (state == States::ForegroundMeasuring || state == States::BackgroundMeasuring) {
+ HandleSensorData();
}
}
}
@@ -111,6 +144,8 @@ void HeartRateTask::StartMeasurement() {
heartRateSensor.Enable();
ppg.Reset(true);
vTaskDelay(100);
+ measurementSucceeded = false;
+ measurementStartTime = xTaskGetTickCount();
}
void HeartRateTask::StopMeasurement() {
@@ -118,3 +153,70 @@ void HeartRateTask::StopMeasurement() {
ppg.Reset(true);
vTaskDelay(100);
}
+
+void HeartRateTask::HandleSensorData() {
+ auto sensorData = heartRateSensor.ReadHrsAls();
+ int8_t ambient = ppg.Preprocess(sensorData.hrs, sensorData.als);
+ int bpm = ppg.HeartRate();
+
+ // Ambient light detected
+ if (ambient > 0) {
+ // Reset all DAQ buffers
+ ppg.Reset(true);
+ controller.Update(Controllers::HeartRateController::States::NotEnoughData, bpm);
+ bpm = 0;
+ valueCurrentlyShown = false;
+ }
+
+ // Reset requested, or not enough data
+ if (bpm == -1) {
+ // Reset all DAQ buffers except HRS buffer
+ ppg.Reset(false);
+ // Set HR to zero and update
+ bpm = 0;
+ controller.Update(Controllers::HeartRateController::States::Running, bpm);
+ valueCurrentlyShown = false;
+ } else if (bpm == -2) {
+ // Not enough data
+ bpm = 0;
+ if (!valueCurrentlyShown) {
+ controller.Update(Controllers::HeartRateController::States::NotEnoughData, bpm);
+ }
+ }
+
+ if (bpm != 0) {
+ // Maintain constant frequency acquisition in background mode
+ // If the last measurement time is set to the start time, then the next measurement
+ // will start exactly one background period after this one
+ // Avoid this if measurement exceeded the time limit (which happens with background intervals <= limit)
+ if (state == States::BackgroundMeasuring && xTaskGetTickCount() - measurementStartTime < backgroundMeasurementTimeLimit) {
+ lastMeasurementTime = measurementStartTime;
+ } else {
+ lastMeasurementTime = xTaskGetTickCount();
+ }
+ measurementSucceeded = true;
+ valueCurrentlyShown = true;
+ controller.Update(Controllers::HeartRateController::States::Running, bpm);
+ return;
+ }
+ // If been measuring for longer than the time limit, set the last measurement time
+ // This allows giving up on background measurement after a while
+ // and also means that background measurement won't begin immediately after
+ // an unsuccessful long foreground measurement
+ if (xTaskGetTickCount() - measurementStartTime > backgroundMeasurementTimeLimit) {
+ // When measuring, propagate failure if no value within the time limit
+ // Prevents stale heart rates from being displayed for >1 background period
+ // Or more than the time limit after switching to screen on (where the last background measurement was successful)
+ // Note: Once a successful measurement is recorded in screen on it will never be cleared
+ // without some other state change e.g. ambient light reset
+ if (!measurementSucceeded) {
+ controller.Update(Controllers::HeartRateController::States::Running, 0);
+ valueCurrentlyShown = false;
+ }
+ if (state == States::BackgroundMeasuring) {
+ lastMeasurementTime = xTaskGetTickCount() - backgroundMeasurementTimeLimit;
+ } else {
+ lastMeasurementTime = xTaskGetTickCount();
+ }
+ }
+}
diff --git a/src/heartratetask/HeartRateTask.h b/src/heartratetask/HeartRateTask.h
index 5bbfb9fb..9478d0d4 100644
--- a/src/heartratetask/HeartRateTask.h
+++ b/src/heartratetask/HeartRateTask.h
@@ -1,8 +1,11 @@
#pragma once
#include <FreeRTOS.h>
+#include <cstdint>
+#include <optional>
#include <task.h>
#include <queue.h>
#include <components/heartrate/Ppg.h>
+#include "components/settings/Settings.h"
namespace Pinetime {
namespace Drivers {
@@ -16,26 +19,37 @@ namespace Pinetime {
namespace Applications {
class HeartRateTask {
public:
- enum class Messages : uint8_t { GoToSleep, WakeUp, StartMeasurement, StopMeasurement };
- enum class States { Idle, Running };
+ enum class Messages : uint8_t { GoToSleep, WakeUp, Enable, Disable };
- explicit HeartRateTask(Drivers::Hrs3300& heartRateSensor, Controllers::HeartRateController& controller);
+ explicit HeartRateTask(Drivers::Hrs3300& heartRateSensor,
+ Controllers::HeartRateController& controller,
+ Controllers::Settings& settings);
void Start();
void Work();
void PushMessage(Messages msg);
private:
+ enum class States : uint8_t { Disabled, Waiting, BackgroundMeasuring, ForegroundMeasuring };
static void Process(void* instance);
+ void HandleSensorData();
void StartMeasurement();
void StopMeasurement();
+ [[nodiscard]] bool BackgroundMeasurementNeeded() const;
+ [[nodiscard]] std::optional<TickType_t> BackgroundMeasurementInterval() const;
+ [[nodiscard]] TickType_t CurrentTaskDelay() const;
+
TaskHandle_t taskHandle;
QueueHandle_t messageQueue;
- States state = States::Running;
+ bool valueCurrentlyShown;
+ bool measurementSucceeded;
+ States state = States::Disabled;
Drivers::Hrs3300& heartRateSensor;
Controllers::HeartRateController& controller;
+ Controllers::Settings& settings;
Controllers::Ppg ppg;
- bool measurementStarted = false;
+ TickType_t lastMeasurementTime;
+ TickType_t measurementStartTime;
};
}
generated by cgit v1.2.3-70-g09d2 (git 2.51.2) at 2026-01-12 06:10:23 +0000