Skip to main content

A simple algorithm to monitor heartrate using any mobile phone with a camera and flash.

Project description

Imgur

PulseTracker Tests PulseTracker Docs code style: prettier

💭 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 Distribution

pulsetracker-0.5.tar.gz (2.2 kB view hashes)

Uploaded source

Built Distribution

pulsetracker-0.5-py3-none-any.whl (3.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page