hyundai-kia-connect-api 3.17.6__py2.py3-none-any.whl → 3.32.0__py2.py3-none-any.whl

hyundai_kia_connect_api/KiaUvoApiAU.py

@@ -7,7 +7,6 @@ import datetime as dt
 import math
 import logging
 import random
-import re
 import uuid
 from time import sleep
 from urllib.parse import parse_qs, urlparse
@@ -17,10 +16,10 @@ import requests
 from dateutil import tz
 
 from .ApiImpl import (
-    ApiImpl,
     ClimateRequestOptions,
     WindowRequestOptions,
 )
+from .ApiImplType1 import ApiImplType1
 from .Token import Token
 from .Vehicle import (
     Vehicle,
@@ -43,19 +42,27 @@ from .const import (
     ENGINE_TYPES,
     OrderStatus,
 )
-from .exceptions import *
+from .exceptions import (
+    AuthenticationError,
+    DuplicateRequestError,
+    RequestTimeoutError,
+    ServiceTemporaryUnavailable,
+    NoDataFound,
+    InvalidAPIResponseError,
+    APIError,
+    RateLimitingError,
+)
 from .utils import (
     get_child_value,
     get_index_into_hex_temp,
     get_hex_temp_into_index,
+    parse_datetime,
 )
 
 _LOGGER = logging.getLogger(__name__)
 
 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
-)
+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:
@@ -96,7 +103,7 @@ def _check_response_for_errors(response: dict) -> None:
             raise APIError(f"Server returned: '{response['resMsg']}'")
 
 
-class KiaUvoApiAU(ApiImpl):
+class KiaUvoApiAU(ApiImplType1):
     data_timezone = tz.gettz("Australia/Sydney")
     temperature_range = [x * 0.5 for x in range(34, 54)]
 
@@ -106,35 +113,18 @@ class KiaUvoApiAU(ApiImpl):
             self.BASE_URL: str = "au-apigw.ccs.kia.com.au:8082"
             self.CCSP_SERVICE_ID: str = "8acb778a-b918-4a8d-8624-73a0beb64289"
             self.APP_ID: str = "4ad4dcde-be23-48a8-bc1c-91b94f5c06f8"  # Android app ID
-            self.BASIC_AUTHORIZATION: str = (
-                "Basic OGFjYjc3OGEtYjkxOC00YThkLTg2MjQtNzNhMGJlYjY0Mjg5OjdTY01NbTZmRVlYZGlFUEN4YVBhUW1nZVlkbFVyZndvaDRBZlhHT3pZSVMyQ3U5VA=="
-            )
+            self.BASIC_AUTHORIZATION: str = "Basic OGFjYjc3OGEtYjkxOC00YThkLTg2MjQtNzNhMGJlYjY0Mjg5OjdTY01NbTZmRVlYZGlFUEN4YVBhUW1nZVlkbFVyZndvaDRBZlhHT3pZSVMyQ3U5VA=="  # noqa
         elif BRANDS[brand] == BRAND_HYUNDAI:
             self.BASE_URL: str = "au-apigw.ccs.hyundai.com.au:8080"
             self.CCSP_SERVICE_ID: str = "855c72df-dfd7-4230-ab03-67cbf902bb1c"
             self.APP_ID: str = "f9ccfdac-a48d-4c57-bd32-9116963c24ed"  # Android app ID
-            self.BASIC_AUTHORIZATION: str = (
-                "Basic ODU1YzcyZGYtZGZkNy00MjMwLWFiMDMtNjdjYmY5MDJiYjFjOmU2ZmJ3SE0zMllOYmhRbDBwdmlhUHAzcmY0dDNTNms5MWVjZUEzTUpMZGJkVGhDTw=="
-            )
+            self.BASIC_AUTHORIZATION: str = "Basic ODU1YzcyZGYtZGZkNy00MjMwLWFiMDMtNjdjYmY5MDJiYjFjOmU2ZmJ3SE0zMllOYmhRbDBwdmlhUHAzcmY0dDNTNms5MWVjZUEzTUpMZGJkVGhDTw=="  # noqa
 
         self.USER_API_URL: str = "https://" + self.BASE_URL + "/api/v1/user/"
         self.SPA_API_URL: str = "https://" + self.BASE_URL + "/api/v1/spa/"
         self.SPA_API_URL_V2: str = "https://" + self.BASE_URL + "/api/v2/spa/"
         self.CLIENT_ID: str = self.CCSP_SERVICE_ID
 
