Merge pull request #26 from sakluk/main

1 renamed set_pulse_amplitude_it() to set_pulse_amplitude_ir()
2 changed bit shift direction in fifo_bytes_to_int() to return (value[0] & 0x3FFFF) >> (3 - self._pulse_width)
3 changed in check() the intendation to left for return True to let the function handle all samples in buffer

Author: n-elia

README.md

@@ -178,7 +178,7 @@ LED_POWER = MAX30105_PULSEAMP_MEDIUM
 # MAX30105_PULSE_AMP_MEDIUM =  0x7F # 25.4mA - Presence detection of ~8 inch
 # MAX30105_PULSE_AMP_HIGH =    0xFF # 50.0mA - Presence detection of ~12 inch
 sensor.set_pulse_amplitude_red(LED_POWER)
-sensor.set_pulse_amplitude_it(LED_POWER)
+sensor.set_pulse_amplitude_ir(LED_POWER)
 sensor.set_pulse_amplitude_green(LED_POWER)
 
 # Set the LED brightness of all the active LEDs

examples/heart_rate/README.md

@@ -40,11 +40,17 @@ The `HeartRateMonitor` class is designed to calculate heart rate from the raw se
 
 ## Example Usage
 
-python
-Copy code
-hr_monitor = HeartRateMonitor(sample_rate=100, window_size=150, smoothing_window=10)
+For a complete example, see `./main.py`.
 
 ```python
+# Initialize the heart rate monitor
+hr_monitor = HeartRateMonitor(
+    # Select a sample rate that matches the sensor's acquisition rate
+    sample_rate=actual_acquisition_rate,
+    # Select a significant window size to calculate the heart rate (2-5 seconds)
+    window_size=int(actual_acquisition_rate * 3),
+)
+
 # Add samples in a loop (replace the sample polling with actual sensor data retrieval)
 for _ in range(1000):  # Example loop
     sample = ...  # Poll the MAX30102/5 sensor to get a new sample

max30102/__init__.py

@@ -211,7 +211,7 @@ def setup_sensor(self, led_mode=2, adc_range=16384, sample_rate=400,
 
         # Set the LED brightness to the default value of 'low'
         self.set_pulse_amplitude_red(led_power)
-        self.set_pulse_amplitude_it(led_power)
+        self.set_pulse_amplitude_ir(led_power)
         self.set_pulse_amplitude_green(led_power)
         self.set_pulse_amplitude_proximity(led_power)
 
@@ -400,14 +400,14 @@ def set_active_leds_amplitude(self, amplitude):
         if self._active_leds > 0:
             self.set_pulse_amplitude_red(amplitude)
         if self._active_leds > 1:
-            self.set_pulse_amplitude_it(amplitude)
+            self.set_pulse_amplitude_ir(amplitude)
         if self._active_leds > 2:
             self.set_pulse_amplitude_green(amplitude)
 
     def set_pulse_amplitude_red(self, amplitude):
         self.i2c_set_register(MAX30105_LED1_PULSE_AMP, amplitude)
 
-    def set_pulse_amplitude_it(self, amplitude):
+    def set_pulse_amplitude_ir(self, amplitude):
         self.i2c_set_register(MAX30105_LED2_PULSE_AMP, amplitude)
 
     def set_pulse_amplitude_green(self, amplitude):
@@ -580,7 +580,8 @@ def bitmask(self, reg, slotMask, thing):
 
     def fifo_bytes_to_int(self, fifo_bytes):
         value = unpack(">i", b'\x00' + fifo_bytes)
-        return (value[0] & 0x3FFFF) >> self._pulse_width
+        # return (value[0] & 0x3FFFF) >> self._pulse_width  # original (bug: shifts wrong direction)
+        return (value[0] & 0x3FFFF) >> (3 - self._pulse_width)
 
     # Returns how many samples are available
     def available(self):
@@ -681,7 +682,7 @@ def check(self):
                         self.fifo_bytes_to_int(fifo_bytes[6:9])
                     )
 
-                return True
+            return True
 
         else:
             return False