From c12b6f5d62395d1f15a37e00dcab477b09924b26 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 3 Oct 2015 11:39:41 +0200 Subject: [PATCH] Add worldclock doc --- source/components/sensor.worldclock.markdown | 34 ++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 source/components/sensor.worldclock.markdown diff --git a/source/components/sensor.worldclock.markdown b/source/components/sensor.worldclock.markdown new file mode 100644 index 00000000000..1f587ee1b5f --- /dev/null +++ b/source/components/sensor.worldclock.markdown @@ -0,0 +1,34 @@ +--- +layout: page +title: "Worldclock support" +description: "Instructions how to integrate a Worldclock within Home Assistant." +date: 2015-10-02 11:15 +sidebar: false +comments: false +sharing: true +footer: true +--- + + +The worldclock platform simple displays the current time in a different time zone + +To enable this sensor in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + platform: worldclock + time_zone: America/New_York + name: 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. + +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. + +```python +python3 -c "import pytz;print(pytz.all_timezones)" +```