-    def _get_authenticated_headers(self, token: Token) -> dict:
-        return {
-            "Authorization": token.access_token,
-            "ccsp-service-id": self.CCSP_SERVICE_ID,
-            "ccsp-application-id": self.APP_ID,
-            "ccsp-device-id": token.device_id,
-            "Stamp": self._get_stamp(),
-            "Host": self.BASE_URL,
-            "Connection": "Keep-Alive",
-            "Accept-Encoding": "gzip",
-            "User-Agent": USER_AGENT_OK_HTTP,
-        }
-
     def _get_control_headers(self, token: Token) -> dict:
         control_token, _ = self._get_control_token(token)
         authenticated_headers = self._get_authenticated_headers(token)
@@ -200,29 +190,11 @@ class KiaUvoApiAU(ApiImpl):
                 VIN=entry["vin"],
                 timezone=self.data_timezone,
                 engine_type=entry_engine_type,
+                ccu_ccs2_protocol_support=entry["ccuCCS2ProtocolSupport"],
             )
             result.append(vehicle)
         return result
 
-    def get_last_updated_at(self, value) -> dt.datetime:
-        _LOGGER.debug(f"{DOMAIN} - last_updated_at - before {value}")
-        if value is None:
-            value = dt.datetime(2000, 1, 1, tzinfo=self.data_timezone)
-        else:
-            m = re.match(r"(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})", value)
-            value = dt.datetime(
-                year=int(m.group(1)),
-                month=int(m.group(2)),
-                day=int(m.group(3)),
-                hour=int(m.group(4)),
-                minute=int(m.group(5)),
-                second=int(m.group(6)),
-                tzinfo=self.data_timezone,
-            )
-
-        _LOGGER.debug(f"{DOMAIN} - last_updated_at - after {value}")
-        return value
-
     def _get_time_from_string(self, value, timesection) -> dt.datetime.time:
         if value is not None:
             lastTwo = int(value[-2:])
@@ -238,17 +210,40 @@ class KiaUvoApiAU(ApiImpl):
         return value
 
     def update_vehicle_with_cached_state(self, token: Token, vehicle: Vehicle) -> None:
-        status = self._get_cached_vehicle_state(token, vehicle)
-        location = self._get_location(token, vehicle)
-        self._update_vehicle_properties(
-            vehicle,
-            {
-                "status": status,
-                "vehicleLocation": location,
-            },
-        )
+        url = self.SPA_API_URL + "vehicles/" + vehicle.id
+        is_ccs2 = vehicle.ccu_ccs2_protocol_support != 0
+        if is_ccs2:
+            url += "/ccs2/carstatus/latest"
+        else:
+            url += "/status/latest"
+
+        response = requests.get(
+            url,
+            headers=self._get_authenticated_headers(
+                token, vehicle.ccu_ccs2_protocol_support
+            ),
+        ).json()
+
+        _LOGGER.debug(f"{DOMAIN} - get_cached_vehicle_status response: {response}")
+        _check_response_for_errors(response)
+
+        if is_ccs2:
+            state = response["resMsg"]["state"]["Vehicle"]
+            self._update_vehicle_properties_ccs2(vehicle, state)
+        else:
+            location = self._get_location(token, vehicle)
+            self._update_vehicle_properties(
+                vehicle,
+                {
+                    "status": response["resMsg"],
+                    "vehicleLocation": location,
+                },
+            )
 
-        if vehicle.engine_type == ENGINE_TYPES.EV:
+        if (
+            vehicle.engine_type == ENGINE_TYPES.EV
+            or vehicle.engine_type == ENGINE_TYPES.PHEV
+        ):
             try:
                 state = self._get_driving_info(token, vehicle)
             except Exception as e:
@@ -278,15 +273,19 @@ class KiaUvoApiAU(ApiImpl):
         )
         # Only call for driving info on cars we know have a chance of supporting it.
         # Could be expanded if other types do support it.
-        if vehicle.engine_type == ENGINE_TYPES.EV:
+        if (
+            vehicle.engine_type == ENGINE_TYPES.EV
+            or vehicle.engine_type == ENGINE_TYPES.PHEV
+        ):
             try:
                 state = self._get_driving_info(token, vehicle)
             except Exception as e:
