pycupra 0.1.12__tar.gz → 0.1.14__tar.gz

{pycupra-0.1.12 → pycupra-0.1.14}/.gitignore

@@ -1,10 +1,10 @@
-
-.eggs/
-*.egg-info/
-build/
-dist/
-__pycache__/
-*.json
-*.txt
-*.log
-www/
+
+.eggs/
+*.egg-info/
+build/
+dist/
+__pycache__/
+*.json
+*.txt
+*.log
+*.png

pycupra-0.1.14/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: pycupra
+Version: 0.1.14
+Summary: A library to read and send vehicle data via Cupra/Seat portal using the same API calls as the MyCupra/MySeat mobile app.
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+Requires-Dist: beautifulsoup4
+Requires-Dist: cryptography
+Requires-Dist: lxml
+Requires-Dist: PyJWT
+Requires-Dist: xmltodict
+Requires-Dist: pandas
+Requires-Dist: pillow
+Requires-Dist: protobuf
+Requires-Dist: http-ece
+Requires-Dist: requests-oauthlib
+Dynamic: license-file
+
+# PyCupra
+
+A library to read and send vehicle data via Cupra/Seat portal using the same API calls as the MyCupra/MySeat mobile app.
+
+Fork of https://github.com/Farfar/seatconnect which in turn is a fork of:
+Fork of https://github.com/lendy007/skodaconnect which in turn is a fork of:
+https://github.com/robinostlund/volkswagencarnet
+
+## Information
+
+Retrieve statistics about your Cupra/Seat from the Cupra/Seat Connect online service
+
+No licence, public domain, no guarantees, feel free to use for anything. Please contribute improvements/bugfixes etc.
+
+## 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
+
+For an extensive example, please use the code found in example/PyCupra.py.
+When logged in the library will automatically create a vehicle object for every car registered to the account. Initially no data is fetched at all. Use the doLogin method and it will signin with the credentials used for the class constructor. After a successful login, the tokens are stored in a json file. Later doLogin calls can use the token file instead of the credentials.
+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 *pycupra_credentials.json.demo* explains the data structure of the credentials file. 
+
+

{pycupra-0.1.12 → pycupra-0.1.14}/example/PyCupra.py

@@ -10,9 +10,11 @@ import pandas as pd
 from aiohttp import ClientSession
 from datetime import datetime
 
-currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
-parentdir = os.path.dirname(currentdir)
-sys.path.insert(0, parentdir)
+currentframe = inspect.currentframe()
+if currentframe != None:
+    currentdir = os.path.dirname(os.path.abspath(inspect.getfile(currentframe)))
+    parentdir = os.path.dirname(currentdir)
+    sys.path.insert(0, parentdir)
 
 try:
     from pycupra import Connection
@@ -383,6 +385,12 @@ async def main():
     if credentials==None or credentials.get('username','')=='' or (credentials.get('password','')==''):
         _LOGGER.warning('Can not use the credentials read from the credentials file.')
         raise
+    if credentials.get('brand','')!='':
+        BRAND = credentials.get('brand','')
+        print('Read brand from the credentials file.')
+    else:
+        print('No brand found in the credentials file. Using the default value.')
+    print(f'Now working with brand={BRAND}')
     async with ClientSession(headers={'Connection': 'keep-alive'}) as session:
         print('')
         print('######################################################')
@@ -594,7 +602,7 @@ async def main():
                     i=i+1
                     _LOGGER.debug(f'Round {i}')
 
-    exit
+    sys.exit(1)
 
 if __name__ == "__main__":
     loop = asyncio.new_event_loop()

pycupra-0.1.14/example/PyCupra_ExportDrivingData.py

@@ -0,0 +1,113 @@
+#!/usr/bin/env python3
+""" Sample program to export the trip statistics as csv file"""
+import asyncio
+import logging
+import inspect
+import sys
+import os
+import json
+import pandas as pd
+from aiohttp import ClientSession
+from datetime import datetime
+
+currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
+parentdir = os.path.dirname(currentdir)
+sys.path.insert(0, parentdir)
+
+try:
+    from pycupra import Connection
+except ModuleNotFoundError as e:
+    print(f"Unable to import library: {e}")
+    sys.exit(1)
+
+logging.basicConfig(level=logging.WARN)
+_LOGGER = logging.getLogger(__name__)
+BRAND = 'cupra' # or 'seat' (Default value if no brand is provided via credentials file)
+
+PRINTRESPONSE = True
+INTERVAL = 5
+TOKEN_FILE_NAME_AND_PATH='./pycupra_token.json'
+CREDENTIALS_FILE_NAME_AND_PATH='./pycupra_credentials.json'
+
+def readCredentialsFile():
+    try:
+        with open(CREDENTIALS_FILE_NAME_AND_PATH, "r") as f:
+            credentialsString=f.read()
+        credentials=json.loads(credentialsString)
+        return credentials
+    except:
+        _LOGGER.info('readCredentialsFile not successful. Perhaps no credentials file present.')
+        return None
+
+def exportToCSV(vehicle, csvFileName, dataType='short'):
+    df= pd.DataFrame(vehicle._states['tripstatistics'][dataType])
+    _LOGGER.debug('Exporting trip data to csv')
+    df.to_csv(csvFileName)
+    return True
+
+async def main():
+    """Main method."""
+    print('')
+    print('######################################################')
+    print('#               Reading credentials file             #')
+    print('######################################################')
+    credentials= readCredentialsFile()
+    if credentials==None or credentials.get('username','')=='' or (credentials.get('password','')==''):
+        _LOGGER.warning('Can not use the credentials read from the credentials file.')
+        raise
+    if credentials.get('brand','')!='':
+        BRAND = credentials.get('brand','')
+        print('Read brand from the credentials file.')
+    else:
+        print('No brand found in the credentials file. Using the default value.')
+    print(f'Now working with brand={BRAND}')
+    async with ClientSession(headers={'Connection': 'keep-alive'}) as session:
+        print('')
+        print('######################################################')
+        print('# Logging on to ola.prod.code.seat.cloud.vwgroup.com #')
+        print('######################################################')
+        print(f"Initiating new session to Cupra/Seat Cloud with {credentials.get('username')} as username")
+        connection = Connection(session, BRAND, credentials.get('username'), credentials.get('password'), PRINTRESPONSE, nightlyUpdateReduction=False, anonymise=True, tripStatisticsStartDate='1970-01-01')
+        print("Attempting to login to the Seat Cloud service")
+        if await connection.doLogin(tokenFile=TOKEN_FILE_NAME_AND_PATH, apiKey=credentials.get('apiKey',None)):
+            print('Login or token refresh success!')
+            print(datetime.now())
+            print('Fetching user information for account.')
+            await connection.get_userData()
+            print(f"\tName: {connection._userData.get('name','')}")
+            print(f"\tNickname: {connection._userData.get('nickname','')}")
+            print(f"\tEmail: {connection._userData.get('email','')}")
+            print(f"\tPicture: {connection._userData.get('picture','')}")
+            print("")
+            print('Fetching vehicles associated with account.')
+            await connection.get_vehicles()
+
+            print('')
+            print('########################################')
+            print('#          Vehicles discovered         #')
+            print('########################################')
+            for vehicle in connection.vehicles:
+                print(f"\tVIN: {vehicle.vin}")
+                print(f"\tModel: {vehicle.model}")
+                print(f"\tManufactured: {vehicle.model_year}")
+                print(f"\tConnect service deactivated: {vehicle.deactivated}")
+                print("")
+                if vehicle.is_nickname_supported: print(f"\tNickname: {vehicle.nickname}")
+        else:
+            return False
+
+        for vehicle in connection.vehicles:
+            txt = vehicle.vin
+            print('########################################')
+            print('#     Export driving data to csv       #')
+            print(txt.center(40, '#'))
+            exportToCSV(vehicle, credentials.get('csvFileName','./drivingData.csv'), 'short') # possible value: short/cyclic
+            print('')
+            print('Export of driving data to csv complete')
+    sys.exit(1)
+
+if __name__ == "__main__":
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    loop.run_until_complete(main())
+