pycupra 0.1.7__py3-none-any.whl → 0.1.9__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.7"
+__version__ = "0.1.9"

pycupra/connection.py

@@ -98,6 +98,7 @@ from .const import (
     API_DESTINATION,
 
     PUBLIC_MODEL_IMAGES_SERVER,
+    FIREBASE_STATUS_NOT_INITIALISED,
 )
 
 version_info >= (3, 0) or exit('Python 3 required')
@@ -109,13 +110,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, tripStatisticsStartDate=None, **optional):
         """ Initialize """
         self._session = session
         self._lock = asyncio.Lock()
         self._session_fulldebug = fulldebug
         self._session_nightlyUpdateReduction = nightlyUpdateReduction
         self._session_anonymise = anonymise
+        self._session_tripStatisticsStartDate = tripStatisticsStartDate
         self._session_headers = HEADERS_SESSION.get(brand).copy()
         self._session_base = BASE_SESSION
         self._session_auth_headers = HEADERS_AUTH.copy()
@@ -560,8 +562,10 @@ class Connection:
         for v in self.vehicles:
             _LOGGER.debug(self.anonymise(f'Calling stopFirebase() for vehicle {v.vin}'))
             newStatus = await v.stopFirebase()
-            if newStatus != 0:
+            if newStatus != FIREBASE_STATUS_NOT_INITIALISED:
                 _LOGGER.debug(self.anonymise(f'stopFirebase() not successful for vehicle {v.vin}'))
+                # Although stopFirebase() was not successful, the firebase status is reset to FIREBASE_STATUS_NOT_INITIALISED to allow a new initialisation
+                v.firebaseStatus = FIREBASE_STATUS_NOT_INITIALISED
         await self.logout()
 
     async def logout(self):
@@ -636,7 +640,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
@@ -701,6 +710,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:
@@ -1080,6 +1092,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_tripStatisticsStartDate==None:
+            # If connection was not initialised with parameter tripStatisticsStartDate, then 360 day is used for the CYCLIC trips and 90 days for the SHORT trips
+            # (This keeps the statistics shorter in Home Assistant)
+            startDate = (datetime.now() - timedelta(days= 360)).strftime('%Y-%m-%d')
+        else:
+            startDate = self._session_tripStatisticsStartDate
         try:
             data={'tripstatistics': {}}
             if supportsCyclicTrips:
@@ -1094,6 +1112,10 @@ class Connection:
             else:
                 _LOGGER.info(f'Vehicle does not support cyclic trips.')
             dataType='SHORT'
+            if self._session_tripStatisticsStartDate==None:
+                # If connection was not initialised with parameter tripStatisticsStartDate, then 360 day is used for the CYCLIC trips and 90 days for the SHORT trips
+                # (This keeps the statistics shorter in Home Assistant)
+                startDate = (datetime.now() - timedelta(days= 90)).strftime('%Y-%m-%d')
             response = await self.get(eval(f"f'{API_TRIP}'"))
             if response.get('data', []):
                 data['tripstatistics']['short']= response.get('data', [])

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={startDate}T00: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'                                # ???

pycupra/dashboard.py

@@ -455,7 +455,7 @@ class RequestRefresh(Switch):
     async def turn_on(self):
         _LOGGER.debug('User has called RequestRefresh().')
         await self.vehicle.set_refresh()
-        await self.vehicle.update(updateType=1) #full update after set_refresh
+        #await self.vehicle.update(updateType=1) #full update after set_refresh
         if self.callback is not None:
             self.callback()
 
@@ -776,11 +776,12 @@ class DepartureTimer1(Switch):
 
     @property
     def state(self):
-        status = self.vehicle.departure1.get("enabled", "")
-        if status:
-            return True
-        else:
-            return False
+        if self.vehicle.departure1 != None:
+            status = self.vehicle.departure1.get("enabled", "")
+            if status:
+                return True
+        #else:
+        return False
 
     async def turn_on(self):
         await self.vehicle.set_timer_active(id=1, action="on")
@@ -808,11 +809,12 @@ class DepartureTimer2(Switch):
 
     @property
     def state(self):
-        status = self.vehicle.departure2.get("enabled", "")
-        if status:
-            return True
-        else:
-            return False
+        if self.vehicle.departure2 != None:
+            status = self.vehicle.departure2.get("enabled", "")
+            if status:
+                return True
+        #else:
+        return False
 
     async def turn_on(self):
         await self.vehicle.set_timer_active(id=2, action="on")
@@ -839,11 +841,12 @@ class DepartureTimer3(Switch):
 
     @property
     def state(self):
-        status = self.vehicle.departure3.get("enabled", "")
-        if status:
-            return True
-        else:
-            return False
+        if self.vehicle.departure3 != None:
+            status = self.vehicle.departure3.get("enabled", "")
+            if status:
+                return True
+        #else:
+        return False
 
     async def turn_on(self):
         await self.vehicle.set_timer_active(id=3, action="on")
