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

pycupra/firebase.py

@@ -16,29 +16,46 @@ from .const import (
 _LOGGER = logging.getLogger(__name__)
 
 class Firebase():
+    def __init__(self):
+        self._pushClient = None
+
     async def firebaseStart(self, onNotificationFunc, firebaseCredentialsFileName, brand='cupra'): 
         """ Starts the firebase cloud messaging receiver """
-        loop = asyncio.get_running_loop()
-        credentials = await loop.run_in_executor(None, readFCMCredsFile, firebaseCredentialsFileName)
-        #credentials = readFCMCredsFile(firebaseCredentialsFileName)
-        if credentials == {}:
-            credentials =''
+        try:
+            loop = asyncio.get_running_loop()
+            credentials = await loop.run_in_executor(None, readFCMCredsFile, firebaseCredentialsFileName)
+            #credentials = readFCMCredsFile(firebaseCredentialsFileName)
+            if credentials == {}:
+                credentials =''
 
-        fcm_project_id=FCM_PROJECT_ID
-        fcm_app_id=FCM_APP_ID[brand]
-        fcm_api_key=FCM_API_KEY
-        chars = string.ascii_letters + string.digits
-        fcmMessageSenderId = ''.join(secrets.choice(chars) for i in range(16)) 
-        fcmMessageSenderId= 'fxpWQ_'+fcmMessageSenderId
+            fcm_project_id=FCM_PROJECT_ID
+            fcm_app_id=FCM_APP_ID[brand]
+            fcm_api_key=FCM_API_KEY
+            chars = string.ascii_letters + string.digits
+            fcmMessageSenderId = ''.join(secrets.choice(chars) for i in range(16)) 
+            fcmMessageSenderId= 'fxpWQ_'+fcmMessageSenderId
 
+            fcm_config = FcmRegisterConfig(fcm_project_id, fcm_app_id, fcm_api_key, fcmMessageSenderId)
+            self._pushClient = FcmPushClient(onNotificationFunc, fcm_config, credentials, onFCMCredentialsUpdated)
+            fcm_token = await self._pushClient.checkin_or_register(firebaseCredentialsFileName)
+            _LOGGER.debug(f'Firebase.checkin_or_register() returned a token:{fcm_token}')
+            await self._pushClient.start()
+            await asyncio.sleep(5)
+            return self._pushClient.is_started()
+        except Exception as e:
+            _LOGGER.error('Error in firebaseStart. Error: {e}')
+            return False
 
-        fcm_config = FcmRegisterConfig(fcm_project_id, fcm_app_id, fcm_api_key, fcmMessageSenderId)
-        pc = FcmPushClient(onNotificationFunc, fcm_config, credentials, onFCMCredentialsUpdated)
-        fcm_token = await pc.checkin_or_register(firebaseCredentialsFileName)
-        _LOGGER.debug(f'Firebase.checkin_or_register() returned a token:{fcm_token}')
-        await pc.start()
-        await asyncio.sleep(5)
-        return pc.is_started()
+    async def firebaseStop(self): 
+        """ Stops the firebase cloud messaging receiver """
+        try:
+            await self._pushClient.stop()
+            #await asyncio.sleep(5)
+            self._pushClient = None
+            return True
+        except Exception as e:
+            _LOGGER.error('Error in firebaseStop. Error: {e}')
+            return False
 
 def readFCMCredsFile(credsFile):
     """ Reads the firebase cloud messaging credentials from file"""
@@ -52,8 +69,8 @@ def readFCMCredsFile(credsFile):
         else:
             _LOGGER.debug(f'{credsFile} not found.')
             return {}
-    except:
-        _LOGGER.warning('readFCMCredsFile() not successful.')
+    except Exception as e:
+        _LOGGER.warning('readFCMCredsFile() not successful. Error: {e}')
         return ''
 
 def writeFCMCredsFile(creds, firebaseCredentialsFileName):

pycupra/utilities.py

@@ -1,116 +1,116 @@
-from datetime import date, datetime
-from base64 import b64encode
-from string import ascii_letters as letters, digits
-from sys import argv
-from os import environ as env
-from os.path import join, dirname, expanduser
-from itertools import product
-import json
-import logging
-import re
-
-_LOGGER = logging.getLogger(__name__)
-
-
-def read_config():
-    """Read config from file."""
-    for directory, filename in product(
-        [
-            dirname(argv[0]),
-            expanduser("~"),
-            env.get("XDG_CONFIG_HOME", join(expanduser("~"), ".config")),
-        ],
-        ["seat.conf", ".seat.conf"],
-    ):
-        try:
-            config = join(directory, filename)
-            _LOGGER.debug("checking for config file %s", config)
-            with open(config) as config:
-                return dict(
-                    x.split(": ")
-                    for x in config.read().strip().splitlines()
-                    if not x.startswith("#")
-                )
-        except (IOError, OSError):
-            continue
-    return {}
-
-
-def json_loads(s):
-    return json.loads(s, object_hook=obj_parser)
-
-
-def obj_parser(obj):
-    """Parse datetime."""
-    for key, val in obj.items():
-        try:
-            obj[key] = datetime.strptime(val, "%Y-%m-%dT%H:%M:%S%z")
-        except (TypeError, ValueError):
-            pass
-    return obj
-
-
-def find_path(src, path):
-    """Simple navigation of a hierarchical dict structure using XPATH-like syntax.
-
-    >>> find_path(dict(a=1), 'a')
-    1
-
-    >>> find_path(dict(a=1), '')
-    {'a': 1}
-
-    >>> find_path(dict(a=None), 'a')
-
-
-    >>> find_path(dict(a=1), 'b')
-    Traceback (most recent call last):
-    ...
-    KeyError: 'b'
-
-    >>> find_path(dict(a=dict(b=1)), 'a.b')
-    1
-
-    >>> find_path(dict(a=dict(b=1)), 'a')
-    {'b': 1}
-
-    >>> find_path(dict(a=dict(b=1)), 'a.c')
-    Traceback (most recent call last):
-    ...
-    KeyError: 'c'
-
-    """
-    if not path:
-        return src
-    if isinstance(path, str):
-        path = path.split(".")
-    return find_path(src[path[0]], path[1:])
-
-
-def is_valid_path(src, path):
-    """
-    >>> is_valid_path(dict(a=1), 'a')
-    True
-
-    >>> is_valid_path(dict(a=1), '')
-    True
-
-    >>> is_valid_path(dict(a=1), None)
-    True
-
-    >>> is_valid_path(dict(a=1), 'b')
-    False
-    """
-    try:
-        find_path(src, path)
-        return True
-    except KeyError:
-        return False
-
-
-def camel2slug(s):
-    """Convert camelCase to camel_case.
-
-    >>> camel2slug('fooBar')
-    'foo_bar'
-    """
-    return re.sub("([A-Z])", "_\\1", s).lower().lstrip("_")
+from datetime import date, datetime
+from base64 import b64encode
+from string import ascii_letters as letters, digits
+from sys import argv
+from os import environ as env
+from os.path import join, dirname, expanduser
+from itertools import product
+import json
+import logging
+import re
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def read_config():
+    """Read config from file."""
+    for directory, filename in product(
+        [
+            dirname(argv[0]),
+            expanduser("~"),
+            env.get("XDG_CONFIG_HOME", join(expanduser("~"), ".config")),
+        ],
+        ["seat.conf", ".seat.conf"],
+    ):
+        try:
+            config = join(directory, filename)
+            _LOGGER.debug("checking for config file %s", config)
+            with open(config) as config:
+                return dict(
+                    x.split(": ")
+                    for x in config.read().strip().splitlines()
+                    if not x.startswith("#")
+                )
+        except (IOError, OSError):
+            continue
+    return {}
+
+
+def json_loads(s):
+    return json.loads(s, object_hook=obj_parser)
+
+
+def obj_parser(obj):
+    """Parse datetime."""
+    for key, val in obj.items():
+        try:
+            obj[key] = datetime.strptime(val, "%Y-%m-%dT%H:%M:%S%z")
+        except (TypeError, ValueError):
+            pass
+    return obj
+
+
+def find_path(src, path):
+    """Simple navigation of a hierarchical dict structure using XPATH-like syntax.
+
+    >>> find_path(dict(a=1), 'a')
+    1
+
+    >>> find_path(dict(a=1), '')
+    {'a': 1}
+
+    >>> find_path(dict(a=None), 'a')
+
+
+    >>> find_path(dict(a=1), 'b')
+    Traceback (most recent call last):
+    ...
+    KeyError: 'b'
+
+    >>> find_path(dict(a=dict(b=1)), 'a.b')
+    1
+
+    >>> find_path(dict(a=dict(b=1)), 'a')
+    {'b': 1}
+
+    >>> find_path(dict(a=dict(b=1)), 'a.c')
+    Traceback (most recent call last):
+    ...
+    KeyError: 'c'
+
+    """
+    if not path:
+        return src
+    if isinstance(path, str):
+        path = path.split(".")
+    return find_path(src[path[0]], path[1:])
+
+
+def is_valid_path(src, path):
+    """
+    >>> is_valid_path(dict(a=1), 'a')
+    True
+
+    >>> is_valid_path(dict(a=1), '')
+    True
+
+    >>> is_valid_path(dict(a=1), None)
+    True
+
+    >>> is_valid_path(dict(a=1), 'b')
+    False
+    """
+    try:
+        find_path(src, path)
+        return True
+    except KeyError:
+        return False
+
+
+def camel2slug(s):
+    """Convert camelCase to camel_case.
+
+    >>> camel2slug('fooBar')
+    'foo_bar'
+    """
+    return re.sub("([A-Z])", "_\\1", s).lower().lstrip("_")

pycupra/vehicle.py

@@ -34,7 +34,7 @@ _LOGGER = logging.getLogger(__name__)
 DATEZERO = datetime(1970,1,1)
 class Vehicle:
     def __init__(self, conn, data):
-        _LOGGER.debug(f'Creating Vehicle class object with data {data}')
+        _LOGGER.debug(conn.anonymise(f'Creating Vehicle class object with data {data}'))
         self._connection = conn
         self._url = data.get('vin', '')
         self._connectivities = data.get('connectivities', '')
@@ -50,6 +50,7 @@ class Vehicle:
         self._firebaseCredentialsFileName = None
         self._firebaseLastMessageId = ''
         self.firebaseStatus = FIREBASE_STATUS_NOT_INITIALISED
+        self.firebase = None
         self.updateCallback = None
 
         self._requests = {
@@ -184,7 +185,7 @@ class Vehicle:
                 if hasattr(self, '_last_full_update'):
                     _LOGGER.debug(f'last_full_update= {self._last_full_update}, fullUpdateExpired= {fullUpdateExpired}.')
                 if updateType!=1 and (hasattr(self, '_last_full_update') and self._last_full_update>fullUpdateExpired):
-                    _LOGGER.debug(f'Just performed small update for vehicle with VIN {self.vin}.')
+                    _LOGGER.debug(f'Just performed small update for vehicle with VIN {self._connection.anonymise(self.vin)}.')
                     return True
                 
                 # Data to be updated less often
@@ -206,13 +207,13 @@ class Vehicle:
                     return_exceptions=True
                 )
                 self._last_full_update = datetime.now(tz=None)
-                _LOGGER.debug(f'Performed full update for vehicle with VIN {self.vin}.')
+                _LOGGER.debug(f'Performed full update for vehicle with VIN {self._connection.anonymise(self.vin)}.')
                 _LOGGER.debug(f'So far about {self._connection._sessionRequestCounter} API calls since {self._connection._sessionRequestTimestamp}.')
             except:
                 raise SeatException("Update failed")
             return True
         else:
-            _LOGGER.info(f'Vehicle with VIN {self.vin} is deactivated.')
+            _LOGGER.info(f'Vehicle with VIN {self._connection.anonymise(self.vin)} is deactivated.')
             return False
         return True
 
@@ -290,6 +291,14 @@ class Vehicle:
         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)
             else:
                 _LOGGER.debug('Could not fetch vehicle health warnings')
