| Name | skodaconnect JSON |
| Version |
1.3.11
JSON |
| download |
| home_page | None |
| Summary | skodaconnect - A Python 3 library for interacting with Skoda Connect and Smartlink services. |
| upload_time | 2024-04-29 06:28:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# **Maintainers and contributors needed**
Keeping up with changes made by Skoda/VAG to the API requires coders with access to various cars and the ability to reverse engineer changes and new features into this project. Contributions in the form of raised issues and pull requests are much needed in order to maintain the functionality for all different models of Skoda cars.
Contributors and maintainers will naturally drift away from the project once they either no longer own a Skoda or move away from Home Assistant. As a results, there aren't really any long-term maintainers or contributors still active. But we do what we can to keep the project alive and up to date.
For questions, further help or contributions you can join the Discord server at https://discord.gg/826X9jEtCh.
# Skoda Connect
**UNOFFICIAL** library for communicating with Skoda Connect.
This project is a fork of https://github.com/robinostlund/volkswagencarnet, modified to support Skoda Connect, mimicking the MySkoda mobile app.
This is an API library for Skoda connected cars.
The library is reverse engineered by intercepting HTTP requests from
MySkoda app, there is no official API. Use at your own risk.
If the Skoda API changes, this library may stop working without warning.
While it might work for other use-cases, the primary purpose for this library is to be consumed by the https://github.com/skodaconnect/homeassistant-skodaconnect project.
## Information
Retrieve statistics about your Skoda from the Skoda Connect online service.
* Support for Skoda Connect services
* Support for SmartLink
* All (native) Skoda cars supported though newer cars (Skoda Enyaq iV) use newer API that's under development
* If your Skoda car don't work with the MySkoda app it won't work with this integration
## Breaking changes
- **From version 1.1.0** and onwards there has been changes to token handling, login procedure and overall mode streamlined code. Logins should now be significantly faster and reliable.
- **From version 1.0.40** and onwards there has been changes to Skoda API and this might break the integration for some cars.
- **From version 1.0.30** and onwards there might be breaking changes for the combustion heating/climatisation.
- **Parking Heater** is the auxiliary/parking heater for **non-PHEV** vehicles. This uses the "legacy" remotestandheizung API function.
Heating is what it sounds like and ventilation is used to ventilate/cool the car.
- **Auxiliary Heater** is the auxiliary/parking heater for **PHEV** vehicles. This uses the climater API function, same as electric climatisation.
## Installation
```sh
[venv-python3] user@localhost:~
$ pip install skodaconnect
```
### Example
For an extensive example, please use the code found in [example/example.py](example/example.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.
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.
#### Attributes
The Vehicle class contains all of the attributes with values fetched from the API.
To access a single attribute, please see and use the [example/example.py](example/example.py).
This will print all available methods, variables and properties as well as a list of supported attributes for discovered car.
#### Methods
Vehicle, in the following example the car object is an object of Vehicle class:
```
car.set_charger(action = "start") # action = "start" or "stop"
car.set_charger_current(value=<int/str> # value = integer 1-255 or Maximum/Reduced (For PHEV: 252=Reduced and 254=Maximum)
car.set_charge_limit(value=<int>) # value = integer 0-100 in 10 increments. Valid values is PHEV: 0-50, EV: 50-100.
car.set_battery_climatisation(mode = False) # mode = False or True
car.set_climatisation(mode = "auxilliary", spin="1234") # mode = "auxilliary", "electric", "off". SPIN only needed for aux heating
car.set_climatisation_temp(temperature = 22) # temperature = integer from 16 to 30
car.set_window_heating(action = "start") # action = "start" or "stop"
- car.set_window_heating(action = "enabled") # action = "enabled/disabled", enable/disable window heating for climatisation
car.set_lock(action = "unlock", spin = "1234") # action = "unlock" or "lock". spin = SPIN, needed for both
car.set_plug_autounlock(setting = "on") # setting = "on"/"off". Enable/disable auto unlock of plug when charged
car.set_pheater(mode = "heating", spin = "1234") # action = "heating", "ventilation" or "off". spin = SPIN, not needed for off
car.set_charge_limit(limit = 30) # limit = 0,10,20,30,40,50
car.set_timer_active(id = 1, action = "on"} # id = 1, 2, 3, action = "on" or "off".
car.set_timer_schedule(id = 1, schedule = dict) # id = 1, 2, 3, see example for full information about schedule variable
car.set_refresh() # Takes no arguments, will trigger force update
```
Connection:
```
session = aiohttp.ClientSession(headers={'Connection': 'keep-alive'}) # Create a aiohttp session object
conn = Connection(session, username, password, fulldebug) #
conn.doLogin() # Attempt a login, returns true/false, variable conn.
conn.get_vehicles() # Attempts to fetch all vehicles associated to account.
conn.update_all() # Calls update for all vehicle objects.
conn.logout() # Logout from API, call for revoke of tokens.
conn.terminate() # Terminate session, calls logout().
conn.get<method> # The get methods calls on API endpoints and returns data. See example.
conn.set<method> # The set methods calls on API endpoints to set config for vehicle.
```
Refrain from using methods starting with _, they are intended for internal use only.
## Building
We are using a `pyproject.toml` style of building, with `flit`.
To build your own version of skodaconnect, use the following steps:
1. Get the current source from GitHub
2. Make sure you have flit installed:
```
pip install flit
```
3. Build the project
```
flit build
```
## Thanks to
- [RobinostLund](https://github.com/robinostlund/volkswagencarnet) for initial project for Volkswagen Carnet which this is based on initially
- [lendy007](https://github.com/lendy007) for the initial release for Skoda cars
- [Farfar](https://github.com/Farfar) for modifications related to electric cars
- [tanelvakker](https://github.com/tanelvakker) for modifications related to correct SPIN handling for various actions and using correct URLs also for MY2021
- [wieshka](https://github.com/wieshka) for help with Skoda Enyaq iV development
- WebSpider and GAEvakYD from Discord for their help with fixing login form handling
Raw data
{
"_id": null,
"home_page": null,
"name": "skodaconnect",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "FarFar <faekie@hotmail.com>, dvx76 <fabrice.devaux@gmail.com>, WebSpider <bacardicoke@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/24/6e/f099f48be2a60cc883950fd84a6fd09dbdfa932d9e88d1e361418d3a302e/skodaconnect-1.3.11.tar.gz",
"platform": null,
"description": "\n\n\n\n# **Maintainers and contributors needed**\n\nKeeping up with changes made by Skoda/VAG to the API requires coders with access to various cars and the ability to reverse engineer changes and new features into this project. Contributions in the form of raised issues and pull requests are much needed in order to maintain the functionality for all different models of Skoda cars.\n\nContributors and maintainers will naturally drift away from the project once they either no longer own a Skoda or move away from Home Assistant. As a results, there aren't really any long-term maintainers or contributors still active. But we do what we can to keep the project alive and up to date.\n\nFor questions, further help or contributions you can join the Discord server at https://discord.gg/826X9jEtCh.\n\n# Skoda Connect\n\n**UNOFFICIAL** library for communicating with Skoda Connect.\n\nThis project is a fork of https://github.com/robinostlund/volkswagencarnet, modified to support Skoda Connect, mimicking the MySkoda mobile app.\n\nThis is an API library for Skoda connected cars.\nThe library is reverse engineered by intercepting HTTP requests from\nMySkoda app, there is no official API. Use at your own risk.\nIf the Skoda API changes, this library may stop working without warning.\n\nWhile it might work for other use-cases, the primary purpose for this library is to be consumed by the https://github.com/skodaconnect/homeassistant-skodaconnect project.\n\n## Information\n\nRetrieve statistics about your Skoda from the Skoda Connect online service.\n* Support for Skoda Connect services\n* Support for SmartLink\n* All (native) Skoda cars supported though newer cars (Skoda Enyaq iV) use newer API that's under development\n* If your Skoda car don't work with the MySkoda app it won't work with this integration\n\n## Breaking changes\n\n- **From version 1.1.0** and onwards there has been changes to token handling, login procedure and overall mode streamlined code. Logins should now be significantly faster and reliable.\n\n- **From version 1.0.40** and onwards there has been changes to Skoda API and this might break the integration for some cars.\n\n- **From version 1.0.30** and onwards there might be breaking changes for the combustion heating/climatisation.\n\n- **Parking Heater** is the auxiliary/parking heater for **non-PHEV** vehicles. This uses the \"legacy\" remotestandheizung API function.\nHeating is what it sounds like and ventilation is used to ventilate/cool the car.\n\n- **Auxiliary Heater** is the auxiliary/parking heater for **PHEV** vehicles. This uses the climater API function, same as electric climatisation.\n\n## Installation\n\n```sh\n[venv-python3] user@localhost:~\n$ pip install skodaconnect\n```\n\n### Example\n\nFor an extensive example, please use the code found in [example/example.py](example/example.py).\nWhen 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.\nMethod get_vehicles will fetch vehicle basic information and create Vehicle class objects for all associated vehicles in account.\nTo 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.\n\n#### Attributes\n\nThe Vehicle class contains all of the attributes with values fetched from the API.\nTo access a single attribute, please see and use the [example/example.py](example/example.py).\nThis will print all available methods, variables and properties as well as a list of supported attributes for discovered car.\n\n#### Methods\n\nVehicle, in the following example the car object is an object of Vehicle class:\n```\ncar.set_charger(action = \"start\") # action = \"start\" or \"stop\"\ncar.set_charger_current(value=<int/str> # value = integer 1-255 or Maximum/Reduced (For PHEV: 252=Reduced and 254=Maximum)\ncar.set_charge_limit(value=<int>) # value = integer 0-100 in 10 increments. Valid values is PHEV: 0-50, EV: 50-100.\ncar.set_battery_climatisation(mode = False) # mode = False or True\ncar.set_climatisation(mode = \"auxilliary\", spin=\"1234\") # mode = \"auxilliary\", \"electric\", \"off\". SPIN only needed for aux heating\ncar.set_climatisation_temp(temperature = 22) # temperature = integer from 16 to 30\ncar.set_window_heating(action = \"start\") # action = \"start\" or \"stop\"\n - car.set_window_heating(action = \"enabled\") # action = \"enabled/disabled\", enable/disable window heating for climatisation\ncar.set_lock(action = \"unlock\", spin = \"1234\") # action = \"unlock\" or \"lock\". spin = SPIN, needed for both\ncar.set_plug_autounlock(setting = \"on\") # setting = \"on\"/\"off\". Enable/disable auto unlock of plug when charged\ncar.set_pheater(mode = \"heating\", spin = \"1234\") # action = \"heating\", \"ventilation\" or \"off\". spin = SPIN, not needed for off\ncar.set_charge_limit(limit = 30) # limit = 0,10,20,30,40,50\ncar.set_timer_active(id = 1, action = \"on\"} # id = 1, 2, 3, action = \"on\" or \"off\".\ncar.set_timer_schedule(id = 1, schedule = dict) # id = 1, 2, 3, see example for full information about schedule variable\ncar.set_refresh() # Takes no arguments, will trigger force update\n```\n\nConnection:\n```\nsession = aiohttp.ClientSession(headers={'Connection': 'keep-alive'}) # Create a aiohttp session object\nconn = Connection(session, username, password, fulldebug) #\nconn.doLogin() # Attempt a login, returns true/false, variable conn.\nconn.get_vehicles() # Attempts to fetch all vehicles associated to account.\nconn.update_all() # Calls update for all vehicle objects.\nconn.logout() # Logout from API, call for revoke of tokens.\nconn.terminate() # Terminate session, calls logout().\nconn.get<method> # The get methods calls on API endpoints and returns data. See example.\nconn.set<method> # The set methods calls on API endpoints to set config for vehicle.\n```\nRefrain from using methods starting with _, they are intended for internal use only.\n\n## Building\nWe are using a `pyproject.toml` style of building, with `flit`.\nTo build your own version of skodaconnect, use the following steps:\n\n1. Get the current source from GitHub\n2. Make sure you have flit installed:\n```\npip install flit\n```\n3. Build the project\n```\nflit build\n```\n\n## Thanks to\n\n- [RobinostLund](https://github.com/robinostlund/volkswagencarnet) for initial project for Volkswagen Carnet which this is based on initially\n- [lendy007](https://github.com/lendy007) for the initial release for Skoda cars\n- [Farfar](https://github.com/Farfar) for modifications related to electric cars\n- [tanelvakker](https://github.com/tanelvakker) for modifications related to correct SPIN handling for various actions and using correct URLs also for MY2021\n- [wieshka](https://github.com/wieshka) for help with Skoda Enyaq iV development\n- WebSpider and GAEvakYD from Discord for their help with fixing login form handling\n\n",
"bugtrack_url": null,
"license": null,
"summary": "skodaconnect - A Python 3 library for interacting with Skoda Connect and Smartlink services.",
"version": "1.3.11",
"project_urls": {
"Bug Tracker": "https://github.com/skodaconnect/skodaconnect/issues",
"Homepage": "https://github.com/skodaconnect",
"Repository": "https://github.com/skodaconnect/skodaconnect.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e65cbf7d61cbe67e9c91a7365afe37e49488433612bc97ff015b413e6ed1fe8b",
"md5": "1dd891be1548c348d3eae3017d2db051",
"sha256": "57d65a51e54336a55126d560523460f4891b7d54e4dfd3d8e93e81cab658fbb2"
},
"downloads": -1,
"filename": "skodaconnect-1.3.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1dd891be1548c348d3eae3017d2db051",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 58758,
"upload_time": "2024-04-29T06:28:51",
"upload_time_iso_8601": "2024-04-29T06:28:51.646317Z",
"url": "https://files.pythonhosted.org/packages/e6/5c/bf7d61cbe67e9c91a7365afe37e49488433612bc97ff015b413e6ed1fe8b/skodaconnect-1.3.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "246ef099f48be2a60cc883950fd84a6fd09dbdfa932d9e88d1e361418d3a302e",
"md5": "3acd435f0656d9c17701a4e3259c3b58",
"sha256": "9b76c153b9a1fb8253d2da73793034b594685d5ab83ff4d93071f5b55211aa61"
},
"downloads": -1,
"filename": "skodaconnect-1.3.11.tar.gz",
"has_sig": false,
"md5_digest": "3acd435f0656d9c17701a4e3259c3b58",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 64499,
"upload_time": "2024-04-29T06:28:53",
"upload_time_iso_8601": "2024-04-29T06:28:53.538508Z",
"url": "https://files.pythonhosted.org/packages/24/6e/f099f48be2a60cc883950fd84a6fd09dbdfa932d9e88d1e361418d3a302e/skodaconnect-1.3.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 06:28:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "skodaconnect",
"github_project": "skodaconnect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "skodaconnect"
}
