hyundai-kia-connect-api 3.33.0__py2.py3-none-any.whl → 3.33.1__py2.py3-none-any.whl

hyundai_kia_connect_api/ApiImplType1.py

@@ -1,6 +1,8 @@
 """ApiImplType1.py"""
 
 import datetime as dt
+import requests
+import logging
 from typing import Optional
 
 from .ApiImpl import (
@@ -15,14 +17,70 @@ from .utils import (
 )
 
 from .const import (
+    DOMAIN,
     DISTANCE_UNITS,
     ENGINE_TYPES,
     SEAT_STATUS,
     TEMPERATURE_UNITS,
 )
 
+from .exceptions import (
+    APIError,
+    DuplicateRequestError,
+    RequestTimeoutError,
+    ServiceTemporaryUnavailable,
+    NoDataFound,
+    InvalidAPIResponseError,
+    RateLimitingError,
+    DeviceIDError,
+)
+
 USER_AGENT_OK_HTTP: str = "okhttp/3.12.0"
 
+_LOGGER = logging.getLogger(__name__)
+
+
+def _check_response_for_errors(response: dict) -> None:
+    """
+    Checks for errors in the API response.
+    If an error is found, an exception is raised.
+    retCode known values:
+    - S: success
+    - F: failure
+    resCode / resMsg known values:
+    - 0000: no error
+    - 4002:  "Invalid request body - invalid deviceId",
+             relogin will resolve but a bandaid.
+    - 4004: "Duplicate request"
+    - 4081: "Request timeout"
+    - 5031: "Unavailable remote control - Service Temporary Unavailable"
+    - 5091: "Exceeds number of requests"
+    - 5921: "No Data Found v2 - No Data Found v2"
+    - 9999: "Undefined Error - Response timeout"
+    :param response: the API's JSON response
+    """
+
+    error_code_mapping = {
+        "4002": DeviceIDError,
+        "4004": DuplicateRequestError,
+        "4081": RequestTimeoutError,
+        "5031": ServiceTemporaryUnavailable,
+        "5091": RateLimitingError,
+        "5921": NoDataFound,
+        "9999": RequestTimeoutError,
+    }
+
+    if not any(x in response for x in ["retCode", "resCode", "resMsg"]):
+        _LOGGER.error(f"Unknown API response format: {response}")
+        raise InvalidAPIResponseError()
+
+    if response["retCode"] == "F":
+        if response["resCode"] in error_code_mapping:
+            raise error_code_mapping[response["resCode"]](response["resMsg"])
+        raise APIError(
+            f"Server returned:  '{response['resCode']}' '{response['resMsg']}'"
+        )
+
 
 class ApiImplType1(ApiImpl):
     """ApiImplType1"""
@@ -319,3 +377,68 @@ class ApiImplType1(ApiImpl):
             )
 
         vehicle.data = state
