/ovms-link

Primary LanguageJavaScript

README

A Better Routeplanner (ABRP) is an electric vehicle (EV) focussed route planner that incorporates planning of EV charging stops.

This OVMS plugin sends live telemetry data from the vehicle to ABRP to be used for the route planning process and appropriate updates to the plan along the way based on live information.

Installation

Obtain Live Data Token

  1. Register with A Better Routeplanner (ABRP) and login
  2. Setup your vehicle, starting with Select car model
  3. In the settings for the new vehicle, click on the Live data button to generate a generic token. Keep a record of this token

Install the abrp.js Plugin in OVMS

  1. Login to the OVMS web console
  2. Navigate to the Tools -> Editor menu item
  3. Create a new lib directory in /store/scripts if it does not exist
  4. Create a new abrp.js file in the /store/scripts/lib directory
  5. Copy the content of the lib/abrp.js file in this repository to that new file and save
  6. Create a new ovmsmain.js file in /store/scripts if it does not exist
  7. Copy the content of the ovmsmain.js file in this repository to that new file and Save

Install the "GoDaddy Class 2 Certification Authority Root Certificate - G2" in OVMS

A recent change to the APRB API means a new CA certificate is required. This requires a "GoDaddy Class 2 Certification Authority Root Certificate - G2" (gdroot-g2.crt) to be installed into OVMS as per the instructions at the OVMS SSL/TLS UserGuide

The gdroot-g2.crt can be downloaded from the GoDaddy Certs Repository.

  1. Login to the OVMS web console
  2. Navigate to the Tools -> Editor menu item
  3. Create a new trustedca directory in /store/ if it does not exist
  4. Create a new gdroot-g2.crt file in the /store/trustedca directory
  5. Copy the contents of the gdroot-g2.crt file into that file
  6. Navigate to the Tools -> Shell menu item
  7. Execute the following message: tls trust reload
  8. Execute the following message: tls trust list and confirm that gdroot-g2.crt shows up in the list

Configure Plugin

  1. Navigate to Tools -> Shell in the OVMS web console

  2. In the OVMS shell issue the following command substituting <token> with the live data generic token that was set up for the vehicle in ABRP

    config set usr abrp.user_token <token>

Reload the JS Engine

  1. Navigate to Tools -> Editor in the OVMS web console and press the Reload JS Engine button. This should result in an ABRP::started notification if the plugin is installed and configured correctly.

Usage

With the configuration described above the ABRP plugin will automatically send live telemetry from the vehicle to ABRP on a periodic basis. When data is sent depends on what is happening for the vehicle. For example, when driving, information will be sent more frequently than when charging, and even less often when the car is off.

OVMS Shell Commands

  • script eval abrp.info() - display vehicle telemetry that would be sent to ABRP
  • script eval abrp.onetime() - send current telemetry to ABRP once only
  • script eval abrp.send(1) - start periodically sending telemetry to ABRP (when necessary)
  • script eval abrp.send(0) - stop sending telemetry
  • script eval abrp.resetConfig() - reset configuration