Somnus

Somnus is your personal wake-up companion, designed to optimize your wake-up routine and ensure you start your day feeling refreshed and revitalized.

Features

• Sleep Cycle Optimization: Utilize sleep data from Google Fit, Samsung Health, Oppo Health, or any other health app via the Health Connect module on Android to calculate the best time to wake up based on sleep cycles.
• Scientifically Grounded: Leverage approximate REM calculations based on studies to determine the optimal wake-up time.
• Personalized Wake-Up Recommendations: Receive personalized recommendations tailored to your sleep patterns and preferences.
• User-Friendly Interface: Simple and intuitive interface for easy navigation and usage.
• Multi-Platform Support: Compatible with Android smartphones and Samsung Edge Panels.

Installation

Somnus can be installed on any Android device. Simply download the APK file from the releases section and install it on your device.

Usage

1. Open Somnus on your Android device
2. Connect Somnus to your preferred health app (Google Fit, Samsung Health, Oppo Health, etc.)
3. Set your desired wake-up time or input your bedtime
4. Receive personalized wake-up recommendations based on your sleep data and approximate REM calculations

Contributing

We encourage contributions to Somnus! This is an open-source project under the GNU General Public License v3.0, which means:

• You are free to modify and distribute the code
• Any modifications must also be open-source under GPL-3.0
• You must share any changes you make back to the project
• Source code must be provided with any distribution

To contribute:

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

Todo List

App Development:

• Set up Android development environment
• Create basic UI mockups for the main app screens
• Implement core functionality for calculating optimal wake-up times based on sleep cycles
• Integrate Health Connect API for accessing sleep data from supported health apps
• Test app functionality on various Android devices
• Edge Panels Samsung Integration

Miscellaneous:

• Set up GitHub repository for version control
• Document code and project setup in README.md
• Test app thoroughly for bugs and performance issues
• Prepare for app release on Google Play Store

License

Somnus is licensed under the GNU General Public License v3.0 - see the LICENSE file for details. This means any modifications must be shared back with the community and distributed under the same license terms.