+
+    def start_charge(self, token: Token, vehicle: Vehicle) -> str:
+        if not vehicle.ccu_ccs2_protocol_support:
+            url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/control/charge"
+
+            payload = {"action": "start", "deviceId": token.device_id}
+            headers = self._get_authenticated_headers(
+                token, vehicle.ccu_ccs2_protocol_support
+            )
+
+        else:
+            url = (
+                self.SPA_API_URL_V2 + "vehicles/" + vehicle.id + "/ccs2/control/charge"
+            )
+
+            payload = {"command": "start"}
+            headers = self._get_control_headers(token, vehicle)
+
+        _LOGGER.debug(f"{DOMAIN} - Start Charge Action Request: {payload}")
+        response = requests.post(url, json=payload, headers=headers).json()
+        _LOGGER.debug(f"{DOMAIN} - Start Charge Action Response: {response}")
+        _check_response_for_errors(response)
+        token.device_id = self._get_device_id(self._get_stamp())
+        return response["msgId"]
+
+    def stop_charge(self, token: Token, vehicle: Vehicle) -> str:
+        if not vehicle.ccu_ccs2_protocol_support:
+            url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/control/charge"
+
+            payload = {"action": "stop", "deviceId": token.device_id}
+            headers = self._get_authenticated_headers(
+                token, vehicle.ccu_ccs2_protocol_support
+            )
+
+        else:
+            url = (
+                self.SPA_API_URL_V2 + "vehicles/" + vehicle.id + "/ccs2/control/charge"
+            )
+
+            payload = {"command": "stop"}
+            headers = self._get_control_headers(token, vehicle)
+
+        _LOGGER.debug(f"{DOMAIN} - Stop Charge Action Request: {payload}")
+        response = requests.post(url, json=payload, headers=headers).json()
+        _LOGGER.debug(f"{DOMAIN} - Stop Charge Action Response: {response}")
+        _check_response_for_errors(response)
+        token.device_id = self._get_device_id(self._get_stamp())
+        return response["msgId"]
+
+    def set_charging_current(self, token: Token, vehicle: Vehicle, level: int) -> str:
+        url = (
+            self.SPA_API_URL + "vehicles/" + vehicle.id + "/ccs2/charge/chargingcurrent"
+        )
+
+        body = {"chargingCurrent": level}
+        response = requests.post(
+            url,
+            json=body,
+            headers=self._get_authenticated_headers(
+                token, vehicle.ccu_ccs2_protocol_support
+            ),
+        ).json()
+        _LOGGER.debug(f"{DOMAIN} - Set Charging Current Response: {response}")
+        _check_response_for_errors(response)
+        return response["msgId"]

hyundai_kia_connect_api/KiaUvoApiAU.py

@@ -29,6 +29,7 @@ from .Vehicle import (
     TripInfo,
     DayTripCounts,
 )
