diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2a6a591..9fbfa47 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,7 +6,9 @@ labels: '' assignees: '' --- - + **Describe the bug** A clear and concise description of what the bug is. @@ -16,7 +18,7 @@ Steps to reproduce the behavior: 1. what command did you use 2. when the bug append ? 3. Does it persist after restarting the program? -4. Does it persist after recreate config by going to http://server_address:port/log/config? +4. Does it persist after recreate config by going to http://server_address:port/config? **Config file** Give the anonymize content of the config file @@ -24,7 +26,7 @@ Give the anonymize content of the config file **Environment (please complete the following information):** - OS: [e.g. Windows] - Brand and model of car - - Application version (commit number, branch) + - Application version (commit number, branch or tag) - Log from http://server_address:port/log and browser console log **Additional context** diff --git a/FAQ.md b/FAQ.md index 884c1d4..7180c03 100644 --- a/FAQ.md +++ b/FAQ.md @@ -6,7 +6,7 @@ If the car isn't in the list we need to add it, to do so you have two options: - If you have the skills : You can add your car to the list yourself to do so look at [this example](https://github.com/flobz/psa_car_controller/pull/112/commits/e7304ef8f4e4a4498f202a7a4a7bbe451fbfe977). -You will need the abrp name of the car, to get it go [here](https://api.iternio.com/1/tlm/get_carmodels_list?api_key=32b2162f-9599-4647-8139-66e9f9528370). +You will need the VIN of your vehicle and the car abrp name, to get it go [here](https://api.iternio.com/1/tlm/get_carmodels_list?api_key=32b2162f-9599-4647-8139-66e9f9528370). Don't forget to do a pull request with your changes. @@ -45,5 +45,5 @@ If you have an error more or less like this one: ``` [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1056) ``` -It's a problem on PSA server so don't open an issue, you just have to wait. +It's a problem on PSA server so don't open an issue, you can retry a second time and if it still doesn't work you just have to wait. You can look to issue about this problem [here](https://github.com/flobz/psa_car_controller/search?q=ssl&type=issues). diff --git a/README.md b/README.md index 3dac4e1..f3f1245 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/f4082f146ad044bb900e1683035a540b)](https://www.codacy.com/gh/flobz/psa_car_controller/dashboard?utm_source=github.com&utm_medium=referral&utm_content=flobz/psa_car_controller&utm_campaign=Badge_Coverage) [![Publish Docker image](https://github.com/flobz/psa_car_controller/actions/workflows/Docker_build.yml/badge.svg?branch=master)](https://hub.docker.com/repository/docker/flobz/psa_car_controller) [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/donate?hosted_button_id=SM652WPXFNCXS) -### This is a python program to control a psa car with connected_car v4 api. Using android app to retrieve credentials. +### This is a python program to control and get information from a PSA car. I test it with a Peugeot e-208, but it works with others PSA vehicles (Citroen, Opel, Vauxhall, DS). With this app you will be able to : diff --git a/api_spec.md b/api_spec.md index 6896e7a..d2b42e0 100644 --- a/api_spec.md +++ b/api_spec.md @@ -1,5 +1,19 @@ # psa-connectedcar -*PSA B2C Connected Car API* # Introduction This is the description of the *Groupe PSA Connected Car V2 API*. The speccification is is based on **OpenAPI Specification version 3** and can be displayed via [ReDoc](https://github.com/Rebilly/ReDoc)a or [Swagger](http://swagger.io). This API allows applications to fetch data from the connected Vehicles data platform. # Authentication PSA Connected Car APIs uses the [OAuth 2.0](https://tools.ietf.org/html/rfc6749) protocol for authentication and Authorization. any application require a valid [Access Token](https://tools.ietf.org/html/rfc6749#section-1.4) to access to user data. # Errors Error codes returned by all REST APIs comply with the standard. Nevertheless, PSA Services (callers) need to have more complete data structures (even when the answer is not Http-OK) to better detail the type of error by providing application code, message and a debugging code(for investigation purposes). The http code of the response is managed by the protocol itself (in the header). **Errors are returned as a generic error response:** * ```xError``` object model. +*PSA B2C Connected Car API* + +# Introduction +This is the description of the *Groupe PSA Connected Car V2 API*. The speccification is is based on **OpenAPI Specification version 3** and can be displayed via [ReDoc](https://github.com/Rebilly/ReDoc)a or [Swagger](http://swagger.io). + +This API allows applications to fetch data from the connected Vehicles data platform. + +# Authentication +PSA Connected Car APIs uses the [OAuth 2.0](https://tools.ietf.org/html/rfc6749) protocol for authentication and Authorization. any application require a valid [Access Token](https://tools.ietf.org/html/rfc6749#section-1.4) to access to user data. + +# Errors +Error codes returned by all REST APIs comply with the standard. Nevertheless, PSA Services (callers) need to have more complete data structures (even when the answer is not Http-OK) to better detail the type of error by providing application code, message and a debugging code(for investigation purposes). The http code of the response is managed by the protocol itself (in the header). + +**Errors are returned as a generic error response:** +* ```xError``` object model. This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: diff --git a/docs/Install.md b/docs/Install.md index e93c5ec..152d076 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -1,10 +1,6 @@ # Installation -We need to get credentials from the android app. -We will retrieve this information: - - client-id and client-secret for the api - - some url to login -1.1 Download the app on your computer, the original MyPeugeot app can be downloaded [here](https://apkpure.com/fr/mypeugeot-app/com.psa.mym.mypeugeot/download/2107-APK?from=versions%2Fversion) for example (please download version **1.27**). +1.1 Download the app on your computer. 1.2 Install requirements :