@@ -7,19 +7,33 @@ NOTE: Any numbering of examples is to retain consistency with the Arduino librar
77Simple example for the qwiic MAX3010x device
88 Outputs all Red/IR/Green values.
99
10+ The key methods showcased by this exmple are:
11+ - [ getIR()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a74b40102bfeaf8f765d20f91b3deb37c )
12+ - [ getGreen()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#ad443418504fbc1fe17db8ca4dd2ff271 )
13+
1014## Ex2 Presence Sensing
1115Simple example for the qwiic MAX3010x device
1216 This takes an average reading at power up and if the reading changes more than 100,
1317 then print 'Something is there!'.
1418
19+ The key methods showcased by this exmple are:
20+ - [ setPulseAmplitudeRed()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#aff2c4701cdc8565ea27cfb03a207cc78 )
21+ - [ setPulseAmplitudeGreen()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a8cce76d9c5e32566ccaa9900e54cb12b )
22+ - [ getIR()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a74b40102bfeaf8f765d20f91b3deb37c )
23+
24+
1525## Ex3 Temperature Sense
1626Simple example for the qwiic MAX3010x device
1727 This demo outputs the onboard temperature sensor.
1828 The temp sensor is accurate to +/-1 C but
1929 has an astonishing precision of 0.0625 C.
30+
31+ The key methods showcased by this exmple are:
32+ - [ readTemperature()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a453aaba7260dd7200b8c5e806d8cb724 )
33+ - [ readTemperatureF()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a4e2e7d76dbdb48b67b152712677fcc17 )
2034
2135## Ex4 Heartbeat Plotter
22- Simple example for the qwiic MAX3010x device
36+ NOTE: This example is ONLY available for Linux/Raspberry Pi, NOT MicroPython and CircuitPython
2337 Shows the user's heart beat on a graphical plotter
2438 Using Matplotlib
2539 To learn more about plotting data in python check out this tutorial:
@@ -31,11 +45,24 @@ Simple example for the qwiic MAX3010x device
3145Simple example for the qwiic MAX3010x device
3246 This is a demo to show the reading of heart rate or beats per minute (BPM) using
3347 a Penpheral Beat Amplitude (PBA) algorithm.
48+
49+ The key methods showcased by this exmple are:
50+ - [ setPulseAmplitudeRed()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#aff2c4701cdc8565ea27cfb03a207cc78 )
51+ - [ setPulseAmplitudeGreen()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a8cce76d9c5e32566ccaa9900e54cb12b )
52+ - [ checkForBeat()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a38a991958e121a42210a0ad44c6d4bdb )
53+
3454
3555## Ex6 Fifo Readings
3656Simple example for the qwiic MAX3010x device
3757 Outputs all Red/IR/Green values at about 5Hz by polling the FIFO
3858 Note, the Hz is slowed down by printing to the python terminal,
3959 It can be drmatically speed up if printing is omitted or intermittent
60+
61+ The key methods showcased by this exmple are:
62+ - [ available()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a8bbd8851f5095ad14de9dfbb8643ed3f )
63+ - [ getFIFORed()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#a1c8df66708cfdf2fd12e16440a8e6316 )
64+ - [ getFIFOIR()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#ac6de275aa402ba5f73c963fed638919e )
65+ - [ getFIFOGreen()] ( https://docs.sparkfun.com/qwiic_max3010x_py/classqwiic__max3010x_1_1qwiic__max3010x_1_1_qwiic_max3010x.html#ae912c2ac08f07689e03405d1192a16b7 )
66+
4067
4168
0 commit comments