@@ -1002,6 +1005,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=None)
+
+    @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(),
@@ -1030,6 +1059,7 @@ def create_instruments():
         DepartureProfile2(),
         DepartureProfile3(),
         ChargingState(),
+        AreaAlarm(),
         Sensor(
             attr="distance",
             name="Odometer",

pycupra/firebase.py

@@ -43,7 +43,7 @@ class Firebase():
             await asyncio.sleep(5)
             return self._pushClient.is_started()
         except Exception as e:
-            _LOGGER.error('Error in firebaseStart. Error: {e}')
+            _LOGGER.error(f'Error in firebaseStart. Error: {e}')
             return False
 
     async def firebaseStop(self): 
@@ -54,7 +54,7 @@ class Firebase():
             self._pushClient = None
             return True
         except Exception as e:
-            _LOGGER.error('Error in firebaseStop. Error: {e}')
+            _LOGGER.error(f'Error in firebaseStop. Error: {e}')
             return False
 
 def readFCMCredsFile(credsFile):
@@ -70,7 +70,7 @@ def readFCMCredsFile(credsFile):
             _LOGGER.debug(f'{credsFile} not found.')
             return {}
     except Exception as e:
-        _LOGGER.warning('readFCMCredsFile() not successful. Error: {e}')
+        _LOGGER.warning(f'readFCMCredsFile() not successful. Error: {e}')
         return ''
 
 def writeFCMCredsFile(creds, firebaseCredentialsFileName):

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]
@@ -725,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",
@@ -805,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
@@ -72,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'},
@@ -95,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 ####
@@ -131,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()
 
@@ -148,11 +148,16 @@ 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():
@@ -170,6 +175,28 @@ 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.')
+                        # Although stopFirebase() was not successful, the firebase status is reset to FIREBASE_STATUS_NOT_INITIALISED to allow a new initialisation
+                        self.firebaseStatus = FIREBASE_STATUS_NOT_INITIALISED
+                    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:
@@ -198,16 +225,6 @@ class Vehicle:
                 if self.firebaseStatus != FIREBASE_STATUS_ACTIVATED:
                     await self.get_mileage() 
 
-                if self.firebaseStatus == FIREBASE_STATUS_ACTIVATION_STOPPED:
-                    # Trying to activate firebase connection again
-                    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.debug(f'Restart of push client failed. Firebase status ={self.firebaseStatus}')
-
 
                 await asyncio.gather(
                     #self.get_statusreport(),
@@ -244,6 +261,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."""
@@ -251,6 +272,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."""
@@ -272,8 +297,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)
 
@@ -283,8 +310,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."""
@@ -301,24 +330,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."""
@@ -327,8 +353,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."""
@@ -336,8 +364,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."""
@@ -346,8 +376,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."""
@@ -356,8 +388,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."""
@@ -366,8 +400,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."""
@@ -1000,7 +1036,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, 
@@ -1051,28 +1087,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',
@@ -1159,7 +1197,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:
@@ -1202,7 +1240,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):
@@ -1264,7 +1302,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):
@@ -1321,7 +1359,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):
@@ -1348,6 +1386,11 @@ class Vehicle:
                     'status': response.get('status', 'Unknown'),
                     'id': response.get('id', 0)
                 }
+                # if firebaseStatus is FIREBASE_STATUS_ACTIVATED, the request is assumed successful. Waiting for push notification before rereading status
+                if self.firebaseStatus == FIREBASE_STATUS_ACTIVATED:
+                    _LOGGER.debug('POST request for wakeup vehicle assumed successful. Waiting for push notification')
+                    return True
+                await self.update(updateType=1) #full update after set_refresh
                 return True
         except(SeatInvalidRequestException, SeatException):
             raise
@@ -1357,7 +1400,7 @@ class Vehicle:
         raise SeatException('Data refresh failed')
 
  #### Vehicle class helpers ####
-  # Vehicle info
+    # Vehicle info
     @property
     def attrs(self):
         return self._states
@@ -1390,7 +1433,7 @@ class Vehicle:
 
 
  #### Information from vehicle states ####
-  # Car information
+    # Car information
     @property
     def nickname(self):
         return self._properties.get('vehicleNickname', '')
@@ -1479,7 +1522,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"""
@@ -1498,7 +1541,7 @@ class Vehicle:
             else:
                 return False
 
-  # Connection status
+    # Connection status
     @property
     def last_connected(self):
         """Return when vehicle was last connected to connect servers."""
@@ -1515,7 +1558,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."""
@@ -1527,7 +1570,7 @@ class Vehicle:
         if hasattr(self,'_last_full_update'):
             return True
 
-  # Service information
+    # Service information
     @property
     def distance(self):
         """Return vehicle odometer."""
@@ -1615,7 +1658,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"""
@@ -1874,7 +1917,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."""
@@ -1941,7 +1984,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
@@ -2080,7 +2123,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."""
@@ -2154,7 +2197,7 @@ class Vehicle:
             else:
                 return False
 
-  # Climatisation, electric
+    # Climatisation, electric
     @property
     def electric_climatisation_attributes(self):
         """Return climatisation attributes."""
