From: Giorgio Ravera <47370115+xraver@users.noreply.github.com> Date: Tue, 29 Sep 2020 11:04:47 +0000 (+0200) Subject: Update README.md X-Git-Tag: v0.1~3 X-Git-Url: http://git.giorgioravera.it/?a=commitdiff_plain;h=8dfac72f543174b0a6ea2a59819253e90f47997e;p=mercedes_me_api.git Update README.md Updated README.md --- diff --git a/README.md b/README.md index e94e5e5..181a0a7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # mercedes_me_api Script to interface with Mercedes Me APIs -# Pre-Requirements +## Pre-Requirements 1) Own a Mercedes Benz Car with Mercedes Me installed and working. 2) Create an application in https://developer.mercedes-benz.com/ 3) Register to the following APIs: @@ -11,7 +11,7 @@ Script to interface with Mercedes Me APIs Note: the APIs described above do not requires any subscription in case you use them with your own car associated the the Mercedes Me Account. -# Installation +## Installation To use this script it's necessary to perform the following instructions: 1) clone the repository 2) create a credentials files (.mercedes_credentials) with: @@ -23,20 +23,25 @@ To use this script it's necessary to perform the following instructions: where CLIENT_ID and CLIENT_SECRET referring to the application information that can be found in [Mercedes Developer Console](https://developer.mercedes-benz.com/console) and VEHICLE_ID is the VIN of your car. +## Usage +To execute the script read below: +```bash +Usage: mercedes_me_api.sh -# Usage -To execute the script the command is: - -> $ ./mercedes_me_api.sh +Example: mercedes_me_api.sh --token --fuel + or: mercedes_me_api.sh -l The possible arguments are: - -> -t, --token Procedure to obtatin the Access Token (stored into .mercedes_token) - -> -r, --refresh Procedure to refresh the Access Token (stored into .mercedes_token) - -> -f, --fuel Retrive the Fuel Status of your Vehicle - -> -l, --lock Retrive the Lock Status of your Vehicle - -> -s, --status Retrive the General Status of your Vehicle + -t, --token Procedure to obtatin the Access Token (stored into .mercedes_token) + -r, --refresh Procedure to refresh the Access Token (stored into .mercedes_token) + -f, --fuel Retrive the Fuel Status of your Vehicle + -l, --lock Retrive the Lock Status of your Vehicle + -s, --status Retrive the General Status of your Vehicle +``` +## License +[MIT](http://opensource.org/licenses/MIT) © Giorgio Ravera + +## Donate +If you want to offer me a coffee: + +[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/xraver)