mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-10-29 08:09:47 +01:00
896afdcfa1
* Missing colon * update sun * format fix and adaptation * fix format * fix format 2 * fix format 3 * fix format * fix format * fix format * format fix * revert title as heads * rename image case-sensitive * rename again
143 lines
3.9 KiB
ReStructuredText
143 lines
3.9 KiB
ReStructuredText
Sun
|
|
===
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up tracking the sun position in ESPHome.
|
|
:image: weather-sunny.png
|
|
|
|
The ``sun`` component allows you to track the sun's position in the sky.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
sun:
|
|
latitude: 48.8584°
|
|
longitude: 2.2945°
|
|
|
|
# At least one time source is required
|
|
time:
|
|
- platform: homeassistant
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **latitude** (**Required**, float): The latitude for performing the calculation.
|
|
- **longitude** (**Required**, float): The longitude for performing the calculation.
|
|
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
|
|
Automation:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
sun:
|
|
latitude: 48.8584°
|
|
longitude: 2.2945°
|
|
|
|
on_sunrise:
|
|
- then:
|
|
- logger.log: Good morning!
|
|
# Custom elevation, will be called shortly after the trigger above.
|
|
- elevation: 5°
|
|
then:
|
|
- logger.log: Good morning 2!
|
|
|
|
on_sunset:
|
|
- then:
|
|
- logger.log: Good evening!
|
|
|
|
- **on_sunrise** (*Optional*, :ref:`Automation <automation>`): An automation to perform at sunrise
|
|
when the sun crosses a specified angle.
|
|
|
|
- **elevation** (*Optional*, float): The elevation to cross. Defaults to 0° (horizon).
|
|
|
|
- **on_sunset** (*Optional*, :ref:`Automation <automation>`): An automation to perform at sunset
|
|
when the sun crosses a specified angle.
|
|
|
|
- **elevation** (*Optional*, float): The elevation to cross. Defaults to 0° (horizon).
|
|
|
|
``sun`` Sensor
|
|
--------------
|
|
|
|
Additionally, the sun component exposes its values over a sensor platform.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
sensor:
|
|
- platform: sun
|
|
name: Sun Elevation
|
|
type: elevation
|
|
- platform: sun
|
|
name: Sun Azimuth
|
|
type: azimuth
|
|
|
|
.. figure:: images/sun-sensor-ui.png
|
|
:align: center
|
|
:width: 80.0%
|
|
|
|
Configuration variables:
|
|
|
|
- **type** (**Required**, string): The type of value to track. One of ``elevation`` and
|
|
``azimuth``.
|
|
- **name** (**Required**, string): The name of the sensor.
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
|
|
|
``sun`` Text Sensor
|
|
-------------------
|
|
|
|
Other properties like the next sunset time can be read out with the sun text_sensor platform.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
text_sensor:
|
|
- platform: sun
|
|
name: Sun Next Sunrise
|
|
type: sunrise
|
|
- platform: sun
|
|
name: Sun Next Sunset
|
|
type: sunset
|
|
|
|
.. figure:: images/sun-text_sensor-ui.png
|
|
:align: center
|
|
:width: 80.0%
|
|
|
|
Configuration variables:
|
|
|
|
- **type** (**Required**, string): The type of value to track. One of ``sunrise`` and
|
|
``sunset``.
|
|
- **name** (**Required**, string): The name of the text sensor.
|
|
- **elevation** (*Optional*, float): The elevation to calculate the next sunrise/sunset event
|
|
for. Defaults to ``0°``.
|
|
- **format** (*Optional*, string): The format to format the time value with, see :ref:`display-strftime`
|
|
for more information. Defaults to ``%X``.
|
|
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- All other options from :ref:`Text Sensor <config-text_sensor>`.
|
|
|
|
.. _sun-is_above_below_horizon-condition:
|
|
|
|
``sun.is_above_horizon`` / ``sun.is_below_horizon`` Conditions
|
|
--------------------------------------------------------------
|
|
|
|
The ``sun.is_above_horizon`` and ``sun.is_below_horizon`` :ref:`conditions <config-condition>`
|
|
allow you to check if the sun is currently above or below the horizon.
|
|
|
|
.. code-block:: yaml
|
|
|
|
on_...:
|
|
- if:
|
|
condition:
|
|
- sun.is_above_horizon:
|
|
then:
|
|
- logger.log: Sun is above horizon!
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :apiref:`sun/sun.h`
|
|
- :ghedit:`Edit`
|