home-assistant.io/source/_integrations/worldclock.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_quality_scale, ha_codeowners, ha_domain, ha_platforms, ha_integration_type, related

title	description	ha_category	ha_iot_class	ha_release	ha_quality_scale	ha_codeowners	ha_domain	ha_platforms	ha_integration_type	related
Worldclock	Instructions on how to integrate a Worldclock within Home Assistant.	Calendar	Local Push	pre 0.7	internal	@fabaff	worldclock	sensor	integration	docs title /docs/configuration/ Configuration file

The worldclock {% term integration %} simply displays the current time in a different time zone.

Configuration

To enable this {% term integration %} in your installation, add the following to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
sensor:
  - platform: worldclock
    time_zone: America/New_York

{% configuration %} time_zone: description: The resource or endpoint that contains the value. required: true type: string name: description: The name of the sensor, e.g., the city. required: false type: string default: Worldclock Sensor time_format: description: The time format. required: false type: string default: "%H:%M" {% endconfiguration %}

For valid time zones, check the TZ column in the Wikipedia overview, or get the full list from the pytz module.

python3 -c "import pytz;print(pytz.all_timezones)"