Merge pull request #565 from plugwise/reboot_gateway

bouwew · web-flow · commit e7112d866e24 · 2024-06-01T19:51:16.000+02:00
Add a reboot_gateway() funtion for actual Plugwise devices.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.38.0
+
+- Add a reboot_gateway() function for actual Plugwise devices.
+
 ## v0.37.9
 
 - Correct set_select() function.
diff --git a/fixtures/adam_heatpump_cooling/all_data.json b/fixtures/adam_heatpump_cooling/all_data.json
@@ -634,6 +634,7 @@
     "heater_id": "0ca13e8176204ca7bf6f09de59f81c83",
     "item_count": 415,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/adam_jip/all_data.json b/fixtures/adam_jip/all_data.json
@@ -300,6 +300,7 @@
     "heater_id": "e4684553153b44afbef2200885f379dc",
     "item_count": 213,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/adam_multiple_devices_per_zone/all_data.json b/fixtures/adam_multiple_devices_per_zone/all_data.json
@@ -479,6 +479,7 @@
         "warning": "Node Plug (with MAC address 000D6F000D13CB01, in room 'n.a.') has been unreachable since 23:03 2020-01-18. Please check the connection and restart the device."
       }
     },
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/adam_onoff_cooling_fake_firmware/all_data.json b/fixtures/adam_onoff_cooling_fake_firmware/all_data.json
@@ -98,6 +98,7 @@
     "heater_id": "0ca13e8176204ca7bf6f09de59f81c83",
     "item_count": 56,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/adam_plus_anna/all_data.json b/fixtures/adam_plus_anna/all_data.json
@@ -115,6 +115,7 @@
         "error": "There is no OpenTherm communication with the boiler."
       }
     },
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/adam_plus_anna_new/all_data.json b/fixtures/adam_plus_anna_new/all_data.json
@@ -233,6 +233,7 @@
     "heater_id": "056ee145a816487eaa69243c3280f8bf",
     "item_count": 147,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/adam_zone_per_device/all_data.json b/fixtures/adam_zone_per_device/all_data.json
@@ -479,6 +479,7 @@
         "warning": "Node Plug (with MAC address 000D6F000D13CB01, in room 'n.a.') has been unreachable since 23:03 2020-01-18. Please check the connection and restart the device."
       }
     },
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/anna_elga_2/all_data.json b/fixtures/anna_elga_2/all_data.json
@@ -93,6 +93,7 @@
     "heater_id": "573c152e7d4f4720878222bd75638f5b",
     "item_count": 62,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_elga_2_cooling/all_data.json b/fixtures/anna_elga_2_cooling/all_data.json
@@ -93,6 +93,7 @@
     "heater_id": "573c152e7d4f4720878222bd75638f5b",
     "item_count": 62,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_elga_2_schedule_off/all_data.json b/fixtures/anna_elga_2_schedule_off/all_data.json
@@ -93,6 +93,7 @@
     "heater_id": "573c152e7d4f4720878222bd75638f5b",
     "item_count": 62,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_elga_no_cooling/all_data.json b/fixtures/anna_elga_no_cooling/all_data.json
@@ -95,6 +95,7 @@
     "heater_id": "1cbf783bb11e4a7c8a6843dee3a86927",
     "item_count": 62,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_heatpump_cooling/all_data.json b/fixtures/anna_heatpump_cooling/all_data.json
@@ -94,6 +94,7 @@
     "heater_id": "1cbf783bb11e4a7c8a6843dee3a86927",
     "item_count": 63,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_heatpump_cooling_fake_firmware/all_data.json b/fixtures/anna_heatpump_cooling_fake_firmware/all_data.json
@@ -94,6 +94,7 @@
     "heater_id": "1cbf783bb11e4a7c8a6843dee3a86927",
     "item_count": 63,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_heatpump_heating/all_data.json b/fixtures/anna_heatpump_heating/all_data.json
@@ -99,6 +99,7 @@
     "heater_id": "1cbf783bb11e4a7c8a6843dee3a86927",
     "item_count": 66,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_loria_cooling_active/all_data.json b/fixtures/anna_loria_cooling_active/all_data.json