@@ -1394,6 +1403,17 @@ class Vehicle:
         #        if car.get('deactivated', False):
         #            return True
 
+    @property
+    def brand(self):
+        """Return brand"""
+        return self._specification.get('factoryModel', False).get('vehicleBrand', 'Unknown')
+
+    @property
+    def is_brand_supported(self):
+        """Return true if brand is supported."""
+        if self._specification.get('factoryModel', False).get('vehicleBrand', False):
+            return True
+
     @property
     def model(self):
         """Return model"""
@@ -2217,7 +2237,12 @@ class Vehicle:
     def warnings(self):
         """Return warnings."""
         if self.attrs.get('warninglights', {}).get('statuses',[]):
-            return 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'
 
     @property
@@ -3120,6 +3145,27 @@ class Vehicle:
         )
 
 
+    async def stopFirebase(self):
+        # Check if firebase is activated
+        if self.firebaseStatus!= FIREBASE_STATUS_ACTIVATED:
+            _LOGGER.info(f'No need to stop firebase. Firebase status={self.firebaseStatus}')
+            return self.firebaseStatus
+        
+        if self.firebase == None:
+            _LOGGER.error(f'Internal error: Firebase status={self.firebaseStatus} but firebase variable not set. Setting firebase status back to not initialised.')
+            self.firebaseStatus = FIREBASE_STATUS_NOT_INITIALISED
+            return self.firebaseStatus
+
+        success = await self.firebase.firebaseStop()
+        if not success:
+            _LOGGER.warning('Stopping of firebase messaging failed.')
+            return self.firebaseStatus
+        
+        #await asyncio.sleep(5) # Wait to ignore the first notifications 
+        self.firebaseStatus = FIREBASE_STATUS_NOT_INITIALISED
+        _LOGGER.info('Stopping of firebase messaging was successful.')
+        return self.firebaseStatus
+
     async def initialiseFirebase(self, firebaseCredentialsFileName=None, updateCallback=None):
         # Check if firebase shall be used
         if firebaseCredentialsFileName == None:
