pycupra 0.0.11__tar.gz → 0.0.13__tar.gz

{pycupra-0.0.11 → pycupra-0.0.13}/.gitignore

@@ -6,4 +6,5 @@ dist/
 __pycache__/
 *.json
 *.txt
+*.log
 www/

{pycupra-0.0.11/pycupra.egg-info → pycupra-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycupra
-Version: 0.0.11
+Version: 0.0.13
 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.0.11 → pycupra-0.0.13}/example/PyCupra.py

@@ -48,6 +48,7 @@ RESOURCES = [
 		"charging",
         "charge_rate",
         "charging_power",
+        "charging_state",
 		"charging_cable_connected",
 		"charging_cable_locked",
 		"charging_time_left",
@@ -204,9 +205,28 @@ async def demo_set_timer_schedule(vehicle):
         print("   Request failed.")
     return success
 
+async def demo_set_departure_profile_schedule(vehicle):
+    print('########################################')
+    print('#    Change one departure profile      #')
+    print('########################################')
+    success= await vehicle.set_departure_profile_schedule(id = 3,                             # id = 1, 2, 3
+        schedule = {                                               # Set the departure time, date and periodicity
+            "enabled": True,                                       # Set the timer active or not, True or False, required
+            "recurring": True,                                     # True or False for recurring, required
+            "time": "12:34",                                       # Time for departure, required
+            "days": "nyynnnn",                                     # Days (mon-sun) for recurring schedule (n=disable, y=enable), required if recurring=True
+            "chargingProgramId": 2,                                # Id of the charging program to be used for the departure profile
+            }
+        )
+    if success:
+        print("   Request completed successfully.")
+    else:
+        print("   Request failed.")
+    return success
+
 async def demo_set_timer_active(vehicle, id=1, action="off"):
     print('########################################')
-    print('#       Active/Deactivate one timer    #')
+    print('#         (De-)Activate one timer      #')
     print('########################################')
     success= await vehicle.set_timer_active(id, action)                # id = 1, 2, 3, action = "on" or "off".
     if success:
@@ -215,6 +235,17 @@ async def demo_set_timer_active(vehicle, id=1, action="off"):
         print("   Request failed.")
     return success
 
+async def demo_set_departure_profile_active(vehicle, id=1, action="off"):
+    print('########################################')
+    print('#  (De-)Activate one departure profile #')
+    print('########################################')
+    success= await vehicle.set_departure_profile_active(id, action)     # id = 1, 2, 3, action = "on" or "off".
+    if success:
+        print("   Request completed successfully.")
+    else:
+        print("   Request failed.")
+    return success
+
 async def demo_set_charge_limit(vehicle, limit=30):
     print('########################################')
     print('#     Change minimum charge limit      #')
@@ -502,6 +533,9 @@ async def main():
             #await demo_set_timer_active(vehicle, id=3, action="off")                 # id = 1, 2, 3, action = "on" or "off".
             #await demo_set_charge_limit(vehicle, 30)                                 # limit = PHEV: 0/10/20/30/40/50, EV: 50/60/70/80/90/100
             
+            #await demo_set_departure_profile_schedule(vehicle)                       # arguments id and schedule can be found in the demo function
+            #await demo_set_departure_profile_active(vehicle, id=3, action="off")                 # id = 1, 2, 3, action = "on" or "off".
+
             #await demo_set_lock(vehicle,action = "lock", 
             #                    spin = credentials.get('spin',''))                    # action = "unlock" or "lock". spin = SPIN, needed for both
 

{pycupra-0.0.11 → pycupra-0.0.13}/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.11"
+__version__ = "0.0.13"

{pycupra-0.0.11 → pycupra-0.0.13}/pycupra/const.py

@@ -125,6 +125,8 @@ AUTH_TOKENKEYS = 'https://identity.vwgroup.io/oidc/v1/keys'
 # API endpoints
 API_MBB_STATUSDATA = 'https://customer-profile.vwgroup.io/v3/customers/{self._user_id}/mbbStatusData'
 API_PERSONAL_DATA= 'https://customer-profile.vwgroup.io/v3/customers/{self._user_id}/personalData'
+#Other option for personal data is '{baseurl}/v1/users/{self._user_id}'
+
 API_VEHICLES = '{APP_URI}/v2/users/{self._user_id}/garage/vehicles'                                  # Garage info
 API_MYCAR = '{baseurl}/v5/users/{self._user_id}/vehicles/{vin}/mycar'                                # Vehicle status report
 API_CHARGING = '{baseurl}/v1/vehicles/{vin}/charging'                                                # Vehicle charging information 

{pycupra-0.0.11 → pycupra-0.0.13}/pycupra/dashboard.py

@@ -933,6 +933,31 @@ class RequestResults(Sensor):
     def attributes(self):
         return dict(self.vehicle.request_results)
 
+class ChargingState(BinarySensor):
+    def __init__(self):
+        super().__init__(attr="charging_state", name="Charging state", icon="mdi:battery-charging", device_class='power')
+
+    @property
+    def state(self):
+        return self.vehicle.charging_state
+
+    @property
+    def assumed_state(self):
+        return False
+
+    @property
+    def attributes(self):
+        attr = {}
+        state = self.vehicle.attrs.get('charging', {}).get('status', {}).get('state', '')
+        type = self.vehicle.attrs.get('charging', {}).get('status', {}).get('charging', {}).get('type', '')
+        mode = self.vehicle.attrs.get('charging', {}).get('status', {}).get('charging', {}).get('mode', '')
+        if state in {'charging', 'conservation'}:
+            attr['state']=state
+            if type != '':
+                attr['type']=type
+            if mode != '':
+                attr['mode']=mode
+        return attr
 
 def create_instruments():
     return [
@@ -960,6 +985,7 @@ def create_instruments():
         DepartureProfile1(),
         DepartureProfile2(),
         DepartureProfile3(),
+        ChargingState(),
         Sensor(
             attr="distance",
             name="Odometer",
@@ -1284,6 +1310,11 @@ def create_instruments():
             name="Energy flow",
             device_class="power"
         ),
+        #BinarySensor(
+        #    attr="charging_state",
+        #    name="Charging state",
+        #    device_class="power"
+        #),
         BinarySensor(
             attr="parking_light",
             name="Parking light",

{pycupra-0.0.11 → pycupra-0.0.13}/pycupra/vehicle.py

@@ -471,7 +471,7 @@ class Vehicle:
             raise SeatInvalidRequestException('Departure timers are not supported.')
 
     async def set_timer_schedule(self, id, schedule={}):
-        """ Set departure schedules. """
+        """ Set departure timer schedule. """
         data = {}
         # Validate required user inputs
         supported = "is_departure" + str(id) + "_supported"
@@ -518,7 +518,7 @@ class Vehicle:
                 if not 16 <= int(schedule.get("targetTemp", None)) <= 30:
                     raise SeatInvalidRequestException('Target temp must be integer value from 16 to 30')
                 else:
-                    data['temp'] = schedule.get('targetTemp')
+                    data['temp'] = int(schedule.get('targetTemp'))
                     raise SeatInvalidRequestException('Target temp (yet) not supported.')
 
             # Validate charge target and current
@@ -666,6 +666,98 @@ class Vehicle:
             self._requests['departuretimer'] = {'status': 'Exception'}
         raise SeatException('Failed to set departure timer schedule')
 
+    async def set_departure_profile_schedule(self, id, schedule={}):
+        """ Set departure profile schedule. """
+        data = {}
+        # Validate required user inputs
+        supported = "is_departure_profile" + str(id) + "_supported"
+        if getattr(self, supported) is not True:
+            raise SeatConfigException(f'Departure profile id {id} is not supported for this vehicle.')
+        else:
+            _LOGGER.debug(f'Departure profile id {id} is supported')
+        if not schedule:
+            raise SeatInvalidRequestException('A schedule must be set.')
+        if not isinstance(schedule.get('enabled', ''), bool):
+            raise SeatInvalidRequestException('The enabled variable must be set to True or False.')
+        if not isinstance(schedule.get('recurring', ''), bool):
+            raise SeatInvalidRequestException('The recurring variable must be set to True or False.')
+        if not re.match('^[0-9]{2}:[0-9]{2}$', schedule.get('time', '')):
+            raise SeatInvalidRequestException('The time for departure must be set in 24h format HH:MM.')
+
+        # Validate optional inputs
+        if schedule.get('recurring', False):
+            if not re.match('^[yn]{7}$', schedule.get('days', '')):
+                raise SeatInvalidRequestException('For recurring schedules the days variable must be set to y/n mask (mon-sun with only wed enabled): nnynnnn.')
+        elif not schedule.get('recurring'):
+            if not re.match('^[0-9]{4}-[0-9]{2}-[0-9]{2}$', schedule.get('date', '')):
+                raise SeatInvalidRequestException('For single departure profile schedule the date variable must be set to YYYY-mm-dd.')
+
+        if self._relevantCapabilties.get('departureProfiles', {}).get('active', False):
+            # Check if profileIds is set and correct
+            if schedule.get('chargingProgramId', False):
+                # At the moment, only one charging program id is supported
+                chargingProgramId = int(schedule.get('chargingProgramId', False))
+                found = False
+                for chargingProgram in self.attrs.get('departureProfiles', {}).get('profileIds', []):
+                    if chargingProgram.get('id',None) == chargingProgramId:
+                        found = True
+                        break
+                if not found:
+                    raise SeatInvalidRequestException('The charging program id provided for the departure profile schedule is unknown.')
+                else:
+                    profileIds = []
+                    profileIds.append(chargingProgramId)
+            else:
+                raise SeatInvalidRequestException('No charging program id provided for departure profile schedule.')
+
+            newDepProfileSchedule = {}
+            # Prepare data and execute
+            newDepProfileSchedule['id'] = id
+            # Converting schedule to data map
+            if schedule.get("enabled",False):
+                newDepProfileSchedule['enabled']=True
+            else:
+                newDepProfileSchedule['enabled']=False
+            if schedule.get("recurring",False):
+                newDepProfileSchedule['recurringTimer']= {
+                    "startTime": schedule.get('time',"00:00"),
+                    "recurringOn":{""
+                        "mondays":(schedule.get('days',"nnnnnnn")[0]=='y'),
+                        "tuesdays":(schedule.get('days',"nnnnnnn")[1]=='y'),
+                        "wednesdays":(schedule.get('days',"nnnnnnn")[2]=='y'),
+                        "thursdays":(schedule.get('days',"nnnnnnn")[3]=='y'),
+                        "fridays":(schedule.get('days',"nnnnnnn")[4]=='y'),
+                        "saturdays":(schedule.get('days',"nnnnnnn")[5]=='y'),
+                        "sundays":(schedule.get('days',"nnnnnnn")[6]=='y'),
+                    }
+                }
+            else:
+                if self._relevantCapabilties.get('departureProfiles', {}).get('supportsSingleTimer', False):
+                    startDateTime = datetime.fromisoformat(schedule.get('date',"2025-01-01")+'T'+schedule.get('time',"00:00"))
+                    _LOGGER.info(f'startDateTime={startDateTime.isoformat()}')
+                    newDepProfileSchedule['singleTimer']= {
+                        "startDateTimeLocal": startDateTime.isoformat(),
+                        }
+                else:
+                    raise SeatInvalidRequestException('Vehicle does not support single timer.')
+            newDepProfileSchedule["profileIds"]= profileIds
+
+            # Now we have to substitute the current departure profile schedule with the given id by the new one
+            data= deepcopy(self.attrs.get('departureProfiles'))
+            if len(data.get('timers', []))<1:
+                raise SeatInvalidRequestException(f'No timers found in departure profile: {data}.')
+            idFound=False
+            for e in range(len(data.get('timers', []))):
+                if data['timers'][e].get('id',-1)==id:
+                    data['timers'][e] = newDepProfileSchedule
+                    idFound=True
+            if idFound:
+                return await self._set_departure_profiles(data, action='set')
+            raise SeatInvalidRequestException(f'Departure profile id {id} not found in {data.get('timers',[])}.')
+        else:
+            _LOGGER.info('Departure profiles are not supported.')
+            raise SeatInvalidRequestException('Departure profiles are not supported.')
+
     async def set_departure_profile_active(self, id=1, action='off'):
         """ Activate/deactivate departure profiles. """
         data = {}
@@ -1552,18 +1644,36 @@ class Vehicle:
             return True
 
     @property
-    def energy_flow(self):
-        """Return true if energy is flowing through charging port."""
-        check = self.attrs.get('charger', {}).get('status', {}).get('chargingStatusData', {}).get('energyFlow', {}).get('content', 'off')
-        if check == 'on':
+    def charging_state(self):
+        """Return true if vehicle is charging."""
+        check = self.attrs.get('charging', {}).get('status', {}).get('state', '')
+        if check == 'charging':
             return True
         else:
             return False
 
+    @property
+    def is_charging_state_supported(self):
+        """Charging state supported."""
+        if self.attrs.get('charging', {}).get('status', {}).get('state', False):
+            return True
+
+    @property
+    def energy_flow(self):
+        """Return true if energy is flowing to (i.e. charging) or from (i.e. climating with battery power) the battery."""
+        if self.charging_state:
+            return True
+        check = self.attrs.get('charging', {}).get('status', {}).get('state', '')
+        if self.is_electric_climatisation_supported:
+            if self.electric_climatisation and check not in {'charging', 'conservation'}:
+                # electric climatisation is on and car is not charging or conserving power 
+                return True
+        return False
+
     @property
     def is_energy_flow_supported(self):
         """Energy flow supported."""
-        if self.attrs.get('charger', {}).get('status', {}).get('chargingStatusData', {}).get('energyFlow', False):
+        if self.is_charging_state_supported:
             return True
 
   # Vehicle location states

{pycupra-0.0.11 → pycupra-0.0.13/pycupra.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pycupra
-Version: 0.0.11
+Version: 0.0.13
 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