@@ -97,6 +97,7 @@
     "heater_id": "bfb5ee0a88e14e5f97bfa725a760cc49",
     "item_count": 64,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_loria_driessens/all_data.json b/fixtures/anna_loria_driessens/all_data.json
@@ -103,6 +103,7 @@
     "heater_id": "a449cbc334ae4a5bb7f89064984b2906",
     "item_count": 64,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_loria_heating_idle/all_data.json b/fixtures/anna_loria_heating_idle/all_data.json
@@ -97,6 +97,7 @@
     "heater_id": "bfb5ee0a88e14e5f97bfa725a760cc49",
     "item_count": 64,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_v4/all_data.json b/fixtures/anna_v4/all_data.json
@@ -89,6 +89,7 @@
     "heater_id": "cd0e6156b1f04d5f952349ffbe397481",
     "item_count": 56,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_v4_dhw/all_data.json b/fixtures/anna_v4_dhw/all_data.json
@@ -89,6 +89,7 @@
     "heater_id": "cd0e6156b1f04d5f952349ffbe397481",
     "item_count": 56,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_v4_no_tag/all_data.json b/fixtures/anna_v4_no_tag/all_data.json
@@ -89,6 +89,7 @@
     "heater_id": "cd0e6156b1f04d5f952349ffbe397481",
     "item_count": 56,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/anna_without_boiler_fw441/all_data.json b/fixtures/anna_without_boiler_fw441/all_data.json
@@ -63,6 +63,7 @@
     "heater_id": "c46b4794d28149699eacf053deedd003",
     "item_count": 38,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/m_adam_cooling/all_data.json b/fixtures/m_adam_cooling/all_data.json
@@ -165,6 +165,7 @@
     "heater_id": "056ee145a816487eaa69243c3280f8bf",
     "item_count": 147,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/m_adam_heating/all_data.json b/fixtures/m_adam_heating/all_data.json
@@ -164,6 +164,7 @@
     "heater_id": "056ee145a816487eaa69243c3280f8bf",
     "item_count": 147,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/m_adam_jip/all_data.json b/fixtures/m_adam_jip/all_data.json
@@ -300,6 +300,7 @@
     "heater_id": "e4684553153b44afbef2200885f379dc",
     "item_count": 213,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/m_adam_multiple_devices_per_zone/all_data.json b/fixtures/m_adam_multiple_devices_per_zone/all_data.json
@@ -470,6 +470,7 @@
         "warning": "Node Plug (with MAC address 000D6F000D13CB01, in room 'n.a.') has been unreachable since 23:03 2020-01-18. Please check the connection and restart the device."
       }
     },
+    "reboot": true,
     "smile_name": "Adam"
   }
 }
diff --git a/fixtures/m_anna_heatpump_cooling/all_data.json b/fixtures/m_anna_heatpump_cooling/all_data.json
@@ -99,6 +99,7 @@
     "heater_id": "1cbf783bb11e4a7c8a6843dee3a86927",
     "item_count": 66,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/m_anna_heatpump_idle/all_data.json b/fixtures/m_anna_heatpump_idle/all_data.json
@@ -99,6 +99,7 @@
     "heater_id": "1cbf783bb11e4a7c8a6843dee3a86927",
     "item_count": 66,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile Anna"
   }
 }
diff --git a/fixtures/p1v4/all_data.json b/fixtures/p1v4/all_data.json
@@ -46,6 +46,7 @@
         "warning": "The Smile P1 does not seem to be connected to a smart meter."
       }
     },
+    "reboot": true,
     "smile_name": "Smile P1"
   }
 }
diff --git a/fixtures/p1v4_442_single/all_data.json b/fixtures/p1v4_442_single/all_data.json
@@ -44,6 +44,7 @@
     "gateway_id": "a455b61e52394b2db5081ce025a430f3",
     "item_count": 31,
     "notifications": {},
+    "reboot": true,
     "smile_name": "Smile P1"
   }
 }
diff --git a/fixtures/p1v4_442_triple/all_data.json b/fixtures/p1v4_442_triple/all_data.json
@@ -57,6 +57,7 @@
         "warning": "The Smile P1 is not connected to a smart meter."
       }
     },
+    "reboot": true,
     "smile_name": "Smile P1"
   }
 }
