Use std::optional for heart rate

WhyNotHugo · WhyNotHugo · commit 3d1ee6d165d8 · 2025-08-30T04:31:01.000+02:00
If no value is available, use null. Use this distinction to
differentiate in the UI between missing data and zero value.

Still sends value 0 over BLE. I'm unsure whether this should
change or not
diff --git a/src/components/ble/HeartRateService.cpp b/src/components/ble/HeartRateService.cpp
@@ -48,19 +48,19 @@ void HeartRateService::Init() {
 int HeartRateService::OnHeartRateRequested(uint16_t attributeHandle, ble_gatt_access_ctxt* context) {
   if (attributeHandle == heartRateMeasurementHandle) {
     NRF_LOG_INFO("HEARTRATE : handle = %d", heartRateMeasurementHandle);
-    uint8_t buffer[2] = {0, heartRateController.HeartRate()}; // [0] = flags, [1] = hr value
+    uint8_t buffer[2] = {0, heartRateController.HeartRate().value_or(0)}; // [0] = flags, [1] = hr value
 
     int res = os_mbuf_append(context->om, buffer, 2);
     return (res == 0) ? 0 : BLE_ATT_ERR_INSUFFICIENT_RES;
   }
   return 0;
 }
 
-void HeartRateService::OnNewHeartRateValue(uint8_t heartRateValue) {
+void HeartRateService::OnNewHeartRateValue(std::optional<uint8_t> heartRateValue) {
   if (!heartRateMeasurementNotificationEnable)
     return;
 
-  uint8_t buffer[2] = {0, heartRateValue}; // [0] = flags, [1] = hr value
+  uint8_t buffer[2] = {0, heartRateValue.value_or(0)}; // [0] = flags, [1] = hr value
   auto* om = ble_hs_mbuf_from_flat(buffer, 2);
 
   uint16_t connectionHandle = nimble.connHandle();
diff --git a/src/components/ble/HeartRateService.h b/src/components/ble/HeartRateService.h
@@ -5,6 +5,7 @@
 #undef max
 #undef min
 #include <atomic>
+#include <optional>
 
 namespace Pinetime {
   namespace Controllers {
@@ -16,7 +17,7 @@ namespace Pinetime {
       HeartRateService(NimbleController& nimble, Controllers::HeartRateController& heartRateController);
       void Init();
       int OnHeartRateRequested(uint16_t attributeHandle, ble_gatt_access_ctxt* context);
-      void OnNewHeartRateValue(uint8_t hearRateValue);
+      void OnNewHeartRateValue(std::optional<uint8_t> hearRateValue);
 
       void SubscribeNotification(uint16_t attributeHandle);
       void UnsubscribeNotification(uint16_t attributeHandle);
diff --git a/src/components/heartrate/HeartRateController.cpp b/src/components/heartrate/HeartRateController.cpp
@@ -1,10 +1,11 @@
 #include "components/heartrate/HeartRateController.h"
 #include <heartratetask/HeartRateTask.h>
 #include <systemtask/SystemTask.h>
+#include <optional>
 
 using namespace Pinetime::Controllers;
 
-void HeartRateController::Update(HeartRateController::States newState, uint8_t heartRate) {
+void HeartRateController::Update(HeartRateController::States newState, std::optional<uint8_t> heartRate) {
   this->state = newState;
   if (this->heartRate != heartRate) {
     this->heartRate = heartRate;
diff --git a/src/components/heartrate/HeartRateController.h b/src/components/heartrate/HeartRateController.h
@@ -2,6 +2,7 @@
 
 #include <cstdint>
 #include <components/ble/HeartRateService.h>
+#include <optional>
 
 namespace Pinetime {
   namespace Applications {
@@ -20,15 +21,15 @@ namespace Pinetime {
       HeartRateController() = default;
       void Start();
       void Stop();
-      void Update(States newState, uint8_t heartRate);
+      void Update(States newState, std::optional<uint8_t> heartRate);
 
       void SetHeartRateTask(Applications::HeartRateTask* task);
 
       States State() const {
         return state;
       }
 
-      uint8_t HeartRate() const {
+      std::optional<uint8_t> HeartRate() const {
         return heartRate;
       }
 
@@ -37,8 +38,8 @@ namespace Pinetime {
     private:
       Applications::HeartRateTask* task = nullptr;
       States state = States::Stopped;
-      uint8_t heartRate = 0;
+      std::optional<uint8_t> heartRate = std::nullopt;
       Pinetime::Controllers::HeartRateService* service = nullptr;
     };
   }
-}
+}
diff --git a/src/displayapp/screens/HeartRate.cpp b/src/displayapp/screens/HeartRate.cpp
@@ -84,10 +84,11 @@ void HeartRate::Refresh() {
       lv_label_set_text_static(label_hr, "---");
       break;
     default:
-      if (heartRateController.HeartRate() == 0) {
+      auto value = heartRateController.HeartRate();
+      if (!value) {
         lv_label_set_text_static(label_hr, "---");
       } else {
-        lv_label_set_text_fmt(label_hr, "%03d", heartRateController.HeartRate());
+        lv_label_set_text_fmt(label_hr, "%03d", value.value());
       }
   }
 
diff --git a/src/displayapp/screens/WatchFaceCasioStyleG7710.cpp b/src/displayapp/screens/WatchFaceCasioStyleG7710.cpp
@@ -294,7 +294,12 @@ void WatchFaceCasioStyleG7710::Refresh() {
   if (heartbeat.IsUpdated() || heartbeatRunning.IsUpdated()) {
     if (heartbeatRunning.Get()) {
       lv_obj_set_style_local_text_color(heartbeatIcon, LV_LABEL_PART_MAIN, LV_STATE_DEFAULT, color_text);
-      lv_label_set_text_fmt(heartbeatValue, "%d", heartbeat.Get());
+      auto hb = heartbeat.Get();
+      if (hb.has_value()) {
+        lv_label_set_text_fmt(heartbeatValue, "%d", hb.value());
+      } else {
+        lv_label_set_text_static(heartbeatValue, "-");
+      }
     } else {
       lv_obj_set_style_local_text_color(heartbeatIcon, LV_LABEL_PART_MAIN, LV_STATE_DEFAULT, lv_color_hex(0x1B1B1B));
       lv_label_set_text_static(heartbeatValue, "");
diff --git a/src/displayapp/screens/WatchFaceCasioStyleG7710.h b/src/displayapp/screens/WatchFaceCasioStyleG7710.h
@@ -48,7 +48,7 @@ namespace Pinetime {
         Utility::DirtyValue<bool> bleRadioEnabled {};
         Utility::DirtyValue<std::chrono::time_point<std::chrono::system_clock, std::chrono::minutes>> currentDateTime {};
         Utility::DirtyValue<uint32_t> stepCount {};
-        Utility::DirtyValue<uint8_t> heartbeat {};
+        Utility::DirtyValue<std::optional<uint8_t>> heartbeat {};
         Utility::DirtyValue<bool> heartbeatRunning {};
         Utility::DirtyValue<bool> notificationState {};
         Utility::DirtyValue<std::chrono::time_point<std::chrono::system_clock, std::chrono::days>> currentDate;
diff --git a/src/displayapp/screens/WatchFaceDigital.cpp b/src/displayapp/screens/WatchFaceDigital.cpp
@@ -155,7 +155,12 @@ void WatchFaceDigital::Refresh() {
   if (heartbeat.IsUpdated() || heartbeatRunning.IsUpdated()) {
     if (heartbeatRunning.Get()) {
       lv_obj_set_style_local_text_color(heartbeatIcon, LV_LABEL_PART_MAIN, LV_STATE_DEFAULT, lv_color_hex(0xCE1B1B));
-      lv_label_set_text_fmt(heartbeatValue, "%d", heartbeat.Get());
+      auto hb = heartbeat.Get();
+      if (hb.has_value()) {
+        lv_label_set_text_fmt(heartbeatValue, "%d", hb.value());
+      } else {
+        lv_label_set_text_static(heartbeatValue, "-");
+      }
     } else {
       lv_obj_set_style_local_text_color(heartbeatIcon, LV_LABEL_PART_MAIN, LV_STATE_DEFAULT, lv_color_hex(0x1B1B1B));
       lv_label_set_text_static(heartbeatValue, "");
diff --git a/src/displayapp/screens/WatchFaceDigital.h b/src/displayapp/screens/WatchFaceDigital.h
@@ -47,7 +47,7 @@ namespace Pinetime {
 
         Utility::DirtyValue<std::chrono::time_point<std::chrono::system_clock, std::chrono::minutes>> currentDateTime {};
         Utility::DirtyValue<uint32_t> stepCount {};
-        Utility::DirtyValue<uint8_t> heartbeat {};
+        Utility::DirtyValue<std::optional<uint8_t>> heartbeat {};
         Utility::DirtyValue<bool> heartbeatRunning {};
         Utility::DirtyValue<bool> notificationState {};
         Utility::DirtyValue<std::optional<Pinetime::Controllers::SimpleWeatherService::CurrentWeather>> currentWeather {};
diff --git a/src/displayapp/screens/WatchFaceTerminal.cpp b/src/displayapp/screens/WatchFaceTerminal.cpp
@@ -137,8 +137,9 @@ void WatchFaceTerminal::Refresh() {
   heartbeat = heartRateController.HeartRate();
   heartbeatRunning = heartRateController.State() != Controllers::HeartRateController::States::Stopped;
   if (heartbeat.IsUpdated() || heartbeatRunning.IsUpdated()) {
-    if (heartbeatRunning.Get()) {
-      lv_label_set_text_fmt(heartbeatValue, "[L_HR]#ee3311 %d bpm#", heartbeat.Get());
+    auto hb = heartbeat.Get();
+    if (hb.has_value()) {
+      lv_label_set_text_fmt(heartbeatValue, "[L_HR]#ee3311 %d bpm#", hb.value());
     } else {
       lv_label_set_text_static(heartbeatValue, "[L_HR]#ee3311 ---#");
     }
diff --git a/src/displayapp/screens/WatchFaceTerminal.h b/src/displayapp/screens/WatchFaceTerminal.h
@@ -42,7 +42,7 @@ namespace Pinetime {
         Utility::DirtyValue<bool> bleRadioEnabled {};
         Utility::DirtyValue<std::chrono::time_point<std::chrono::system_clock, std::chrono::seconds>> currentDateTime {};
         Utility::DirtyValue<uint32_t> stepCount {};
-        Utility::DirtyValue<uint8_t> heartbeat {};
+        Utility::DirtyValue<std::optional<uint8_t>> heartbeat {};
         Utility::DirtyValue<bool> heartbeatRunning {};
         Utility::DirtyValue<bool> notificationState {};
         Utility::DirtyValue<std::chrono::time_point<std::chrono::system_clock, std::chrono::days>> currentDate;
diff --git a/src/heartratetask/HeartRateTask.cpp b/src/heartratetask/HeartRateTask.cpp
@@ -2,6 +2,7 @@
 #include <drivers/Hrs3300.h>
 #include <components/heartrate/HeartRateController.h>
 #include <nrf_log.h>
+#include <optional>
 
 using namespace Pinetime::Applications;
 
@@ -24,7 +25,7 @@ void HeartRateTask::Process(void* instance) {
 }
 
 void HeartRateTask::Work() {
-  int lastBpm = 0;
+  std::optional<uint8_t> lastBpm = std::nullopt;
   while (true) {
     Messages msg;
     uint32_t delay;
@@ -47,15 +48,15 @@ void HeartRateTask::Work() {
         case Messages::WakeUp:
           state = States::Running;
           if (measurementStarted) {
-            lastBpm = 0;
+            lastBpm = std::nullopt;
             StartMeasurement();
           }
           break;
         case Messages::StartMeasurement:
           if (measurementStarted) {
             break;
           }
-          lastBpm = 0;
+          lastBpm = std::nullopt;
           StartMeasurement();
           measurementStarted = true;
           break;
@@ -79,7 +80,7 @@ void HeartRateTask::Work() {
         // Reset all DAQ buffers
         ppg.Reset(true);
         // Force state to NotEnoughData (below)
-        lastBpm = 0;
+        lastBpm = std::nullopt;
         bpm = 0;
       } else if (bpm < 0) {
         // Reset all DAQ buffers except HRS buffer
@@ -94,7 +95,7 @@ void HeartRateTask::Work() {
       }
 
       if (bpm != 0) {
-        lastBpm = bpm;
+        lastBpm = std::make_optional(bpm);
         controller.Update(Controllers::HeartRateController::States::Running, lastBpm);
       }
     }

Original file line number	Diff line number	Diff line change
`@@ -84,10 +84,11 @@ void HeartRate::Refresh() {`
`84`	`84`	`lv_label_set_text_static(label_hr, "---");`
`85`	`85`	`break;`
`86`	`86`	`default:`
`87`		`- if (heartRateController.HeartRate() == 0) {`
	`87`	`+ auto value = heartRateController.HeartRate();`
	`88`	`+ if (!value) {`
`88`	`89`	`lv_label_set_text_static(label_hr, "---");`
`89`	`90`	`} else {`
`90`		`- lv_label_set_text_fmt(label_hr, "%03d", heartRateController.HeartRate());`
	`91`	`+ lv_label_set_text_fmt(label_hr, "%03d", value.value());`
`91`	`92`	`}`
`92`	`93`	`}`
`93`	`94`