carconnectivity-connector-skoda 0.2a2__py3-none-any.whl → 0.2a4__py3-none-any.whl

{carconnectivity_connector_skoda-0.2a2.dist-info → carconnectivity_connector_skoda-0.2a4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: carconnectivity-connector-skoda
-Version: 0.2a2
+Version: 0.2a4
 Summary: CarConnectivity connector for Skoda services
 Author: Till Steinbach
 License: MIT License
@@ -37,10 +37,11 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: carconnectivity>=0.2
+Requires-Dist: carconnectivity>=0.3a2
 Requires-Dist: oauthlib~=3.2.2
 Requires-Dist: requests~=2.32.3
 Requires-Dist: jwt~=1.3.1
+Requires-Dist: paho-mqtt~=2.1.0
 
 
 

carconnectivity_connector_skoda-0.2a4.dist-info/RECORD

@@ -0,0 +1,22 @@
+carconnectivity_connectors/skoda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+carconnectivity_connectors/skoda/_version.py,sha256=BvxRhPNikofS69C59rpfXi_PwIqZKOowoWGrEf19x7Y,408
+carconnectivity_connectors/skoda/capability.py,sha256=vbAKK8KKre-CndLF6_5qyWLpfa4KZHk1U-hpb6nCL5w,4225
+carconnectivity_connectors/skoda/charging.py,sha256=CoUOYHHUPPPldKQvv0h-qrUsoEtstR3iUx-l0IU5rNM,6798
+carconnectivity_connectors/skoda/climatization.py,sha256=-Nk4tO5C5_YYNQfUIUWBL7mGgR6-J0_pOZplLK8p_ms,1627
+carconnectivity_connectors/skoda/command_impl.py,sha256=WdgxWPgi82-UgmyFpiSZE-KHRtRjqn7CH-YX9N3bAoI,2875
+carconnectivity_connectors/skoda/connector.py,sha256=3SiP181vatcHF-2YJEvmxQ7Gb1RUCRE2Z2sRCakcz7w,110760
+carconnectivity_connectors/skoda/error.py,sha256=ffxzvjmci7vtp9Q1K4DR1kBF0kTJxN5Gluci3kDBkEI,2459
+carconnectivity_connectors/skoda/mqtt_client.py,sha256=PHvMkNhmkP_FxHvVlXzFLJA6Q3vkFCK8jZHkfII_j74,38123
+carconnectivity_connectors/skoda/vehicle.py,sha256=EhrhAY41A05S2yf5YoU-uvo_alAiSdjFuAyLW318DJw,3383
+carconnectivity_connectors/skoda/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+carconnectivity_connectors/skoda/auth/auth_util.py,sha256=dGLUbUre0HBsTg_Ii5vW34f8DLrCykYJYCyzEvUBBEE,4434
+carconnectivity_connectors/skoda/auth/my_skoda_session.py,sha256=lSh23SFJs8opjmPwHTv-KNIKDep_WY4aItSP4Zq7bT8,10396
+carconnectivity_connectors/skoda/auth/openid_session.py,sha256=5JfR-gS1uKpE8DD-sx5Qvw6zv-OJhzcRlt0D-cm38-Y,16832
+carconnectivity_connectors/skoda/auth/session_manager.py,sha256=Uf1vujuDBYUCAXhYToOsZkgbTtfmY3Qe0ICTfwomBpI,2899
+carconnectivity_connectors/skoda/auth/skoda_web_session.py,sha256=cjzMkzx473Sh-4RgZAQULeRRcxB1MboddldCVM_y5LE,10640
+carconnectivity_connectors/skoda/auth/helpers/blacklist_retry.py,sha256=f3wsiY5bpHDBxp7Va1Mv9nKJ4u3qnCHZZmDu78_AhMk,1251
+carconnectivity_connector_skoda-0.2a4.dist-info/LICENSE,sha256=PIwI1alwDyOfvEQHdGCm2u9uf_mGE8030xZDfun0xTo,1071
+carconnectivity_connector_skoda-0.2a4.dist-info/METADATA,sha256=LW_mlPJJ3bdQZJeTlAnNoITcNPGTUMVIKjMWShAn8Yg,5365
+carconnectivity_connector_skoda-0.2a4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+carconnectivity_connector_skoda-0.2a4.dist-info/top_level.txt,sha256=KqA8GviZsDH4PtmnwSQsz0HB_w-TWkeEHLIRNo5dTaI,27
+carconnectivity_connector_skoda-0.2a4.dist-info/RECORD,,

carconnectivity_connectors/skoda/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2a2'
+__version__ = version = '0.2a4'
 __version_tuple__ = version_tuple = (0, 2)

carconnectivity_connectors/skoda/auth/openid_session.py

@@ -18,8 +18,8 @@ from requests.adapters import HTTPAdapter
 
 from carconnectivity.errors import AuthenticationError, RetrievalError
 
-from carconnectivity_connectors.volkswagen.auth.auth_util import add_bearer_auth_header
-from carconnectivity_connectors.volkswagen.auth.helpers.blacklist_retry import BlacklistRetry
+from carconnectivity_connectors.skoda.auth.auth_util import add_bearer_auth_header
+from carconnectivity_connectors.skoda.auth.helpers.blacklist_retry import BlacklistRetry
 
 if TYPE_CHECKING:
     from typing import Dict

carconnectivity_connectors/skoda/capability.py

@@ -102,7 +102,7 @@ class Capability(GenericObject):
             raise ValueError('Capability ID cannot be None')
         super().__init__(object_id=capability_id, parent=capabilities)
         self.delay_notifications = True
-        self.capability_id = StringAttribute("id", self, capability_id)
+        self.capability_id = StringAttribute("id", self, capability_id, tags={'connector_custom'})
         self.statuses = list[Capability.Status]
         self.enabled = True
         self.delay_notifications = False

carconnectivity_connectors/skoda/charging.py

@@ -32,7 +32,7 @@ class SkodaCharging(Charging):  # pylint: disable=too-many-instance-attributes
             super().__init__(vehicle=vehicle)
             self.settings: Charging.Settings = SkodaCharging.Settings(origin=self.settings)
         self.errors: Dict[str, Error] = {}
-        self.is_in_saved_location: BooleanAttribute = BooleanAttribute("is_in_saved_location", parent=self)
+        self.is_in_saved_location: BooleanAttribute = BooleanAttribute("is_in_saved_location", parent=self, tags={'connector_custom'})
 
     class Settings(Charging.Settings):
         """
@@ -43,10 +43,10 @@ class SkodaCharging(Charging):  # pylint: disable=too-many-instance-attributes
                 super().__init__(origin=origin)
             else:
                 super().__init__(parent=parent)
-            self.preferred_charge_mode: EnumAttribute = EnumAttribute("preferred_charge_mode", parent=self)
-            self.available_charge_modes: StringAttribute = StringAttribute("available_charge_modes", parent=self)
-            self.charging_care_mode: EnumAttribute = EnumAttribute("charging_care_mode", parent=self)
-            self.battery_support: EnumAttribute = EnumAttribute("battery_support", parent=self)
+            self.preferred_charge_mode: EnumAttribute = EnumAttribute("preferred_charge_mode", parent=self, tags={'connector_custom'})
+            self.available_charge_modes: StringAttribute = StringAttribute("available_charge_modes", parent=self, tags={'connector_custom'})
+            self.charging_care_mode: EnumAttribute = EnumAttribute("charging_care_mode", parent=self, tags={'connector_custom'})
+            self.battery_support: EnumAttribute = EnumAttribute("battery_support", parent=self, tags={'connector_custom'})
 
     class SkodaChargingState(Enum,):
         """

carconnectivity_connectors/skoda/connector.py

@@ -42,6 +42,16 @@ from carconnectivity_connectors.skoda._version import __version__
 from carconnectivity_connectors.skoda.mqtt_client import SkodaMQTTClient
 from carconnectivity_connectors.skoda.command_impl import SpinCommand
 
+SUPPORT_IMAGES = False
+try:
+    from PIL import Image
+    import base64
+    import io
+    SUPPORT_IMAGES = True
+    from carconnectivity.attributes import ImageAttribute
+except ImportError:
+    pass
+
 if TYPE_CHECKING:
     from typing import Dict, List, Optional, Any, Set, Union
 
@@ -69,8 +79,8 @@ class Connector(BaseConnector):
         self._background_connect_thread: Optional[threading.Thread] = None
         self._stop_event = threading.Event()
 
-        self.connected: BooleanAttribute = BooleanAttribute(name="connected", parent=self)
-        self.interval: DurationAttribute = DurationAttribute(name="interval", parent=self)
+        self.connected: BooleanAttribute = BooleanAttribute(name="connected", parent=self, tags={'connector_custom'})
+        self.interval: DurationAttribute = DurationAttribute(name="interval", parent=self, tags={'connector_custom'})
         self.commands: Commands = Commands(parent=self)
 
         self.user_id: Optional[str] = None
@@ -315,6 +325,8 @@ class Connector(BaseConnector):
                         log_extra_keys(LOG_API, 'vehicles', vehicle_dict,  {'vin', 'licensePlate', 'name'})
 
                         vehicle = self.fetch_vehicle_details(vehicle)
+                        if SUPPORT_IMAGES:
+                            vehicle = self.fetch_vehicle_images(vehicle)
                     else:
                         raise APIError('Could not parse vehicle, vin missing')
         for vin in set(garage.list_vehicle_vins()) - seen_vehicle_vins:
@@ -930,6 +942,68 @@ class Connector(BaseConnector):
             log_extra_keys(LOG_API, 'api/v2/garage/vehicles/VIN', vehicle_data, {'softwareVersion'})
         return vehicle
 
+    def fetch_vehicle_images(self, vehicle: SkodaVehicle, no_cache: bool = False) -> SkodaVehicle:
+        if SUPPORT_IMAGES:
+            url: str = f'https://mysmob.api.connect.skoda-auto.cz/api/v1/vehicle-information/{vehicle.vin.value}/renders'
+            data = self._fetch_data(url, session=self.session, allow_http_error=True)
+            if data is not None and 'compositeRenders' in data:  # pylint: disable=too-many-nested-blocks
+                for image in data['compositeRenders']:
+                    if not 'layers' in image or image['layers'] is None or len(image['layers']) == 0:
+                        continue
+                    image_url: Optional[str] = None
+                    for layer in image['layers']:
+                        if 'url' in layer and layer['url'] is not None:
+                            image_url = layer['url']
+                            break
+                    if image_url is None:
+                        continue
+                    img = None
+                    cache_date = None
+                    if self.max_age is not None and self.session.cache is not None and image_url in self.session.cache:
+                        img, cache_date_string = self.session.cache[image_url]
+                        img = base64.b64decode(img)  # pyright: ignore[reportPossiblyUnboundVariable]
+                        img = Image.open(io.BytesIO(img))  # pyright: ignore[reportPossiblyUnboundVariable]
+                        cache_date = datetime.fromisoformat(cache_date_string)
+                    if img is None or self.max_age is None \
+                            or (cache_date is not None and cache_date < (datetime.utcnow() - timedelta(seconds=self.max_age))):
+                        try:
+                            image_download_response = requests.get(image_url, stream=True)
+                            if image_download_response.status_code == requests.codes['ok']:
+                                img = Image.open(image_download_response.raw)  # pyright: ignore[reportPossiblyUnboundVariable]
+                                if self.session.cache is not None:
+                                    buffered = io.BytesIO()  # pyright: ignore[reportPossiblyUnboundVariable]
+                                    img.save(buffered, format="PNG")
+                                    img_str = base64.b64encode(buffered.getvalue()).decode("utf-8")  # pyright: ignore[reportPossiblyUnboundVariable]
+                                    self.session.cache[image_url] = (img_str, str(datetime.utcnow()))
+                            elif image_download_response.status_code == requests.codes['unauthorized']:
+                                LOG.info('Server asks for new authorization')
+                                self.session.login()
+                                image_download_response = self.session.get(image_url, stream=True)
+                                if image_download_response.status_code == requests.codes['ok']:
+                                    img = Image.open(image_download_response.raw)  # pyright: ignore[reportPossiblyUnboundVariable]
+                                    if self.session.cache is not None:
+                                        buffered = io.BytesIO()  # pyright: ignore[reportPossiblyUnboundVariable]
+                                        img.save(buffered, format="PNG")
+                                        img_str = base64.b64encode(buffered.getvalue()).decode("utf-8")  # pyright: ignore[reportPossiblyUnboundVariable]
+                                        self.session.cache[image_url] = (img_str, str(datetime.utcnow()))
+                        except requests.exceptions.ConnectionError as connection_error:
+                            raise RetrievalError(f'Connection error: {connection_error}') from connection_error
+                        except requests.exceptions.ChunkedEncodingError as chunked_encoding_error:
+                            raise RetrievalError(f'Error: {chunked_encoding_error}') from chunked_encoding_error
+                        except requests.exceptions.ReadTimeout as timeout_error:
+                            raise RetrievalError(f'Timeout during read: {timeout_error}') from timeout_error
+                        except requests.exceptions.RetryError as retry_error:
+                            raise RetrievalError(f'Retrying failed: {retry_error}') from retry_error
+                    if img is not None:
+                        vehicle._car_images[image['viewType']] = img  # pylint: disable=protected-access
+                        if image['viewType'] == 'UNMODIFIED_EXTERIOR_FRONT':
+                            if 'car_picture' in vehicle.images.images:
+                                vehicle.images.images['car_picture']._set_value(img)  # pylint: disable=protected-access
+                            else:
+                                vehicle.images.images['car_picture']: ImageAttribute = ImageAttribute(name="car_picture", parent=vehicle.images,
+                                                                                                        value=img, tags={'carconnectivity'})
+        return vehicle
+
     def fetch_driving_range(self, vehicle: SkodaVehicle, no_cache: bool = False) -> SkodaVehicle:
         """
         Fetches the driving range data for a given Skoda vehicle and updates the vehicle object accordingly.
@@ -1194,6 +1268,9 @@ class Connector(BaseConnector):
     def get_version(self) -> str:
         return __version__
 
+    def get_type(self) -> str:
+        return "carconnectivity-connector-skoda"
+
     def __on_air_conditioning_target_temperature_change(self, temperature_attribute: TemperatureAttribute, target_temperature: float) -> float:
         """
         Callback for the climatization target temperature change.

carconnectivity_connectors/skoda/error.py

@@ -18,8 +18,8 @@ class Error(GenericObject):
 
     def __init__(self, object_id, parent: Optional[GenericObject] = None) -> None:
         super().__init__(object_id, parent=parent)
-        self.type: EnumAttribute = EnumAttribute("type", parent=self)
-        self.description: StringAttribute = StringAttribute("description", parent=self)
+        self.type: EnumAttribute = EnumAttribute("type", parent=self, tags={'connector_custom'})
+        self.description: StringAttribute = StringAttribute("description", parent=self, tags={'connector_custom'})
 
     class ChargingError(Enum):
         """

carconnectivity_connectors/skoda/mqtt_client.py

@@ -179,7 +179,10 @@ class SkodaMQTTClient(Client):  # pylint: disable=too-many-instance-attributes
                 vin: str = vehicle.vin.value
                 # If the skoda connector is managing this vehicle
                 if self._skoda_connector in vehicle.managing_connectors:
-                    account_events: Set[str] = {'privacy'}
+                    account_events: Set[str] = {'privacy',
+                                                'guest-user-nomination',
+                                                'primary-user-nomination'}
+                    vehicle_status_events: Set[str] = {'vehicle-connection-status'}
                     operation_requests: Set[str] = {
                         'air-conditioning/set-air-conditioning-at-unlock',
                         'air-conditioning/set-air-conditioning-seats-heating',
@@ -216,6 +219,8 @@ class SkodaMQTTClient(Client):  # pylint: disable=too-many-instance-attributes
                     # Compile all possible topics
                     for event in account_events:
                         possible_topics.add(f'{user_id}/{vin}/account-event/{event}')
+                    for event in vehicle_status_events:
+                        possible_topics.add(f'{user_id}/{vin}/vehicle-status/{event}')
                     for event in operation_requests:
                         possible_topics.add(f'{user_id}/{vin}/operation-request/{event}')
                     for event in service_events:

carconnectivity_connectors/skoda/vehicle.py

@@ -8,8 +8,15 @@ from carconnectivity.charging import Charging
 from carconnectivity_connectors.skoda.capability import Capabilities
 from carconnectivity_connectors.skoda.charging import SkodaCharging
 
+SUPPORT_IMAGES = False
+try:
+    from PIL import Image
+    SUPPORT_IMAGES = True
+except ImportError:
+    pass
+
 if TYPE_CHECKING:
-    from typing import Optional
+    from typing import Optional, Dict
     from carconnectivity.garage import Garage
     from carconnectivity_connectors.base.connector import BaseConnector
 
@@ -24,9 +31,14 @@ class SkodaVehicle(GenericVehicle):  # pylint: disable=too-many-instance-attribu
             super().__init__(origin=origin)
             self.capabilities: Capabilities = origin.capabilities
             self.capabilities.parent = self
+            if SUPPORT_IMAGES:
+                self._car_images = origin._car_images
+
         else:
             super().__init__(vin=vin, garage=garage, managing_connector=managing_connector)
             self.capabilities = Capabilities(vehicle=self)
+            if SUPPORT_IMAGES:
+                self._car_images: Dict[str, Image.Image] = {}
         self.manufacturer._set_value(value='Škoda')  # pylint: disable=protected-access
 
 

carconnectivity_connector_skoda-0.2a2.dist-info/RECORD

@@ -1,22 +0,0 @@
-carconnectivity_connectors/skoda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-carconnectivity_connectors/skoda/_version.py,sha256=K5FRuDp7oE3vVzMAjjBq7gz8WRnAzHih0vG_csLk83E,408
-carconnectivity_connectors/skoda/capability.py,sha256=SnK9xVsqDA5EcWtBznzfWxe6gIpkYdjgY3UzNIc3OCY,4198
-carconnectivity_connectors/skoda/charging.py,sha256=rG_GoDPetjyjWCyV6l65hgEDU6ths6MkMQ0KL25rbVU,6663
-carconnectivity_connectors/skoda/climatization.py,sha256=-Nk4tO5C5_YYNQfUIUWBL7mGgR6-J0_pOZplLK8p_ms,1627
-carconnectivity_connectors/skoda/command_impl.py,sha256=WdgxWPgi82-UgmyFpiSZE-KHRtRjqn7CH-YX9N3bAoI,2875
-carconnectivity_connectors/skoda/connector.py,sha256=g4G9u8xE3iG6ASy7sGSXimaJ3zFV04E9GrNn5TB0ia4,105140
-carconnectivity_connectors/skoda/error.py,sha256=EnzzDxxJ1fswYT5QnMOVSebfoAcqoPmHKcG5i0Tqk3E,2405
-carconnectivity_connectors/skoda/mqtt_client.py,sha256=lfHJfKOl-FBVd5hV6cS6ZMpZ53ktXyVc4lafvQls-Tk,37748
-carconnectivity_connectors/skoda/vehicle.py,sha256=_ALtlBy7sKVHmqpqAhWNbMd9dto915_SdNWcRi_AqYU,3088
-carconnectivity_connectors/skoda/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-carconnectivity_connectors/skoda/auth/auth_util.py,sha256=dGLUbUre0HBsTg_Ii5vW34f8DLrCykYJYCyzEvUBBEE,4434
-carconnectivity_connectors/skoda/auth/my_skoda_session.py,sha256=lSh23SFJs8opjmPwHTv-KNIKDep_WY4aItSP4Zq7bT8,10396
-carconnectivity_connectors/skoda/auth/openid_session.py,sha256=LusWi2FZZIL3buodGXZKUR0naLhhqeYv0uRW4V3wI2w,16842
-carconnectivity_connectors/skoda/auth/session_manager.py,sha256=Uf1vujuDBYUCAXhYToOsZkgbTtfmY3Qe0ICTfwomBpI,2899
-carconnectivity_connectors/skoda/auth/skoda_web_session.py,sha256=cjzMkzx473Sh-4RgZAQULeRRcxB1MboddldCVM_y5LE,10640
-carconnectivity_connectors/skoda/auth/helpers/blacklist_retry.py,sha256=f3wsiY5bpHDBxp7Va1Mv9nKJ4u3qnCHZZmDu78_AhMk,1251
-carconnectivity_connector_skoda-0.2a2.dist-info/LICENSE,sha256=PIwI1alwDyOfvEQHdGCm2u9uf_mGE8030xZDfun0xTo,1071
-carconnectivity_connector_skoda-0.2a2.dist-info/METADATA,sha256=t2d6yjpItOO8uvEmSK53fb2YoxQ7RK3TLBQ3x9YmHdw,5331
-carconnectivity_connector_skoda-0.2a2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-carconnectivity_connector_skoda-0.2a2.dist-info/top_level.txt,sha256=KqA8GviZsDH4PtmnwSQsz0HB_w-TWkeEHLIRNo5dTaI,27
-carconnectivity_connector_skoda-0.2a2.dist-info/RECORD,,