diff --git a/plugwise/__init__.py b/plugwise/__init__.py
@@ -18,7 +18,14 @@
     PlugwiseData,
     ThermoLoc,
 )
-from plugwise.exceptions import InvalidSetupError, ResponseError, UnsupportedDeviceError
+from plugwise.exceptions import (
+    ConnectionFailedError,
+    DataMissingError,
+    InvalidSetupError,
+    PlugwiseError,
+    ResponseError,
+    UnsupportedDeviceError,
+)
 from plugwise.helper import SmileComm
 from plugwise.legacy.smile import SmileLegacyAPI
 from plugwise.smile import SmileAPI
@@ -141,30 +148,28 @@ async def connect(self) -> bool:
             self._user,
             self._port,
             self._timeout,
-         )
-        if self.smile_legacy:
-            self._smile_api = SmileLegacyAPI(
-                self._host,
-                self._passwd,
-                self._websession,
-                self._is_thermostat,
-                self._on_off_device,
-                self._opentherm_device,
-                self._stretch_v2,
-                self._target_smile,
-                self.loc_data,
-                self.smile_fw_version,
-                self.smile_hostname,
-                self.smile_hw_version,
-                self.smile_mac_address,
-                self.smile_model,
-                self.smile_name,
-                self.smile_type,
-                self.smile_zigbee_mac_address,
-                self._user,
-                self._port,
-                self._timeout,
-            )
+         ) if not self.smile_legacy else SmileLegacyAPI(
+            self._host,
+            self._passwd,
+            self._websession,
+            self._is_thermostat,
+            self._on_off_device,
+            self._opentherm_device,
+            self._stretch_v2,
+            self._target_smile,
+            self.loc_data,
+            self.smile_fw_version,
+            self.smile_hostname,
+            self.smile_hw_version,
+            self.smile_mac_address,
+            self.smile_model,
+            self.smile_name,
+            self.smile_type,
+            self.smile_zigbee_mac_address,
+            self._user,
+            self._port,
+            self._timeout,
+        )
 
         # Update all endpoints on first connect
         await self._smile_api.full_update_device()
@@ -289,17 +294,22 @@ async def _smile_detect_legacy(
         return return_model
 
     async def full_update_device(self) -> None:
-        """Perform a first fetch of all XML data, needed for initialization."""
+        """Helper-function used for testing."""
         await self._smile_api.full_update_device()
 
     def get_all_devices(self) -> None:
-        """Determine the devices present from the obtained XML-data."""
+        """Helper-function used for testing."""
         self._smile_api.get_all_devices()
 
     async def async_update(self) -> PlugwiseData:
         """Perform an incremental update for updating the various device states."""
-        data: PlugwiseData = await self._smile_api.async_update()
-        self.gateway_id = data.gateway["gateway_id"]
+        data = PlugwiseData({}, {})
+        try:
+            data = await self._smile_api.async_update()
+            self.gateway_id = data.gateway["gateway_id"]
+        except (DataMissingError, KeyError) as err:
+            raise PlugwiseError("No Plugwise data received") from err
+
         return data
 
 ########################################################################################################
@@ -366,4 +376,14 @@ async def set_dhw_mode(self, mode: str) -> None:
 
     async def delete_notification(self) -> None:
         """Delete the active Plugwise Notification."""
-        await self._smile_api.delete_notification()
+        try:
+            await self._smile_api.delete_notification()
+        except ConnectionFailedError as exc:
+            raise PlugwiseError(f"Failed to delete notification: {str(exc)}") from exc
+
+    async def reboot_gateway(self) -> None:
+        """Reboot the Plugwise Gateway."""
+        try:
+            await self._smile_api.reboot_gateway()
+        except ConnectionFailedError as exc:
+            raise PlugwiseError(f"Failed to reboot gateway: {str(exc)}") from exc
diff --git a/plugwise/constants.py b/plugwise/constants.py
@@ -17,6 +17,7 @@
 ELECTRIC_POTENTIAL_VOLT: Final = "V"
 ENERGY_KILO_WATT_HOUR: Final = "kWh"
 ENERGY_WATT_HOUR: Final = "Wh"
+GATEWAY_REBOOT: Final = "/core/gateways;@reboot"
 PERCENTAGE: Final = "%"
 POWER_WATT: Final = "W"
 PRESET_AWAY: Final = "away"
@@ -388,6 +389,7 @@ class GatewayData(TypedDict, total=False):
     heater_id: str
     item_count: int
     notifications: dict[str, dict[str, str]]
+    reboot: bool
     smile_name: str
 
 
diff --git a/plugwise/data.py b/plugwise/data.py
@@ -38,6 +38,7 @@ def _all_device_data(self) -> None:
                 "gateway_id": self.gateway_id,
                 "item_count": self._count,
                 "notifications": self._notifications,
+                "reboot": True,
                 "smile_name": self.smile_name,
             }
         )
