CLI Usage¶
renault-api¶
Main entry point for the Renault CLI.
Usage
renault-api [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show the version and exit.
- --debug¶
Display debug traces.
- --log¶
Log debug traces to file.
- --json¶
Return data as JSON
- --locale <locale>¶
API locale (eg. fr_FR)
- --account <account>¶
Kamereon account ID to use
- --vin <vin>¶
Vehicle VIN to use
accounts¶
Display list of accounts.
Usage
renault-api accounts [OPTIONS]
charge¶
Charge functionality.
Usage
renault-api charge [OPTIONS] COMMAND [ARGS]...
history¶
Display charge history.
Usage
renault-api charge history [OPTIONS]
Options
- --period <period>¶
Period over which to aggregate.
- Options:
day | month
- --to <end>¶
Required Date to finish showing history at (cannot be in the future)
- --from <start>¶
Required Date to start showing history from
mode¶
Display or set charge mode.
Usage
renault-api charge mode [OPTIONS]
Options
- --set <set>¶
Target charge mode (schedule_mode/always/always_schedule)
schedule¶
Display or update charge schedules.
Usage
renault-api charge schedule [OPTIONS] COMMAND [ARGS]...
activate¶
Activate charging schedule {ID}.
Usage
renault-api charge schedule activate [OPTIONS] ID
Arguments
- ID¶
Required argument
deactivate¶
Deactivate charging schedule {ID}.
Usage
renault-api charge schedule deactivate [OPTIONS] ID
Arguments
- ID¶
Required argument
set¶
Update charging schedule {ID}.
Usage
renault-api charge schedule set [OPTIONS] ID
Options
- --monday <monday>¶
Monday schedule in format hh:mm,duration (for local timezone) or Thh:mmZ,duration (for utc) or clear to unset.
- --tuesday <tuesday>¶
Tuesday schedule in format hh:mm,duration (for local timezone) or Thh:mmZ,duration (for utc) or clear to unset.
- --wednesday <wednesday>¶
Wednesday schedule in format hh:mm,duration (for local timezone) or Thh:mmZ,duration (for utc) or clear to unset.
- --thursday <thursday>¶
Thursday schedule in format hh:mm,duration (for local timezone) or Thh:mmZ,duration (for utc) or clear to unset.
- --friday <friday>¶
Friday schedule in format hh:mm,duration (for local timezone) or Thh:mmZ,duration (for utc) or clear to unset.
- --saturday <saturday>¶
Saturday schedule in format hh:mm,duration (for local timezone) or Thh:mmZ,duration (for utc) or clear to unset.
- --sunday <sunday>¶
Sunday schedule in format hh:mm,duration (for local timezone) or Thh:mmZ,duration (for utc) or clear to unset.
Arguments
- ID¶
Required argument
show¶
Display charge schedules.
Usage
renault-api charge schedule show [OPTIONS]
sessions¶
Display charge sessions.
Usage
renault-api charge sessions [OPTIONS]
Options
- --to <end>¶
Required Date to finish showing history at (cannot be in the future)
- --from <start>¶
Required Date to start showing history from
soclevels¶
Display or update charge SoC levels.
Usage
renault-api charge soclevels [OPTIONS] COMMAND [ARGS]...
set¶
Set battery soc levels.
Usage
renault-api charge soclevels set [OPTIONS]
Options
- --min <min>¶
Required Minimum state of charge level to set
- --target <target>¶
Required Target state of charge level to set
show¶
Display battery soc levels.
Usage
renault-api charge soclevels show [OPTIONS]
start¶
Start charging with optional delay.
Usage
renault-api charge start [OPTIONS]
Options
- --at <at>¶
Date/time at which to start charging. (defaults to immediate if not given). You can use times like ‘in 5 minutes’ or ‘tomorrow at 9am’.
stop¶
Stop charge.
Usage
renault-api charge stop [OPTIONS]
contracts¶
Display vehicle contracts.
Usage
renault-api contracts [OPTIONS]
horn¶
Start horn.
Usage
renault-api horn [OPTIONS]
http¶
Raw HTTP.
Usage
renault-api http [OPTIONS] COMMAND [ARGS]...
get¶
Process HTTP GET request on endpoint.
Usage
renault-api http get [OPTIONS] ENDPOINT
Arguments
- ENDPOINT¶
Required argument
post¶
Process HTTP POST request on endpoint.
Usage
renault-api http post [OPTIONS] ENDPOINT JSON_BODY
Arguments
- ENDPOINT¶
Required argument
- JSON_BODY¶
Required argument
post-file¶
Process HTTP POST request on endpoint.
Usage
renault-api http post-file [OPTIONS] ENDPOINT JSON_BODY
Arguments
- ENDPOINT¶
Required argument
- JSON_BODY¶
Required argument
hvac¶
HVAC functionality.
Usage
renault-api hvac [OPTIONS] COMMAND [ARGS]...
cancel¶
Cancel air conditioning.
Usage
renault-api hvac cancel [OPTIONS]
history¶
Display air conditioning history.
Usage
renault-api hvac history [OPTIONS]
Options
- --period <period>¶
Period over which to aggregate.
- Options:
day | month
- --to <end>¶
Required Date to finish showing history at (cannot be in the future)
- --from <start>¶
Required Date to start showing history from
sessions¶
Display air conditioning sessions.
Usage
renault-api hvac sessions [OPTIONS]
Options
- --to <end>¶
Required Date to finish showing history at (cannot be in the future)
- --from <start>¶
Required Date to start showing history from
start¶
Start air conditioning.
Usage
renault-api hvac start [OPTIONS]
Options
- --temperature <temperature>¶
Required Target temperature (in Celsius)
- --at <at>¶
Date/time at which to complete preconditioning (defaults to immediate if not given). You can use times like ‘in 5 minutes’ or ‘tomorrow at 9am’.
lights¶
Start lights.
Usage
renault-api lights [OPTIONS]
login¶
Login to Renault.
Usage
renault-api login [OPTIONS]
Options
- --user <user>¶
- --password <password>¶
reset¶
Clear all credentials/settings from the credential store.
Usage
renault-api reset [OPTIONS]
set¶
Store specified settings into credential store.
Usage
renault-api set [OPTIONS]
Options
- --locale <locale>¶
API locale (eg. fr_FR)
- --account <account>¶
Kamereon account ID to use for future calls
- --vin <vin>¶
Vehicle VIN to use for future calls
settings¶
Display the current configuration keys.
Usage
renault-api settings [OPTIONS]
status¶
Display vehicle status.
Usage
renault-api status [OPTIONS]
vehicle¶
Display vehicle details.
Usage
renault-api vehicle [OPTIONS]
vehicles¶
Display list of vehicles.
Usage
renault-api vehicles [OPTIONS]