Component: Pulse Oximeter (Max30100) (Environmental)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 1.0 |
| Category | Environmental |
Contents
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 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
|
ReadRed |
| Returns one of the FIFO Red readings from the last update | |
 - UINT
|
Return |
|
|
ReadIR |
| Returns one of the FIFO IR readings from the last update | |
| - UINT
|
Return |
|
|
SetHighResModeEnabled |
 - BYTE
|
Enabled |
 - VOID
|
Return |
|
|
SetLEDsPulseWidth |
| - BYTE
|
PulseWidth |
| - VOID
|
Return |
|
|
SetSamplingRate |
| - BYTE
|
SampleRate |
| Range: 0-7 / 0=50Hz, 1=100Hz, .., 6=800Hz, 7=1000Hz | |
| - VOID
|
Return |
|
|
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 |
|
|
Update |
| Reads the sensor FIFO buffer and stores the readings into local RAM. Returns the number of samples read. | |
| - BYTE
|
Return |
|
|
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 |
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. | |
==Macro reference==
|
|
ReadRed |
| Returns one of the FIFO Red readings from the last update | |
| - UINT
|
Return |
|
|
ReadIR |
| Returns one of the FIFO IR readings from the last update | |
| - UINT
|
Return |
|
|
SetHighResModeEnabled |
| - BYTE
|
Enabled |
| - VOID
|
Return |
|
|
SetLEDsPulseWidth |
| - BYTE
|
PulseWidth |
| - VOID
|
Return |
|
|
SetSamplingRate |
| - BYTE
|
SampleRate |
| Range: 0-7 / 0=50Hz, 1=100Hz, .., 6=800Hz, 7=1000Hz | |
| - VOID
|
Return |
|
|
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 |
|
|
Update |
| Reads the sensor FIFO buffer and stores the readings into local RAM. Returns the number of samples read. | |
| - BYTE
|
Return |
|
|
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 |
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. | |
