Fixed a bug when using software timer

biomurph · biomurph · commit 3deefeadb971 · 2025-04-28T15:59:07.000-04:00
diff --git a/examples/.DS_Store b/examples/.DS_Store
diff --git a/examples/PulseSensor_BPM/PulseSensor_BPM.ino b/examples/PulseSensor_BPM/PulseSensor_BPM.ino
@@ -15,6 +15,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
@@ -147,19 +151,20 @@ if(pulseSensor.UsingHardwareTimer){
 */
   if (pulseSensor.sawNewSample()) {
     /*
-        Every so often, send the latest Sample.
+        Every 20 milliseconds, send the latest Sample.
         We don't print every sample, because our baud rate
         won't support that much I/O.
     */
-    if (--pulseSensor.samplesUntilReport == (byte) 0) {
+    if ((pulseSensor.samplesUntilReport--) == 0) {
       pulseSensor.samplesUntilReport = SAMPLES_PER_SERIAL_SAMPLE;
       pulseSensor.outputSample();
     }
   }
 }
   /*
      If a beat has happened since we last checked,
-     write the per-beat information to Serial.
+     write the per-beat information to Serial, formatted as CSV:
+     BPM, IBI, PulseSensor Signal
    */
     if (pulseSensor.sawStartOfBeat()) {
       pulseSensor.outputBeat();
diff --git a/examples/PulseSensor_ESP32/PulseSensor_ESP32.ino b/examples/PulseSensor_ESP32/PulseSensor_ESP32.ino
@@ -28,6 +28,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 
diff --git a/examples/PulseSensor_Pulse_Transit_Time/PulseSensor_Pulse_Transit_Time.ino b/examples/PulseSensor_Pulse_Transit_Time/PulseSensor_Pulse_Transit_Time.ino
@@ -22,6 +22,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
@@ -182,11 +186,11 @@ if(pulseSensor.UsingHardwareTimer){
 */
   if (pulseSensor.sawNewSample()) {
     /*
-        Every so often, send the latest Sample.
+        Every 20 milliseconds, send the latest Sample.
         We don't print every sample, because our baud rate
         won't support that much I/O.
     */
-    if (--pulseSensor.samplesUntilReport == (byte) 0) {
+    if ((pulseSensor.samplesUntilReport--) == 0) {
       pulseSensor.samplesUntilReport = SAMPLES_PER_SERIAL_SAMPLE;
       pulseSensor.outputSample();
     }
diff --git a/examples/PulseSensor_Servo_Motor/PulseSensor_Servo_Motor.ino b/examples/PulseSensor_Servo_Motor/PulseSensor_Servo_Motor.ino
@@ -20,6 +20,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
@@ -170,7 +174,7 @@ void loop() {
   */
     if (pulseSensor.sawNewSample()) {
       /*
-          Every so often, send the latest Sample.
+          Every 20 milliseconds, send the latest Sample.
           We don't print every sample, because our baud rate
           won't support that much I/O.
       */
diff --git a/examples/PulseSensor_Speaker/PulseSensor_Speaker.ino b/examples/PulseSensor_Speaker/PulseSensor_Speaker.ino
@@ -21,6 +21,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
@@ -164,11 +168,11 @@ void loop() {
   */
     if (pulseSensor.sawNewSample()) {
       /*
-          Every so often, send the latest Sample.
+          Every 20 milliseconds, send the latest Sample.
           We don't print every sample, because our baud rate
           won't support that much I/O.
       */
-      if (--pulseSensor.samplesUntilReport == (byte) 0) {
+      if ((pulseSensor.samplesUntilReport--) == 0) {
         pulseSensor.samplesUntilReport = SAMPLES_PER_SERIAL_SAMPLE;
         pulseSensor.outputSample();
       }
diff --git a/examples/PulseSensor_UNO_R4_WiFi_LEDmatrix_Heartbeat/PulseSensor_UNO_R4_WiFi_LEDmatrix_Heartbeat.ino b/examples/PulseSensor_UNO_R4_WiFi_LEDmatrix_Heartbeat/PulseSensor_UNO_R4_WiFi_LEDmatrix_Heartbeat.ino
@@ -16,6 +16,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
diff --git a/examples/PulseSensor_UNO_R4_WiFi_LEDmatrix_Plotter/PulseSensor_UNO_R4_WiFi_LEDmatrix_Plotter.ino b/examples/PulseSensor_UNO_R4_WiFi_LEDmatrix_Plotter/PulseSensor_UNO_R4_WiFi_LEDmatrix_Plotter.ino
@@ -17,6 +17,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
diff --git a/examples/PulseSensor_nRF52_Heartrate_Monitor_Service/PulseSensor_nRF52_Heartrate_Monitor_Service.ino b/examples/PulseSensor_nRF52_Heartrate_Monitor_Service/PulseSensor_nRF52_Heartrate_Monitor_Service.ino
@@ -13,6 +13,10 @@
     https://www.amazon.com/Heartbeat-Sensor-Projects-PulseSensor-Prototyping/dp/148429324X
     There is also a tutorial online here:
     https://pulsesensor.com/pages/nrf52-bluetooth-low-energy
+
+    For more information on the PulseSensor methods and functions
+    go to our Resources page
+    https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
diff --git a/examples/SoftwareSerialDemo/SoftwareSerialDemo.ino b/examples/SoftwareSerialDemo/SoftwareSerialDemo.ino
@@ -16,6 +16,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 /*
    Include the PulseSensor Playground library to get all the good stuff!
@@ -151,11 +155,11 @@ void loop() {
   */
     if (pulseSensor.sawNewSample()) {
       /*
-          Every so often, send the latest Sample.
+          Every 20 millisectonds, send the latest Sample.
           We don't print every sample, because our baud rate
           won't support that much I/O.
       */
-      if (--pulseSensor.samplesUntilReport == (byte) 0) {
+      if ((pulseSensor.samplesUntilReport--) == 0) {
         pulseSensor.samplesUntilReport = SAMPLES_PER_SERIAL_SAMPLE;
         pulseSensor.outputSample();
       }
diff --git a/examples/TwoPulseSensors_On_OneArduino/TwoPulseSensors_On_OneArduino.ino b/examples/TwoPulseSensors_On_OneArduino/TwoPulseSensors_On_OneArduino.ino
@@ -18,6 +18,10 @@
    should have been included with this software.
 
    This software is not intended for medical use.
+
+   For more information on the PulseSensor methods and functions
+   go to our Resources page
+   https://github.com/WorldFamousElectronics/PulseSensorPlayground/blob/master/resources/PulseSensor%20Playground%20Tools.md
 */
 
 /*
@@ -172,11 +176,11 @@ void loop() {
   */
     if (pulseSensor.sawNewSample()) {
       /*
-          Every so often, send the latest Sample.
+          Every 20 milliseconds, send the latest Sample.
           We don't print every sample, because our baud rate
           won't support that much I/O.
       */
-      if (--pulseSensor.samplesUntilReport == (byte) 0) {
+      if ((pulseSensor.samplesUntilReport--) == 0) {
         pulseSensor.samplesUntilReport = SAMPLES_PER_SERIAL_SAMPLE;
         pulseSensor.outputSample();
       }
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=PulseSensor Playground
-version=2.3.0
+version=2.4.0
 author=Joel Murphy, Yury Gitman, Brad Needham
 maintainer=Joel Murphy, Yury Gitman
 sentence=Support at PulseSensor.com
diff --git a/resources/PulseSensor_V2_BPM_Prototype/PulseSensor_V2_BPM_Prototype.ino b/resources/PulseSensor_V2_BPM_Prototype/PulseSensor_V2_BPM_Prototype.ino
diff --git a/src/PulseSensorPlayground.cpp b/src/PulseSensorPlayground.cpp
@@ -128,6 +128,7 @@ bool PulseSensorPlayground::sawNewSample() {
       unsigned long nowMicros = micros();
       if ((long) (NextSampleMicros - nowMicros) > 0L) {
         result = false;  // not time yet.
+        return result;
       }
       NextSampleMicros = nowMicros + MICROS_PER_READ;
 
diff --git a/src/PulseSensorPlayground.h b/src/PulseSensorPlayground.h
