CLI Usage

renault-api

Main entry point for the Renault CLI.

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.

renault-api accounts [OPTIONS]

charge

Charge functionality.

renault-api charge [OPTIONS] COMMAND [ARGS]...

history

Display charge history.

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.

renault-api charge mode [OPTIONS]

Options

--set <set>

Target charge mode (schedule_mode/always/always_schedule)

schedule

Display or update charge schedules.

renault-api charge schedule [OPTIONS] COMMAND [ARGS]...
activate

Activate charging schedule {ID}.

renault-api charge schedule activate [OPTIONS] ID

Arguments

ID

Required argument

deactivate

Deactivate charging schedule {ID}.

renault-api charge schedule deactivate [OPTIONS] ID

Arguments

ID

Required argument

set

Update charging schedule {ID}.

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.

renault-api charge schedule show [OPTIONS]

sessions

Display charge sessions.

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

start

Start charge.

renault-api charge start [OPTIONS]

stop

Stop charge.

renault-api charge stop [OPTIONS]

contracts

Display vehicle contracts.

renault-api contracts [OPTIONS]

http

Raw HTTP.

renault-api http [OPTIONS] COMMAND [ARGS]...

get

Process HTTP GET request on endpoint.

renault-api http get [OPTIONS] ENDPOINT

Arguments

ENDPOINT

Required argument

post

Process HTTP POST request on endpoint.

renault-api http post [OPTIONS] ENDPOINT JSON_BODY

Arguments

ENDPOINT

Required argument

JSON_BODY

Required argument

post-file

Process HTTP POST request on endpoint.

renault-api http post-file [OPTIONS] ENDPOINT JSON_BODY

Arguments

ENDPOINT

Required argument

JSON_BODY

Required argument

hvac

HVAC functionality.

renault-api hvac [OPTIONS] COMMAND [ARGS]...

cancel

Cancel air conditioning.

renault-api hvac cancel [OPTIONS]

history

Display air conditioning history.

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.

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.

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’.

login

Login to Renault.

renault-api login [OPTIONS]

Options

--user <user>
--password <password>

reset

Clear all credentials/settings from the credential store.

renault-api reset [OPTIONS]

set

Store specified settings into credential store.

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.

renault-api settings [OPTIONS]

status

Display vehicle status.

renault-api status [OPTIONS]

vehicle

Display vehicle details.

renault-api vehicle [OPTIONS]

vehicles

Display list of vehicles.

renault-api vehicles [OPTIONS]