hyundai-kia-connect-api 3.34.2__py2.py3-none-any.whl → 3.34.3__py2.py3-none-any.whl

hyundai_kia_connect_api/ApiImpl.py

@@ -15,7 +15,7 @@ from .Vehicle import Vehicle
 from .const import (
     WINDOW_STATE,
     CHARGE_PORT_ACTION,
-    OrderStatus,
+    ORDER_STATUS,
     DOMAIN,
     VALET_MODE_ACTION,
     VEHICLE_LOCK_ACTION,
@@ -107,7 +107,7 @@ class ApiImpl:
         action_id: str,
         synchronous: bool = False,
         timeout: int = 0,
-    ) -> OrderStatus:
+    ) -> ORDER_STATUS:
         pass
 
     def force_refresh_vehicle_state(self, token: Token, vehicle: Vehicle) -> None:

hyundai_kia_connect_api/ApiImplType1.py

@@ -5,6 +5,9 @@ import requests
 import logging
 from typing import Optional
 
+from time import sleep
+
+
 from .ApiImpl import (
     ApiImpl,
 )
@@ -23,6 +26,7 @@ from .const import (
     SEAT_STATUS,
     TEMPERATURE_UNITS,
     VEHICLE_LOCK_ACTION,
+    ORDER_STATUS,
 )
 
 from .exceptions import (
@@ -528,3 +532,63 @@ class ApiImplType1(ApiImpl):
         _check_response_for_errors(response)
         token.device_id = self._get_device_id(self._get_stamp())
         return response["msgId"]
+
+    def check_action_status(
+        self,
+        token: Token,
+        vehicle: Vehicle,
+        action_id: str,
+        synchronous: bool = False,
+        timeout: int = 0,
+    ) -> ORDER_STATUS:
+        url = self.SPA_API_URL + "notifications/" + vehicle.id + "/records"
+
+        if synchronous:
+            if timeout < 1:
+                raise APIError("Timeout must be 1 or higher")
+
+            end_time = dt.datetime.now() + dt.timedelta(seconds=timeout)
+            while end_time > dt.datetime.now():
+                # recursive call with Synchronous set to False
+                state = self.check_action_status(
+                    token, vehicle, action_id, synchronous=False
+                )
+                if state == ORDER_STATUS.PENDING:
+                    # state pending: recheck regularly
+                    # (until we get a final state or exceed the timeout)
+                    sleep(5)
+                else:
+                    # any other state is final
+                    return state
+
+            # if we exit the loop after the set timeout, return a Timeout state
+            return ORDER_STATUS.TIMEOUT
+
+        else:
+            response = requests.get(
+                url,
+                headers=self._get_authenticated_headers(
+                    token, vehicle.ccu_ccs2_protocol_support
+                ),
+            ).json()
+            _LOGGER.debug(f"{DOMAIN} - Check last action status Response: {response}")
+            _check_response_for_errors(response)
+
+            for action in response["resMsg"]:
+                if action["recordId"] == action_id:
+                    if action["result"] == "success":
+                        return ORDER_STATUS.SUCCESS
+                    elif action["result"] == "fail":
+                        return ORDER_STATUS.FAILED
+                    elif action["result"] == "non-response":
+                        return ORDER_STATUS.TIMEOUT
+                    elif action["result"] is None:
+                        _LOGGER.info(
+                            "Action status not set yet by server - try again in a few seconds"  # noqa
+                        )
+                        return ORDER_STATUS.PENDING
+
+            # if iterate the whole notifications list and
+            # can't find the action, raise an exception
+            # Old code: raise APIError(f"No action found with ID {action_id}")
+            return ORDER_STATUS.UNKNOWN

hyundai_kia_connect_api/KiaUvoApiAU.py

@@ -8,7 +8,6 @@ import math
 import logging
 import random
 import uuid
-from time import sleep
 from urllib.parse import parse_qs, urlparse
 
 import pytz
@@ -40,11 +39,9 @@ from .const import (
     SEAT_STATUS,
     CHARGE_PORT_ACTION,
     ENGINE_TYPES,
-    OrderStatus,
 )
 from .exceptions import (
     AuthenticationError,
-    APIError,
 )
 from .utils import (
     get_child_value,
@@ -1063,59 +1060,3 @@ class KiaUvoApiAU(ApiImplType1):
             dt.datetime.now().timestamp() + response["expiresTime"]
         )
         return control_token, control_token_expire_at
-
-    def check_action_status(
-        self,
-        token: Token,
-        vehicle: Vehicle,
-        action_id: str,
-        synchronous: bool = False,
-        timeout: int = 0,
-    ) -> OrderStatus:
-        url = self.SPA_API_URL + "notifications/" + vehicle.id + "/records"
-
-        if synchronous:
-            if timeout < 1:
-                raise APIError("Timeout must be 1 or higher")
-
-            end_time = dt.datetime.now() + dt.timedelta(seconds=timeout)
-            while end_time > dt.datetime.now():
-                # recursive call with Synchronous set to False
-                state = self.check_action_status(
-                    token, vehicle, action_id, synchronous=False
-                )
-                if state == OrderStatus.PENDING:
-                    # state pending: recheck regularly
-                    # (until we get a final state or exceed the timeout)
-                    sleep(5)
-                else:
-                    # any other state is final
-                    return state
-
-            # if we exit the loop after the set timeout, return a Timeout state
-            return OrderStatus.TIMEOUT
-
-        else:
-            response = requests.get(
-                url, headers=self._get_authenticated_headers(token)
-            ).json()
-            _LOGGER.debug(f"{DOMAIN} - Check last action status Response: {response}")
-            _check_response_for_errors(response)
-
-            for action in response["resMsg"]:
-                if action["recordId"] == action_id:
-                    if action["result"] == "success":
-                        return OrderStatus.SUCCESS
-                    elif action["result"] == "fail":
-                        return OrderStatus.FAILED
-                    elif action["result"] == "non-response":
-                        return OrderStatus.TIMEOUT
-                    elif action["result"] is None:
-                        _LOGGER.debug(
-                            "Action status not set yet by server - try again in a few seconds"  # noqa
-                        )
-                        return OrderStatus.PENDING
-
-            # if iterate the whole notifications list and
-            # can't find the action, raise an exception
-            raise APIError(f"No action found with ID {action_id}")

hyundai_kia_connect_api/KiaUvoApiCA.py

@@ -22,7 +22,7 @@ from .const import (
     DISTANCE_UNITS,
     DOMAIN,
     ENGINE_TYPES,
-    OrderStatus,
+    ORDER_STATUS,
     SEAT_STATUS,
     TEMPERATURE_UNITS,
     VEHICLE_LOCK_ACTION,
@@ -677,9 +677,9 @@ class KiaUvoApiCA(ApiImpl):
         action_id: str,
         synchronous: bool = False,
         timeout: int = 0,
-    ) -> OrderStatus:
+    ) -> ORDER_STATUS:
         if timeout < 0:
