Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjne/pyporscheconnectapi
Python client library for Porsche Connect API
https://github.com/cjne/pyporscheconnectapi
Last synced: 6 days ago
JSON representation
Python client library for Porsche Connect API
- Host: GitHub
- URL: https://github.com/cjne/pyporscheconnectapi
- Owner: CJNE
- License: mit
- Created: 2021-01-28T22:14:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T16:02:27.000Z (6 days ago)
- Last Synced: 2024-12-16T16:47:00.656Z (6 days ago)
- Language: Python
- Size: 159 KB
- Stars: 48
- Watchers: 11
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyporscheconnectapi
A python library for Porsche Connect API
This library will let you access your car equipped with Porsche Connect. It does not work with the predecessor Porsche Car Connect.
Porsche Connect is available for the following Porsche models:
* Boxster & Cayman (718)
* 911 (from 992)
* Taycan
* Panamera (from 2021, G2 PA)
* Macan (EV, from 2024)
* Cayenne (from 2017, E3)
You can also take a look here, select your model and see if your model has support for Porsche Connect:
https://connect-store.porsche.com/
A Porsche Connect subscription alse needs to be active for it to work.
*NOTE:* This work is not officially supported by Porsche and functionality can stop working at any time without warning.
## Installation
The easiest method is to install using pip3/pip (venv is also a good idea).
```
pip install pyporscheconnectapi
```
to update to the latest version
```
pip install pyporscheconnectapi -U
```
Setup will add a cli under the name porschecli, see below for usage.
## CLI usage
A simple cli is provided with this library, it will cache tokens to a file to speed up invocations.
If no email or password is supplied as input arguments and no config file with those details is found you will be prompted.
```
usage: porschecli [-h] [-d] [-e EMAIL] [-p PASSWORD] [-s SESSION_FILE] [--nowait]
{list,token,capabilities,currentoverview,storedoverview,trip_statistics,pictures,location,climatise_on,climatise_off,direct_charge_on,direct_charge_off,flash_indicators,honk_and_flash,lock_vehicle,unlock_vehicle,vehicle_closed,doors_and_lids,tire_pressure_status,tire_pressures,chargingprofile}
...
Porsche Connect CLI
positional arguments:
{list,token,capabilities,currentoverview,storedoverview,trip_statistics,pictures,location,climatise_on,climatise_off,direct_charge_on,direct_charge_off,flash_indicators,honk_and_flash,lock_vehicle,unlock_vehicle,vehicle_closed,doors_and_lids,tire_pressure_status,tire_pressures,chargingprofile}
command help
capabilities Get vehicle capabilities
currentoverview Get stored overview for vehicle
storedoverview Poll vehicle for current overview
trip_statistics Get trip statistics from backend
pictures Get vehicle pictures url
location Show location of vehicle
climatise_on Start remote climatisation
climatise_off Stop remote climatisation
direct_charge_on Enable direct charging
direct_charge_off Disable direct charging
flash_indicators Flash indicators
honk_and_flash Flash indicators and sound the horn
lock_vehicle Lock vehicle
unlock_vehicle Unlock vehicle
vehicle_closed Check if all doors and lids are closed
doors_and_lids List status of all doors and lids
tire_pressure_status
Check if tire pressure are ok
tire_pressures Get tire pressure readings
chargingprofile Update parameters in configured charging profile
options:
-h, --help show this help message and exit
-d, --debug
-e EMAIL, --email EMAIL
-p PASSWORD, --password PASSWORD
-s SESSION_FILE, --sessionfile SESSION_FILE
--nowait
```
## Config file (for CLI)
A config file is searched for in ~/.porscheconnect.cfg and ./.porscheconnect.cfg
The format is:
```
[porsche]
email=
password=
session_file=
```
## Library usage
Install pyporscheconnectapi using pip (requires python > 3.6)
### Example client usage
Please refer to the examples provided in the repository.