carconnectivity-connector-skoda 0.1a5__tar.gz → 0.1a7__tar.gz

{carconnectivity_connector_skoda-0.1a5 → carconnectivity_connector_skoda-0.1a7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: carconnectivity-connector-skoda
-Version: 0.1a5
+Version: 0.1a7
 Summary: CarConnectivity connector for Skoda services
 Author: Till Steinbach
 License: MIT License

carconnectivity_connector_skoda-0.1a7/doc/Config.md

@@ -0,0 +1,27 @@
+
+
+# CarConnectivity Connector for MySkoda Config Options
+The configuration for CarConnectivity is a .json file.
+## MySkoda Connector Options
+These are the valid options for the MySkoda Connector
+```json
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda", // Definition for the MySkoda Connector
+                "config": {
+                    "log_level": "error", // set the connectos log level
+                    "interval": 300, // Interval in which the server is checked in seconds
+                    "username": "test@test.de", // Username of your Volkswagen Account
+                    "password": "testpassword123", // Username of your Volkswagen Account
+                    "netrc": "~/.netr", // netrc file if to be used for passwords
+                    "api_log_level": "debug", // Show debug information regarding the API
+                    "max_age": 300 //Cache requests to the server vor MAX_AGE seconds
+                }
+            }
+        ],
+        "plugins": []
+    }
+}
+```

{carconnectivity_connector_skoda-0.1a5 → carconnectivity_connector_skoda-0.1a7}/src/carconnectivity_connector_skoda.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: carconnectivity-connector-skoda
-Version: 0.1a5
+Version: 0.1a7
 Summary: CarConnectivity connector for Skoda services
 Author: Till Steinbach
 License: MIT License

{carconnectivity_connector_skoda-0.1a5 → carconnectivity_connector_skoda-0.1a7}/src/carconnectivity_connector_skoda.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ setup_requirements.txt
 .github/workflows/build.yml
 .github/workflows/build_and_publish.yml
 .github/workflows/codeql-analysis.yml
+doc/Config.md
 src/carconnectivity_connector_skoda.egg-info/PKG-INFO
 src/carconnectivity_connector_skoda.egg-info/SOURCES.txt
 src/carconnectivity_connector_skoda.egg-info/dependency_links.txt

{carconnectivity_connector_skoda-0.1a5 → carconnectivity_connector_skoda-0.1a7}/src/carconnectivity_connectors/skoda/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1a5'
+__version__ = version = '0.1a7'
 __version_tuple__ = version_tuple = (0, 1)

{carconnectivity_connector_skoda-0.1a5 → carconnectivity_connector_skoda-0.1a7}/src/carconnectivity_connectors/skoda/auth/my_skoda_session.py

@@ -146,7 +146,7 @@ class MySkodaSession(SkodaWebSession):
         if 'refreshToken' in token:
             found_tokens.add('refreshToken')
             token['refresh_token'] = token.pop('refreshToken')
-        LOG.info(f'Found tokens in answer: {found_tokens}')
+        LOG.debug(f'Found tokens in answer: {found_tokens}')
         # generate json from fixed dict
         fixed_token_response = to_unicode(json.dumps(token)).encode("utf-8")
         # Let OAuthlib parse the token

{carconnectivity_connector_skoda-0.1a5 → carconnectivity_connector_skoda-0.1a7}/src/carconnectivity_connectors/skoda/connector.py

@@ -14,7 +14,7 @@ from carconnectivity.vehicle import GenericVehicle
 from carconnectivity.errors import AuthenticationError, TooManyRequestsError, RetrievalError, APIError, APICompatibilityError, \
     TemporaryAuthenticationError, ConfigurationError
 from carconnectivity.util import robust_time_parse, log_extra_keys, config_remove_credentials
-from carconnectivity.units import Length
+from carconnectivity.units import Length, Speed, Power
 from carconnectivity.doors import Doors
 from carconnectivity.windows import Windows
 from carconnectivity.lights import Lights
@@ -267,7 +267,9 @@ class Connector(BaseConnector):
                             vehicle.license_plate._set_value(None)  # pylint: disable=protected-access
 
                         log_extra_keys(LOG_API, 'vehicles', vehicle_dict,  {'vin', 'licensePlate'})
-                        self.fetch_vehicle_status(vehicle)
+                        vehicle = self.fetch_vehicle_status(vehicle)
+                        if isinstance(vehicle, SkodaElectricVehicle):
+                            vehicle = self.fetch_charging(vehicle)
                     else:
                         raise APIError('Could not parse vehicle, vin missing')
         for vin in set(garage.list_vehicle_vins()) - seen_vehicle_vins:
@@ -275,7 +277,53 @@ class Connector(BaseConnector):
             if vehicle_to_remove is not None and vehicle_to_remove.is_managed_by_connector(self):
                 garage.remove_vehicle(vin)
 
-    def fetch_vehicle_status(self, vehicle: SkodaVehicle) -> None:
+    def fetch_charging(self, vehicle: SkodaElectricVehicle) -> SkodaElectricVehicle:
+        """
+        Fetches the charging information for a given Skoda electric vehicle.
+
+        Args:
+            vehicle (SkodaElectricVehicle): The Skoda electric vehicle object.
+
+        Raises:
+            APIError: If the VIN is missing or if the carCapturedTimestamp is missing in the response data.
+            ValueError: If the vehicle has no charging object.
+        """
+        vin = vehicle.vin.value
+        if vin is None:
+            raise APIError('VIN is missing')
+        if vehicle.charging is None:
+            raise ValueError('Vehicle has no charging object')
+        url = f'https://mysmob.api.connect.skoda-auto.cz/api/v1/charging/{vin}'
+        data: Dict[str, Any] | None = self._fetch_data(url, session=self.session)
+        if data is not None:
+            if 'carCapturedTimestamp' in data and data['carCapturedTimestamp'] is not None:
+                captured_at: datetime = robust_time_parse(data['carCapturedTimestamp'])
+            else:
+                raise APIError('Could not fetch charging, carCapturedTimestamp missing')
+            if 'status' in data and data['status'] is not None:
+                if 'chargingRateInKilometersPerHour' in data['status'] and data['status']['chargingRateInKilometersPerHour'] is not None:
+                    # pylint: disable-next=protected-access
+                    vehicle.charging.rate._set_value(value=data['status']['chargingRateInKilometersPerHour'], measured=captured_at, unit=Speed.KMH)
+                else:
+                    vehicle.charging.rate._set_value(None, measured=captured_at, unit=Speed.KMH)  # pylint: disable=protected-access
+                if 'chargePowerInKw' in data['status'] and data['status']['chargePowerInKw'] is not None:
+                    # pylint: disable-next=protected-access
+                    vehicle.charging.power._set_value(value=data['status']['chargePowerInKw'], measured=captured_at, unit=Power.KW)
+                else:
+                    vehicle.charging.power._set_value(None, measured=captured_at, unit=Power.KW)  # pylint: disable=protected-access
+                if 'remainingTimeToFullyChargedInMinutes' in data['status'] and data['status']['remainingTimeToFullyChargedInMinutes'] is not None:
+                    remaining_duration: timedelta = timedelta(minutes=data['status']['remainingTimeToFullyChargedInMinutes'])
+                    # pylint: disable-next=protected-access
+                    vehicle.charging.remaining_duration._set_value(value=remaining_duration, measured=captured_at)
+                else:
+                    vehicle.charging.remaining_duration._set_value(None, measured=captured_at)  # pylint: disable=protected-access
+                log_extra_keys(LOG_API, 'status', data['status'],  {'chargingRateInKilometersPerHour',
+                                                                    'chargePowerInKw',
+                                                                    'remainingTimeToFullyChargedInMinutes'})
+            log_extra_keys(LOG_API, 'charging data', data,  {'carCapturedTimestamp', 'status'})
+        return vehicle
+
+    def fetch_vehicle_status(self, vehicle: SkodaVehicle) -> SkodaVehicle:
         """
         Fetches the status of a vehicle from the Skoda API.
 
@@ -579,6 +627,7 @@ class Connector(BaseConnector):
                     vehicle.lights.lights = {}
                 log_extra_keys(LOG_API, 'lights', vehicle_status_data['lights'], {'overallStatus', 'lightsStatus'})
             log_extra_keys(LOG_API, 'vehicles', vehicle_status_data,  {'capturedAt', 'mileageInKm', 'status', 'doors', 'windows', 'lights'})
+        return vehicle
 
     def _record_elapsed(self, elapsed: timedelta) -> None:
         """

{carconnectivity_connector_skoda-0.1a5 → carconnectivity_connector_skoda-0.1a7}/src/carconnectivity_connectors/skoda/mqtt_client.py

@@ -2,24 +2,31 @@
 from __future__ import annotations
 from typing import TYPE_CHECKING
 
+import re
 import logging
 import uuid
 import ssl
+import json
+from datetime import timedelta
 
 from paho.mqtt.client import Client
 from paho.mqtt.enums import MQTTProtocolVersion, CallbackAPIVersion, MQTTErrorCode
 
 from carconnectivity.observable import Observable
-from carconnectivity.vehicle import GenericVehicle
+from carconnectivity.vehicle import GenericVehicle, ElectricVehicle
+from carconnectivity.drive import ElectricDrive
+from carconnectivity.util import robust_time_parse, log_extra_keys
 
 
 if TYPE_CHECKING:
-    from typing import Set
+    from typing import Set, Dict, Any, Optional
+    from datetime import datetime
 
     from carconnectivity_connectors.skoda.connector import Connector
 
 
 LOG: logging.Logger = logging.getLogger("carconnectivity.connectors.skoda.mqtt")
+LOG_API: logging.Logger = logging.getLogger("carconnectivity.connectors.skoda-api-debug")
 
 
 class SkodaMQTTClient(Client):  # pylint: disable=too-many-instance-attributes
@@ -362,10 +369,14 @@ class SkodaMQTTClient(Client):  # pylint: disable=too-many-instance-attributes
         self._skoda_connector.connected._set_value(value=False)  # pylint: disable=protected-access
         self._skoda_connector.car_connectivity.garage.remove_observer(observer=self._on_carconnectivity_vehicle_enabled)
 
+        self.subscribed_topics.clear()
+
         if reason_code == 0:
             LOG.info('Client successfully disconnected')
         elif reason_code == 4:
             LOG.info('Client successfully disconnected: %s', userdata)
+        elif reason_code == 128:
+            LOG.info('Client disconnected: Needs new access token, trying to reconnect')
         elif reason_code == 137:
             LOG.error('Client disconnected: Server busy')
         elif reason_code == 139:
@@ -373,7 +384,7 @@ class SkodaMQTTClient(Client):  # pylint: disable=too-many-instance-attributes
         elif reason_code == 160:
             LOG.error('Client disconnected: Maximum connect time')
         else:
-            LOG.error('Client unexpectedly disconnected (%s), trying to reconnect', reason_code)
+            LOG.error('Client unexpectedly disconnected (%d: %s), trying to reconnect', reason_code, reason_code)
 
     def _on_subscribe_callback(self, mqttc, obj, mid, reason_codes, properties) -> None:
         """
@@ -418,5 +429,45 @@ class SkodaMQTTClient(Client):  # pylint: disable=too-many-instance-attributes
         """
         del mqttc  # unused
         del obj  # unused
-        error_message = f'I don\'t understand message {msg.topic}: {msg.payload}'
-        LOG.info(error_message)
+        if len(msg.payload) == 0:
+            LOG_API.debug('MQTT topic %s: ignoring empty message', msg.topic)
+            return
+
+        # service_events
+        match = re.match(r'^(?P<user_id>[0-9a-fA-F-]+)/(?P<vin>[A-Z0-9]+)/service-event/(?P<service_event>\w+)$', msg.topic)
+        if match:
+            user_id: str = match.group('user_id')
+            vin: str = match.group('vin')
+            service_event: str = match.group('service_event')
+            data: Dict[str, Any] = json.loads(msg.payload)
+            if data is not None:
+                if 'timestamp' in data and data['timestamp'] is not None:
+                    measured_at: datetime = robust_time_parse(data['timestamp'])
+                else:
+                    measured_at: datetime = datetime.now()
+                if service_event == 'charging':
+                    if 'name' in data and data['name'] == 'change-charge-mode' or data['name'] == 'change-soc':
+                        if 'data' in data and data['data'] is not None:
+                            vehicle: Optional[GenericVehicle] = self._skoda_connector.car_connectivity.garage.get_vehicle(vin)
+                            if isinstance(vehicle, ElectricVehicle):
+                                electric_drive: ElectricDrive = vehicle.get_electric_drive()
+                                if electric_drive is not None:
+                                    if 'soc' in data['data'] and data['data']['soc'] is not None:
+                                        electric_drive.level._set_value(measured=measured_at, value=data['data']['soc'])  # pylint: disable=protected-access
+                                    if 'chargedRange' in data['data'] and data['data']['chargedRange'] is not None:
+                                        # pylint: disable-next=protected-access
+                                        electric_drive.range._set_value(measured=measured_at, value=data['data']['chargedRange'])
+                                if 'timeToFinish' in data['data'] and data['data']['timeToFinish'] is not None \
+                                        and vehicle.charging is not None:
+                                    remaining_duration: timedelta = timedelta(minutes=data['data']['timeToFinish'])
+                                    # pylint: disable-next=protected-access
+                                    vehicle.charging.remaining_duration._set_value(measured=measured_at, value=remaining_duration)
+                                log_extra_keys(LOG_API, 'data', data['data'],  {'vin', 'userId', 'soc', 'chargedRange', 'timeToFinish'})
+                                LOG.debug('Received %s event for vehicle %s from user %s', data['name'], vin, user_id)
+                                return
+                    LOG_API.info('Received event name %s service event %s for vehicle %s from user %s: %s', data['name'],
+                                 service_event, vin, user_id, msg.payload)
+                    return
+            LOG_API.info('Received unknown service event %s for vehicle %s from user %s: %s', service_event, vin, user_id, msg.payload)
+            return
+        LOG_API.info('I don\'t understand message %s: %s', msg.topic, msg.payload)