Merge pull request #766 from plugwise/api-smile

bouwew · web-flow · commit 611fcbaa50c8 · 2025-06-29T11:57:44.000+02:00
Rename smile to api
diff --git a/tests/test_adam.py b/tests/test_adam.py
diff --git a/tests/test_anna.py b/tests/test_anna.py
diff --git a/tests/test_generic.py b/tests/test_generic.py
@@ -17,7 +17,7 @@ async def test_fail_anna_connected_to_adam(self):
         """Test erroneous adam with anna system."""
         self.smile_setup = "anna_connected_to_adam"
         try:
-            _server, _smile, _client = await self.connect_wrapper()
+            _server, _api, _client = await self.connect_wrapper()
             setup_result = False  # pragma: no cover
         except pw_exceptions.InvalidSetupError:
             setup_result = True
@@ -59,7 +59,7 @@ async def test_connect_timeout(self, timeout_test):
             self.smile_setup = "p1v4"
             (
                 server,
-                smile,
+                api,
                 client,
             ) = await self.connect_wrapper()
             setup_result = False  # pragma: no cover
diff --git a/tests/test_init.py b/tests/test_init.py
diff --git a/tests/test_legacy_anna.py b/tests/test_legacy_anna.py
@@ -18,34 +18,32 @@ async def test_connect_legacy_anna(self):
         self.smile_setup = "legacy_anna"
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
 
-        server, smile, client = await self.connect_legacy_wrapper()
-        assert smile.smile.hostname == "smile000000"
+        server, api, client = await self.connect_legacy_wrapper()
+        assert api.smile.hostname == "smile000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_version="1.8.22",
             smile_legacy=True,
         )
 
-        await self.device_test(smile, "2020-03-22 00:00:01", testdata)
-        assert smile.gateway_id == "0000aaaa0000aaaa0000aaaa0000aa00"
+        await self.device_test(api, "2020-03-22 00:00:01", testdata)
+        assert api.gateway_id == "0000aaaa0000aaaa0000aaaa0000aa00"
         assert self.entity_items == 41
-        assert not smile.reboot
+        assert not api.reboot
 
-        result = await self.tinker_legacy_thermostat(smile, schedule_on=False)
+        result = await self.tinker_legacy_thermostat(api, schedule_on=False)
         assert result
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
 
-        server, smile, client = await self.connect_legacy_wrapper(raise_timeout=True)
-        await self.device_test(
-            smile, "2020-03-22 00:00:01", testdata, skip_testing=True
-        )
-        result = await self.tinker_legacy_thermostat(smile, unhappy=True)
+        server, api, client = await self.connect_legacy_wrapper(raise_timeout=True)
+        await self.device_test(api, "2020-03-22 00:00:01", testdata, skip_testing=True)
+        result = await self.tinker_legacy_thermostat(api, unhappy=True)
         assert result
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
 
     @pytest.mark.asyncio
@@ -54,26 +52,26 @@ async def test_connect_legacy_anna_2(self):
         self.smile_setup = "legacy_anna_2"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_legacy_wrapper()
-        assert smile.smile.hostname == "smile000000"
+        server, api, client = await self.connect_legacy_wrapper()
+        assert api.smile.hostname == "smile000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_version="1.8.22",
             smile_legacy=True,
         )
 
-        await self.device_test(smile, "2020-05-03 00:00:01", testdata)
+        await self.device_test(api, "2020-05-03 00:00:01", testdata)
 
-        assert smile.gateway_id == "be81e3f8275b4129852c4d8d550ae2eb"
+        assert api.gateway_id == "be81e3f8275b4129852c4d8d550ae2eb"
         assert self.entity_items == 43
 
-        result = await self.tinker_legacy_thermostat(smile)
+        result = await self.tinker_legacy_thermostat(api)
         assert result
 
-        result = await self.tinker_legacy_thermostat_schedule(smile, "on")
+        result = await self.tinker_legacy_thermostat_schedule(api, "on")
         assert result
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
diff --git a/tests/test_legacy_generic.py b/tests/test_legacy_generic.py
@@ -13,7 +13,7 @@ async def test_fail_legacy_system(self):
         """Test erroneous legacy stretch system."""
         self.smile_setup = "faulty_stretch"
         try:
-            _server, _smile, _client = await self.connect_legacy_wrapper()
+            _server, _api, _client = await self.connect_legacy_wrapper()
             setup_result = False  # pragma: no cover
         except pw_exceptions.InvalidXMLError:
             setup_result = True
