mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-03 17:48:59 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
38 lines
1.1 KiB
Markdown
38 lines
1.1 KiB
Markdown
---
|
|
layout: page
|
|
title: "Worldclock"
|
|
description: "Instructions on how to integrate a Worldclock within Home Assistant."
|
|
date: 2015-10-02 11:15
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: home-assistant.png
|
|
ha_category: Calendar
|
|
ha_iot_class: "Local Push"
|
|
ha_release: pre 0.7
|
|
---
|
|
|
|
|
|
The `worldclock` sensor platform simply 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
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **time_zone** (*Required*): The resource or endpoint that contains the value.
|
|
- **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.
|
|
|
|
```python
|
|
python3 -c "import pytz;print(pytz.all_timezones)"
|
|
```
|