-            return OrderStatus.TIMEOUT
+            return ORDER_STATUS.TIMEOUT
         start_time = dt.datetime.now()
 
         url = self.API_URL + "rmtsts"
@@ -700,12 +700,12 @@ class KiaUvoApiCA(ApiImpl):
             _LOGGER.debug(f"{DOMAIN} - Last action_status: {action_status}")
 
         if response["responseHeader"]["responseCode"] == 1:
-            return OrderStatus.FAILED
+            return ORDER_STATUS.FAILED
         elif response["result"]["transaction"]["apiResult"] == "C":
-            return OrderStatus.SUCCESS
+            return ORDER_STATUS.SUCCESS
         elif response["result"]["transaction"]["apiResult"] == "P":
             if not synchronous:
-                return OrderStatus.PENDING
+                return ORDER_STATUS.PENDING
             else:
                 timedelta = dt.datetime.now() - start_time
                 time_left = timeout - timedelta.seconds - 10
@@ -714,7 +714,7 @@ class KiaUvoApiCA(ApiImpl):
                     token, vehicle, action_id, synchronous, time_left
                 )
 
-        return OrderStatus.FAILED
+        return ORDER_STATUS.FAILED
 
     def start_charge(self, token: Token, vehicle: Vehicle) -> str:
         url = self.API_URL + "evc/rcstrt"

