Only warn about new config once

Author: pnbruckner

custom_components/composite/__init__.py

@@ -30,6 +30,8 @@
     CONF_OPTS,
     CONF_TIME_AS,
     CONF_TRACKERS,
+    DATA_LEGACY_WARNED,
+    DATA_TF,
     DOMAIN,
     TZ_DEVICE_LOCAL,
     TZ_DEVICE_UTC,
@@ -82,6 +84,8 @@ def _tracker_ids(value):
 
 
 async def async_setup(hass, config):
+    hass.data[DOMAIN] = {DATA_LEGACY_WARNED: False}
+
     # Get a list of all the object IDs in known_devices.yaml to see if any were created
     # when this integration was a legacy device tracker, or would otherwise conflict
     # with IDs in our config.
@@ -185,7 +189,7 @@ async def create_config(conf):
             from timezonefinder import TimezoneFinderL
 
             tf = TimezoneFinderL()
-        hass.data[DOMAIN] = tf
+        hass.data[DOMAIN][DATA_TF] = tf
 
     return True
 

custom_components/composite/const.py

@@ -3,6 +3,9 @@
 
 DOMAIN = "composite"
 
+DATA_LEGACY_WARNED = "legacy_warned"
+DATA_TF = "tf"
+
 CONF_ALL_STATES = "all_states"
 CONF_ENTITY = "entity"
 CONF_REQ_MOVEMENT = "require_movement"

custom_components/composite/device_tracker.py

@@ -71,6 +71,8 @@
     CONF_REQ_MOVEMENT,
     CONF_TIME_AS,
     CONF_TRACKERS,
+    DATA_LEGACY_WARNED,
+    DATA_TF,
     DOMAIN,
     TIME_AS_OPTS,
     TZ_DEVICE_LOCAL,
@@ -141,30 +143,32 @@ def _entities(entities):
 def setup_scanner(hass, config, see, discovery_info=None):
     """Set up a device scanner."""
     CompositeScanner(hass, config, see)
-    _LOGGER.warning(
-        '"%s: %s" under %s is deprecated. Move to "%s: %s"',
-        CONF_PLATFORM,
-        DOMAIN,
-        DT_DOMAIN,
-        DOMAIN,
-        CONF_TRACKERS,
-    )
-    pn_async_create(
-        hass,
-        title="Composite configuration has changed",
-        message="```text\n"
-        f"{DT_DOMAIN}:\n"
-        f"- platform: {DOMAIN}\n"
-        "  <TRACKER CONFIG>\n\n"
-        "```\n"
-        "is deprecated. Move to:\n\n"
-        "```text\n"
-        f"{DOMAIN}:\n"
-        f"  {CONF_TRACKERS}:\n"
-        "  - <TRACKER_CONFIG>\n"
-        "```\n\n"
-        "Also remove entries from known_devices.yaml.",
-    )
+    if not hass.data[DOMAIN][DATA_LEGACY_WARNED]:
+        _LOGGER.warning(
+            '"%s: %s" under %s is deprecated. Move to "%s: %s"',
+            CONF_PLATFORM,
+            DOMAIN,
+            DT_DOMAIN,
+            DOMAIN,
+            CONF_TRACKERS,
+        )
+        pn_async_create(
+            hass,
+            title="Composite configuration has changed",
+            message="```text\n"
+            f"{DT_DOMAIN}:\n"
+            f"- platform: {DOMAIN}\n"
+            "  <TRACKER CONFIG>\n\n"
+            "```\n"
+            "is deprecated. Move to:\n\n"
+            "```text\n"
+            f"{DOMAIN}:\n"
+            f"  {CONF_TRACKERS}:\n"
+            "  - <TRACKER_CONFIG>\n"
+            "```\n\n"
+            "Also remove entries from known_devices.yaml.",
+        )
+        hass.data[DOMAIN][DATA_LEGACY_WARNED] = True
     return True
 
 
@@ -322,7 +326,7 @@ def __init__(self, hass, config, see):
         self._entity_id = f"{DT_DOMAIN}.{self._dev_id}"
         self._time_as = config[CONF_TIME_AS]
         if self._time_as in [TZ_DEVICE_UTC, TZ_DEVICE_LOCAL]:
-            self._tf = hass.data[DOMAIN]
+            self._tf = hass.data[DOMAIN][DATA_TF]
         self._req_movement = config[CONF_REQ_MOVEMENT]
         self._lock = threading.Lock()