@@ -2262,7 +2305,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
@@ -2310,7 +2353,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)
@@ -2417,7 +2460,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
@@ -2460,7 +2503,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"""
@@ -2545,7 +2588,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."""
@@ -2657,7 +2700,7 @@ class Vehicle:
             return True
         return False
 
-  # Departure profiles
+    # Departure profiles
     @property
     def departure_profile1(self):
         """Return profile status and attributes."""
@@ -2730,7 +2773,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]
@@ -2955,7 +2998,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."""
@@ -3060,7 +3122,7 @@ class Vehicle:
         """Data update is supported."""
         return True
 
-   # Honk and flash
+    # Honk and flash
     @property
     def request_honkandflash(self):
         """State is always False"""
@@ -3083,7 +3145,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."""
@@ -3138,7 +3200,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
 
@@ -3157,7 +3219,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
         
@@ -3171,7 +3233,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
@@ -3236,17 +3298,21 @@ 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)
-
         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} ')
@@ -3317,7 +3383,29 @@ 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 == 'vehicle-wakeup-succeeded':
+        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 in ('vehicle-wake-up-succeeded', 'vehicle-wakeup-succeeded'):
             if self._requests.get('refresh', {}).get('id', None):
                 openRequest= self._requests.get('refresh', {}).get('id', None)
                 if openRequest == requestId:
@@ -3327,20 +3415,8 @@ 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')
-
-        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.7.dist-info → pycupra-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycupra
-Version: 0.1.7
+Version: 0.1.9
 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.7.dist-info → pycupra-0.1.9.dist-info}/RECORD

@@ -1,25 +1,25 @@
 pycupra/__init__.py,sha256=p0880jPkLqOErX3u3qaLboBLOsEHFpe44axApdaGeqI,231
-pycupra/__version__.py,sha256=DKM773a_0KC1VMvD1yaWYuzJUpp3XsxR_HcWB1g_-Ys,207
-pycupra/connection.py,sha256=GWup_DcxnHNydb0DRJV79Hd108HJxMrGk89vi5R7meE,91150
-pycupra/const.py,sha256=F6y3qt_wS1QxhdSR-NHxB7lpUcf5uKLeoeTAJcAXgsE,10630
-pycupra/dashboard.py,sha256=xWggxTyKTBm3ByjRtymVzLJWtlIa52IEJsNx0z7bA9Q,44324
+pycupra/__version__.py,sha256=dcxJ-u8Zz6qTGBXri5kGr0y8fa_8l43365hGXeOK-zU,207
+pycupra/connection.py,sha256=Knu3vzokMRrsg9psjeD_r-2cl04ySJ1j7Mrn2g9mzdg,92941
+pycupra/const.py,sha256=5b4uuNUE1AGZHmqQfIZv-76Ad20mJTXXQPGI8TU6FfY,10631
+pycupra/dashboard.py,sha256=AlffEx8WmhLaSwX-eVcrOc54rUmwpzZUuR1fhruYkzI,45337
 pycupra/exceptions.py,sha256=Nq_F79GP8wjHf5lpvPy9TbSIrRHAJrFMo0T1N9TcgSQ,2917
-pycupra/firebase.py,sha256=tuN_W3OX3h3-yfdprWzmCn6z_T-BMx-OpL7Z6hOA8Lc,3451
+pycupra/firebase.py,sha256=lmI4a8f5VAlmHAqP2OiJWZhn7dmhyHkIBxL252qdtkA,3454
 pycupra/utilities.py,sha256=6sDxWP13-XtxmqhuBJBGdVbkj48BQ9AxFMrBPxH0J7g,2679
-pycupra/vehicle.py,sha256=jOtpn8WUxKBYPIuCuPMfmH19AVfY0Mn1GXtRJM_gosQ,157941
+pycupra/vehicle.py,sha256=12pFVqgIRkPMJ9IoBt0TAuSS4RRQOdTCq4-ltNtbN9c,162376
 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=7ADEYA6Aw4c42bwbIJr_I76wGiLOu99oV7PSNC4UcVs,30157
+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.7.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pycupra-0.1.7.dist-info/METADATA,sha256=hQAjfqNAkgF72DsnoCrLL6NtkF5_iIWY8mgc4ssgsCo,3757
-pycupra-0.1.7.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pycupra-0.1.7.dist-info/top_level.txt,sha256=9Lbj_jG4JvpGwt6K3AwhWFc0XieDnuHFOP4x44wSXSQ,8
-pycupra-0.1.7.dist-info/RECORD,,
+pycupra-0.1.9.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pycupra-0.1.9.dist-info/METADATA,sha256=5LDPYAqO74WlAZanWVES__uzRngZlq2t_JS8cbABI9w,3757
+pycupra-0.1.9.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pycupra-0.1.9.dist-info/top_level.txt,sha256=9Lbj_jG4JvpGwt6K3AwhWFc0XieDnuHFOP4x44wSXSQ,8
+pycupra-0.1.9.dist-info/RECORD,,