@@ -3141,12 +3187,13 @@ class Vehicle:
         subscribedBrand = credentials.get('subscription',{}).get('brand','')
         if subscribedVin != '' and subscribedUserId != '':
             if subscribedVin != self.vin or subscribedUserId != self._connection._user_id or subscribedBrand != self._connection._session_auth_brand:
-                _LOGGER.debug(f'Change of vin, userId or brand. Deleting subscription for vin={subscribedVin} and userId={subscribedUserId}.')
+                _LOGGER.debug(self._connection.anonymise(f'Change of vin, userId or brand. Deleting subscription for vin={subscribedVin} and userId={subscribedUserId}.'))
                 result = await self._connection.deleteSubscription(credentials)
 
         # Start firebase
-        fb = Firebase()
-        success = await fb.firebaseStart(self.onNotification, firebaseCredentialsFileName, brand=self._connection._session_auth_brand)
+        if self.firebase == None:
+            self.firebase = Firebase()
+        success = await self.firebase.firebaseStart(self.onNotification, firebaseCredentialsFileName, brand=self._connection._session_auth_brand)
         if not success:
             self.firebaseStatus = FIREBASE_STATUS_ACTIVATION_FAILED
             _LOGGER.warning('Activation of firebase messaging failed.')
@@ -3167,7 +3214,7 @@ class Vehicle:
         loop = asyncio.get_running_loop()
         await loop.run_in_executor(None, writeFCMCredsFile, credentials, firebaseCredentialsFileName)
 
