mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-26 20:16:52 +00:00
eb027142ab
* s-t integrations: apply sentence-style capitalization * Fix capitalization errors in brand names I instroduced in previous commit.
95 lines
3.1 KiB
Markdown
95 lines
3.1 KiB
Markdown
---
|
|
title: Sun
|
|
description: Instructions on how to track the sun within Home Assistant.
|
|
ha_category:
|
|
- Environment
|
|
ha_release: pre 0.7
|
|
ha_quality_scale: internal
|
|
ha_codeowners:
|
|
- '@Swamp-Ig'
|
|
ha_iot_class: Calculated
|
|
ha_domain: sun
|
|
ha_config_flow: true
|
|
ha_integration_type: integration
|
|
ha_platforms:
|
|
- sensor
|
|
---
|
|
|
|
The sun integration will use the location as
|
|
{% my general title="configured in your Home Assistant configuration" %} to
|
|
track if the sun is above or below the horizon. The sun can be used within
|
|
automations as
|
|
[a trigger with an optional offset to simulate dawn/dusk][sun_trigger] or as
|
|
[a condition with an optional offset to test if the sun has already set or risen][sun_condition].
|
|
|
|
[sun_trigger]: /docs/automation/trigger/#sun-trigger
|
|
[sun_condition]: /docs/scripts/conditions/#sun-condition
|
|
|
|
## Configured by default
|
|
|
|
This integration is by default configured and installed, and you don't need
|
|
to configure it yourself, unless you've disabled or removed the
|
|
[`default_config:`](/integrations/default_config/) line from your
|
|
YAML configuration.
|
|
|
|
If that is the case, you can configure it as described in the next paragraphs.
|
|
|
|
{% include integrations/config_flow.md %}
|
|
|
|
## YAML configuration
|
|
|
|
Alternatively, this integration can be configured and set up manually via YAML
|
|
instead. To enable the sun integration in your installation, add the
|
|
following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sun:
|
|
```
|
|
|
|
<p class='img'>
|
|
<img src='/images/screenshots/more-info-dialog-sun.png' />
|
|
</p>
|
|
|
|
## Automation trigger
|
|
|
|
The sun's event listener will call the service when the sun rises or sets with
|
|
an offset.
|
|
|
|
The sun trigger need to have the type 'sun', which event (sunset or sunrise) and an optional offset.
|
|
|
|
```yaml
|
|
trigger:
|
|
- platform: sun
|
|
event: sunrise
|
|
offset: "-01:00:01"
|
|
```
|
|
|
|
| Key name | Description |
|
|
| --------- | ----------- |
|
|
| `event` | Possible values: `sunset` or `sunrise`
|
|
| `offset` | An optional offset for the sun event trigger, in a positive or negative number of seconds, or specified in `HH:MM:SS` (after sun event trigger) or `-HH:MM:SS` (before sun event trigger).
|
|
|
|
### Maintains entity `sun.sun`
|
|
|
|
| Possible state | Description |
|
|
| --------- | ----------- |
|
|
| `above_horizon` | When the sun is above the horizon.
|
|
| `below_horizon` | When the sun is below the horizon.
|
|
|
|
## Sensors
|
|
|
|
The sensors are also available as attributes on the `sun.sun` entity for backwards compatibility reasons.
|
|
|
|
| Sensors | Description |
|
|
| --------- | ----------- |
|
|
| Next rising | Date and time of the next sun rising (in UTC).
|
|
| Next setting | Date and time of the next sun setting (in UTC).
|
|
| Next dawn | Date and time of the next dawn (in UTC).
|
|
| Next dusk | Date and time of the next dusk (in UTC).
|
|
| Next noon | Date and time of the next solar noon (in UTC).
|
|
| Next midnight | Date and time of the next solar midnight (in UTC).
|
|
| Elevation | Solar elevation. This is the angle between the sun and the horizon. Negative values mean the sun is below the horizon.
|
|
| Azimuth | Solar azimuth. The angle is shown clockwise from north.
|
|
| `rising` | True if the Sun is currently rising, after solar midnight and before solar noon.
|