Creates sensors that provide information about various sun related events.

Follow the installation instructions below. Then add the desired configuration. Here is an example of a typical configuration:

sensor:
  - platform: sun2
    monitored_conditions:
      - sunrise
      - sunset
      - sun_phase
binary_sensor:
  - platform: sun2
    monitored_conditions:
      - elevation

You can use HACS to manage the installation and provide update notifications.

1. Add this repo as a custom repository:

https://github.com/pnbruckner/ha-sun2

2. Install the integration using the appropriate button on the HACS Integrations page. Search for "sun2".

Place a copy of:

__init__.py at <config>/custom_components/sun2/__init__.py
binary_sensor.py at <config>/custom_components/sun2/binary_sensor.py
const.py at <config>/custom_components/sun2/const.py
helpers.py at <config>/custom_components/sun2/helpers.py
sensor.py at <config>/custom_components/sun2/sensor.py
manifest.json at <config>/custom_components/sun2/manifest.json

where <config> is your Home Assistant configuration directory.

NOTE: Do not download the file by using the link above directly. Rather, click on it, then on the page that comes up use the Raw button.

This custom integration supports HomeAssistant versions 2023.3 or newer.

• monitored_conditions: A list of sensor types to create. One or more of the following:

For example, this:

- time_at_elevation: -0.833

Would be equivalent to:

- time_at_elevation: -0.833
  direction: rising
  icon: mdi:weather-sunny
  name: Rising at minus 0.833 °

Which would result in an entity with the ID: sensor.rising_at_minus_0_833_deg

When using an input_datetime entity it must have the time component. The date component is optional. If the date is not present, the result will be the sun's elevation at the given time on the current date. If the date is present, it will be used and the result will be the sun's elevation at the given time on the given date. Also in this case, the sensor entity will not have yesterday, today and tomorrow attributes.

• monitored_conditions: A list of sensor types to create. One or more of the following:

'on' when sun's elevation is above threshold, 'off' when at or below threshold. Can be specified in any of the following ways:

elevation

elevation: THRESHOLD

elevation:
  above: THRESHOLD
  name: FRIENDLY_NAME

Default THRESHOLD (as with first format) is -0.833 (same as sunrise/sunset).

Default FRIENDLY_NAME is "Above Horizon" if THRESHOLD is -0.833, "Above minus THRESHOLD" if THRESHOLD is negative, otherwise "Above THRESHOLD".

entity_id will therefore be, for example, binary_sensor.above_horizon (-0.833), or binary_sensor.above_minus_5_0 (-5) or binary_sensor.above_10_5 (10.5).

The following configuration parameters are optional, and can be used with all types of sensors. All four parameters are required, and should be specified once per platform entry. These can be used to create sensors that show sun data for another (or even multiple) location(s.) The default is to use Home Assistant's location configuration.

When using the optional entity_namespace configuration parameter, not only will this affect Entity IDs, but it will also be used in creating the entity's friendly_name. E.g., in the configuration show below, the sunrise and sunset entities for London will be named "London Sunrise" and "London Sunset".

sensor:
  - platform: sun2
    monitored_conditions:
      - solar_midnight
      - astronomical_dawn
      - nautical_dawn
      - dawn
      - sunrise
      - solar_noon
      - sunset
      - dusk
      - nautical_dusk
      - astronomical_dusk
      - daylight
      - civil_daylight
      - nautical_daylight
      - astronomical_daylight
      - night
      - civil_night
      - nautical_night
      - astronomical_night
      - azimuth
      - elevation
      - min_elevation
      - max_elevation
      - sun_phase
      - deconz_daylight
      - time_at_elevation: 10
      - time_at_elevation: -10
        direction: setting
        icon: mdi:weather-sunset-down
        name: Setting past 10 deg below horizon
      - elevation_at_time: '12:00'
      - elevation_at_time: input_datetime.test
        name: Elv @ test time
  - platform: sun2
    entity_namespace: London
    latitude: 51.50739529645933
    longitude: -0.12767666584664272
    time_zone: Europe/London
    elevation: 11
    monitored_conditions:
      - sunrise
      - sunset
binary_sensor:
  - platform: sun2
    monitored_conditions:
      - elevation
      - elevation: 3
      - elevation:
          above: -6
          name: Above Civil Dawn