pycupra 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

pycupra/__version__.py

@@ -3,4 +3,4 @@ pycupra - A Python 3 library for interacting with the My Cupra/My Seat portal.
 
 For more details and documentation, visit the github page at https://github.com/WulfgarW/pycupra
 """
-__version__ = "0.1.6"
+__version__ = "0.1.8"

pycupra/connection.py

@@ -109,13 +109,14 @@ TIMEOUT = timedelta(seconds=90)
 class Connection:
     """ Connection to Connect services """
   # Init connection class
-    def __init__(self, session, brand='cupra', username='', password='', fulldebug=False, nightlyUpdateReduction=False, anonymise=True, **optional):
+    def __init__(self, session, brand='cupra', username='', password='', fulldebug=False, nightlyUpdateReduction=False, anonymise=True, tripStatisticsStartYear=None, **optional):
         """ Initialize """
         self._session = session
         self._lock = asyncio.Lock()
         self._session_fulldebug = fulldebug
         self._session_nightlyUpdateReduction = nightlyUpdateReduction
         self._session_anonymise = anonymise
+        self._session_tripStatisticsStartYear = tripStatisticsStartYear
         self._session_headers = HEADERS_SESSION.get(brand).copy()
         self._session_base = BASE_SESSION
         self._session_auth_headers = HEADERS_AUTH.copy()
@@ -151,6 +152,7 @@ class Connection:
         self.addToAnonymisationKeys('family_name')
         self.addToAnonymisationKeys('birthdate')
         self.addToAnonymisationKeys('vin')
+        self._error401 = False
 
 
     def _clear_cookies(self):
@@ -596,22 +598,31 @@ class Connection:
                 'request_info': error.request_info
             }
             if error.status == 401:
-                _LOGGER.warning('Received "Unauthorized" while fetching data.\nThis can occur if tokens expired or refresh service is unavailable.')
+                _LOGGER.warning('Received "Unauthorized" while fetching data. This can occur if tokens expired or refresh service is unavailable.')
+                if self._error401 != True:
+                    self._error401 = True
+                    rc=await self.refresh_token(self._session_auth_brand)
+                    if rc:
+                        _LOGGER.info('Successfully refreshed tokens after error 401.')
+                        self._error401 = False
+                        #return True
+                    else:
+                        _LOGGER.info('Refresh of tokens after error 401 not successful.')
             elif error.status == 400:
-                _LOGGER.error('Received "Bad Request" from server.\nThe request might be malformed or not implemented correctly for this vehicle.')
+                _LOGGER.error('Received "Bad Request" from server. The request might be malformed or not implemented correctly for this vehicle.')
             elif error.status == 412:
-                _LOGGER.debug('Received "Pre-condition failed".\nService might be temporarily unavailable.')
+                _LOGGER.debug('Received "Pre-condition failed". Service might be temporarily unavailable.')
             elif error.status == 500:
-                _LOGGER.info('Received "Internal server error".\nThe service is temporarily unavailable.')
+                _LOGGER.info('Received "Internal server error". The service is temporarily unavailable.')
             elif error.status == 502:
-                _LOGGER.info('Received "Bad gateway".\nEither the endpoint is temporarily unavailable or not supported for this vehicle.')
+                _LOGGER.info('Received "Bad gateway". Either the endpoint is temporarily unavailable or not supported for this vehicle.')
             elif 400 <= error.status <= 499:
                 _LOGGER.error('Received unhandled error indicating client-side problem.\nRestart or try again later.')
             elif 500 <= error.status <= 599:
                 _LOGGER.error('Received unhandled error indicating server-side problem.\nThe service might be temporarily unavailable.')
             else:
                 _LOGGER.error('Received unhandled error while requesting API endpoint.')
-            _LOGGER.debug(f'HTTP request information: {data}')
+            _LOGGER.debug(self.anonymise(f'HTTP request information: {data}'))
             return data
         except Exception as e:
             _LOGGER.debug(f'Got non HTTP related error: {e}')
@@ -626,7 +637,12 @@ class Connection:
     async def _request(self, method, url, **kwargs):
         """Perform a HTTP query"""
         if self._session_fulldebug:
-            _LOGGER.debug(self.anonymise(f'HTTP {method} "{url}"'))
+            argsString =''
+            if len(kwargs)>0:
+                argsString = 'with '
+                for k, val in kwargs.items():
+                    argsString = argsString + f"{k}=\'{val}\' " 
+            _LOGGER.debug(self.anonymise(f'HTTP {method} "{url}" {argsString}'))
         try:
             if datetime.now(tz=None).date() != self._sessionRequestTimestamp.date():
                 # A new day has begun. Store _sessionRequestCounter in history and reset timestamp and counter
@@ -691,6 +707,9 @@ class Connection:
             if self._session_fulldebug:
                 if 'image/png'  in response.headers.get('Content-Type', ''):
                     _LOGGER.debug(self.anonymise(f'Request for "{url}" returned with status code [{response.status}]. Not showing response for Content-Type image/png.'))
+                elif method==METH_PUT or method==METH_DELETE:
+                    # deepcopy() of res can produce errors, if res is the API response on PUT or DELETE
+                    _LOGGER.debug(f'Request for "{self.anonymise(url)}" returned with status code [{response.status}]. Not showing response for http {method}')
                 else:
                     _LOGGER.debug(self.anonymise(f'Request for "{url}" returned with status code [{response.status}], response: {self.anonymise(deepcopy(res))}'))
             else:
@@ -704,7 +723,7 @@ class Connection:
             _LOGGER.debug(self.anonymise(f'Data call returned: {response}'))
             return response
         except aiohttp.client_exceptions.ClientResponseError as error:
-            _LOGGER.debug(f'Request failed. Data: {data}, HTTP request headers: {self._session_headers}')
+            _LOGGER.debug(self.anonymise(f'Request failed. Data: {data}, HTTP request headers: {self._session_headers}'))
             if error.status == 401:
                 _LOGGER.error('Unauthorized')
             elif error.status == 400:
@@ -1070,6 +1089,12 @@ class Connection:
     async def getTripStatistics(self, vin, baseurl, supportsCyclicTrips):
         """Get short term and cyclic trip statistics."""
         await self.set_token(self._session_auth_brand)
+        if self._session_tripStatisticsStartYear==None:
+            # If connection was not initialised with parameter tripStatisticsStartYear, then the value of the last year is used
+            # (This keeps the statistics shorter in Home Assistant)
+            startYear = datetime.now().year - 1
+        else:
+            startYear = self._session_tripStatisticsStartYear
         try:
             data={'tripstatistics': {}}
             if supportsCyclicTrips:
@@ -1625,7 +1650,7 @@ class Connection:
             if expires > now:
                 return expires
             else:
-                _LOGGER.debug(f'Token expired at {expires.strftime("%Y-%m-%d %H:%M:%S")})')
+                _LOGGER.debug(f'Token expired at {expires.strftime("%Y-%m-%d %H:%M:%S")}')
                 return False
         except Exception as e:
             _LOGGER.info(f'Token validation failed, {e}')

pycupra/const.py

@@ -138,7 +138,7 @@ API_DEPARTURE_TIMERS = '{baseurl}/v1/vehicles/{vin}/departure-timers'
 API_DEPARTURE_PROFILES = '{baseurl}/v1/vehicles/{vin}/departure/profiles'                             # Departure profiles
 API_POSITION = '{baseurl}/v1/vehicles/{vin}/parkingposition'                                         # Position data
 API_POS_TO_ADDRESS= 'https://maps.googleapis.com/maps/api/directions/json?origin={lat},{lon}&destination={lat},{lon}&traffic_model=best_guess&departure_time=now&language=de&key={apiKeyForGoogle}&mode=driving'
-API_TRIP = '{baseurl}/v1/vehicles/{vin}/driving-data/{dataType}?from=1970-01-01T00:00:00Z&to=2099-12-31T09:59:01Z' # Trip statistics (whole history) SHORT/LONG/CYCLIC (WEEK only with from)
+API_TRIP = '{baseurl}/v1/vehicles/{vin}/driving-data/{dataType}?from={startYear}-07-01T00:00:00Z&to=2099-12-31T09:59:01Z' # Trip statistics (whole history) SHORT/LONG/CYCLIC (WEEK only with from)
 API_MILEAGE = '{baseurl}/v1/vehicles/{vin}/mileage'                                                  # Total km etc
 API_MAINTENANCE = '{baseurl}/v1/vehicles/{vin}/maintenance'                                          # Inspection information
 API_MEASUREMENTS = '{baseurl}/v1/vehicles/{vin}/measurements/engines'                                # ???
@@ -192,3 +192,4 @@ FIREBASE_STATUS_NOT_INITIALISED= 0
 FIREBASE_STATUS_ACTIVATED= 1
 FIREBASE_STATUS_NOT_WANTED= -2
 FIREBASE_STATUS_ACTIVATION_FAILED= -1
+FIREBASE_STATUS_ACTIVATION_STOPPED= -3

pycupra/dashboard.py

@@ -755,6 +755,18 @@ class Warnings(Sensor):
     def assumed_state(self):
         return False
 
+    @property
+    def attributes(self):
+        attrs = {'warnings': 'No warnings'}
+        if self.vehicle.attrs.get('warninglights', {}).get('statuses',[]):
+            warningTextList = []
+            for elem in self.vehicle.attrs['warninglights']['statuses']:
+                if isinstance(elem, dict):
+                    if elem.get('text',''):
+                        warningTextList.append(elem.get('text',''))
+            attrs['warnings'] = warningTextList
+        return attrs
+
 class DepartureTimer1(Switch):
     def __init__(self):
         super().__init__(attr="departure1", name="Departure timer 1", icon="mdi:radiator")
@@ -990,6 +1002,32 @@ class ChargingState(BinarySensor):
                 attr['mode']=mode
         return attr
 
+class AreaAlarm(BinarySensor):
+    def __init__(self):
+        super().__init__(attr="area_alarm", name="Area alarm", icon="mdi:alarm-light", device_class='safety')
+
+    @property
+    def state(self):
+        return self.vehicle.area_alarm
+
+    @property
+    def assumed_state(self):
+        return False
+
+    @property
+    def attributes(self):
+        attr = {}
+        type = self.vehicle.attrs.get('areaAlarm', {}).get('type', '')
+        zones = self.vehicle.attrs.get('areaAlarm', {}).get('zones', [])
+        timestamp = self.vehicle.attrs.get('areaAlarm', {}).get('timestamp', 0)
+        if type != '':
+            attr['type']=type
+            if len(zones) > 0:
+                attr['zone']=zones[0]
+            if timestamp != 0:
+                attr['timestamp']=timestamp
+        return attr
+
 def create_instruments():
     return [
         Position(),
@@ -1018,6 +1056,7 @@ def create_instruments():
         DepartureProfile2(),
         DepartureProfile3(),
         ChargingState(),
+        AreaAlarm(),
         Sensor(
             attr="distance",
             name="Odometer",

pycupra/firebase_messaging/fcmpushclient.py

@@ -92,10 +92,10 @@ class FcmPushClientConfig:  # pylint:disable=too-many-instance-attributes
     """Class to provide configuration to
     :class:`firebase_messaging.FcmPushClientConfig`.FcmPushClient."""
 
-    server_heartbeat_interval: int | None = 20 # original value was 10
+    server_heartbeat_interval: int | None = 30 # original value was 10
     """Time in seconds to request the server to send heartbeats"""
 
-    client_heartbeat_interval: int | None = 30 # original value was 20
+    client_heartbeat_interval: int | None = 40 # original value was 20
     """Time in seconds to send heartbeats to the server"""
 
     send_selective_acknowledgements: bool = True
@@ -218,6 +218,7 @@ class FcmPushClient:  # pylint:disable=too-many-instance-attributes
             or (self.stopping_lock and self.stopping_lock.locked())
             or not self.do_listen
         ):
+            _logger.debug(f"In _reset. reset_lock={self.reset_lock}, reset_lock.locked={self.reset_lock.locked()}, stopping_lock={self.stopping_lock}, stopping_lock.locked={self.stopping_lock.locked()}, do_listen={self.do_listen}")
             return
 
         async with self.reset_lock:  # type: ignore[union-attr]
@@ -599,10 +600,21 @@ class FcmPushClient:  # pylint:disable=too-many-instance-attributes
             return
 
         if isinstance(msg, DataMessageStanza):
-            await self._handle_data_message(msg)
-            self.persistent_ids.append(msg.persistent_id)
+            #await self._handle_data_message(msg)
+            #self.persistent_ids.append(msg.persistent_id)
+            #if self.config.send_selective_acknowledgements:
+            #    await self._send_selective_ack(msg.persistent_id)
             if self.config.send_selective_acknowledgements:
-                await self._send_selective_ack(msg.persistent_id)
+                # As handle_data_message with the callback of onNotification can take some time, send_selective_ack is called in parallel
+                await asyncio.gather(
+                    self._handle_data_message(msg),
+                    self._send_selective_ack(msg.persistent_id),
+                    return_exceptions=True
+                )
+                self.persistent_ids.append(msg.persistent_id),
+            else:
+                await self._handle_data_message(msg)
+                self.persistent_ids.append(msg.persistent_id)
         elif isinstance(msg, HeartbeatPing):
             await self._handle_ping(msg)
         elif isinstance(msg, HeartbeatAck):
@@ -714,7 +726,10 @@ class FcmPushClient:  # pylint:disable=too-many-instance-attributes
                     else:
                         _logger.exception("Unexpected exception during read\n")
                         if self._try_increment_error_count(ErrorType.CONNECTION):
+                            _logger.debug("Calling reset()\n")
                             await self._reset()
+                        else:
+                            _logger.debug("Not calling reset()\n")
         except Exception as ex:
             _logger.error(
                 "Unknown error: %s, shutting down FcmPushClient.\n%s",
@@ -794,3 +809,4 @@ class FcmPushClient:  # pylint:disable=too-many-instance-attributes
         dms.persistent_id = persistent_id
 
         # Not supported yet
+

pycupra/vehicle.py

@@ -4,6 +4,7 @@
 import re
 import logging
 import asyncio
+import json
 
 from copy import deepcopy
 from datetime import datetime, timedelta, timezone
@@ -24,6 +25,7 @@ from .const import (
     FIREBASE_STATUS_NOT_INITIALISED,
     FIREBASE_STATUS_ACTIVATED,
     FIREBASE_STATUS_ACTIVATION_FAILED,
+    FIREBASE_STATUS_ACTIVATION_STOPPED,
     FIREBASE_STATUS_NOT_WANTED,
 )
 
@@ -71,7 +73,6 @@ class Vehicle:
         self._relevantCapabilties = {
             'measurements': {'active': False, 'reason': 'not supported', },
             'climatisation': {'active': False, 'reason': 'not supported'},
-            #'parkingInformation': {'active': False, 'reason': 'not supported'},
             'tripStatistics': {'active': False, 'reason': 'not supported', 'supportsCyclicTrips': False},
             'vehicleHealthInspection': {'active': False, 'reason': 'not supported'},
             'vehicleHealthWarnings': {'active': False, 'reason': 'not supported'},
@@ -94,6 +95,7 @@ class Vehicle:
         self._last_get_charger = datetime.now(tz=None) - timedelta(seconds=600)
         self._last_get_climater = datetime.now(tz=None) - timedelta(seconds=600)
         self._last_get_mileage = datetime.now(tz=None) - timedelta(seconds=600)
+        self._last_get_position = datetime.now(tz=None) - timedelta(seconds=600)
 
 
  #### API get and set functions ####
@@ -130,8 +132,7 @@ class Vehicle:
                 self._relevantCapabilties[id].update(data)
                 
 
-        #await self.get_trip_statistic() # in full update
-        
+       
         # Get URLs for model image
         self._modelimages = await self.get_modelimageurl()
 
@@ -147,12 +148,22 @@ class Vehicle:
             hourago = datetime.now() - timedelta(hours = 2)
             if self._discovered < hourago:
                 await self.discover()
-                #_LOGGER.debug('Achtung! self.discover() auskommentiert')
 
         # Fetch all data if car is not deactivated
         if not self.deactivated:
             try:
+                if self.attrs.get('areaAlarm', {}) !={}:
+                    # Delete an area alarm if it is older than 900 seconds
+                    alarmTimestamp = self.attrs.get('areaAlarm', {}).get('timestamp', 0)
+                    if alarmTimestamp < datetime.now(tz=None) - timedelta(seconds= 900):
+                        self.attrs.pop("areaAlarm")
+
                 if self.firebaseStatus == FIREBASE_STATUS_ACTIVATED:
+                    # Check, if fcmpushclient still started
+                    if not self.firebase._pushClient.is_started():
+                        _LOGGER.warning(f'firebaseStatus={self.firebaseStatus}, but state of push client is not started. Changing firebaseStatus to {FIREBASE_STATUS_ACTIVATION_STOPPED}')
+                        self.firebaseStatus = FIREBASE_STATUS_ACTIVATION_STOPPED
+
                     fullUpdateExpired = datetime.now(tz=None) - timedelta(seconds= 1700)
                     oldMileage = self.distance
                     if self._last_get_mileage < datetime.now(tz=None) - timedelta(seconds= 300):
@@ -164,6 +175,26 @@ class Vehicle:
                 else:
                     fullUpdateExpired = datetime.now(tz=None) - timedelta(seconds= 1100)
 
+                if self.firebaseStatus == FIREBASE_STATUS_ACTIVATION_STOPPED:
+                    # Trying to activate firebase connection again
+                    """_LOGGER.debug(f'As firebase status={self.firebaseStatus}, fcmpushclient.start() is called.')
+                    await self.firebase._pushClient.start()
+                    #await asyncio.sleep(5)
+                    if self.firebase._pushClient.is_started():
+                        self.firebaseStatus = FIREBASE_STATUS_ACTIVATED
+                        _LOGGER.debug(f'Successfully restarted push client. New firebase status={self.firebaseStatus}')
+                    else:
+                        _LOGGER.warning(f'Restart of push client failed. Firebase status={self.firebaseStatus}')"""
+                    newStatus = await self.stopFirebase()
+                    if newStatus != FIREBASE_STATUS_NOT_INITIALISED:
+                        _LOGGER.debug(f'stopFirebase() not successful.')
+                    newStatus = await self.initialiseFirebase(self._firebaseCredentialsFileName, self.updateCallback)
+                    if newStatus == FIREBASE_STATUS_ACTIVATED:
+                        _LOGGER.debug(f'Reinitialisation of firebase successful.New firebase status={self.firebaseStatus}.')
+                    else:
+                        self.firebaseStatus = FIREBASE_STATUS_ACTIVATION_STOPPED
+                        _LOGGER.warning(f'Reinitialisation of firebase failed. New firebase status={self.firebaseStatus}.')
+
                 if self._connection._session_nightlyUpdateReduction:
                     # nightlyUpdateReduction is activated
                     if datetime.now(tz=None).hour<5 or datetime.now(tz=None).hour>=22:
@@ -192,6 +223,7 @@ class Vehicle:
                 if self.firebaseStatus != FIREBASE_STATUS_ACTIVATED:
                     await self.get_mileage() 
 
+
                 await asyncio.gather(
                     #self.get_statusreport(),
                     self.get_charger(),
@@ -227,6 +259,10 @@ class Vehicle:
         data = await self._connection.getBasicCarData(self.vin, self._apibase)
         if data:
             self._states.update(data)
+            return True
+        else:
+            _LOGGER.debug('Could not fetch basic car data')
+            return False
 
     async def get_mileage(self):
         """Fetch basic car data."""
@@ -234,6 +270,10 @@ class Vehicle:
         if data:
             self._states.update(data)
             self._last_get_mileage = datetime.now(tz=None)
+            return True
+        else:
+            _LOGGER.debug('Could not fetch mileage data')
+            return False
 
     async def get_preheater(self):
         """Fetch pre-heater data if function is enabled."""
@@ -255,8 +295,10 @@ class Vehicle:
             if data:
                 self._states.update(data)
                 self._last_get_climater = datetime.now(tz=None)
+                return True
             else:
                 _LOGGER.debug('Could not fetch climater data')
+                return False
         #else:
         #    self._requests.pop('climatisation', None)
 
@@ -266,8 +308,10 @@ class Vehicle:
             data = await self._connection.getTripStatistics(self.vin, self._apibase, self._relevantCapabilties['tripStatistics'].get('supportsCyclicTrips', False))
             if data:
                 self._states.update(data)
+                return True
             else:
                 _LOGGER.debug('Could not fetch trip statistics')
+                return False
 
     async def get_position(self):
         """Fetch position data if function is enabled."""
@@ -284,24 +328,21 @@ class Vehicle:
                     except:
                         pass
                 self._states.update(data)
+                self._last_get_position = datetime.now(tz=None)
+                return True
             else:
                 _LOGGER.debug('Could not fetch any positional data')
+                return False
 
     async def get_vehicleHealthWarnings(self):
         if self._relevantCapabilties.get('vehicleHealthWarnings', {}).get('active', False):
             data = await self._connection.getVehicleHealthWarnings(self.vin, self._apibase)
             if data:
-                #warningsList = data.get('warninglights',{}).get('statuses',[])
-                #for i in range(len(warningsList)):
-                #    _LOGGER.debug(f'Element {i} in warninglights: {warningsList[i]}')
-                #    if isinstance(warningsList[i], dict):
-                #        if warningsList[i].get('icon',''):
-                #               #Value of icon is very long and can lead to problems
-                #            _LOGGER.debug(f'Substituting value of icon by \'DELETED\'')
-                #            data['warninglights']['statuses'][i]['icon']='DELETED'
                 self._states.update(data)
+                return True
             else:
                 _LOGGER.debug('Could not fetch vehicle health warnings')
+                return False
 
     async def get_statusreport(self):
         """Fetch status data if function is enabled."""
@@ -310,8 +351,10 @@ class Vehicle:
             if data:
                 self._states.update(data)
                 self._last_get_statusreport = datetime.now(tz=None)
+                return True
             else:
                 _LOGGER.debug('Could not fetch status report')
+                return False
 
     async def get_maintenance(self):
         """Fetch maintenance data if function is enabled."""
@@ -319,8 +362,10 @@ class Vehicle:
             data = await self._connection.getMaintenance(self.vin, self._apibase)
             if data:
                 self._states.update(data)
+                return True
             else:
                 _LOGGER.debug('Could not fetch status report')
+                return False
 
     async def get_charger(self):
         """Fetch charger data if function is enabled."""
@@ -329,8 +374,10 @@ class Vehicle:
             if data:
                 self._states.update(data)
                 self._last_get_charger = datetime.now(tz=None)
+                return True
             else:
                 _LOGGER.debug('Could not fetch charger data')
+                return False
 
     async def get_departure_timers(self):
         """Fetch timer data if function is enabled."""
@@ -339,8 +386,10 @@ class Vehicle:
             if data:
                 self._states.update(data)
                 self._last_get_departure_timers = datetime.now(tz=None)
+                return True
             else:
                 _LOGGER.debug('Could not fetch timers')
+                return False
 
     async def get_departure_profiles(self):
         """Fetch timer data if function is enabled."""
@@ -349,8 +398,10 @@ class Vehicle:
             if data:
                 self._states.update(data)
                 self._last_get_departure_profiles = datetime.now(tz=None)
+                return True
             else:
                 _LOGGER.debug('Could not fetch timers')
+                return False
 
     #async def wait_for_request(self, section, request, retryCount=36):
         """Update status of outstanding requests."""
@@ -983,7 +1034,7 @@ class Vehicle:
     async def set_climatisation_temp(self, temperature=20):
         """Set climatisation target temp."""
         if self.is_electric_climatisation_supported or self.is_auxiliary_climatisation_supported:
-            if 16 <= int(temperature) <= 30:
+            if 16 <= float(temperature) <= 30:
                 data = {
                     'climatisationWithoutExternalPower': self.climatisation_without_external_power, 
                     'targetTemperature':    temperature, 
@@ -1034,28 +1085,30 @@ class Vehicle:
         data = {}
         # Validate user input
         if mode.lower() not in ['electric', 'auxiliary', 'start', 'stop', 'on', 'off']:
+            _LOGGER.error(f"Invalid mode for 'set_climatisation': {mode}")
             raise SeatInvalidRequestException(f"Invalid mode for set_climatisation: {mode}")
         elif mode == 'auxiliary' and spin is None:
             raise SeatInvalidRequestException("Starting auxiliary heater requires provided S-PIN")
         if temp is not None:
-            if not isinstance(temp, float):
+            if not isinstance(temp, float) and not isinstance(temp, int):
+                _LOGGER.error(f"Invalid type for temp. type={type(temp)}")
                 raise SeatInvalidRequestException(f"Invalid type for temp")
             elif not 16 <= float(temp) <=30:
                 raise SeatInvalidRequestException(f"Invalid value for temp")
         else:
             temp = self.climatisation_target_temperature
-        if hvpower is not None:
-            if not isinstance(hvpower, bool):
-                raise SeatInvalidRequestException(f"Invalid type for hvpower")
+        #if hvpower is not None:
+        #    if not isinstance(hvpower, bool):
+        #        raise SeatInvalidRequestException(f"Invalid type for hvpower")
         if self.is_electric_climatisation_supported:
             if self._relevantCapabilties.get('climatisation', {}).get('active', False):
                 if mode in ['Start', 'start', 'Electric', 'electric', 'On', 'on']:
                     mode = 'start'
                 if mode in ['start', 'auxiliary']:
-                    if hvpower is not None:
-                        withoutHVPower = hvpower
-                    else:
-                        withoutHVPower = self.climatisation_without_external_power
+                    #if hvpower is not None:
+                    #    withoutHVPower = hvpower
+                    #else:
+                    #    withoutHVPower = self.climatisation_without_external_power
                     data = {
                             'targetTemperature': temp,
                             'targetTemperatureUnit': 'celsius',
@@ -1142,7 +1195,7 @@ class Vehicle:
             self._requests['climatisation'] = {'status': 'Exception'}
         raise SeatException('Climatisation action failed')
 
-   # Parking heater heating/ventilation (RS)
+    # Parking heater heating/ventilation (RS)
     async def set_pheater(self, mode, spin):
         """Set the mode for the parking heater."""
         if not self.is_pheater_heating_supported:
@@ -1185,7 +1238,7 @@ class Vehicle:
             self._requests['preheater'] = {'status': 'Exception'}
         raise SeatException('Pre-heater action failed')
 
-   # Lock 
+    # Lock 
     async def set_lock(self, action, spin):
         """Remote lock and unlock actions."""
         #if not self._services.get('rlu_v1', False):
@@ -1247,7 +1300,7 @@ class Vehicle:
             self._requests['lock'] = {'status': 'Exception'}
         raise SeatException('Lock action failed')
 
-   # Honk and flash (RHF)
+    # Honk and flash (RHF)
     async def set_honkandflash(self, action, lat=None, lng=None):
         """Turn on/off honk and flash."""
         if not self._relevantCapabilties.get('honkAndFlash', {}).get('active', False):
@@ -1304,7 +1357,7 @@ class Vehicle:
             self._requests['honkandflash'] = {'status': 'Exception'}
         raise SeatException('Honk and flash action failed')
 
-   # Refresh vehicle data (VSR)
+    # Refresh vehicle data (VSR)
     async def set_refresh(self):
         """Wake up vehicle and update status data."""
         if not self._relevantCapabilties.get('state', {}).get('active', False):
@@ -1340,7 +1393,7 @@ class Vehicle:
         raise SeatException('Data refresh failed')
 
  #### Vehicle class helpers ####
-  # Vehicle info
+    # Vehicle info
     @property
     def attrs(self):
         return self._states
@@ -1373,7 +1426,7 @@ class Vehicle:
 
 
  #### Information from vehicle states ####
-  # Car information
+    # Car information
     @property
     def nickname(self):
         return self._properties.get('vehicleNickname', '')
@@ -1462,7 +1515,7 @@ class Vehicle:
         if self._modelimages is not None:
             return True
 
-  # Lights
+    # Lights
     @property
     def parking_light(self):
         """Return true if parking light is on"""
@@ -1481,7 +1534,7 @@ class Vehicle:
             else:
                 return False
 
-  # Connection status
+    # Connection status
     @property
     def last_connected(self):
         """Return when vehicle was last connected to connect servers."""
@@ -1498,7 +1551,7 @@ class Vehicle:
         if 'updatedAt' in self.attrs.get('status', {}):
             return True
 
-  # Update status
+    # Update status
     @property
     def last_full_update(self):
         """Return when the last full update for the vehicle took place."""
@@ -1510,7 +1563,7 @@ class Vehicle:
         if hasattr(self,'_last_full_update'):
             return True
 
-  # Service information
+    # Service information
     @property
     def distance(self):
         """Return vehicle odometer."""
@@ -1598,7 +1651,7 @@ class Vehicle:
                         return True
         return False
 
-  # Charger related states for EV and PHEV
+    # Charger related states for EV and PHEV
     @property
     def charging(self):
         """Return battery level"""
@@ -1857,7 +1910,7 @@ class Vehicle:
         if self.attrs.get('charging', {}).get('info', {}).get('settings', {}).get('targetSoc', False):
             return True
 
-  # Vehicle location states
+    # Vehicle location states
     @property
     def position(self):
         """Return  position."""
@@ -1924,7 +1977,7 @@ class Vehicle:
         if 'parkingTimeUTC' in self.attrs.get('findCarResponse', {}):
             return True
 
-  # Vehicle fuel level and range
+    # Vehicle fuel level and range
     @property
     def primary_range(self):
         value = -1
@@ -2063,7 +2116,7 @@ class Vehicle:
                     return self.is_secondary_range_supported
         return False
 
-  # Climatisation settings
+    # Climatisation settings
     @property
     def climatisation_target_temperature(self):
         """Return the target temperature from climater."""
@@ -2137,7 +2190,7 @@ class Vehicle:
             else:
                 return False
 
-  # Climatisation, electric
+    # Climatisation, electric
     @property
     def electric_climatisation_attributes(self):
         """Return climatisation attributes."""
@@ -2236,14 +2289,7 @@ class Vehicle:
     @property
     def warnings(self):
         """Return warnings."""
-        if self.attrs.get('warninglights', {}).get('statuses',[]):
-            warningTextList = []
-            for elem in self.attrs['warninglights']['statuses']:
-                if isinstance(elem, dict):
-                    if elem.get('text',''):
-                        warningTextList.append(elem.get('text',''))
-            return warningTextList
-        return 'No warnings'
+        return len(self.attrs.get('warninglights', {}).get('statuses',[]))
 
     @property
     def is_warnings_supported(self):
@@ -2252,7 +2298,7 @@ class Vehicle:
             return True
         return False
 
-  # Parking heater, "legacy" auxiliary climatisation
+    # Parking heater, "legacy" auxiliary climatisation
     @property
     def pheater_duration(self):
         return self._climate_duration
@@ -2300,7 +2346,7 @@ class Vehicle:
         if self.attrs.get('heating', {}).get('climatisationStateReport', {}).get('climatisationState', False):
             return True
 
-  # Windows
+    # Windows
     @property
     def windows_closed(self):
         return (self.window_closed_left_front and self.window_closed_left_back and self.window_closed_right_front and self.window_closed_right_back)
@@ -2407,7 +2453,7 @@ class Vehicle:
             #    response = self.attrs.get('status')['windows'].get('sunRoof', '')
         return True if response != '' else False
 
-  # Locks
+    # Locks
     @property
     def door_locked(self):
         # LEFT FRONT
@@ -2450,7 +2496,7 @@ class Vehicle:
                     return True
         return False
 
-  # Doors, hood and trunk
+    # Doors, hood and trunk
     @property
     def hood_closed(self):
         """Return true if hood is closed"""
@@ -2535,7 +2581,7 @@ class Vehicle:
                 response = self.attrs.get('status')['trunk'].get('open', 0)
         return True if response != 0 else False
 
-  # Departure timers
+    # Departure timers
     @property
     def departure1(self):
         """Return timer status and attributes."""
@@ -2647,7 +2693,7 @@ class Vehicle:
             return True
         return False
 
-  # Departure profiles
+    # Departure profiles
     @property
     def departure_profile1(self):
         """Return profile status and attributes."""
@@ -2720,7 +2766,7 @@ class Vehicle:
             return True
         return False
 
-  # Trip data
+    # Trip data
     @property
     def trip_last_entry(self):
         return self.attrs.get('tripstatistics', {}).get('short', [{},{}])[-1]
@@ -2945,7 +2991,26 @@ class Vehicle:
         if response and type(response.get('totalElectricConsumption', None)) in (float, int):
             return True
 
-#   Status of set data requests
+    # Area alarm
+    @property
+    def area_alarm(self):
+        """Return True, if attribute areaAlarm is not {}"""
+        alarmPresent = self.attrs.get('areaAlarm', {})
+        if alarmPresent !={}:
+            # Delete an area alarm if it is older than 900 seconds
+            alarmTimestamp = self.attrs.get('areaAlarm', {}).get('timestamp', 0)
+            if alarmTimestamp < datetime.now(tz=None) - timedelta(seconds= 900):
+                self.attrs.pop("areaAlarm")
+                alarmPresent = {}
+        return False if alarmPresent == {} else True
+
+    @property
+    def is_area_alarm_supported(self):
+        """Return True, if vehicle supports area alarm (always True at the moment)"""
+        # Always True at the moment. Have to check, if the geofence capability is a necessary condition
+        return True
+
+    #  Status of set data requests
     @property
     def refresh_action_status(self):
         """Return latest status of data refresh request."""
@@ -3050,7 +3115,7 @@ class Vehicle:
         """Data update is supported."""
         return True
 
-   # Honk and flash
+    # Honk and flash
     @property
     def request_honkandflash(self):
         """State is always False"""
@@ -3073,7 +3138,7 @@ class Vehicle:
         if self._relevantCapabilties.get('honkAndFlash', {}).get('active', False):
             return True
 
-  # Requests data
+    # Requests data
     @property
     def request_in_progress(self):
         """Request in progress is always supported."""
@@ -3128,7 +3193,7 @@ class Vehicle:
         #if self.is_request_in_progress_supported:
         #    return True if self._requests.get('remaining', False) else False
 
- #### Helper functions ####
+    #### Helper functions ####
     def __str__(self):
         return self.vin
 
@@ -3147,7 +3212,7 @@ class Vehicle:
 
     async def stopFirebase(self):
         # Check if firebase is activated
-        if self.firebaseStatus!= FIREBASE_STATUS_ACTIVATED:
+        if self.firebaseStatus not in (FIREBASE_STATUS_ACTIVATED, FIREBASE_STATUS_ACTIVATION_STOPPED):
             _LOGGER.info(f'No need to stop firebase. Firebase status={self.firebaseStatus}')
             return self.firebaseStatus
         
@@ -3161,7 +3226,7 @@ class Vehicle:
             _LOGGER.warning('Stopping of firebase messaging failed.')
             return self.firebaseStatus
         
-        #await asyncio.sleep(5) # Wait to ignore the first notifications 
+        #await asyncio.sleep(5) 
         self.firebaseStatus = FIREBASE_STATUS_NOT_INITIALISED
         _LOGGER.info('Stopping of firebase messaging was successful.')
         return self.firebaseStatus
@@ -3226,17 +3291,25 @@ class Vehicle:
         _LOGGER.debug(f'Received push notification: notification id={notification}, type={obj.get('data',{}).get('type','')}, requestId={obj.get('data',{}).get('requestId','[None]')}')
         _LOGGER.debug(f'   data_message={data_message}, payload={obj.get('data',{}).get('payload','[None]')}')
 
-        #temporary output of notifications in a file
-        if self.updateCallback == self.update:
-            self.storeFirebaseNotifications(obj, notification, data_message)
+        #temporary output of notifications in a file, will be removed in the next release
+        #if self.updateCallback == self.update:
+        #    self.storeFirebaseNotifications(obj, notification, data_message)
 
         if self.firebaseStatus != FIREBASE_STATUS_ACTIVATED:
-            _LOGGER.info(f'While firebase is not fully activated, received notifications are just acknowledged.')
-            # As long as the firebase status is not set to activated, ignore the notifications
-            return False 
+            if self.firebaseStatus != FIREBASE_STATUS_ACTIVATION_STOPPED:
+                _LOGGER.info(f'While firebase is not fully activated, received notifications are just acknowledged.')
+                # As long as the firebase status is not set to activated, ignore the notifications
+                return False 
+            else:
+                # It seems that the firebase connection still works although fcmpushclient.is_started() returned False some time ago
+                _LOGGER.info(f'Firebase status={self.firebaseStatus}, but PyCupra still receives push notifications.')
+                self.firebaseStatus = FIREBASE_STATUS_ACTIVATED
+                _LOGGER.info(f'Set firebase status back to {self.firebaseStatus}.')
+
  
         type = obj.get('data',{}).get('type','')
         requestId = obj.get('data',{}).get('requestId','')
+        payload = obj.get('data',{}).get('payload','')
         openRequest = -1
         if requestId != '':
             _LOGGER.info(f'Received notification of type \'{type}\', request id={requestId} ')
@@ -3307,6 +3380,28 @@ class Vehicle:
                     await self.updateCallback(2)
             else:
                 _LOGGER.debug(f'It is now {datetime.now(tz=None)}. Last get_climater was at {self._last_get_climater}. So no need to update.')
+        elif type in ('vehicle-area-alarm-vehicle-exits-zone-triggered', 'vehicle-area-alarm-vehicle-enters-zone-triggered'):
+            #if self._last_get_position < datetime.now(tz=None) - timedelta(seconds= 30):
+            #    # Update position data only if the last one is older than timedelta
+            #    await self.get_position()
+            #else:
+            #    _LOGGER.debug(f'It is now {datetime.now(tz=None)}. Last get_position was at {self._last_get_position}. So no need to update.')
+            if payload != '':
+                payloadDict = json.loads(payload) # Convert json string to dict
+                #_LOGGER.debug(f'payloadDict is dict: {isinstance(payloadDict, dict)}')
+                zones = payloadDict.get('description',{}).get('values',[])
+            else:
+                _LOGGER.warning(f'Missing information about areas. Payload ={payload}')
+                zones = []
+            areaAlarm = {'areaAlarm' : {
+                'type': 'vehicle-exits-zone' if type=='vehicle-area-alarm-vehicle-exits-zone-triggered' else 'vehicle-enters-zone',
+                'timestamp': datetime.now(tz=None),
+                'zones': zones
+                }
+            }
+            self._states.update(areaAlarm)
+            if self.updateCallback:
+                await self.updateCallback(2)
         elif type == 'vehicle-wakeup-succeeded':
             if self._requests.get('refresh', {}).get('id', None):
                 openRequest= self._requests.get('refresh', {}).get('id', None)
@@ -3317,22 +3412,23 @@ class Vehicle:
                 # Do full update only if the last one is older than timedelta or if the notification belongs to an open request initiated by PyCupra
                 if self.updateCallback:
                     await self.updateCallback(1)
+        elif type in ('vehicle-area-alert-added', 'vehicle-area-alert-updated'):
+            _LOGGER.info(f'   Intentionally ignoring a notification of type \'{type}\')')
         else:
             _LOGGER.warning(f'   Don\'t know what to do with a notification of type \'{type}\')')
 
-            
-
 
-    def storeFirebaseNotifications(self, obj, notification, data_message):
-        _LOGGER.debug(f'In storeFirebaseNotifications. notification={notification}')
-        fName = self._firebaseCredentialsFileName
-        fName = fName.replace('pycupra_firebase_credentials.json', 'pycupra_firebasenotifications.txt')
+    #temporary output of notifications in a file, will be removed in the next release
+    #def storeFirebaseNotifications(self, obj, notification, data_message):
+    #    _LOGGER.debug(f'In storeFirebaseNotifications. notification={notification}')
+    #    fName = self._firebaseCredentialsFileName
+    #    fName = fName.replace('pycupra_firebase_credentials.json', 'pycupra_firebasenotifications.txt')
 
-        with open(fName, "a") as ofile:
-            ofile.write(f'{datetime.now()}\n')
-            ofile.write(f'   notification id={notification}, data_message={data_message}\n')
-            ofile.write(f'   obj={obj}\n')
-            ofile.write("----------------------------------------------------------------\n")
+    #    with open(fName, "a") as ofile:
+    #        ofile.write(f'{datetime.now()}\n')
+    #        ofile.write(f'   notification id={notification}, data_message={data_message}\n')
+    #        ofile.write(f'   obj={obj}\n')
+    #        ofile.write("----------------------------------------------------------------\n")
 
 
 

{pycupra-0.1.6.dist-info → pycupra-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycupra
-Version: 0.1.6
+Version: 0.1.8
 Summary: A library to read and send vehicle data via Cupra/Seat portal using the same API calls as the MyCupra/MySeat mobile app.
 Home-page: https://github.com/WulfgarW/pycupra
 Author: WulfgarW

{pycupra-0.1.6.dist-info → pycupra-0.1.8.dist-info}/RECORD

@@ -1,25 +1,25 @@
 pycupra/__init__.py,sha256=p0880jPkLqOErX3u3qaLboBLOsEHFpe44axApdaGeqI,231
-pycupra/__version__.py,sha256=orABFX8h4AFdsffPt4uVXqXeC0Wz3ZJOeNAzyeNw7O8,207
-pycupra/connection.py,sha256=cZIqsjEwA1rTkhVyjowrTdbWnviOXFSso-WR8FnSrmg,90610
-pycupra/const.py,sha256=cJJ9xrof6HZ7ZE7nXnB6tU4qMbSadlN8mgs43Igy7Mo,10591
-pycupra/dashboard.py,sha256=RlJPdTvJV7Urog5gCz_4pYWNd5_ApQIVJUCwJIi_7L8,43822
+pycupra/__version__.py,sha256=ahbRianoeRb9v2bqw7g3dKIyoW7jt_rvwY0nas5Bn0c,207
+pycupra/connection.py,sha256=5bUxSUC03O-4kceZn8fPWKyOaxOq13JVMjY-_UqrOwo,92187
+pycupra/const.py,sha256=hCtDfI0gRewmVjXOQRrC4pUphOxGwCA3_Plfp2NwFXU,10637
+pycupra/dashboard.py,sha256=bEmIRvxX08WNa0rftpQ6JrD0GW5FeVTDu5yQr0IUjMM,45178
 pycupra/exceptions.py,sha256=Nq_F79GP8wjHf5lpvPy9TbSIrRHAJrFMo0T1N9TcgSQ,2917
 pycupra/firebase.py,sha256=tuN_W3OX3h3-yfdprWzmCn6z_T-BMx-OpL7Z6hOA8Lc,3451
 pycupra/utilities.py,sha256=6sDxWP13-XtxmqhuBJBGdVbkj48BQ9AxFMrBPxH0J7g,2679
-pycupra/vehicle.py,sha256=stxeyn2vd2j2yQ3dWEmT9XX1aZNZ7FdYvxbIraF6M0o,157175
+pycupra/vehicle.py,sha256=1sKJJ4xuBIrx6ZWnH50-b7bzjmqyBgRiETOSzDiNNN8,162609
 pycupra/firebase_messaging/__init__.py,sha256=oerLHWvEf4qRqu3GxSX6SLY_OYI430ydAiAhKtzyMEM,666
 pycupra/firebase_messaging/android_checkin_pb2.py,sha256=-U1oGroFt3KRuGDieae3iTcux6mAfx1TFkE1Q35ul2E,2849
 pycupra/firebase_messaging/android_checkin_pb2.pyi,sha256=7KL-zQIz2Zz7uftcLkv57Podzu-yk6trn50FN4X4A8E,9379
 pycupra/firebase_messaging/checkin_pb2.py,sha256=lFzCIAkYz9NFUpRbVuW-2kM_EaYKVWHeifHS1PV2eHQ,2795
 pycupra/firebase_messaging/checkin_pb2.pyi,sha256=mHOqbedt5jZDI20jcyFrTMSnQ0f_tq4zkIlHiaSC3xI,14626
 pycupra/firebase_messaging/const.py,sha256=XMy8kJ37uBSkTpVpdLeSjxk5UIPuvDuo-rxYdgmo2G8,1191
-pycupra/firebase_messaging/fcmpushclient.py,sha256=nO3WJUMQ7G2M9CE3aUlEdD75tFbC04gDsd4UsksQqKM,29543
+pycupra/firebase_messaging/fcmpushclient.py,sha256=5kAp6rnl9EJqVPn9OfHFKUfFDRWA9LAVbfiL-pLRSqo,30550
 pycupra/firebase_messaging/fcmregister.py,sha256=yZngC-0ZfTygtjfdzg03OW_3xk2n_uSQQ3Lrash5Y_E,18091
 pycupra/firebase_messaging/mcs_pb2.py,sha256=nwXY7IDgLYPxgpSGs6wyTSyYDdomQsyGqH8R8EgODLg,7733
 pycupra/firebase_messaging/mcs_pb2.pyi,sha256=HfIhInC3wRg8_caKwUm-V3knE2jTdEQvBy6uXgQ5rHY,33959
 pycupra/firebase_messaging/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pycupra-0.1.6.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pycupra-0.1.6.dist-info/METADATA,sha256=u9ZdIDY607S5-5APn3VwI1nJgvWHPngzptNHedmY_k4,3757
-pycupra-0.1.6.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pycupra-0.1.6.dist-info/top_level.txt,sha256=9Lbj_jG4JvpGwt6K3AwhWFc0XieDnuHFOP4x44wSXSQ,8
-pycupra-0.1.6.dist-info/RECORD,,
+pycupra-0.1.8.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pycupra-0.1.8.dist-info/METADATA,sha256=GC1Av2ilKrcM3hNfIoFPsBRKsSBjzlkIQrH8nmUzijY,3757
+pycupra-0.1.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pycupra-0.1.8.dist-info/top_level.txt,sha256=9Lbj_jG4JvpGwt6K3AwhWFc0XieDnuHFOP4x44wSXSQ,8
+pycupra-0.1.8.dist-info/RECORD,,