From a664249de9806c3bb3ef82edb1a3589c403bb3ba Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 30 Sep 2016 20:49:21 +0200 Subject: [PATCH] Minimizing of the configuration sample (#1009) --- source/_components/sensor.time_date.markdown | 20 +++++++++---------- source/_components/sensor.worldclock.markdown | 7 +++---- 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/source/_components/sensor.time_date.markdown b/source/_components/sensor.time_date.markdown index a35b70f4c08..a37980565e5 100644 --- a/source/_components/sensor.time_date.markdown +++ b/source/_components/sensor.time_date.markdown @@ -14,24 +14,24 @@ ha_release: pre 0.7 --- -The time and date (`time_date`) platform simple displays the time in various formats, the date, or both. +The time and date (`time_date`) sensor platform simple displays the time in various formats, the date, or both. To enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - platform: time_date - display_options: - - 'time' - - 'date' - - 'date_time' - - 'time_date' - - 'time_utc' - - 'beat' + - platform: time_date + display_options: + - 'time' + - 'date' + - 'date_time' + - 'time_date' + - 'time_utc' + - 'beat' ``` -The types *date_time* and *time_date* shows the date and the time. The other types just the time or the date. *beat* shows the [Swatch Internet Time](http://www.swatch.com/en_us/internet-time). +- **display_options** array (*Required*): The option to display. The types *date_time* and *time_date* shows the date and the time. The other types just the time or the date. *beat* shows the [Swatch Internet Time](http://www.swatch.com/en_us/internet-time).

diff --git a/source/_components/sensor.worldclock.markdown b/source/_components/sensor.worldclock.markdown index d6f37031f3e..c195fe37ce9 100644 --- a/source/_components/sensor.worldclock.markdown +++ b/source/_components/sensor.worldclock.markdown @@ -21,15 +21,14 @@ To enable this sensor in your installation, add the following to your `configura ```yaml # Example configuration.yaml entry sensor: - platform: worldclock - time_zone: America/New_York - name: New York + - platform: worldclock + time_zone: America/New_York ``` Configuration variables: - **time_zone** (*Required*): The resource or endpoint that contains the value. -- **name** (*Optional*): The name of the sensor, eg. the city. +- **name** (*Optional*): The name of the sensor, eg. the city. Defaults to 'Worldclock Sensor'. For valid time zones check the **TZ** column in the [Wikipedia overview](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Or get the full list from the [pytz](https://pypi.python.org/pypi/pytz) module.