shivamkak19 / rem-clock

The REM-Clock sets an alarm that wakes up users after an input REM sleep cycle count to maximize restful sleep for users. `

Project Description

Have you ever wanted to optimize the sleep you get at night? From service staff working night shifts to doctors staffing the emergency room to athletes on professional training cycles, many people in society only have a limited window of time in which they can get the sleep they need for the night.

What if there was a way to guarantee restful sleep during this window of time?

Sleep therapists recommend waking from sleep after completion of a REM cycle, which is the latter half of the general sleep cycle. The REM-Clock sets an alarm that wakes up users after an input REM sleep cycle count to maximize restful sleep for users. `

View Product · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Project Design

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Below, we have included the set up process for running the arduino code. For set up process of the hardware with Arduino Uno, heart rate chip, and LED panel, please see REPORT.md.

Prerequisites

To run this project, you must download the latest version of the Arduino IDE (2.1.1). Download here: https://www.arduino.cc/en/software

Installation

1. Clone the repo

   git clone https://github.com/Shivamkak19/REM-Clock.git

(back to top)

Usage

Once the source code is uploaded onto an Arduino Uno, the user must strap their finger into the heart rate monitor finger clasp. The LED panel will display important information regarding REM sleep cycle count and current heart rate.

The alarm will ring after the input REM cycle count has elapsed.

(back to top)

Roadmap

• Configure Circuit Design
• Design algorithm for locating REM sleep cycles
• Collect user input for desired quantity of REM sleep cycles
  • Set alarm accordingly

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/newFeature)
3. Commit your Changes (git commit -m 'Add some new feature to REM-Clock')
4. Push to the Branch (git push origin feature/newFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

• Shivam Kak: [email protected]
• Maxwell Lin: [email protected]
• Project Link: https://github.com/Shivamkak19/REM-Clock

(back to top)

Acknowledgments

• Hossein Valavi, professor of Electrical Engineering at Princeton, for instruction of ECE 203 circuit analysis as well as support throughout the building process.
• David Radcliff, Undergraduate Lab Manager @ Princeton Engineering, for assistance in debugging hardware issues and instruction in proper usage of electrical equipment.

(back to top)