novikov-alexander/SmartSunrise

Smart Sunrise Alarm clock for Noolite MTRF-64-USB Adapter

Smart Sunrise Project

The Smart Sunrise project is a simple application that utilizes the NooLite library to simulate a sunrise by gradually adjusting the brightness level using a NooLite adapter. Is is designed to serve as a sunrise light alarm. The gradual increase in brightness mimics the natural sunrise, providing users with a gentle and effective wake-up experience. This project allows users to specify the COM port name and the desired duration for the sunrise, providing a customizable and automated way to create a gradual and natural wake-up experience.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Command-line Arguments
• Automate Daily Sunrise Simulation
• Configuration
• Plans
• Contributing
• License

Getting Started

Prerequisites

Before running the Smart Sunrise application, ensure that you have the following prerequisites:

• A PC, router, or Raspberry Pi with USB support
• .NET Core Runtime 7.0 or higher
• A NooLite power block from the SU or SUF series
• A NooLite MTRF-64-USB adapter bound to the power block

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/novikov-alexander/SmartSunrise.git

2. Navigate to the project directory:

   cd SmartSunrise

3. Build the application:

   dotnet build -c Release

Usage

Command-line Arguments

To run the Smart Sunrise application, use the following command-line syntax:

SmartSunrise.exe <COMPortName> <SunriseDurationMinutes>

<COMPortName>: The name of the COM port where the NooLite adapter is connected.

<SunriseDurationMinutes>: The duration of the simulated sunrise in minutes.

Example:

SmartSunrise.exe COM4 30

This command initiates a sunrise simulation on COM port COM4 with a duration of 30 minutes.

Automate Daily Sunrise Simulation

Windows

You can automate the sunrise simulation every day by scheduling the Smart Sunrise application using the Windows Task Scheduler. Follow these steps to set up the task:

1. Open Task Scheduler:

   • Press Win + S, type "Task Scheduler," and select the application from the search results.

2. Create a Basic Task:

   • In the right-hand Actions pane, click on "Create Basic Task..."

3. Task Name and Description:

   • Enter a name and description for your task, then click "Next."

4. Trigger Type:

   • Choose "Daily" as the trigger type, then click "Next."

5. Daily Trigger Settings:

   • Set the start date and time you want the task to run every day.
   • Choose "Recur every" and set it to "1 days."
   • Specify the "Repeat task every" if you want the task to repeat.
   • Set the duration or end date if needed.
   • Click "Next" when you're done.

6. Action Type:

   • Select "Start a program" as the action type, then click "Next."

7. Program/Script and Add Arguments:

   • In the "Program/script" field, enter the full path to your dotnet.exe and the full path to your Smart Sunrise DLL, like this:

     Program/script: path\to\SmartSunrise.exe
     Add arguments: COM4 30
     

   • Adjust the paths and command-line arguments based on your setup.
   • Click "Next" when you're done.

8. Summary:

   • Review your settings, and if everything looks correct, click "Finish."

Now, your task is scheduled to run your Smart Sunrise application every day at the specified time.

Keep in mind:

• Adjust the COM port and sunrise duration in the command-line arguments as needed.

This setup will run your Smart Sunrise application daily at the specified time, simulating a sunrise according to the configured parameters.

Linux

MacOS

TODO

Configuration

You can customize COM port name and sunrise duration via command line.

Plans

• Add a feature to customize the sunrise pattern (e.g., different brightness curves).
  • Research and analyze real lamp brightness changes during a sunrise simulation.
  • Research and analyze sun brightness changes during a real sunrise.
• Implement sunset simulation.
• Add support for smart alarm integration (e.g., Sleep as Android).
• Implement a configuration file for user preferences.
• Test the program on an OpenWRT router.
• Test the program on a Raspberry Pi.

Contributing

Contributions are welcome! If you find a bug, have a feature request, or want to contribute improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.