homebridge-hue-daylight-sync
v1.4.0
Published
A Homebridge plugin for syncing Hue lights with daylight
Downloads
4,634
Maintainers
Readme
Hue Daylight Sync
Hue Daylight Sync: Automated Philips Hue Light Adjustment for Natural Daylight Cycles
Hue Daylight Sync is a Homebridge plugin that automatically adjusts your Philips Hue lights based on the natural daylight cycle. It calculates the ideal color temperature throughout the day based on your geographical location and smoothly transitions your lights to match.
Demo
Features
- Natural Bell Curve Color Temperature Transitions
- Smooth, Gradual Changes: The plugin now uses a cosine function to create a smooth, bell-shaped curve for color temperature transitions throughout the day.
- Enhanced Natural Lighting: Mimics the natural progression of daylight, providing a more comfortable and realistic lighting environment.
- Automatic color temperature adjustment based on time of day
- Customizable warm and cool temperature ranges
- Geolocation-based calculations for accurate sunlight mimicking
- Manual override option with automatic mode switch
Auto Mode and Manual Adjustments
- Auto Mode: Automatically adjusts your lights' color temperature based on the time of day. Enabled by default.
- Manual Adjustments: Changing the brightness slider or color temperature in the Home app will disable Auto Mode, allowing you to set your preferred lighting.
- Re-Enabling Auto Mode: To resume automatic adjustments, simply toggle the "Auto Mode" switch back on in the Home app.
Prerequisites
- Homebridge installed on your system
- Philips Hue Bridge with API access - Hue Guide
- Philips Hue color temperature capable lights
Installation
- Install the plugin through Homebridge UI or manually:
npm install -g homebridge-hue-daylight-sync
- Configure the plugin in your Homebridge
config.json
or through the Homebridge UI.
Configuration
Add the following to your Homebridge config.json
file:
{
"platforms": [
{
"platform": "HueDaylightSync",
"name": "Hue Daylight Sync",
"bridgeIp": "YOUR_HUE_BRIDGE_IP",
"apiToken": "YOUR_HUE_API_TOKEN",
"latitude": 51.5072, // Replace with your latitude
"longitude": 0.1276, // Replace with your longitude
"warmTemp": 2700,
"coolTemp": 3000,
"curveExponent": 3,
"updateInterval": 300000,
"inputDebounceDelay": 750,
"defaultAutoMode" : true
}
]
}
Configuration Options
| Option | Type | Description | Default |
|--------|------|-------------|---------|
| bridgeIp
| string
| The IP address of your Hue Bridge | Required |
| apiToken
| string
| Your Hue API token | Required |
| latitude
| number
| Your geographical decimal degrees latitude. Example: 51.5072 for London, but use your location's coordinates | Required |
| longitude
| number
| Your geographical decimal degrees longitude. Example: 0.1276 for London, but use your location's coordinates | Required |
| warmTemp
| number
| Warmest color temperature in Kelvin | 2700 |
| coolTemp
| number
| Coolest color temperature in Kelvin | 3000 |
| curveExponent
| number
| Adjusts the steepness of the transition curve | 3 |
| updateInterval
| number
| Interval in milliseconds between temperature updates | 300000 (5 minutes) |
| inputDebounceDelay
| number
| Delay in milliseconds to prevent rapid successive updates | 750 |
| defaultAutoMode
| boolean
| Enable Auto Mode by default | true |
Note: For latitude
and longitude
, you must enter the coordinates for your specific location. The values shown in the example are for London, UK - make sure to replace these with your own coordinates.
You can find your coordinates using online services like Google Maps or websites like https://www.latlong.net/
Usage
Once installed and configured, the plugin will appear in your Home app as a light accessory with an additional switch for the Auto Mode.
- Toggle the main switch to turn the Daylight Sync on or off.
- Use the brightness slider to manually adjust the color temperature.
- Toggle the Auto Mode switch to enable or disable automatic temperature adjustments.
When Auto Mode is enabled, the plugin will automatically adjust your Hue lights' color temperature throughout the day to match natural daylight patterns.
Troubleshooting
If you encounter any issues:
- Check your Homebridge logs for any error messages.
- Ensure your Hue Bridge IP and API token are correct.
- Verify that your latitude and longitude are set correctly.
- Make sure your Hue lights support color temperature adjustments.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.
Acknowledgements
- Homebridge for making this integration possible.
- Philips Hue for their smart lighting system and API.