Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cgxeiji/max3010x
Go library to use the MAX3010x family of sensors for heart rate and SpO2 readings.
https://github.com/cgxeiji/max3010x
go golang heart-rate max30102 raspberry-pi spo2
Last synced: 17 days ago
JSON representation
Go library to use the MAX3010x family of sensors for heart rate and SpO2 readings.
- Host: GitHub
- URL: https://github.com/cgxeiji/max3010x
- Owner: cgxeiji
- License: mit
- Created: 2020-09-03T07:25:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-15T07:05:33.000Z (over 3 years ago)
- Last Synced: 2024-10-16T19:31:46.454Z (2 months ago)
- Topics: go, golang, heart-rate, max30102, raspberry-pi, spo2
- Language: Go
- Homepage:
- Size: 1.73 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# max3010x
[](https://github.com/cgxeiji/max3010x/releases)
[](https://pkg.go.dev/github.com/cgxeiji/max3010x)
[](https://github.com/cgxeiji/max3010x/blob/master/LICENSE)
Go library to use the MAX3010x sensor for heart rate and SpO2 readings. Uses
[periph.io](https://periph.io/) to handle I2C communication with the sensor.
| :bangbang: | **This library has only been tested with a `MAX30102` on a `Raspberry Pi 4`. If you have a `MAX30100`, please help me with testing.** |
| :---: | :--- |
## TL;DR
You can download and build this test program:
```sh
$ go get github.com/cgxeiji/max3010x/max3010x
$ max3010x
```
## How to use?
It is as simple as:
```go
func main() {
sensor, err := max3010x.New()
if err != nil {
log.Fatal(err)
}
defer sensor.Close()
// Detect the heart rate
hr, err := sensor.HeartRate()
if errors.Is(err, max3010x.ErrNotDetected) {
hr = 0
} else if err != nil {
log.Fatal(err)
}
fmt.Println("Heart rate:", hr)
// Detect the SpO2 level
spO2, err := sensor.SpO2()
if errors.Is(err, max3010x.ErrNotDetected) {
spO2 = 0
} else if err != nil {
log.Fatal(err)
}
fmt.Println("SpO2:", spO2)
}
```
Trying to read the heart rate or SpO2 values when the sensor is not in contact
with a person will return a `max3010x.ErrNotDetected` error. You are free to
handle this however you like.
### Low-level interface
If you need to access specific functions of each sensor, or want to work with
raw data, you can cast the `sensor` to the specific `device`:
```go
func main() {
sensor, err := max3010x.New()
if err != nil {
log.Fatal(err)
}
defer sensor.Close()
device, err := sensor.ToMax30102()
if errors.Is(err, max3010x.ErrWrongDevice) {
fmt.Println("device is not MAX30102")
return
} else if err != nil {
log.Fatal(err)
}
// Get the values for the IR and red LEDs.
ir, red, err := device.IRRed()
if err != nil {
log.Fatal(err)
}
}
```
## Any questions or feedback?
[Issues](https://github.com/cgxeiji/max3010x/issues/new) and
[pull-requests](https://github.com/cgxeiji/max3010x/pulls) are welcomed!