hyundai_kia_connect_api/KiaUvoApiCN.py

@@ -37,7 +37,7 @@ from .const import (
     DOMAIN,
     ENGINE_TYPES,
     LOGIN_TOKEN_LIFETIME,
-    OrderStatus,
+    ORDER_STATUS,
     SEAT_STATUS,
     TEMPERATURE_UNITS,
     VEHICLE_LOCK_ACTION,
@@ -1143,7 +1143,7 @@ class KiaUvoApiCN(ApiImplType1):
         action_id: str,
         synchronous: bool = False,
         timeout: int = 0,
-    ) -> OrderStatus:
+    ) -> ORDER_STATUS:
         url = self.SPA_API_URL + "notifications/" + vehicle.id + "/records"
 
         if synchronous:
@@ -1156,7 +1156,7 @@ class KiaUvoApiCN(ApiImplType1):
                 state = self.check_action_status(
                     token, vehicle, action_id, synchronous=False
                 )
-                if state == OrderStatus.PENDING:
+                if state == ORDER_STATUS.PENDING:
                     # state pending: recheck regularly
                     # (until we get a final state or exceed the timeout)
                     sleep(5)
@@ -1165,7 +1165,7 @@ class KiaUvoApiCN(ApiImplType1):
                     return state
 
             # if we exit the loop after the set timeout, return a Timeout state
