Skip to content

Latest commit

 

History

History
104 lines (88 loc) · 3.25 KB

api.md

File metadata and controls

104 lines (88 loc) · 3.25 KB

OSAIS API

Oasis API expect user input orig point, destination point and vehicle information, it will select needed charge station to achieve the trip and return them as waypoints.

Input

The input contains information related with user's vehicle status, where to go and specific settings.

  • Orig point
  • Dest point
  • Max charge range
  • Current electric range
  • Preferred charge buffer level
  • Safe charge level
  • Curve
Option Values Descriptions Comments
max_range float(meters) Max range if fully charged
curr_range float(meters) Distance represent current electric level
prefer_level float(meters) Preferred charge buffer level more info
safe_level float(meters) Safe charge level more info
curve string TBD

Input Example

/oasis/v1/earliest/-82.058695,35.036645;-81.89309,34.97914?max_range=500000.0&curr_range=160000.0

Response

Response contains information for charge station needed to complete the route.

Response Example

[
{
  "distance": 90.0,
  "duration": 300.0,
  "estimate_remaining_range":100000.0,
  "weight": 300.0,
  "weight_name": "duration",
  "charge_stations": [
    {
      "address" : [
               {
                      "geo_coordinates": {
                                "latitude": 37.78509,  
                                 "longitude": -122.41988
                       },
                      "nav_coordinates": [
                                  {
                                           "latitude": 37.78509,
                                           "longitude": -122.41988
                                  }
                       ]
               }
       ],
      "wait_time" : 30.0,
      "charge_time": 100.0,
      "charge_range": 100.0,
       "detail_url":"url from search component which could retrieve charge station's information"
    },
    {
      "address" : [
               {
                      "geo_coordinates": {
                                "latitude": 13.40677,  
                                 "longitude": 52.53333
                       },
                      "nav_coordinates": [
                                  {
                                           "latitude": 13.40677,
                                           "longitude": 52.53333
                                  }
                       ]
               }
       ],
      "wait_time": 100.0,
      "charge_time": 100.0,
      "charge_range": 100.0,
      "detail_url":"url from search component which could retrieve charge station's information"
    },
  ]
}

]

Reference