diff --git a/tests/test_legacy_p1.py b/tests/test_legacy_p1.py
@@ -16,22 +16,22 @@ async def test_connect_smile_p1_v2(self):
         self.smile_setup = "smile_p1_v2"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_legacy_wrapper()
-        assert smile.smile.hostname == "smile000000"
+        server, api, client = await self.connect_legacy_wrapper()
+        assert api.smile.hostname == "smile000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_type="power",
             smile_version="2.5.9",
             smile_legacy=True,
         )
 
-        await self.device_test(smile, "2022-05-16 00:00:01", testdata)
-        assert smile.gateway_id == "aaaa0000aaaa0000aaaa0000aaaa00aa"
+        await self.device_test(api, "2022-05-16 00:00:01", testdata)
+        assert api.gateway_id == "aaaa0000aaaa0000aaaa0000aaaa00aa"
         assert self.entity_items == 26
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
 
     @pytest.mark.asyncio
@@ -40,18 +40,18 @@ async def test_connect_smile_p1_v2_2(self):
         self.smile_setup = "smile_p1_v2_2"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_legacy_wrapper()
-        assert smile.smile.hostname == "smile000000"
+        server, api, client = await self.connect_legacy_wrapper()
+        assert api.smile.hostname == "smile000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_type="power",
             smile_version="2.5.9",
             smile_legacy=True,
         )
 
-        await self.device_test(smile, "2022-05-16 00:00:01", testdata)
+        await self.device_test(api, "2022-05-16 00:00:01", testdata)
         assert self.entity_items == 26
 
         # Now change some data and change directory reading xml from
@@ -61,8 +61,8 @@ async def test_connect_smile_p1_v2_2(self):
         )
         self.smile_setup = "updated/smile_p1_v2_2"
         await self.device_test(
-            smile, "2022-05-16 00:00:01", testdata_updated, initialize=False
+            api, "2022-05-16 00:00:01", testdata_updated, initialize=False
         )
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
diff --git a/tests/test_legacy_stretch.py b/tests/test_legacy_stretch.py
@@ -16,23 +16,23 @@ async def test_connect_stretch_v31(self):
         self.smile_setup = "stretch_v31"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_legacy_wrapper(stretch=True)
-        assert smile.smile.hostname == "stretch000000"
+        server, api, client = await self.connect_legacy_wrapper(stretch=True)
+        assert api.smile.hostname == "stretch000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_type="stretch",
             smile_version="3.1.11",
             smile_legacy=True,
         )
 
-        await self.device_test(smile, "2022-05-16 00:00:01", testdata)
-        assert smile.gateway_id == "0000aaaa0000aaaa0000aaaa0000aa00"
+        await self.device_test(api, "2022-05-16 00:00:01", testdata)
+        assert api.gateway_id == "0000aaaa0000aaaa0000aaaa0000aa00"
         assert self.entity_items == 83
 
         switch_change = await self.tinker_switch(
-            smile,
+            api,
             "059e4d03c7a34d278add5c7a4a781d19",
         )
         assert not switch_change
@@ -44,10 +44,10 @@ async def test_connect_stretch_v31(self):
         )
         self.smile_setup = "updated/stretch_v31"
         await self.device_test(
-            smile, "2022-05-16 00:00:01", testdata_updated, initialize=False
+            api, "2022-05-16 00:00:01", testdata_updated, initialize=False
         )
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
 
     @pytest.mark.asyncio
@@ -56,36 +56,36 @@ async def test_connect_stretch_v23(self):
         self.smile_setup = "stretch_v23"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_legacy_wrapper(stretch=True)
-        assert smile.smile.hostname == "stretch000000"
+        server, api, client = await self.connect_legacy_wrapper(stretch=True)
+        assert api.smile.hostname == "stretch000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_type="stretch",
             smile_version="2.3.12",
             smile_legacy=True,
         )
 