+from .ApiImplType1 import _check_response_for_errors
 from .const import (
     BRAND_HYUNDAI,
     BRAND_KIA,
@@ -44,13 +45,7 @@ from .const import (
 )
 from .exceptions import (
     AuthenticationError,
-    DuplicateRequestError,
-    RequestTimeoutError,
-    ServiceTemporaryUnavailable,
-    NoDataFound,
-    InvalidAPIResponseError,
     APIError,
-    RateLimitingError,
 )
 from .utils import (
     get_child_value,
@@ -65,44 +60,6 @@ USER_AGENT_OK_HTTP: str = "okhttp/3.12.0"
 USER_AGENT_MOZILLA: str = "Mozilla/5.0 (Linux; Android 4.1.1; Galaxy Nexus Build/JRO03C) AppleWebKit/535.19 (KHTML, like Gecko) Chrome/18.0.1025.166 Mobile Safari/535.19"  # noqa
 
 
-def _check_response_for_errors(response: dict) -> None:
-    """
-    Checks for errors in the API response.
-    If an error is found, an exception is raised.
-    retCode known values:
-    - S: success
-    - F: failure
-    resCode / resMsg known values:
-    - 0000: no error
-    - 4004: "Duplicate request"
-    - 4081: "Request timeout"
-    - 5031: "Unavailable remote control - Service Temporary Unavailable"
-    - 5091: "Exceeds number of requests"
-    - 5921: "No Data Found v2 - No Data Found v2"
-    - 9999: "Undefined Error - Response timeout"
-    :param response: the API's JSON response
-    """
-
-    error_code_mapping = {
-        "4004": DuplicateRequestError,
-        "4081": RequestTimeoutError,
-        "5031": ServiceTemporaryUnavailable,
-        "5091": RateLimitingError,
-        "5921": NoDataFound,
-        "9999": RequestTimeoutError,
-    }
-
-    if not any(x in response for x in ["retCode", "resCode", "resMsg"]):
-        _LOGGER.error(f"Unknown API response format: {response}")
-        raise InvalidAPIResponseError()
-
-    if response["retCode"] == "F":
-        if response["resCode"] in error_code_mapping:
-            raise error_code_mapping[response["resCode"]](response["resMsg"])
-        else:
-            raise APIError(f"Server returned: '{response['resMsg']}'")
-
-
 class KiaUvoApiAU(ApiImplType1):
     data_timezone = tz.gettz("Australia/Sydney")
     temperature_range = [x * 0.5 for x in range(34, 54)]
@@ -783,30 +740,6 @@ class KiaUvoApiAU(ApiImplType1):
         _check_response_for_errors(response)
         return response["msgId"]
 
-    def start_charge(self, token: Token, vehicle: Vehicle) -> str:
-        url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/control/charge"
-
-        payload = {"action": "start", "deviceId": token.device_id}
-        _LOGGER.debug(f"{DOMAIN} - Start Charge Action Request: {payload}")
-        response = requests.post(
-            url, json=payload, headers=self._get_control_headers(token)
-        ).json()
-        _LOGGER.debug(f"{DOMAIN} - Start Charge Action Response: {response}")
-        _check_response_for_errors(response)
-        return response["msgId"]
-
-    def stop_charge(self, token: Token, vehicle: Vehicle) -> str:
-        url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/control/charge"
-
-        payload = {"action": "stop", "deviceId": token.device_id}
-        _LOGGER.debug(f"{DOMAIN} - Stop Charge Action Request {payload}")
-        response = requests.post(
-            url, json=payload, headers=self._get_control_headers(token)
-        ).json()
-        _LOGGER.debug(f"{DOMAIN} - Stop Charge Action Response: {response}")
-        _check_response_for_errors(response)
-        return response["msgId"]
-
     def _get_charge_limits(self, token: Token, vehicle: Vehicle) -> dict:
         # Not currently used as value is in the general get.
         # Most likely this forces the car the update it.

hyundai_kia_connect_api/KiaUvoApiEU.py

@@ -21,6 +21,7 @@ from .ApiImpl import (
     ScheduleChargingClimateRequestOptions,
 )
 from .ApiImplType1 import ApiImplType1
+from .ApiImplType1 import _check_response_for_errors
 
 from .Token import Token
 from .Vehicle import (
@@ -49,14 +50,7 @@ from .const import (
 )
 from .exceptions import (
     AuthenticationError,
-    DuplicateRequestError,
-    RequestTimeoutError,
-    ServiceTemporaryUnavailable,
-    NoDataFound,
-    InvalidAPIResponseError,
     APIError,
-    RateLimitingError,
-    DeviceIDError,
 )
 from .utils import (
     get_child_value,
@@ -90,48 +84,6 @@ SUPPORTED_LANGUAGES_LIST = [
 ]
 
 
-def _check_response_for_errors(response: dict) -> None:
-    """
-    Checks for errors in the API response.
-    If an error is found, an exception is raised.
-    retCode known values:
-    - S: success
-    - F: failure
-    resCode / resMsg known values:
-    - 0000: no error
-    - 4002:  "Invalid request body - invalid deviceId",
-             relogin will resolve but a bandaid.
-    - 4004: "Duplicate request"
-    - 4081: "Request timeout"
-    - 5031: "Unavailable remote control - Service Temporary Unavailable"
-    - 5091: "Exceeds number of requests"
-    - 5921: "No Data Found v2 - No Data Found v2"
-    - 9999: "Undefined Error - Response timeout"
-    :param response: the API's JSON response
-    """
-
-    error_code_mapping = {
-        "4002": DeviceIDError,
-        "4004": DuplicateRequestError,
-        "4081": RequestTimeoutError,
-        "5031": ServiceTemporaryUnavailable,
-        "5091": RateLimitingError,
-        "5921": NoDataFound,
-        "9999": RequestTimeoutError,
-    }
-
-    if not any(x in response for x in ["retCode", "resCode", "resMsg"]):
-        _LOGGER.error(f"Unknown API response format: {response}")
-        raise InvalidAPIResponseError()
-
-    if response["retCode"] == "F":
-        if response["resCode"] in error_code_mapping:
-            raise error_code_mapping[response["resCode"]](response["resMsg"])
-        raise APIError(
-            f"Server returned:  '{response['resCode']}' '{response['resMsg']}'"
-        )
-
-
 class KiaUvoApiEU(ApiImplType1):
     data_timezone = tz.gettz("Europe/Berlin")
     temperature_range = [x * 0.5 for x in range(28, 60)]
@@ -1013,54 +965,6 @@ class KiaUvoApiEU(ApiImplType1):
         token.device_id = self._get_device_id(self._get_stamp())
         return response["msgId"]
 
-    def start_charge(self, token: Token, vehicle: Vehicle) -> str:
-        if not vehicle.ccu_ccs2_protocol_support:
-            url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/control/charge"
-
-            payload = {"action": "start", "deviceId": token.device_id}
-            headers = self._get_authenticated_headers(
-                token, vehicle.ccu_ccs2_protocol_support
-            )
-
-        else:
-            url = (
-                self.SPA_API_URL_V2 + "vehicles/" + vehicle.id + "/ccs2/control/charge"
-            )
-
-            payload = {"command": "start"}
-            headers = self._get_control_headers(token, vehicle)
-
-        _LOGGER.debug(f"{DOMAIN} - Start Charge Action Request: {payload}")
-        response = requests.post(url, json=payload, headers=headers).json()
-        _LOGGER.debug(f"{DOMAIN} - Start Charge Action Response: {response}")
-        _check_response_for_errors(response)
-        token.device_id = self._get_device_id(self._get_stamp())
-        return response["msgId"]
-
-    def stop_charge(self, token: Token, vehicle: Vehicle) -> str:
-        if not vehicle.ccu_ccs2_protocol_support:
-            url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/control/charge"
-
-            payload = {"action": "stop", "deviceId": token.device_id}
-            headers = self._get_authenticated_headers(
-                token, vehicle.ccu_ccs2_protocol_support
-            )
-
-        else:
-            url = (
-                self.SPA_API_URL_V2 + "vehicles/" + vehicle.id + "/ccs2/control/charge"
-            )
-
-            payload = {"command": "stop"}
-            headers = self._get_control_headers(token, vehicle)
-
-        _LOGGER.debug(f"{DOMAIN} - Stop Charge Action Request: {payload}")
-        response = requests.post(url, json=payload, headers=headers).json()
-        _LOGGER.debug(f"{DOMAIN} - Stop Charge Action Response: {response}")
-        _check_response_for_errors(response)
-        token.device_id = self._get_device_id(self._get_stamp())
-        return response["msgId"]
-
     def start_hazard_lights(self, token: Token, vehicle: Vehicle) -> str:
         url = self.SPA_API_URL_V2 + "vehicles/" + vehicle.id + "/ccs2/control/light"
 
@@ -1330,23 +1234,6 @@ class KiaUvoApiEU(ApiImplType1):
         _check_response_for_errors(response)
         return response["msgId"]
 
-    def set_charging_current(self, token: Token, vehicle: Vehicle, level: int) -> str:
-        url = (
-            self.SPA_API_URL + "vehicles/" + vehicle.id + "/ccs2/charge/chargingcurrent"
-        )
-
-        body = {"chargingCurrent": level}
-        response = requests.post(
-            url,
-            json=body,
-            headers=self._get_authenticated_headers(
-                token, vehicle.ccu_ccs2_protocol_support
-            ),
-        ).json()
-        _LOGGER.debug(f"{DOMAIN} - Set Charging Current Response: {response}")
-        _check_response_for_errors(response)
-        return response["msgId"]
-
     def schedule_charging_and_climate(
         self,
         token: Token,

{hyundai_kia_connect_api-3.33.0.dist-info → hyundai_kia_connect_api-3.33.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyundai_kia_connect_api
-Version: 3.33.0
+Version: 3.33.1
 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.33.0.dist-info → hyundai_kia_connect_api-3.33.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
 hyundai_kia_connect_api/ApiImpl.py,sha256=PuK3dID01qTGB6aGtQY4uf1hF-t4d03wUzG_gUFn_1g,8353
-hyundai_kia_connect_api/ApiImplType1.py,sha256=PnKwpbCoYGOXBWzBLIlDSrC6daIYeW9qlfW7TM4HCU0,12184
+hyundai_kia_connect_api/ApiImplType1.py,sha256=V2rieKKPhR-92E4_0N6wKFEupab5OgAaKxHxB5OKVi4,16587
 hyundai_kia_connect_api/HyundaiBlueLinkApiUSA.py,sha256=FGYyrS3dSq8Plfu8DQMwVG1LM3nmRv8Y4vrN7wZ4oVY,36988
-hyundai_kia_connect_api/KiaUvoApiAU.py,sha256=tslh0gzvPBwYJmcWlf9B0l7PyYZdy2e7GqpRkl8_Svk,48471
+hyundai_kia_connect_api/KiaUvoApiAU.py,sha256=0QmWLeLa6RL3tKrCLOfemhVDmC8pdsxykdNd_C1DHLg,45945
 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=TxgO2dfLjKSKfSkRMoTL_fbmzRFRPb8oJ9IDztD50Ug,71300
+hyundai_kia_connect_api/KiaUvoApiEU.py,sha256=RuPWWsyEYP4xYPH5YTNnC2Vzgkm0tB9PE9Ar2wK2v_M,67075
 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
@@ -14,10 +14,10 @@ hyundai_kia_connect_api/bluelink.py,sha256=JiNIHl-Qi8zwqyN6ywKg5CdXOLT74WkvpjVcn
 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.33.0.dist-info/licenses/AUTHORS.rst,sha256=T77OE1hrQF6YyDE6NbdMKyL66inHt7dnjHAzblwuk2A,155
-hyundai_kia_connect_api-3.33.0.dist-info/licenses/LICENSE,sha256=49hmc755oyMwKdZ-2epiorjStRB0PfcZR1w5_NXZPgs,1068
-hyundai_kia_connect_api-3.33.0.dist-info/METADATA,sha256=XVjyHKnqYRRtOs_DdZDcMRdcNAIqAMmQRp8QmIongwU,7142
-hyundai_kia_connect_api-3.33.0.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
-hyundai_kia_connect_api-3.33.0.dist-info/entry_points.txt,sha256=XfrroRdyC_9q9VXjEZe5SdRPhkQyCCE4S7ZK6XSKelA,67
-hyundai_kia_connect_api-3.33.0.dist-info/top_level.txt,sha256=otZ7J_fN-s3EW4jD-kAearIo2OIzhQLR8DNEHIaFfds,24
-hyundai_kia_connect_api-3.33.0.dist-info/RECORD,,
+hyundai_kia_connect_api-3.33.1.dist-info/licenses/AUTHORS.rst,sha256=T77OE1hrQF6YyDE6NbdMKyL66inHt7dnjHAzblwuk2A,155
+hyundai_kia_connect_api-3.33.1.dist-info/licenses/LICENSE,sha256=49hmc755oyMwKdZ-2epiorjStRB0PfcZR1w5_NXZPgs,1068
+hyundai_kia_connect_api-3.33.1.dist-info/METADATA,sha256=q9Xdkya0cPSkYGagr8hL8l0P07KgHgi3ZLM5R--dpaU,7142
+hyundai_kia_connect_api-3.33.1.dist-info/WHEEL,sha256=MAQBAzGbXNI3bUmkDsiV_duv8i-gcdnLzw7cfUFwqhU,109
+hyundai_kia_connect_api-3.33.1.dist-info/entry_points.txt,sha256=XfrroRdyC_9q9VXjEZe5SdRPhkQyCCE4S7ZK6XSKelA,67
+hyundai_kia_connect_api-3.33.1.dist-info/top_level.txt,sha256=otZ7J_fN-s3EW4jD-kAearIo2OIzhQLR8DNEHIaFfds,24
+hyundai_kia_connect_api-3.33.1.dist-info/RECORD,,