Difference between revisions of "Component: Pulse Oximeter (Max30100) (Environmental)"

Latest revision as of 11:57, 3 November 2023

Author	Matrix TSL
Version	1.0
Category	Environmental

Pulse Oximeter (Max30100) component

Sensor designed to monitor heart rate and pulse omimetry. Connected using an I2C bus.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Initialise

	Initialise
Sets up the I2C bus ready for communications with the sensor IC. Must be called once before calling any of the other component macros. Applies the defauilt settings from the component properties.
- VOID	Return

ReadIR

	ReadIR
Returns one of the FIFO IR readings from the last update
- UINT	Return

ReadRed

	ReadRed
Returns one of the FIFO Red readings from the last update
- UINT	Return

SetHighResModeEnabled

	SetHighResModeEnabled

- BYTE	Enabled

- VOID	Return

SetLEDsCurrent

	SetLEDsCurrent

- BYTE	IR
Range: 0-15 / 0=0mA, 1=4mA, .., 14=46mA, 15=50mA
- BYTE	Red
Range: 0-15 / 0=0mA, 1=4mA, .., 14=46mA, 15=50mA
- VOID	Return

SetLEDsPulseWidth

	SetLEDsPulseWidth

- BYTE	PulseWidth

- VOID	Return

SetSamplingRate

	SetSamplingRate

- BYTE	SampleRate
Range: 0-7 / 0=50Hz, 1=100Hz, .., 6=800Hz, 7=1000Hz
- VOID	Return

Update

	Update
Reads the sensor FIFO buffer and stores the readings into local RAM. Returns the number of samples read.
- BYTE	Return

Property reference

	Properties
	Connections
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SDA Remap Pin

	SCL
Pin used for SCL (clock signal)
	SCL Remap Pin

	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Sensor Defaults
	Sample Rate
Sets the default sample rate
	Pulse Width
Sets the default pulse width and bit depth of the sensor measurements
	High Resolution Mode
Sets if the module defaults to high or low reolution mode
	IR LED Current
Default current to drive the IR LED
	Red LED Current
Default current to drive the Red LED
	Simulation
	Simulate Comms
Allows the I2C communications to be simulated and interfaced via an API component to real world hardware.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx FC_Comp_Source_Max30100_Pulse_Oximeter.fcfx]
 ==Detailed description==
@@ Line 34: / Line 44: @@
 ==Examples==
@@ Line 46: / Line 64: @@
 ''<span style="color:red;">No additional examples</span>''
 ==Macro reference==
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRed'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Returns one of the FIFO Red readings from the last update&nbsp;
+| colspan="2" | Sets up the I2C bus ready for communications with the sensor IC. Must be called once before calling any of the other component macros. Applies the defauilt settings from the component properties.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ReadIR===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 75: / Line 107: @@
+===ReadRed===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRed'''
+|-
+| colspan="2" | Returns one of the FIFO Red readings from the last update&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===SetHighResModeEnabled===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 93: / Line 140: @@
+===SetLEDsCurrent===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDsPulseWidth'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDsCurrent'''
 |-
 | colspan="2" | &nbsp;
@@ Line 102: / Line 150: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | PulseWidth
+| width="90%" | IR
+|-
+| colspan="2" | Range: 0-15 / 0=0mA, 1=4mA, .., 14=46mA, 15=50mA&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Red
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Range: 0-15 / 0=0mA, 1=4mA, .., 14=46mA, 15=50mA&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 111: / Line 164: @@
+===SetLEDsPulseWidth===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSamplingRate'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDsPulseWidth'''
 |-
 | colspan="2" | &nbsp;
@@ Line 120: / Line 174: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SampleRate
+| width="90%" | PulseWidth
 |-
-| colspan="2" | Range: 0-7 / 0=50Hz, 1=100Hz, .., 6=800Hz, 7=1000Hz&nbsp;
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 129: / Line 183: @@
+===SetSamplingRate===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDsCurrent'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSamplingRate'''
 |-
 | colspan="2" | &nbsp;
@@ Line 138: / Line 193: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | IR
+| width="90%" | SampleRate
 |-
-| colspan="2" | Range: 0-15 / 0=0mA, 1=4mA, .., 14=46mA, 15=50mA&nbsp;
+| colspan="2" | Range: 0-7 / 0=50Hz, 1=100Hz, .., 6=800Hz, 7=1000Hz&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Red
-|-
-| colspan="2" | Range: 0-15 / 0=0mA, 1=4mA, .., 14=46mA, 15=50mA&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 152: / Line 202: @@
+===Update===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 163: / Line 214: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | Sets up the I2C bus ready for communications with the sensor IC. Must be called once before calling any of the other component macros. Applies the defauilt settings from the component properties.&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}