-        await asyncio.sleep(5) # Wait to let the first notifications 
+        await asyncio.sleep(5) # Wait to ignore the first notifications 
         self.firebaseStatus = FIREBASE_STATUS_ACTIVATED
         _LOGGER.info('Activation of firebase messaging was successful.')
         return self.firebaseStatus
@@ -3247,7 +3294,7 @@ class Vehicle:
                     await self.updateCallback(2)
             else:
                 _LOGGER.debug(f'It is now {datetime.now(tz=None)}. Last get_charger was at {self._last_get_charger}. So no need to update.')
-        elif type in ('climatisation-status-changed','climatisation-started', 'climatisation-stopped'):
+        elif type in ('climatisation-status-changed','climatisation-started', 'climatisation-stopped', 'climatisation-settings-updated'):
             if self._requests.get('climatisation', {}).get('id', None):
                 openRequest= self._requests.get('climatisation', {}).get('id', None)
                 if openRequest == requestId:

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

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

@@ -1,12 +1,12 @@
 pycupra/__init__.py,sha256=p0880jPkLqOErX3u3qaLboBLOsEHFpe44axApdaGeqI,231
-pycupra/__version__.py,sha256=y2dos0x1TDMyh80ZOW3YvhHvw1DWdxYSgYNyRSzioPY,207
-pycupra/connection.py,sha256=VPyLBfcmWPm4L8cL5HXvFT179PhNmiDn3yvWiNtu3Pw,86366
+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/exceptions.py,sha256=Nq_F79GP8wjHf5lpvPy9TbSIrRHAJrFMo0T1N9TcgSQ,2917
-pycupra/firebase.py,sha256=V3Ico6FZzEn0-5-CnqaDP9Mg9LpVU-_qLyZQwiRBbD0,2725
-pycupra/utilities.py,sha256=cH4MiIzT2WlHgmnl_E7rR0R5LvCXfDNvirJolct50V8,2563
-pycupra/vehicle.py,sha256=yMaO-6lquak8821usCen6LWEM7rn0EZjiEOzK9jp6e4,154682
+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/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
@@ -18,8 +18,8 @@ pycupra/firebase_messaging/fcmregister.py,sha256=yZngC-0ZfTygtjfdzg03OW_3xk2n_uS
 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.5.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pycupra-0.1.5.dist-info/METADATA,sha256=upt06crj4Naaogz_wPgfmLUDZ8VXdwDlZLzP9bthKpM,3757
-pycupra-0.1.5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pycupra-0.1.5.dist-info/top_level.txt,sha256=9Lbj_jG4JvpGwt6K3AwhWFc0XieDnuHFOP4x44wSXSQ,8
-pycupra-0.1.5.dist-info/RECORD,,
+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,,