Entity Time Zone Sensor

Creates sensors that have details (time zone, address, etc.) about another entity's location, or the local time of a fixed time zone.

Type	Description
address	The address where the entity is located. See also Address Sensor.
country	The country the entity is in. Includes a country_code attribute.
different country	Is on when the country where entity is located is different than Home Assistant's country configuration
different time	Is on when the local time where entity is located is different than Home Assistant's local time
local time	The local time where the entity is located. No time zone suffix is included so that the UI doesn't automatically change it back to Home Assistant's local time. Includes a time attribute with a time zone "aware" Python datetime object.
time zone	The name of the time zone where the entity is located. Includes a utc_offset attribute.

All entities are disabled by default, exept for the "local time" sensor, which is enabled by default for static time zones and zone entities, and the "time zone" sensor, which is enabled by default for all other entities.

Address Sensor

The address sensor's state will typically be a "combined" address string, containing house number, road, etc. It will also have attributes for each of the address "details". The list of possible attributes is documented here. The exact set of attributes can change over time. Do not count on any particular attribute always being present. E.g., in templates, always check for the attribute's presence, or provide a |default() filter.

Installation

With HACS

You can use HACS to manage the installation and provide update notifications.

1. Add this repo as a custom repository:

https://github.com/pnbruckner/ha-entity-tz

2. Install the integration using the appropriate button on the HACS Integrations page. Search for "entity time zone".

Manual

Place a copy of the files from custom_components/entity_tz in <config>/custom_components/entity_tz, where <config> is your Home Assistant configuration directory.

NOTE: When downloading, make sure to use the Raw button from each file's page.

Versions

This custom integration supports HomeAssistant versions 2023.4.0 or newer.

Sensor History

When enabled, the "local time" sensor will change its state every minute. Also, when enabled, the "address" sensor can update quite often, especially when the input device is moving. These will cause a lot of data to get recorded that really isn't useful.

It is suggested, therefore, to add the following to your YAML configuration:

recorder:
  exclude:
    entity_globs:
      - sensor.*_address
      - sensor.*_local_time

Template Example

It is possible to use the time attribute of the "local time" sensor to convert other Python datetime or time objects to the same time zone. For example:

{% set test = states('input_datetime.test')|as_datetime|as_local %}
{{ test }}
{{ test.astimezone(state_attr('sensor.abc_local_time', 'time').tzinfo) }}