diff --git a/plugwise/exceptions.py b/plugwise/exceptions.py
diff --git a/plugwise/helper.py b/plugwise/helper.py
diff --git a/plugwise/legacy/smile.py b/plugwise/legacy/smile.py
diff --git a/plugwise/smile.py b/plugwise/smile.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/tests/test_adam.py b/tests/test_adam.py
diff --git a/tests/test_init.py b/tests/test_init.py
diff --git a/userdata/error/adam_plus_anna_new/core.domain_objects.xml b/userdata/error/adam_plus_anna_new/core.domain_objects.xml
diff --git a/userdata/reboot/adam_plus_anna_new/core.domain_objects.xml b/userdata/reboot/adam_plus_anna_new/core.domain_objects.xml

Original file line number	Diff line number	Diff line change
`@@ -634,6 +634,7 @@`
`634`	`634`	`"heater_id": "0ca13e8176204ca7bf6f09de59f81c83",`
`635`	`635`	`"item_count": 415,`
`636`	`636`	`"notifications": {},`
	`637`	`+ "reboot": true,`
`637`	`638`	`"smile_name": "Adam"`
`638`	`639`	`}`
`639`	`640`	`}`
Original file line number	Diff line number	Diff line change
`@@ -300,6 +300,7 @@`
`300`	`300`	`"heater_id": "e4684553153b44afbef2200885f379dc",`
`301`	`301`	`"item_count": 213,`
`302`	`302`	`"notifications": {},`
	`303`	`+ "reboot": true,`
`303`	`304`	`"smile_name": "Adam"`
`304`	`305`	`}`
`305`	`306`	`}`
Original file line number	Diff line number	Diff line change
`@@ -479,6 +479,7 @@`
`479`	`479`	`"warning": "Node Plug (with MAC address 000D6F000D13CB01, in room 'n.a.') has been unreachable since 23:03 2020-01-18. Please check the connection and restart the device."`
`480`	`480`	`}`
`481`	`481`	`},`
	`482`	`+ "reboot": true,`
`482`	`483`	`"smile_name": "Adam"`
`483`	`484`	`}`
`484`	`485`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,7 @@`
`98`	`98`	`"heater_id": "0ca13e8176204ca7bf6f09de59f81c83",`
`99`	`99`	`"item_count": 56,`
`100`	`100`	`"notifications": {},`
	`101`	`+ "reboot": true,`
`101`	`102`	`"smile_name": "Adam"`
`102`	`103`	`}`
`103`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,7 @@`
`115`	`115`	`"error": "There is no OpenTherm communication with the boiler."`
`116`	`116`	`}`
`117`	`117`	`},`
	`118`	`+ "reboot": true,`
`118`	`119`	`"smile_name": "Adam"`
`119`	`120`	`}`
`120`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -233,6 +233,7 @@`
`233`	`233`	`"heater_id": "056ee145a816487eaa69243c3280f8bf",`
`234`	`234`	`"item_count": 147,`
`235`	`235`	`"notifications": {},`
	`236`	`+ "reboot": true,`
`236`	`237`	`"smile_name": "Adam"`
`237`	`238`	`}`
`238`	`239`	`}`
Original file line number	Diff line number	Diff line change
`@@ -93,6 +93,7 @@`
`93`	`93`	`"heater_id": "573c152e7d4f4720878222bd75638f5b",`
`94`	`94`	`"item_count": 62,`
`95`	`95`	`"notifications": {},`
	`96`	`+ "reboot": true,`
`96`	`97`	`"smile_name": "Smile Anna"`
`97`	`98`	`}`
`98`	`99`	`}`