myvsb-developer-api 0.1.4__tar.gz → 0.2.0__tar.gz

{myvsb_developer_api-0.1.4/src/myvsb_developer_api.egg-info → myvsb_developer_api-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: myvsb-developer-api
-Version: 0.1.4
+Version: 0.2.0
 Summary: Asynchronous Python library for the MyVSB Developer API
 Author-email: net0045 <stepan.netolicky@vsb.cz>
 Project-URL: Homepage, https://github.com/mobility-lab-vsb/myvsb-developer-api

{myvsb_developer_api-0.1.4 → myvsb_developer_api-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "myvsb-developer-api"
-version = "0.1.4"
+version = "0.2.0"
 authors = [
   { name="net0045", email="stepan.netolicky@vsb.cz" },
 ]

{myvsb_developer_api-0.1.4 → myvsb_developer_api-0.2.0}/src/myskoda_openapi/api_layer/open_api_client.py

@@ -9,6 +9,8 @@ from ..models.air_conditioning import AirConditioning
 from ..models.parking_position import ParkingPosition
 from ..models.auxiliary_heating import AuxiliaryHeating
 from ..models.charging import Charging
+from ..models.driving_range import FuelStatus
+from ..models.charging_profiles import ChargingProfiles
 
 class OpenAPIClient:
     """Client for interacting with rest API and used in HomeAssistant."""
@@ -52,9 +54,21 @@ class OpenAPIClient:
         return endpoint_result.result
     
     async def get_active_ventilation(self, vin: str) -> ActiveVentilation:
-        """Get the actual vehicle status and return the parsed Pydantic model."""
+        """Get the actual active ventilation and return the parsed Pydantic model."""
         endpoint_result = await self.rest_api.get_active_ventilation(vin)
         return endpoint_result.result
+
+    async def get_fuel_status(self, vin: str) -> FuelStatus:
+        """Get the actual fuel status and return the parsed Pydantic model."""
+        endpoint_result = await self.rest_api.get_fuel_status(vin)
+        return endpoint_result.result
+
+    async def get_charging_profiles(self, vin: str) -> ChargingProfiles:
+        """Get the actual charging profiles and return the parsed Pydantic model."""
+        endpoint_result = await self.rest_api.get_charging_profiles(vin)
+        return endpoint_result.result
+    
+
     
     async def start_air_conditioning(self, vin: str, temperature: float) -> None:
         """Starts the air conditioning for the vehicle with the given VIN."""

{myvsb_developer_api-0.1.4 → myvsb_developer_api-0.2.0}/src/myskoda_openapi/api_layer/rest_api.py

@@ -12,6 +12,8 @@ from ..models.parking_position import ParkingPosition
 from ..models.auxiliary_heating import AuxiliaryHeating
 from ..models.charging import Charging
 from ..models.active_ventilation import ActiveVentilation
+from ..models.charging_profiles import ChargingProfiles
+from ..models.driving_range import FuelStatus
 from .exceptions import (
     OpenApiError,
     OpenApiAuthenticationError,
@@ -194,6 +196,30 @@ class SkodaRestAPI:
         status_model = full_response.vehicle.active_ventilation
         
         return GetEndpointResult(url=url, raw_json=raw_json, result=status_model)
+
+    async def get_charging_profiles(self, vin: str) -> GetEndpointResult[Optional[ChargingProfiles]]:
+        """Retrieve ONLY the vehicle charging profiles object by filtering via the 'include' parameter."""
+        url = f"/api/v1/vehicles/{vin}"        
+        params = {"include": "chargingProfiles"}
+    
+        raw_json = await self._make_get_request(url, params=params)
+    
+        full_response = VehicleResponse.model_validate(raw_json)
+        status_model = full_response.vehicle.charging_profiles
+            
+        return GetEndpointResult(url=url, raw_json=raw_json, result=status_model)
+
+    async def get_fuel_status(self, vin: str) -> GetEndpointResult[Optional[FuelStatus]]:
+        """Retrieve ONLY the vehicle fuel status object by filtering via the 'include' parameter."""
+        url = f"/api/v1/vehicles/{vin}"        
+        params = {"include": "fuelStatus"}
+        
+        raw_json = await self._make_get_request(url, params=params)
+        
+        full_response = VehicleResponse.model_validate(raw_json)
+        status_model = full_response.vehicle.fuel_status
+                
+        return GetEndpointResult(url=url, raw_json=raw_json, result=status_model)
     
     # =========================================================================
     # ENDPOINT METHODS - POST

myvsb_developer_api-0.2.0/src/myskoda_openapi/models/charging_profiles.py

@@ -0,0 +1,46 @@
+from typing import List, Optional
+
+from .base_model import BaseModel
+
+class Timer(BaseModel):
+    """Details of the profiles timer."""
+    id: int
+    enabled: bool
+    time: Optional[str] = None
+    type: str
+    one_off_day: Optional[str] = None
+    recurring_on: Optional[List[str]] = None
+
+class ChargingTime(BaseModel):
+    """Details of the profiles' charging time."""
+    id: int
+    enabled: bool
+    start_time: str
+    end_time: str
+
+class MinBatteryStateOfCharge(BaseModel):
+    """Details of the minimum battery state of charge."""
+    enabled: Optional[bool] = None
+    minimum_battery_state_of_charge_in_percent: Optional[int] = None
+  
+class ChargingProfileSettings(BaseModel):
+    """Details of the charging profile settings."""
+    max_charging_current: Optional[str] = None
+    min_battery_state_of_charge: Optional[MinBatteryStateOfCharge] = None
+    target_state_of_charge_in_percent: Optional[int] = None
+    auto_unlock_plug_when_charged: Optional[str] = None
+
+class ChargingProfile(BaseModel):
+    """Details of the vehicle's charging profile."""
+    id: int
+    name: str
+    settings: ChargingProfileSettings
+    preferredChargingTimes: List[ChargingTime]
+    timers: List[Timer]
+
+
+class ChargingProfiles(BaseModel):
+    """Details of the vehicle's charging profiles."""
+    profiles: List[ChargingProfile]
+    current_vehicle_position_profile: Optional[ChargingProfile] = None
+    car_captured_timestamp: Optional[str] = None

{myvsb_developer_api-0.1.4 → myvsb_developer_api-0.2.0}/src/myskoda_openapi/models/driving_range.py

@@ -11,7 +11,7 @@ class EngineRange(BaseModel):
     remaining_range_in_km: Optional[int] = None
 
 
-class DrivingRange(BaseModel):
+class FuelStatus(BaseModel):
     """Details of the vehicle's fuel status and driving range."""
     car_type: Optional[str] = None
     ad_blue_range: Optional[int] = None

{myvsb_developer_api-0.1.4 → myvsb_developer_api-0.2.0}/src/myskoda_openapi/models/vehicle.py

@@ -10,8 +10,9 @@ from .parking_position import ParkingPosition
 from .auxiliary_heating import AuxiliaryHeating
 from .active_ventilation import ActiveVentilation
 from .charging import Charging
-from .driving_range import DrivingRange
+from .driving_range import FuelStatus
 from .air_conditioning import AirConditioning
+from .charging_profiles import ChargingProfiles
 
 class Odometer(BaseModel):
     """Odometer of the vehicle."""
@@ -30,8 +31,9 @@ class VehicleObject(BaseModel):
     auxiliary_heating: Optional[AuxiliaryHeating] = None
     active_ventilation: Optional[ActiveVentilation] = None
     air_conditioning: Optional[AirConditioning] = None
-    driving_range: Optional[DrivingRange] = None
+    fuel_status: Optional[FuelStatus] = None
     charging: Optional[Charging] = None
+    charging_profiles: Optional[ChargingProfiles] = None
 
 class VehicleResponse(BaseModel):
     """Response object for vehicle data."""

{myvsb_developer_api-0.1.4 → myvsb_developer_api-0.2.0/src/myvsb_developer_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: myvsb-developer-api
-Version: 0.1.4
+Version: 0.2.0
 Summary: Asynchronous Python library for the MyVSB Developer API
 Author-email: net0045 <stepan.netolicky@vsb.cz>
 Project-URL: Homepage, https://github.com/mobility-lab-vsb/myvsb-developer-api

{myvsb_developer_api-0.1.4 → myvsb_developer_api-0.2.0}/src/myvsb_developer_api.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ src/myskoda_openapi/models/air_conditioning.py
 src/myskoda_openapi/models/auxiliary_heating.py
 src/myskoda_openapi/models/base_model.py
 src/myskoda_openapi/models/charging.py
+src/myskoda_openapi/models/charging_profiles.py
 src/myskoda_openapi/models/common.py
 src/myskoda_openapi/models/driving_range.py
 src/myskoda_openapi/models/enums.py