-                # we don't know if all car types provide this information.
-                # we also don't know what the API returns if the info is unavailable.
-                # so, catch any exception and move on.
+                # we don't know if all car types (ex: ICE cars) provide this
+                # information. We also don't know what the API returns if
+                # the info is unavailable. So, catch any exception and move on.
                 _LOGGER.exception(
                     """Failed to parse driving info. Possible reasons:
+                                    - incompatible vehicle (ICE)
                                     - new API format
                                     - API outage
                             """,
@@ -297,21 +296,22 @@ class KiaUvoApiAU(ApiImpl):
 
     def _update_vehicle_properties(self, vehicle: Vehicle, state: dict) -> None:
         if get_child_value(state, "status.time"):
-            vehicle.last_updated_at = self.get_last_updated_at(
-                get_child_value(state, "status.time")
+            vehicle.last_updated_at = parse_datetime(
+                get_child_value(state, "status.time"), self.data_timezone
             )
         else:
             vehicle.last_updated_at = dt.datetime.now(self.data_timezone)
 
-        vehicle.odometer = (
-            get_child_value(state, "status.odometer.value"),
-            DISTANCE_UNITS[
-                get_child_value(
-                    state,
-                    "status.odometer.unit",
-                )
-            ],
-        )
+        if get_child_value(state, "status.odometer.value"):
+            vehicle.odometer = (
+                get_child_value(state, "status.odometer.value"),
+                DISTANCE_UNITS[
+                    get_child_value(
+                        state,
+                        "status.odometer.unit",
+                    )
+                ],
+            )
         vehicle.car_battery_percentage = get_child_value(state, "status.battery.batSoc")
         vehicle.engine_is_running = get_child_value(state, "status.engine")
 
@@ -490,7 +490,7 @@ class KiaUvoApiAU(ApiImpl):
             vehicle.ev_charge_limits_dc = [
                 x["targetSOClevel"] for x in target_soc_list if x["plugType"] == 0
             ][-1]
-        except:
+        except Exception:
             _LOGGER.debug(f"{DOMAIN} - SOC Levels couldn't be found. May not be an EV.")
         if (
             get_child_value(
@@ -646,8 +646,8 @@ class KiaUvoApiAU(ApiImpl):
             vehicle.location = (
                 get_child_value(state, "vehicleLocation.coord.lat"),
                 get_child_value(state, "vehicleLocation.coord.lon"),
-                self.get_last_updated_at(
-                    get_child_value(state, "vehicleLocation.time")
+                parse_datetime(
+                    get_child_value(state, "vehicleLocation.time"), self.data_timezone
                 ),
             )
         vehicle.data = state
@@ -657,18 +657,6 @@ class KiaUvoApiAU(ApiImpl):
         vehicle.power_consumption_30d = get_child_value(state, "consumption30d")
         vehicle.daily_stats = get_child_value(state, "dailyStats")
 
-    def _get_cached_vehicle_state(self, token: Token, vehicle: Vehicle) -> dict:
-        url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/status/latest"
-
-        response = requests.get(
-            url, headers=self._get_authenticated_headers(token)
-        ).json()
-        _LOGGER.debug(f"{DOMAIN} - get_cached_vehicle_status response: {response}")
-        _check_response_for_errors(response)
-        response = response["resMsg"]
-
-        return response
-
     def _get_location(self, token: Token, vehicle: Vehicle) -> dict:
         url = self.SPA_API_URL + "vehicles/" + vehicle.id + "/location/park"
 
@@ -679,7 +667,7 @@ class KiaUvoApiAU(ApiImpl):
             _LOGGER.debug(f"{DOMAIN} - _get_location response: {response}")
             _check_response_for_errors(response)
             return response["resMsg"]["gpsDetail"]
-        except:
+        except Exception:
             _LOGGER.debug(f"{DOMAIN} - _get_location failed")
             return None
 
@@ -867,7 +855,7 @@ class KiaUvoApiAU(ApiImpl):
         yyyymm_string,
     ) -> None:
         """
-        Europe feature only.
+        feature only available for some regions.
         Updates the vehicle.month_trip_info for the specified month.
 
         Default this information is None:
@@ -911,7 +899,7 @@ class KiaUvoApiAU(ApiImpl):
         yyyymmdd_string,
     ) -> None:
         """
-        Europe feature only.
+        feature only available for some regions.
         Updates the vehicle.day_trip_info information for the specified day.
 
         Default this information is None:
@@ -985,6 +973,7 @@ class KiaUvoApiAU(ApiImpl):
                     battery_care_consumption=day["batteryMgPwrCsp"],
                     regenerated_energy=day["regenPwr"],
                     distance=day["calculativeOdo"],
+                    distance_unit=vehicle.odometer_unit,
                 )
                 drivingInfo["dailyStats"].append(processedDay)
 

hyundai_kia_connect_api/KiaUvoApiCA.py

@@ -2,10 +2,10 @@
 
 # pylint:disable=unused-argument,missing-timeout,logging-fstring-interpolation,bare-except,invalid-name,missing-function-docstring
 
+import time
 import datetime as dt
 import json
 import logging
-import re
 
 import pytz
 import requests
@@ -35,6 +35,7 @@ from .utils import (
     get_child_value,
     get_hex_temp_into_index,
     get_index_into_hex_temp,
+    parse_datetime,
 )
 
 import ssl
@@ -69,6 +70,7 @@ class KiaUvoApiCA(ApiImpl):
     def __init__(self, region: int, brand: int, language: str) -> None:
         self.vehicle_timezone = self.data_timezone
         self.LANGUAGE: str = language
+        self.brand = brand
         if BRANDS[brand] == BRAND_KIA:
             self.BASE_URL: str = "kiaconnect.ca"
         elif BRANDS[brand] == BRAND_HYUNDAI:
@@ -94,8 +96,14 @@ class KiaUvoApiCA(ApiImpl):
             "sec-fetch-mode": "cors",
             "sec-fetch-site": "same-origin",
         }
-        self.sessions = requests.Session()
-        self.sessions.mount("https://" + self.BASE_URL, cipherAdapter())
+        self._sessions = None
+
+    @property
+    def sessions(self):
+        if not self._sessions:
+            self._sessions = requests.Session()
+            self._sessions.mount("https://" + self.BASE_URL, cipherAdapter())
+        return self._sessions
 
     def _check_response_for_errors(self, response: dict) -> None:
         """
@@ -202,8 +210,8 @@ class KiaUvoApiCA(ApiImpl):
 
         # Calculate offset between vehicle last_updated_at and UTC
         self.vehicle_timezone = vehicle.timezone
-        last_updated_at = self.get_last_updated_at(
-            get_child_value(state, "status.lastStatusDate")
+        last_updated_at = parse_datetime(
+            get_child_value(state, "status.lastStatusDate"), self.data_timezone
         )
         now_utc: dt = dt.datetime.now(pytz.utc)
         offset = round((last_updated_at - now_utc).total_seconds() / 3600)
@@ -238,15 +246,19 @@ class KiaUvoApiCA(ApiImpl):
     def _update_vehicle_properties_base(self, vehicle: Vehicle, state: dict) -> None:
         _LOGGER.debug(f"{DOMAIN} - Old Vehicle Last Updated: {vehicle.last_updated_at}")
         self.vehicle_timezone = vehicle.timezone
-        vehicle.last_updated_at = self.get_last_updated_at(
-            get_child_value(state, "status.lastStatusDate")
+        vehicle.last_updated_at = parse_datetime(
+            get_child_value(state, "status.lastStatusDate"), self.data_timezone
         )
         _LOGGER.debug(
             f"{DOMAIN} - Current Vehicle Last Updated: {vehicle.last_updated_at}"
         )
         # Converts temp to usable number. Currently only support celsius.
         # Future to do is check unit in case the care itself is set to F.
-        if get_child_value(state, "status.airTemp.value") != "OFF":
+        if (
+            get_child_value(state, "status.airTemp.value") is not None
+            and get_child_value(state, "status.airTemp.value") != "OFF"
+            and get_child_value(state, "status.airTemp.value")[-1] == "H"
+        ):
             tempIndex = get_hex_temp_into_index(
                 get_child_value(state, "status.airTemp.value")
             )
@@ -426,29 +438,10 @@ class KiaUvoApiCA(ApiImpl):
             vehicle.location = (
                 get_child_value(state, "coord.lat"),
                 get_child_value(state, "coord.lon"),
-                self.get_last_updated_at(get_child_value(state, "time")),
+                parse_datetime(get_child_value(state, "time"), self.data_timezone),
             )
         vehicle.data["vehicleLocation"] = state
 
-    def get_last_updated_at(self, value) -> dt.datetime:
-        _LOGGER.debug(f"{DOMAIN} - last_updated_at - before {value}")
-        if value is None:
-            value = dt.datetime(2000, 1, 1, tzinfo=self.vehicle_timezone)
-        else:
-            m = re.match(r"(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})", value)
-            value = dt.datetime(
-                year=int(m.group(1)),
-                month=int(m.group(2)),
-                day=int(m.group(3)),
-                hour=int(m.group(4)),
-                minute=int(m.group(5)),
-                second=int(m.group(6)),
-                tzinfo=self.vehicle_timezone,
-            )
-
-        _LOGGER.debug(f"{DOMAIN} - last_updated_at - after {value}")
-        return value
-
     def _get_cached_vehicle_state(self, token: Token, vehicle: Vehicle) -> dict:
         # Vehicle Status Call
         url = self.API_URL + "lstvhclsts"
@@ -509,7 +502,7 @@ class KiaUvoApiCA(ApiImpl):
             if response["responseHeader"]["responseCode"] != 0:
                 raise APIError("No Location Located")
             return response["result"]
-        except:
+        except Exception:
             _LOGGER.warning(f"{DOMAIN} - Get vehicle location failed")
             return None
 
@@ -590,18 +583,33 @@ class KiaUvoApiCA(ApiImpl):
             )
         if vehicle.engine_type == ENGINE_TYPES.EV:
             payload = {
-                "hvacInfo": {
-                    "airCtrl": int(options.climate),
-                    "defrost": options.defrost,
-                    "heating1": options.heating,
-                    "airTemp": {
-                        "value": hex_set_temp,
-                        "unit": 0,
-                        "hvacTempType": 1,
-                    },
-                },
                 "pin": token.pin,
             }
+            climate_settings = {
+                "airCtrl": int(options.climate),
+                "defrost": options.defrost,
+                "heating1": options.heating,
+                "airTemp": {
+                    "value": hex_set_temp,
+                    "unit": 0,
+                    "hvacTempType": 1,
+                },
+            }
+            if BRANDS[self.brand] == BRAND_KIA:
+                payload["remoteControl"] = climate_settings
+                payload["remoteControl"].update(
+                    {
+                        "igniOnDuration": options.duration,
+                        "seatHeaterVentCMD": {
+                            "drvSeatOptCmd": options.front_left_seat,
+                            "astSeatOptCmd": options.front_right_seat,
+                            "rlSeatOptCmd": options.rear_left_seat,
+                            "rrSeatOptCmd": options.rear_right_seat,
+                        },
+                    }
+                )
+            else:
+                payload["hvacInfo"] = climate_settings
         else:
             payload = {
                 "setting": {
@@ -656,6 +664,10 @@ class KiaUvoApiCA(ApiImpl):
         synchronous: bool = False,
         timeout: int = 0,
     ) -> OrderStatus:
+        if timeout < 0:
+            return OrderStatus.TIMEOUT
+        start_time = dt.datetime.now()
+
         url = self.API_URL + "rmtsts"
         headers = self.API_HEADERS
         headers["accessToken"] = token.access_token
@@ -668,10 +680,27 @@ class KiaUvoApiCA(ApiImpl):
         last_action_completed = (
             response["result"]["transaction"]["apiStatusCode"] != "null"
         )
+
         if last_action_completed:
             action_status = response["result"]["transaction"]["apiStatusCode"]
             _LOGGER.debug(f"{DOMAIN} - Last action_status: {action_status}")
-        return last_action_completed
+
+        if response["responseHeader"]["responseCode"] == 1:
+            return OrderStatus.FAILED
+        elif response["result"]["transaction"]["apiResult"] == "C":
+            return OrderStatus.SUCCESS
+        elif response["result"]["transaction"]["apiResult"] == "P":
+            if not synchronous:
+                return OrderStatus.PENDING
+            else:
+                timedelta = dt.datetime.now() - start_time
+                time_left = timeout - timedelta.seconds - 10
+                time.sleep(10)
+                return self.check_action_status(
+                    token, vehicle, action_id, synchronous, time_left
+                )
+
+        return OrderStatus.FAILED
 
     def start_charge(self, token: Token, vehicle: Vehicle) -> str:
         url = self.API_URL + "evc/rcstrt"
@@ -717,7 +746,7 @@ class KiaUvoApiCA(ApiImpl):
                 vehicle.ev_charge_limits_dc = [
                     x["level"] for x in state if x["plugType"] == 0
                 ][-1]
-        except:
+        except Exception:
             _LOGGER.debug(f"{DOMAIN} - SOC Levels couldn't be found. May not be an EV.")
 
     def _get_charge_limits(self, token: Token, vehicle: Vehicle) -> dict: