homebridge-suncalc-2

Suncalc plugin for Homebridge that publishes occupancy sensors aligning with Suncalc's time periods

| Suncalc Time Period | HomeKit Sensor Name | | ------------------- | --------------------------------------------------- | | nightEnd | Morning Twilight - Astronomical twilight starts | | nauticalDawn | Nautical Dawn - Nautical twilight starts | | dawn | Civil Dawn - Civil twilight starts | | sunrise | First Light - Sun starts appearing over the horizon | | sunriseEnd | Morning Golden Hour - Sun is up, golden hour starts | | goldenHourEnd | Daytime - Golden hour ends, full day starts | | solarNoon | Solar Noon - Sun is at its highest point in the sky | | goldenHour | Evening Golden Hour - Evening golden hour starts | | sunsetStart | Sunset - Sun starts setting | | sunset | Evening Twilight - Sun falls below the horizon | | dusk | Civil Dusk - Civil twilight ends | | nauticalDusk | Nautical Dusk - Nautical twilight ends | | night | Nightfall - Astronomical twilight ends | | nadir | Deepest Night - Darkest part of the night |

This is intended for use in triggering scenes using times like sunrise and sunset, or adjacent to those events like the start of golden hour.

Modes (new in v1.1.0)

Allows the user to select how many sensors are created in case 14 is too many. Modes include:

• Full: all 14 Suncalc periods
• Extended: sunrise, sunset, and both morning and evening golden hours
• Basic: sunrise and sunset only

Offset (Sunrise/Sunset only)

Triggering from a time relative to sunset/sunrise can be useful for light triggers, if the other time periods are not suitable. This plugin allows you to specify an offset for the end of sunrise, and the beginning of sunset. For instance, if you want to trigger a scene to start 30 minutes before sunset, you can specify an sunsetStart offset of -30 in the config. This fires the trigger 30 minutes earlier than normal, allowing your lights to come on as it gets darker at your location.

Installation

1. Install Homebridge using your preferred method (you've probably done this already)
2. Install this plugin using by searching in the Homebridge UI or by running: npm install -g homebridge-suncalc-2
3. Use a website like GPS Coordinates to get your location's coordinates.
4. Save the configuration and restart Homebridge when prompted.

Configuration

{
    "instances": [
        {
            "name": "Long Beach",
            "mode": "full",
            "location": {
                "lat": 33.7527056,
                "lon": -118.1907613
            },
            "offset": {
                "sunriseEnd": 0,
                "sunsetStart": 0
            }
        }
    ],
    "platform": "Suncalc2Platform"
}

Fields:

• instances is an array which contains one or more of the following: (required).
• name is the name of the published accessory (required, unique).
• mode is a value of full, extended, or basic (required).
• location contains your location coordinates (required).
• offset contains offset values in minutes of when that event should be fired for sunrise/sunset. (optional).
• platform must be "Suncalc2Platform" (required).