docs get elevation

This commit is contained in:
afischerdev 2023-05-14 16:46:53 +02:00
parent 40b4794573
commit ec942243be
3 changed files with 9 additions and 2 deletions

View file

@ -34,7 +34,7 @@ interface IBRouterService {
// "timode" = turnInstructionMode [0=none, 1=auto-choose, 2=locus-style, 3=osmand-style, 4=comment-style, 5=gpsies-style, 6=orux-style, 7=locus-old-style] default 0
// "heading" = angle (optional to give a route a start direction)
// "direction" = angle (optional, used like "heading" on a recalculation request by Locus as start direction)
// "engineMode" = 0 (optional, no more modes defined at the moment)
// "engineMode" = 0 (optional, default 0, 2 = get elevation)
// return null if all ok and no path given, the track if ok and path given, an error message if it was wrong
// the resultas string when 'pathToFileResult' is null, this should be default when Android Q or later

View file

@ -44,3 +44,10 @@ This parameters are needed to tell BRouter what to do.
Profile parameters affect the result of a profile.
For the app it is a list of params concatenated by '&'. E.g. extraParams=avoidferry=1&avoidsteps=0
The server calls profile params by a prefix 'profile:'. E.g. ...&profile:avoidferry=1&profile:avoidsteps=0
## other routing engine modes in app
### get elevation
"engineMode=2" allows a client to only request an elevation for a point. This can be restricted with "waypointCatchingRange".

View file

@ -10,7 +10,7 @@ Android
Library
- Add engineMode for future use
- Add new function 'get elevation'
- Minor bug fixes