@@ -43,7 +43,7 @@ Please do not rely on it for medical purposes or professional usage.
43
43
44
44
Driver usage is quite straightforward. You just need to import the library, and to set up a ` SoftI2C ` instance.
45
45
46
- A full example is provided in ` /example ` directory.
46
+ A full example is provided in ` /examples/basic_usage ` directory.
47
47
48
48
### 1 - Including this library into your project
49
49
@@ -98,8 +98,8 @@ Then, import the constructor as follows:
98
98
from max30102 import MAX30102
99
99
```
100
100
101
- To run the example in ` ./example ` folder, copy ` max30102/circular_buffer.py ` and ` max30102/__init__.py ` into
102
- the ` ./example/ lib/max30102 ` directory. Then, upload the ` ./example ` directory content into your microcontroller. After the
101
+ To run the example in ` ./examples/basic_usage ` folder, copy ` max30102/circular_buffer.py ` and ` max30102/__init__.py ` into
102
+ the ` ./examples/basic_usage/ lib/max30102 ` directory. Then, upload the ` ./examples/basic_usage ` directory content into your microcontroller. After the
103
103
upload, press the reset button of your board are you're good to go.
104
104
105
105
### 2 - I2C setup and sensor configuration
@@ -288,6 +288,9 @@ resolution of 0.0625°C, but be aware that the accuracy is ±1°C.
288
288
289
289
## Changelog
290
290
291
+ - v0.4.2
292
+ - Added an heartrate estimation example.
293
+ - Issued a new release to update the PyPi docs.
291
294
- v0.4.1
292
295
- Changed the module files organization.
293
296
- Added support to ` mip ` package manager.
@@ -356,7 +359,7 @@ running an I2C scan before actually using the sensor, as shown in the provided e
356
359
357
360
### Realtime plot over Serial
358
361
359
- The example proposed in this repository ([ main.py] ( ./example /main.py ) ) contains a print statement in a CSV-like
362
+ The example proposed in this repository ([ main.py] ( ./examples/basic_usage /main.py ) ) contains a print statement in a CSV-like
360
363
format: ` print(red_reading, ",", IR_reading) ` . If you open Arduino IDE and connect your board, then you will be able to
361
364
open the * serial plotter* (Ctrl+Maiusc+L) and see a real-time plot of your readings (need some help? take a
362
365
look [ here] ( https://learn.sparkfun.com/tutorials/max30105-particle-and-pulse-ox-sensor-hookup-guide/all ) ).
@@ -376,8 +379,9 @@ your phone camera to check), then you have to collect IR samples as red ones and
376
379
377
380
If you're looking for algorithms for extracting heartrate and SPO2 from your RAW data, take a
378
381
look [ here] ( https://github.com/aromring/MAX30102_by_RF )
379
- and [ here] ( https://github.com/kandizzy/esp32-micropython/tree/master/PPG )
382
+ and [ here] ( https://github.com/kandizzy/esp32-micropython/tree/master/PPG ) .
380
383
384
+ A basic example of heartrate detection is also available in ` ./examples/heart_rate ` .
381
385
382
386
### ESP8266 module import error
383
387
0 commit comments