From 1566dfb1cd0a549f4474fb9ebb762cb9dd997deb Mon Sep 17 00:00:00 2001
From: Xavier Moreno <xaviml.93@gmail.com>
Date: Thu, 9 Jun 2022 20:00:05 +0200
Subject: [PATCH] fix(device): rename W2049 for E2002

related to #504
---
 RELEASE_NOTES.md                              |   1 +
 apps/controllerx/cx_devices/ikea.py           |  27 ++++++++++++++++--
 .../controllers/{W2049.jpeg => E2002.jpeg}    | Bin
 docs/main.py                                  |   4 +++
 docs/notes.yaml                               |   6 ++++
 5 files changed, 35 insertions(+), 3 deletions(-)
 rename docs/docs/assets/controllers/{W2049.jpeg => E2002.jpeg} (100%)

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index ee89287a..10e8f4cd 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -13,6 +13,7 @@ _Note: Remember to restart the AppDaemon addon/server after updating to a new ve
 ## :hammer: Fixes
 
 - :warning: Change [Hue Dimmer](https://BASE_URL/controllerx/controllers/HueDimmer) mapping for Zigbee2MQTT to be compatible with `legacy: false` mapping. This option will need to be [enabled from Zigbee2MQTT](https://www.zigbee2mqtt.io/devices/324131092621.html#options). [ #496 ]
+- :warning: Rename `W2049` controllers for `E2002` (e.g. `W2049LightController` is now `E2002LightController`). The old names can still be used, but they show a warning and will be removed in the future.
 
 <!--
 ## :clock2: Performance
diff --git a/apps/controllerx/cx_devices/ikea.py b/apps/controllerx/cx_devices/ikea.py
index b6e7ee6e..d7caee39 100644
--- a/apps/controllerx/cx_devices/ikea.py
+++ b/apps/controllerx/cx_devices/ikea.py
@@ -593,7 +593,7 @@ def get_zha_action(self, data: EventData) -> str:
         return command
 
 
-class W2049LightController(LightController):
+class E2002LightController(LightController):
     def get_z2m_actions_mapping(self) -> DefaultActionsMapping:
         return {
             "on": Light.ON,
@@ -640,7 +640,17 @@ def get_zha_actions_mapping(self) -> DefaultActionsMapping:
         }
 
 
-class W2049Z2MLightController(Z2MLightController):
+class W2049LightController(E2002LightController):
+    async def initialize(self) -> None:
+        await super().initialize()
+        self.log(
+            "⚠️ `W2049LightController` is deprecated and will be removed. Use `E2002LightController` instead.",
+            level="WARNING",
+            ascii_encode=False,
+        )
+
+
+class E2002Z2MLightController(Z2MLightController):
     def get_z2m_actions_mapping(self) -> DefaultActionsMapping:
         return {
             "on": Z2MLight.ON,
@@ -657,7 +667,7 @@ def get_z2m_actions_mapping(self) -> DefaultActionsMapping:
         }
 
 
-class W2049MediaPlayerController(MediaPlayerController):
+class E2002MediaPlayerController(MediaPlayerController):
     def get_z2m_actions_mapping(self) -> DefaultActionsMapping:
         return {
             "on": MediaPlayer.PLAY_PAUSE,
@@ -688,3 +698,14 @@ def get_deconz_actions_mapping(self) -> DefaultActionsMapping:
             4001: MediaPlayer.NEXT_SOURCE,
             4003: MediaPlayer.RELEASE,
         }
+
+
+class W2049MediaPlayerController(E2002MediaPlayerController):
+    async def initialize(self) -> None:
+        await super().initialize()
+        self.log(
+            "⚠️ `W2049MediaPlayerController` is deprecated and will be removed. "
+            "Use `E2002MediaPlayerController` instead.",
+            level="WARNING",
+            ascii_encode=False,
+        )
diff --git a/docs/docs/assets/controllers/W2049.jpeg b/docs/docs/assets/controllers/E2002.jpeg
similarity index 100%
rename from docs/docs/assets/controllers/W2049.jpeg
rename to docs/docs/assets/controllers/E2002.jpeg
diff --git a/docs/main.py b/docs/main.py
index d6393c12..fd222cd4 100644
--- a/docs/main.py
+++ b/docs/main.py
@@ -60,6 +60,8 @@
     },
 ]
 
+DEPRECATED_CONTROLLERS = ["W2049"]
+
 with open(Path(__file__).parent / "notes.yaml") as f:
     NOTES: Dict[str, str] = yaml.full_load(f)
 
@@ -231,6 +233,8 @@ def get_devices() -> Dict[str, ControllerDocs]:
     devices = defaultdict(list)
     for controller in get_controllers():
         device_name = get_device_name(controller.__class__.__name__)
+        if device_name in DEPRECATED_CONTROLLERS:
+            continue
         controller_docs = get_controller_docs(controller)
         devices[device_name].append(controller_docs)
 
diff --git a/docs/notes.yaml b/docs/notes.yaml
index 48268ec4..ed17fbbb 100644
--- a/docs/notes.yaml
+++ b/docs/notes.yaml
@@ -2,6 +2,12 @@ E1744: |
   If you want to use the default controller, you will need to set `legacy: false` in the Zigbee2MQTT configuration.
   Read more in <a href="https://www.zigbee2mqtt.io/devices/E1744.html#legacy-integration">here</a>.
 
+E1810: |
+  This device mapping has also support for E1524 controller.
+
+E2002: |
+  This device mapping has also support for E2001 controller.
+
 HueDimmer: |
   In case of working with <strong>z2m</strong> the device needs to be flagged as `legacy: false` as
   <a href="https://www.zigbee2mqtt.io/devices/324131092621.html#options">Zigbee2MQTT