Skip to content

Latest commit

 

History

History
178 lines (112 loc) · 5.09 KB

README.md

File metadata and controls

178 lines (112 loc) · 5.09 KB

Heart Monitor Library by CureIO

Created by CureIO C++ Python MIT License

This library allows you to detect an irregular heart rate, find times where the user's heart is at risk and perform calculations around user specific heart rate data (MHR & THR).

C++ Installation

Once inside your projects directory perform either of the following ...

Use cURL to install the library.

curl -O https://raw.githubusercontent.com/cureio/heart/master/src/c++/CureIOHR.h

Use Wget to install the library.

wget https://raw.githubusercontent.com/cureio/heart/master/src/c++/CureIOHR.h

Python Installation

Once inside your projects directory perform either of the following ...

Use cURL to install the library.

curl -O https://raw.githubusercontent.com/cureio/heart/master/src/python/CureIOHR.py -O https://raw.githubusercontent.com/cureio/heart/master/src/python/Receive.py

Use Wget to install the library.

wget https://raw.githubusercontent.com/cureio/heart/master/src/python/CureIOHR.py  https://raw.githubusercontent.com/cureio/heart/master/src/python/Receive.py

C++ Usage

#include <CureIOHR.h> 

// Link Library

int receive();

// Only needed if functions called before full declaration of receive()

irregularHeartRateCheck(receive(), 56); 

// Function: Attempts to find an irregular heart rate if the user is 56. 
// Return Style: Boolean (0 = No, 1 = Yes)
// Requires: A receive() Function Like Below
// Variables: The number 56 can be changed to the user's real age

riskCheck(receive(), 56);

// Function: Finds if the user's heart is at risk
// Return Style: Boolean (0 = No, 1 = Yes)
// Requires: A receive() Function Like Below
// Variables: The number 56 can be changed to the user's real age

maxHeartRate(56);

// Function: Finds the maximum heart rate
// Return Style: Integer
// Requires: None
// Variables: The number 56 can be changed to the user's real age

minTargetHeartRate(56);

// Function: Finds the minimum target heart rate
// Return Style: Integer
// Requires: None
// Variables: The number 56 can be changed to the user's real age

maxTargetHeartRate(56);

// Function: Finds the maximum target heart rate
// Return Style: Integer
// Requires: None
// Variables: The number 56 can be changed to the user's real age

int receive(){

   heartRate = // Insert Specific Way to Read BPM (ONLY CHANGE THIS LINE)

   return heartRate

}

Python Usage

Main File

import CureIOHR

CureIOHR.irregularHeartRateCheck(56) 

// Function: Attempts to find an irregular heart rate if the user is 56. 
// Return Style: Boolean (True or False)
// Requires: The Receive.py File Be Adapted
// Variables: The number 56 can be changed to the user's real age

CureIOHR.riskCheck(56)

// Function: Finds if the user's heart is at risk
// Return Style: Boolean (True or False)
// Requires: The Receive.py File Be Adapted
// Variables: The number 56 can be changed to the user's real age

CureIOHR.maxHeartRate(56)

// Function: Finds the maximum heart rate
// Return Style: Integer
// Requires: None
// Variables: The number 56 can be changed to the user's real age

CureIOHR.minTargetHeartRate(56)

// Function: Finds the minimum target heart rate
// Return Style: Integer
// Requires: None
// Variables: The number 56 can be changed to the user's real age

CureIOHR.maxTargetHeartRate(56)

// Function: Finds the maximum target heart rate
// Return Style: Integer
// Requires: None
// Variables: The number 56 can be changed to the user's real age

Recieve.py File

def r():

  heartrate = # Place Specfic Code On How to Get Heart Rate For Your Certain Device
  
  return heartrate

More Examples Coming Soon

Contributing

Pull requests are welcome and greatly appreciated. If you need help open an issue and we will provide support ASAP. If you need any ideas on what to contribute check the issues tab! Thanks in advance for your support!

Contributors

Want to be on the list? When ever you make your first pull request add your name in.

About CureIO

CureIO is an open source organization that creates code to better the lives of the elderly population. We were started by three passionate teenagers; Sam Poder, Arsh Shrivastava and Neil Ghosh.

Read More

Licensed Under The MIT License

View License