A simple algorithm to monitor heartrate using any mobile phone with a camera and flash.
Project description
💭 Background
An open source tool built for monitoring heart rate. The goal here is to have a low cost and widely accessible way to measure someones heart rate. It uses a touch-based system for generating heart rate values. In contrast to it's counterpart(touchless-based systems) it is a far more accurate and less sensitive to enviornmental conditions.
Usage
After cloning this repository and changing directories to it.
1. Install the dependencies
$ make install
2. Install library
$ make
See example of usage in examples folder.
Testing
Local Testing
$ sudo sh install.sh && sudo make test
Testing with Docker
$ sudo sh run_docker_test.sh
Documentation
We use sphinx to build our documentation based on rST files and comments in the code, below is a quick guide to getting started.
cd docs
make html
This will output the documentation to docs/_build/html
.
Now to view built documentation run open _build/html/index.html
.
Contributing
Contributions are welcome! Please read our Code of Conduct and how to contribute before contributing to help this project stay welcoming.
Directory Structure
.
├── docs # Sphinx documentation folder
├── examples # The example code
├── src # The source code for the library
├── tests # Unit tests and system tests
└── ui # The UI
To understand how the library works see pulse.py
License
MIT License
Copyright (c) 2020 Akil M Hylton
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for pulsetracker-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21e5194f1fee39ff3d5b112f81d3ec6777440d69f65706ba45e5b083115dd949 |
|
MD5 | 689a58044654c64ace4591e640653b07 |
|
BLAKE2b-256 | d13b1eb271fd772f7b7cab31573606be6875ab1a4b345b24b37a9890cd8cb9c3 |