-        await self.device_test(smile, "2022-05-16 00:00:01", testdata)
+        await self.device_test(api, "2022-05-16 00:00:01", testdata)
         assert self.entity_items == 243
 
         switch_change = await self.tinker_switch(
-            smile, "2587a7fcdd7e482dab03fda256076b4b"
+            api, "2587a7fcdd7e482dab03fda256076b4b"
         )
         assert switch_change
         switch_change = await self.tinker_switch(
-            smile, "2587a7fcdd7e482dab03fda256076b4b", model="lock"
+            api, "2587a7fcdd7e482dab03fda256076b4b", model="lock"
         )
         assert switch_change
         switch_change = await self.tinker_switch(
-            smile,
+            api,
             "f7b145c8492f4dd7a4de760456fdef3e",
             ["407aa1c1099d463c9137a3a9eda787fd"],
         )
         assert switch_change
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
 
     @pytest.mark.asyncio
@@ -95,25 +95,25 @@ async def test_connect_stretch_v27_no_domain(self):
         self.smile_setup = "stretch_v27_no_domain"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_legacy_wrapper(stretch=True)
-        assert smile.smile.hostname == "stretch000000"
+        server, api, client = await self.connect_legacy_wrapper(stretch=True)
+        assert api.smile.hostname == "stretch000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_type="stretch",
             smile_version="2.7.18",
             smile_legacy=True,
         )
 
-        await self.device_test(smile, "2022-05-16 00:00:01", testdata)
+        await self.device_test(api, "2022-05-16 00:00:01", testdata)
         assert self.entity_items == 190
         _LOGGER.info(" # Assert no master thermostat")
 
         switch_change = await self.tinker_switch(
-            smile, "8b8d14b242e24cd789743c828b9a2ea9"
+            api, "8b8d14b242e24cd789743c828b9a2ea9"
         )
         assert switch_change
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
diff --git a/tests/test_p1.py b/tests/test_p1.py
@@ -16,18 +16,18 @@ async def test_connect_p1v4_442_single(self):
         self.smile_setup = "p1v4_442_single"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_wrapper()
-        assert smile.smile.hostname == "smile000000"
+        server, api, client = await self.connect_wrapper()
+        assert api.smile.hostname == "smile000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_type="power",
             smile_version="4.4.2",
         )
 
-        await self.device_test(smile, "2022-05-16 00:00:01", testdata)
-        assert smile.gateway_id == "a455b61e52394b2db5081ce025a430f3"
+        await self.device_test(api, "2022-05-16 00:00:01", testdata)
+        assert api.gateway_id == "a455b61e52394b2db5081ce025a430f3"
         assert self.entity_items == 33
         assert not self.notifications
 
@@ -38,13 +38,13 @@ async def test_connect_p1v4_442_single(self):
         )
         self.smile_setup = "updated/p1v4_442_single"
         await self.device_test(
-            smile, "2022-05-16 00:00:01", testdata_updated, initialize=False
+            api, "2022-05-16 00:00:01", testdata_updated, initialize=False
         )
 
         # Simulate receiving no xml-data after a requesting a reboot of the gateway
         self.smile_setup = "reboot/p1v4_442_single"
         try:
-            await self.device_test(smile, initialize=False)
+            await self.device_test(api, initialize=False)
         except pw_exceptions.PlugwiseError as err:
             _LOGGER.debug(
                 f"Receiving no data after a reboot is properly handled: {err}"
@@ -53,11 +53,11 @@ async def test_connect_p1v4_442_single(self):
         # Simulate receiving xml-data with <error>
         self.smile_setup = "error/p1v4_442_single"
         try:
-            await self.device_test(smile, initialize=False)
+            await self.device_test(api, initialize=False)
         except pw_exceptions.ResponseError:
             _LOGGER.debug("Receiving error-data from the Gateway")
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
 
     @pytest.mark.asyncio
@@ -66,20 +66,20 @@ async def test_connect_p1v4_442_triple(self):
         self.smile_setup = "p1v4_442_triple"
 
         testdata = await self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_wrapper()
-        assert smile.smile.hostname == "smile000000"
+        server, api, client = await self.connect_wrapper()
+        assert api.smile.hostname == "smile000000"
 
         self.validate_test_basics(
             _LOGGER,
-            smile,
+            api,
             smile_type="power",
             smile_version="4.4.2",
         )
 
-        await self.device_test(smile, "2022-05-16 00:00:01", testdata)
-        assert smile.gateway_id == "03e65b16e4b247a29ae0d75a78cb492e"
+        await self.device_test(api, "2022-05-16 00:00:01", testdata)
+        assert api.gateway_id == "03e65b16e4b247a29ae0d75a78cb492e"
         assert self.entity_items == 42
         assert self.notifications
 
-        await smile.close_connection()
+        await api.close_connection()
         await self.disconnect(server, client)
