Oasis API design

[CodeBear801]

Subtask of #120. API design for POC. For deployment information, could go to here.

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

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

The unit is alined with OSRM, distance's unit is meter, time's unit is second

Response

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

[
{
  "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

• https://github.com/Telenav/osrm-backend/blob/master-telenav/docs/http.md

[CodeBear801]

Initial fake response:
For any input, will generate one way_points as

location = (orig + dest) / 2

and with fixed value for other parameters

[wangyoucao577]

• Suggset to unify names with http.md, i.e. way_points --> waypoints.
• Does the curve means vehicle's energy consumption curve? You could take the HERE's energy consumption model as reference.

[CodeBear801]

• Suggset to unify names with http.md, i.e. way_points --> waypoints.
• Does the curve means vehicle's energy consumption curve? You could take the HERE's energy consumption model as reference.

Yes, thanks for the suggestions :)

[CodeBear801]

[outdated]

[CodeBear801]

Adjust:

• How to identify destination is chargeable
  • Destination might be user's home, and only user knows whether destination is chargeable
  • Besides the parameter of safe_level, need additional boolean value to identify this

[CodeBear801]

Update

Due to new information found in:#132 (comment)
Modify Oasis API

• Remove

Location

• Add

ChargeStation   [
{
          Address {
                     geo_coordinates {
                                lat
                                lon
                     }
                     nav_coordinates[
                              {
                                     lat,
                                     lon
                              }
                     ]
          }
          "detail_url": "xxxxx"
}]
- Add
Estimate remaining range

[CodeBear801]

To do:

• Add detour_time for charge stations.
• Flag to identify destination is chargeable (need to confirm with PM)