-            return OrderStatus.TIMEOUT
+            return ORDER_STATUS.TIMEOUT
 
         else:
             response = requests.get(
@@ -1177,16 +1177,16 @@ class KiaUvoApiCN(ApiImplType1):
             for action in response["resMsg"]:
                 if action["recordId"] == action_id:
                     if action["result"] == "success":
-                        return OrderStatus.SUCCESS
+                        return ORDER_STATUS.SUCCESS
                     elif action["result"] == "fail":
-                        return OrderStatus.FAILED
+                        return ORDER_STATUS.FAILED
                     elif action["result"] == "non-response":
-                        return OrderStatus.TIMEOUT
+                        return ORDER_STATUS.TIMEOUT
                     elif action["result"] is None:
                         _LOGGER.debug(
                             "Action status not set yet by server - try again in a few seconds"  # noqa
                         )
-                        return OrderStatus.PENDING
+                        return ORDER_STATUS.PENDING
 
             # if iterate the whole notifications list and
             # can't find the action, raise an exception

hyundai_kia_connect_api/KiaUvoApiEU.py

@@ -8,7 +8,6 @@ import datetime as dt
 import logging
 import uuid
 import math
-from time import sleep
 from urllib.parse import parse_qs, urlparse
 
 import pytz
@@ -42,14 +41,12 @@ from .const import (
     DOMAIN,
     ENGINE_TYPES,
     LOGIN_TOKEN_LIFETIME,
-    OrderStatus,
     SEAT_STATUS,
     TEMPERATURE_UNITS,
     VALET_MODE_ACTION,
 )
 from .exceptions import (
     AuthenticationError,
-    APIError,
 )
 from .utils import (
     get_child_value,
@@ -1549,63 +1546,3 @@ class KiaUvoApiEU(ApiImplType1):
             dt.datetime.now().timestamp() + response["expiresTime"]
         )
         return control_token, control_token_expire_at
-
-    def check_action_status(
-        self,
-        token: Token,
-        vehicle: Vehicle,
-        action_id: str,
-        synchronous: bool = False,
-        timeout: int = 0,
-    ) -> OrderStatus:
-        url = self.SPA_API_URL + "notifications/" + vehicle.id + "/records"
-
-        if synchronous:
-            if timeout < 1:
-                raise APIError("Timeout must be 1 or higher")
-
-            end_time = dt.datetime.now() + dt.timedelta(seconds=timeout)
-            while end_time > dt.datetime.now():
-                # recursive call with Synchronous set to False
-                state = self.check_action_status(
-                    token, vehicle, action_id, synchronous=False
-                )
-                if state == OrderStatus.PENDING:
-                    # state pending: recheck regularly
-                    # (until we get a final state or exceed the timeout)
-                    sleep(5)
-                else:
-                    # any other state is final
-                    return state
-
-            # if we exit the loop after the set timeout, return a Timeout state
-            return OrderStatus.TIMEOUT
-
-        else:
-            response = requests.get(
-                url,
-                headers=self._get_authenticated_headers(
-                    token, vehicle.ccu_ccs2_protocol_support
-                ),
-            ).json()
-            _LOGGER.debug(f"{DOMAIN} - Check last action status Response: {response}")
-            _check_response_for_errors(response)
-
-            for action in response["resMsg"]:
-                if action["recordId"] == action_id:
-                    if action["result"] == "success":
-                        return OrderStatus.SUCCESS
-                    elif action["result"] == "fail":
-                        return OrderStatus.FAILED
-                    elif action["result"] == "non-response":
-                        return OrderStatus.TIMEOUT
-                    elif action["result"] is None:
-                        _LOGGER.info(
-                            "Action status not set yet by server - try again in a few seconds"  # noqa
-                        )
-                        return OrderStatus.PENDING
-
-            # if iterate the whole notifications list and
-            # can't find the action, raise an exception
-            # Old code: raise APIError(f"No action found with ID {action_id}")
-            return OrderStatus.UNKNOWN

hyundai_kia_connect_api/KiaUvoApiUSA.py

@@ -25,7 +25,7 @@ from .const import (
     DISTANCE_UNITS,
     DOMAIN,
     LOGIN_TOKEN_LIFETIME,
-    OrderStatus,
+    ORDER_STATUS,
     TEMPERATURE_UNITS,
     VEHICLE_LOCK_ACTION,
 )
@@ -595,7 +595,7 @@ class KiaUvoApiUSA(ApiImpl):
         action_id: str,
         synchronous: bool = False,
         timeout: int = 0,
-    ) -> OrderStatus:
+    ) -> ORDER_STATUS:
         url = self.API_URL + "cmm/gts"
         body = {"xid": action_id}
         response = self.post_request_with_logging_and_active_session(

hyundai_kia_connect_api/VehicleManager.py

@@ -36,7 +36,7 @@ from .const import (
     REGIONS,
     VEHICLE_LOCK_ACTION,
     CHARGE_PORT_ACTION,
-    OrderStatus,
+    ORDER_STATUS,
     VALET_MODE_ACTION,
 )
 
@@ -206,7 +206,7 @@ class VehicleManager:
         action_id: str,
         synchronous: bool = False,
         timeout: int = 120,
-    ) -> OrderStatus:
+    ) -> ORDER_STATUS:
         """
         Check for the status of a sent action/command.
 

hyundai_kia_connect_api/const.py

@@ -86,7 +86,7 @@ class CHARGE_PORT_ACTION(Enum):
     OPEN = "open"
 
 
-class OrderStatus(Enum):
+class ORDER_STATUS(Enum):
     # pending (waiting for response from vehicle)
     PENDING = "PENDING"
     # order executed by vehicle and response returned

{hyundai_kia_connect_api-3.34.2.dist-info → hyundai_kia_connect_api-3.34.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyundai_kia_connect_api
-Version: 3.34.2
+Version: 3.34.3
 Summary: Python Boilerplate contains all the boilerplate you need to create a Python package.
 Home-page: https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api
 Author: Fuat Akgun

hyundai_kia_connect_api-3.34.3.dist-info/RECORD

@@ -0,0 +1,23 @@
+hyundai_kia_connect_api/ApiImpl.py,sha256=UeG2FH4KCdU5LvGp5Ks793vrWbwBx8MN_DedbVRRouM,9612
+hyundai_kia_connect_api/ApiImplType1.py,sha256=YGN7H0Q06ikdjgL3O2F9SeigQaRwx9ht3lXiITOVQGw,22205
+hyundai_kia_connect_api/HyundaiBlueLinkApiUSA.py,sha256=FGYyrS3dSq8Plfu8DQMwVG1LM3nmRv8Y4vrN7wZ4oVY,36988
+hyundai_kia_connect_api/KiaUvoApiAU.py,sha256=gvywTkeZRiL0vv_mSqZefttFK44lHmY2kFDVv31gx70,41929
+hyundai_kia_connect_api/KiaUvoApiCA.py,sha256=Y2xWIYUuiilk3FXq1ZdHQ0DsFZA_8b6AIT32l595leg,32521
+hyundai_kia_connect_api/KiaUvoApiCN.py,sha256=WP-rRI3wZmjuLYZmPXeOSk2NNNc6UhTrpOMuYMG6-iE,47043
+hyundai_kia_connect_api/KiaUvoApiEU.py,sha256=CSuIhYsDEXnG1j6u6-c-TZ9fVqSV5oMc4xtVryJ5HU0,62295
+hyundai_kia_connect_api/KiaUvoApiUSA.py,sha256=bOG3ugG_O1g5cL3E_b4F2McXeZYJVzfBpqK_kaYgM9E,30550
+hyundai_kia_connect_api/Token.py,sha256=ZsPvXh1ID7FUTGHAqhZUZyrKT7xVbOtIn6FRJn4Ygf0,370
+hyundai_kia_connect_api/Vehicle.py,sha256=hZT0wU7-mMi85bgqNHMu6CyhQQ5h-Jfmoc1ce2uPhYM,18867
+hyundai_kia_connect_api/VehicleManager.py,sha256=nnHsTy49bf5nRhEC9EXFnnfx6M39JSaM2TxKK9vosbY,11733
+hyundai_kia_connect_api/__init__.py,sha256=IkyVeIMbcFJZgLaiiNnUVA1Ferxvrm1bXHKVg01cxvc,319
+hyundai_kia_connect_api/bluelink.py,sha256=JiNIHl-Qi8zwqyN6ywKg5CdXOLT74WkvpjVcn-rYEjI,19730
+hyundai_kia_connect_api/const.py,sha256=gFAhj9-YgrJNd7ZjYr4Qu1Yf4v-RhmyON1MJDN0eR90,2281
+hyundai_kia_connect_api/exceptions.py,sha256=m7gyDnvA5OVAK4EXSP_ZwE0s0uV8HsGUV0tiYwqofK0,1343
+hyundai_kia_connect_api/utils.py,sha256=J0aXUX-nKIoS3XbelatNh-DZlHRU2_DYz_Mg_ZUKQJU,1957
+hyundai_kia_connect_api-3.34.3.dist-info/licenses/AUTHORS.rst,sha256=T77OE1hrQF6YyDE6NbdMKyL66inHt7dnjHAzblwuk2A,155
+hyundai_kia_connect_api-3.34.3.dist-info/licenses/LICENSE,sha256=49hmc755oyMwKdZ-2epiorjStRB0PfcZR1w5_NXZPgs,1068
+hyundai_kia_connect_api-3.34.3.dist-info/METADATA,sha256=55o6-yIUNyUjHgIAaYQx4pGXHB1nMOw0-rttz9HovTA,7142
+hyundai_kia_connect_api-3.34.3.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
+hyundai_kia_connect_api-3.34.3.dist-info/entry_points.txt,sha256=XfrroRdyC_9q9VXjEZe5SdRPhkQyCCE4S7ZK6XSKelA,67
+hyundai_kia_connect_api-3.34.3.dist-info/top_level.txt,sha256=otZ7J_fN-s3EW4jD-kAearIo2OIzhQLR8DNEHIaFfds,24
+hyundai_kia_connect_api-3.34.3.dist-info/RECORD,,

hyundai_kia_connect_api-3.34.2.dist-info/RECORD

@@ -1,23 +0,0 @@
-hyundai_kia_connect_api/ApiImpl.py,sha256=smtAOUzjmO3ci2LHoNiEmTe2UR1f0SqmVUQiweZ6je4,9610
-hyundai_kia_connect_api/ApiImplType1.py,sha256=dlWw_HW0eLwl3Tj83llckMWxFk96QGShwXlA1iknCqY,19730
-hyundai_kia_connect_api/HyundaiBlueLinkApiUSA.py,sha256=FGYyrS3dSq8Plfu8DQMwVG1LM3nmRv8Y4vrN7wZ4oVY,36988
-hyundai_kia_connect_api/KiaUvoApiAU.py,sha256=hsm3PYQho9oT_TpPl7XzgcIPQjqcUL9TBv9R6ftvFiI,44267
-hyundai_kia_connect_api/KiaUvoApiCA.py,sha256=XBya0yHZ2MC3TBVQLSc6N-SzmGt_s3l4nGVyNgmjl9Q,32514
-hyundai_kia_connect_api/KiaUvoApiCN.py,sha256=cwIPZ0dU6HolKdooUQeQKlLAic6YU8dQmNs0VQDBgpQ,47035
-hyundai_kia_connect_api/KiaUvoApiEU.py,sha256=UB8JwYyRLxxmUmCkvFHt1NCiEcwfW3ZYy-r3WKOCy7M,64773
-hyundai_kia_connect_api/KiaUvoApiUSA.py,sha256=8DP7iOORHtU98LipcAYEPdtJvubBlUP2-jlDxAhTDhQ,30548
-hyundai_kia_connect_api/Token.py,sha256=ZsPvXh1ID7FUTGHAqhZUZyrKT7xVbOtIn6FRJn4Ygf0,370
-hyundai_kia_connect_api/Vehicle.py,sha256=hZT0wU7-mMi85bgqNHMu6CyhQQ5h-Jfmoc1ce2uPhYM,18867
-hyundai_kia_connect_api/VehicleManager.py,sha256=JQLh9Tq1wIRz_CdrqiQAQBLMv1DTO_yNASIWWqZWksg,11731
-hyundai_kia_connect_api/__init__.py,sha256=IkyVeIMbcFJZgLaiiNnUVA1Ferxvrm1bXHKVg01cxvc,319
-hyundai_kia_connect_api/bluelink.py,sha256=JiNIHl-Qi8zwqyN6ywKg5CdXOLT74WkvpjVcn-rYEjI,19730
-hyundai_kia_connect_api/const.py,sha256=dXEh-lpthH8000nUXFoRZpQXkTxVHDAgDe_KqnSZhZw,2280
-hyundai_kia_connect_api/exceptions.py,sha256=m7gyDnvA5OVAK4EXSP_ZwE0s0uV8HsGUV0tiYwqofK0,1343
-hyundai_kia_connect_api/utils.py,sha256=J0aXUX-nKIoS3XbelatNh-DZlHRU2_DYz_Mg_ZUKQJU,1957
-hyundai_kia_connect_api-3.34.2.dist-info/licenses/AUTHORS.rst,sha256=T77OE1hrQF6YyDE6NbdMKyL66inHt7dnjHAzblwuk2A,155
-hyundai_kia_connect_api-3.34.2.dist-info/licenses/LICENSE,sha256=49hmc755oyMwKdZ-2epiorjStRB0PfcZR1w5_NXZPgs,1068
-hyundai_kia_connect_api-3.34.2.dist-info/METADATA,sha256=r4pHCHt9lHQRgYymUUkf_FVkxUFmC-YyMB4S67MUbjQ,7142
-hyundai_kia_connect_api-3.34.2.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
-hyundai_kia_connect_api-3.34.2.dist-info/entry_points.txt,sha256=XfrroRdyC_9q9VXjEZe5SdRPhkQyCCE4S7ZK6XSKelA,67
-hyundai_kia_connect_api-3.34.2.dist-info/top_level.txt,sha256=otZ7J_fN-s3EW4jD-kAearIo2OIzhQLR8DNEHIaFfds,24
-hyundai_kia_connect_api-3.34.2.dist-info/RECORD,,