home-assistant.github.io/source/_components/sensor.season.markdown
Patrick Easters 622fd9098a Clarify docs of season sensor (#3402)
Just adding clearer documentation around the configuration variables for the season sensor. Brings this more inline with other component documentation.
2017-09-19 18:37:31 +02:00

33 lines
1,023 B
Markdown

---
layout: page
title: "Season Sensor"
description: "Instructions how to add season sensors into Home Assistant."
date: 2017-07-04 07:00:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: 0.53
---
This sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the users setting in the config file.
All information about how the seasons work was taken from Wikipedia:
- [https://en.wikipedia.org/wiki/Season#Astronomical](https://en.wikipedia.org/wiki/Season#Astronomical)
- [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox)
- [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice)
```yaml
# Example configuration.yaml entry
sensor:
- platform: season
type: astronomical
```
Configuration variables:
- **type** (*Optional*): Type of season definition. Options are `meteorological` or `astronomical`. Default is `astronomical`.