pycupra 0.0.15__tar.gz → 0.1.1__tar.gz

{pycupra-0.0.15/pycupra.egg-info → pycupra-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycupra
-Version: 0.0.15
+Version: 0.1.1
 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
@@ -39,11 +39,21 @@ No licence, public domain, no guarantees, feel free to use for anything. Please
 
 ## Breaking changes
 
+- The method vehicle.update(updateType) supports 3 different update types: 
+   - updateType=0: Small update (=only get_basiccardata() and get_statusreport are called). If the last full update is more than 1100 seconds ago, then a full update is performed.
+   - updateType=1: Full update (nearly all get-methods are called. The model images and the capabilitites are refreshed only every 2 hours.)
+   - updateType=2: Like updateType=0, but ignoring the nightly update reduction
+
+- Nightly update reduction: If nightly reduction is activated and the current time is within the time frame between 22:00 and 05:00, then vehicle.update(0) performs a full update, if the last full update is more than 1700 seconds ago. If that's not the case, vehicle.update(0) does nothing.
+
+- PyCupra can ask the Seat/Cupra portal to send push notifications to PyCupra if the charging status or the climatisation status has changed or when the API has finished a request like lock or unlock vehicle, start or stop charging or change departure timers or ....
+
 ## Thanks to
 
 - [RobinostLund](https://github.com/robinostlund/volkswagencarnet) for initial project for Volkswagen Carnet I was able to fork
 - [Farfar](https://github.com/Farfar) for modifications related to electric engines
 - [tanelvakker](https://github.com/tanelvakker) for modifications related to correct SPIN handling for various actions and using correct URLs also for MY2021
+- [sdb9696](https://github.com/sdb9696) for the firebase-messaging package that is used in PyCupra with only minor modifications
 
 ### Example
 
@@ -52,6 +62,6 @@ When logged in the library will automatically create a vehicle object for every
 Method get_vehicles will fetch vehicle basic information and create Vehicle class objects for all associated vehicles in account.
 To update all available data use the update_all method of the Connect class. This will call the update function for all registered vehicles, which in turn will fetch data from all available API endpoints.
 
-The file *cupra_credentials.json.demo* explains the data structure of the credentials file. 
+The file *pycupra_credentials.json.demo* explains the data structure of the credentials file. 
 
 

{pycupra-0.0.15 → pycupra-0.1.1}/README.md

@@ -14,11 +14,21 @@ No licence, public domain, no guarantees, feel free to use for anything. Please
 
 ## Breaking changes
 
+- The method vehicle.update(updateType) supports 3 different update types: 
+   - updateType=0: Small update (=only get_basiccardata() and get_statusreport are called). If the last full update is more than 1100 seconds ago, then a full update is performed.
+   - updateType=1: Full update (nearly all get-methods are called. The model images and the capabilitites are refreshed only every 2 hours.)
+   - updateType=2: Like updateType=0, but ignoring the nightly update reduction
+
+- Nightly update reduction: If nightly reduction is activated and the current time is within the time frame between 22:00 and 05:00, then vehicle.update(0) performs a full update, if the last full update is more than 1700 seconds ago. If that's not the case, vehicle.update(0) does nothing.
+
+- PyCupra can ask the Seat/Cupra portal to send push notifications to PyCupra if the charging status or the climatisation status has changed or when the API has finished a request like lock or unlock vehicle, start or stop charging or change departure timers or ....
+
 ## Thanks to
 
 - [RobinostLund](https://github.com/robinostlund/volkswagencarnet) for initial project for Volkswagen Carnet I was able to fork
 - [Farfar](https://github.com/Farfar) for modifications related to electric engines
 - [tanelvakker](https://github.com/tanelvakker) for modifications related to correct SPIN handling for various actions and using correct URLs also for MY2021
+- [sdb9696](https://github.com/sdb9696) for the firebase-messaging package that is used in PyCupra with only minor modifications
 
 ### Example
 
@@ -27,6 +37,6 @@ When logged in the library will automatically create a vehicle object for every
 Method get_vehicles will fetch vehicle basic information and create Vehicle class objects for all associated vehicles in account.
 To update all available data use the update_all method of the Connect class. This will call the update function for all registered vehicles, which in turn will fetch data from all available API endpoints.
 
-The file *cupra_credentials.json.demo* explains the data structure of the credentials file. 
+The file *pycupra_credentials.json.demo* explains the data structure of the credentials file. 
 
 

{pycupra-0.0.15 → pycupra-0.1.1}/example/PyCupra.py

@@ -26,9 +26,10 @@ BRAND = 'cupra' # or 'seat' (Change it to 'seat' if you want to connect to the M
 
 PRINTRESPONSE = True
 INTERVAL = 5
-TOKEN_FILE_NAME_AND_PATH='./cupra_token.json'
-CREDENTIALS_FILE_NAME_AND_PATH='./cupra_credentials.json'
-ALL_ATTRIBUTES_FILE_NAME_AND_PATH='./cupra_all_attributes.txt'
+TOKEN_FILE_NAME_AND_PATH='./pycupra_token.json'
+CREDENTIALS_FILE_NAME_AND_PATH='./pycupra_credentials.json'
+FIREBASE_CREDENTIALS_FILE_NAME_AND_PATH='./pycupra_firebase_credentials.json'
+ALL_ATTRIBUTES_FILE_NAME_AND_PATH='./pycupra_all_attributes.txt'
 
 
 COMPONENTS = {
@@ -99,6 +100,7 @@ RESOURCES = [
 		"service_inspection_distance",
         "slow_charge",
 		"sunroof_closed",
+        "target_soc",
 		"trip_last_average_auxillary_consumption",
 		"trip_last_average_electric_consumption",
 		"trip_last_average_fuel_consumption",
@@ -375,7 +377,7 @@ async def main():
         print('# Logging on to seat.cloud.vwgroup.com #')
         print('########################################')
         print(f"Initiating new session to Seat Cloud with {credentials.get('username')} as username")
-        connection = Connection(session, BRAND, credentials.get('username'), credentials.get('password'), PRINTRESPONSE)
+        connection = Connection(session, BRAND, credentials.get('username'), credentials.get('password'), PRINTRESPONSE, nightlyUpdateReduction=False)
         print("Attempting to login to the Seat Cloud service")
         print(datetime.now())
         if await connection.doLogin(tokenFile=TOKEN_FILE_NAME_AND_PATH, apiKey=credentials.get('apiKey',None)):
@@ -394,6 +396,13 @@ async def main():
             instruments = set()
             for vehicle in connection.vehicles:
                 txt = vehicle.vin
+                if vehicle == connection.vehicles[0]: # Firebase can only be activated for one vehicle. So we use it for the first one
+                    newStatus = await vehicle.initialiseFirebase(FIREBASE_CREDENTIALS_FILE_NAME_AND_PATH, vehicle.update)
+                    print('########################################')
+                    print('#      Initialisation of firebase      #')
+                    print(txt.center(40, '#'))
+                    print(f"New status of firebase={newStatus}")
+
                 print('')
                 print('########################################')
                 print('#         Setting up dashboard         #')
@@ -524,7 +533,7 @@ async def main():
             # Examples for using set functions:
 
             #await demo_set_charger(vehicle, action = "start")                        # action = "start" or "stop"
-            #await demo_set_charger_current(vehicle, value='reduced')                          # value = 1-255/Maximum/Reduced (PHEV: 252 for reduced and 254 for max, EV: Maximum/Reduced)
+            #await demo_set_charger_current(vehicle, value='reduced')                 # value = 1-255/Maximum/Reduced (PHEV: 252 for reduced and 254 for max, EV: Maximum/Reduced)
 
             #await demo_set_climatisation(vehicle, action = "start", temp=18.0)         # action = "auxilliary", "electric" or "off". spin is S-PIN and only needed for aux heating
             #await demo_set_climatisation_temp(vehicle, temp = 18.0)                  # temp = integer from 16 to 30
@@ -562,9 +571,15 @@ async def main():
                 print('Export of all attributes successfully completed')
             else:
                 print('Export of all attributes failed')
-            
-            print(f"Sleeping for {INTERVAL} seconds")
-            await asyncio.sleep(INTERVAL)
+
+            if vehicle.firebaseStatus== 1: # firebase messaging activated
+                # Do an endless loop to wait and receive firebase messages    
+                i=0
+                while True:
+                    print(f"Sleeping for {6*INTERVAL} seconds")
+                    await asyncio.sleep(6*INTERVAL)
+                    i=i+1
+                    _LOGGER.debug(f'Round {i}')
 
     exit
 

{pycupra-0.0.15 → pycupra-0.1.1}/pycupra/__init__.py

@@ -5,3 +5,4 @@ For more details and documentation, visit the github page at https://github.com/
 """
 
 from pycupra.connection import Connection
+

{pycupra-0.0.15 → pycupra-0.1.1}/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.0.15"
+__version__ = "0.1.1"

{pycupra-0.0.15 → pycupra-0.1.1}/pycupra/connection.py

@@ -46,7 +46,7 @@ from requests_oauthlib import OAuth2Session
 from oauthlib.oauth2.rfc6749.parameters import parse_authorization_code_response, parse_token_response, prepare_grant_uri
 
 from aiohttp import ClientSession, ClientTimeout
-from aiohttp.hdrs import METH_GET, METH_POST, METH_PUT
+from aiohttp.hdrs import METH_GET, METH_POST, METH_PUT, METH_DELETE
 
 from .const import (
     HEADERS_SESSION,
@@ -643,6 +643,8 @@ class Connection:
                     res = {'status_code': response.status}
                 elif response.status == 202 and method==METH_PUT:
                     res = response
+                elif response.status == 200 and method==METH_DELETE:
+                    res = response
                 elif response.status >= 200 or response.status <= 300:
                     # If this is a revoke token url, expect Content-Length 0 and return
                     if int(response.headers.get('Content-Length', 0)) == 0 and 'revoke' in url:
@@ -759,7 +761,7 @@ class Connection:
         # Check if user needs to update consent
         try:
             await self.set_token(self._session_auth_brand)
-            _LOGGER.debug('Achtung! getConsentInfo auskommentiert')
+            #_LOGGER.debug('Achtung! getConsentInfo auskommentiert')
             response = await self.get(eval(f"f'{API_MBB_STATUSDATA}'"))
             if response.get('profileCompleted','incomplete'):
                 if response.get('profileCompleted',False):
@@ -1182,6 +1184,8 @@ class Connection:
         """Get charger data."""
         await self.set_token(self._session_auth_brand)
         try:
+            chargingStatus = {}
+            chargingInfo = {}
             response = await self.get(eval(f"f'{API_CHARGING}/status'"))
             if response.get('battery', {}):
                 chargingStatus = response
@@ -1203,12 +1207,16 @@ class Connection:
                 _LOGGER.warning(f'Could not fetch charging modes, HTTP status code: {response.get("status_code")}')
             else:
                 _LOGGER.info('Unhandled error while trying to fetch charging modes')"""
-            data = {'charging': {
-                'status': chargingStatus,
-                'info' :  chargingInfo,
-                #'modes' :  chargingModes,
-            }
-            }
+            if chargingStatus != {} and chargingInfo != {}:
+                data = {'charging': {
+                    'status': chargingStatus,
+                    'info' :  chargingInfo,
+                    #'modes' :  chargingModes,
+                    }
+                }
+            else:
+                _LOGGER.warning(f'getCharger() got no valid data. Returning None')
+                return None
             return data
         except Exception as error:
             _LOGGER.warning(f'Could not fetch charger, error: {error}')
@@ -1321,7 +1329,7 @@ class Connection:
                             if 'state' in k.lower():
                                 data['state'] = response.get(key).get(k)
                     else:
-                        if 'Id' in key:
+                        if 'Id' in key or 'id' in key:
                             data['id'] = str(response.get(key))
                         if 'State' in key:
                             data['state'] = response.get(key)
@@ -1365,6 +1373,55 @@ class Connection:
             raise
         return False
 
+    async def subscribe(self, vin, credentials):
+        url = f'{APP_URI}/v2/subscriptions'
+        deviceId = credentials.get('gcm',{}).get('app_id','')
+        token = credentials.get('fcm',{}).get('registration',{}).get('token','')
+
+        data = {
+            "deviceId": deviceId, 
+            "locale":"en_GB",
+            "services":{"charging":True,"climatisation":True},
+            "token": token, 
+            "userId": self._user_id, 
+            "vin":vin
+            }
+        return await self._setViaAPI(url, json=data)
+
+    async def deleteSubscription(self, credentials):
+        await self.set_token(self._session_auth_brand)
+        try:
+            id = credentials.get('subscription',{}).get('id','')
+            url = f'{APP_URI}/v1/subscriptions/{id}'
+            response = await self._request(METH_DELETE, url)
+            if response.status==200: 
+                _LOGGER.debug(f'Subscription {id} successfully deleted.')
+                return response
+            else:
+                _LOGGER.debug(f'API did not successfully delete subscription.')
+                raise SeatException(f'Invalid or no response for endpoint {url}')
+                return response
+        except aiohttp.client_exceptions.ClientResponseError as error:
+            _LOGGER.debug(f'Request failed. Id: {id}, HTTP request headers: {self._session_headers}')
+            if error.status == 401:
+                _LOGGER.error('Unauthorized')
+            elif error.status == 400:
+                _LOGGER.error(f'Bad request')
+            elif error.status == 429:
+                _LOGGER.warning('Too many requests. Further requests can only be made after the end of next trip in order to protect your vehicles battery.')
+                return 429
+            elif error.status == 500:
+                _LOGGER.error('Internal server error, server might be temporarily unavailable')
+            elif error.status == 502:
+                _LOGGER.error('Bad gateway, this function may not be implemented for this vehicle')
+            else:
+                _LOGGER.error(f'Unhandled HTTP exception: {error}')
+            #return False
+        except Exception as error:
+            _LOGGER.error(f'Error: {error}')
+            raise
+        return False
+
     async def setCharger(self, vin, baseurl, mode, data):
         """Start/Stop charger."""
         if mode in {'start', 'stop'}:

{pycupra-0.0.15 → pycupra-0.1.1}/pycupra/const.py

@@ -181,3 +181,14 @@ REQ_STATUS = {
     'vsr': 'fs-car/bs/vsr/v1/{BRAND}/{COUNTRY}/vehicles/{vin}/requests/{id}/jobstatus',
     'default': 'fs-car/bs/{section}/v1/{BRAND}/{COUNTRY}/vehicles/{vin}/requests/{id}/status'
 }
+
+FCM_PROJECT_ID='ola-apps-prod'
+FCM_APP_ID={
+    'cupra': '1:530284123617:android:9b9ba5a87c7ffd37fbeea0',
+    'seat':  '1:530284123617:android:d6187613ac3d7b08fbeea0'
+}
+FCM_API_KEY='AIzaSyCoSp1zitklb1EDj5yQumN0VNhDizJQHLk'
+FIREBASE_STATUS_NOT_INITIALISED= 0
+FIREBASE_STATUS_ACTIVATED= 1
+FIREBASE_STATUS_NOT_WANTED= -2
+FIREBASE_STATUS_ACTIVATION_FAILED= -1

{pycupra-0.0.15 → pycupra-0.1.1}/pycupra/dashboard.py

@@ -1037,6 +1037,13 @@ def create_instruments():
             unit="%",
             device_class="battery"
         ),
+        Sensor(
+            attr="target_soc",
+            name="Target state of charge",
+            icon="mdi:battery-positive",
+            unit="%",
+            device_class="battery"
+        ),
         Sensor(
             attr="adblue_level",
             name="Adblue level",

pycupra-0.1.1/pycupra/firebase.py

@@ -0,0 +1,73 @@
+import logging
+import asyncio
+import os
+import json
+import string
+import secrets
+
+from .firebase_messaging import FcmPushClient, FcmRegisterConfig
+
+from .const import (
+    FCM_PROJECT_ID,
+    FCM_API_KEY,
+    FCM_APP_ID
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+class Firebase():
+    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 =''
+
+        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)
+        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()
+
+def readFCMCredsFile(credsFile):
+    """ Reads the firebase cloud messaging credentials from file"""
+    try:
+        if os.path.isfile(credsFile):
+            with open(credsFile, "r") as f:
+                credString=f.read()
+            f.close()
+            creds=json.loads(credString)
+            return creds
+        else:
+            _LOGGER.debug(f'{credsFile} not found.')
+            return {}
+    except:
+        _LOGGER.warning('readFCMCredsFile() not successful.')
+        return ''
+
+def writeFCMCredsFile(creds, firebaseCredentialsFileName):
+    """ Saves the firebase cloud messaging credentials to a file for future use """
+    try:
+        with open(firebaseCredentialsFileName, "w") as f:
+            f.write(json.dumps(creds))
+        f.close()
+    except Exception as e:
+        _LOGGER.warning(f'writeFCMCredsFile() not successful. Error: {e}')
+    
+async def onFCMCredentialsUpdated(creds, firebaseCredentialsFileName):
+    """ Is called from firebase-messaging package """
+    loop = asyncio.get_running_loop()
+    await loop.run_in_executor(None, writeFCMCredsFile, creds, firebaseCredentialsFileName)
+    #writeFCMCredsFile(creds, firebaseCredentialsFileName)
+    

pycupra-0.1.1/pycupra/firebase_messaging/__init__.py

@@ -0,0 +1,20 @@
+from .fcmpushclient import FcmPushClient, FcmPushClientConfig, FcmPushClientRunState
+from .fcmregister import FcmRegisterConfig
+from .proto.mcs_pb2 import (  # pylint: disable=no-name-in-module
+    Close,
+    DataMessageStanza,
+    HeartbeatAck,
+    HeartbeatPing,
+    IqStanza,
+    LoginRequest,
+    LoginResponse,
+    SelectiveAck,
+    StreamErrorStanza,
+)
+
+__all__ = [
+    "FcmPushClientConfig",
+    "FcmPushClient",
+    "FcmPushClientRunState",
+    "FcmRegisterConfig",
+]

pycupra-0.1.1/pycupra/firebase_messaging/const.py

@@ -0,0 +1,32 @@
+"""Constants module."""
+
+GCM_REGISTER_URL = "https://android.clients.google.com/c2dm/register3"
+GCM_CHECKIN_URL = "https://android.clients.google.com/checkin"
+GCM_SERVER_KEY_BIN = (
+    b"\x04\x33\x94\xf7\xdf\xa1\xeb\xb1\xdc\x03\xa2\x5e\x15\x71\xdb\x48\xd3"
+    + b"\x2e\xed\xed\xb2\x34\xdb\xb7\x47\x3a\x0c\x8f\xc4\xcc\xe1\x6f\x3c"
+    + b"\x8c\x84\xdf\xab\xb6\x66\x3e\xf2\x0c\xd4\x8b\xfe\xe3\xf9\x76\x2f"
+    + b"\x14\x1c\x63\x08\x6a\x6f\x2d\xb1\x1a\x95\xb0\xce\x37\xc0\x9c\x6e"
+)
+# urlsafe b64 encoding of the binary key with = padding removed
+GCM_SERVER_KEY_B64 = (
+    "BDOU99-h67HcA6JeFXHbSNMu7e2yNNu3RzoM"
+    + "j8TM4W88jITfq7ZmPvIM1Iv-4_l2LxQcYwhqby2xGpWwzjfAnG4"
+)
+
+FCM_SUBSCRIBE_URL = "https://fcm.googleapis.com/fcm/connect/subscribe/"
+FCM_SEND_URL = "https://fcm.googleapis.com/fcm/send/"
+
+FCM_API = "https://fcm.googleapis.com/v1/"
+FCM_REGISTRATION = "https://fcmregistrations.googleapis.com/v1/"
+FCM_INSTALLATION = "https://firebaseinstallations.googleapis.com/v1/"
+AUTH_VERSION = "FIS_v2"
+SDK_VERSION = "w:0.6.6"
+
+DOORBELLS_ENDPOINT = "/clients_api/doorbots/{0}"
+
+MCS_VERSION = 41
+MCS_HOST = "mtalk.google.com"
+MCS_PORT = 5228
+MCS_SELECTIVE_ACK_ID = 12
+MCS_STREAM_ACK_ID = 13