Home Assistant

Worldclock

The worldclock integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] simply displays the current time in a different time zone.

Configuration

To enable this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.[Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.[Learn more] file, restart Home Assistant to apply the changes.

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

Configuration Variables

Looking for your configuration file?
time_zone string Required

The resource or endpoint that contains the value.

name string (Optional, default: Worldclock Sensor)

The name of the sensor, e.g., the city.

time_format string (Optional, default: %H:%M)

The time format.

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)"

Related topics