## Setup
Follow these steps to set up the Philips Hue Lighting Demo on your local machine:
1. **Clone the repository:**
```bash
git clone <repository-url>
-
Navigate to the project directory:
cd philips-hue-lighting-demo
-
Install dependencies:
pip install -r requirements.txt
-
Configure Hue Bridge:
- Update the
bridge_ip
andusername
inapp/hue_api.py
with your Philips Hue bridge's IP address and username.
- Update the
-
Run the Flask App:
python app/main.py
-
Access the Web Interface:
- Open your web browser and go to
http://localhost:5000
.
- Open your web browser and go to
To use the application on mobile devices:
-
Set Up Environment Variables:
- Create a
.env
file in the root of the React project. - Add the following line to specify your computer's IP address:
REACT_APP_API_HOST=your.ip.addr.ess
- Replace
your.ip.addr.ess
with the actual IP address of your computer where the Flask server is running.
- Create a
-
Restart the Development Server:
- After setting the environment variable, restart your React development server to apply the changes.
### Updated README.md
With the new **Setup** section added, here is the revised README structure:
```markdown
# Philips Hue Lighting Demo
## Setup
Follow these steps to set up the Philips Hue Lighting Demo on your local machine:
1. **Clone the repository:**
```bash
git clone <repository-url>
-
Navigate to the project directory:
cd philips-hue-lighting-demo
-
Install dependencies:
pip install -r requirements.txt
-
Configure Hue Bridge:
- Update the
bridge_ip
andusername
inapp/hue_api.py
with your Philips Hue bridge's IP address and username.
- Update the
-
Run the Flask App:
python app/main.py
-
Access the Web Interface:
- Open your web browser and go to
http://localhost:5000
.
- Open your web browser and go to
To use the application on mobile devices:
-
Set Up Environment Variables:
- Create a
.env
file in the root of the React project. - Add the following line to specify your computer's IP address:
REACT_APP_API_HOST=your.ip.addr.ess
- Replace
your.ip.addr.ess
with the actual IP address of your computer where the Flask server is running.
- Create a
-
Restart the Development Server:
- After setting the environment variable, restart your React development server to apply the changes.
This feature automates indoor lighting to sync with natural circadian rhythms, enhancing user well-being by simulating natural light cycles.
- Automate lighting to align with natural circadian rhythms.
- Provide easy-to-use settings for customizing light timing.
- Timing Logic: Develop the backend logic for circadian-based light timing.
- User Settings: Create a simple UI for users to adjust light schedules.
- Integration: Ensure smooth integration with existing lighting controls.
- Testing: Test the automation feature in different scenarios.
- Open the web interface.
- Navigate to the new "Circadian Rhythm Lighting" section.
- Customize the light schedules as per your preference.
- Focus on simplicity and user control.
Target completion: Next product update.