added new parameter doc

This commit is contained in:
afischerdev 2025-04-12 16:05:14 +02:00
parent e88b936afd
commit ba31aa69c9
2 changed files with 22 additions and 0 deletions

View file

@ -136,3 +136,13 @@ This suppress the first question after installation for the BRouter path, genera
### get info
"engineMode=3" allows a client to request the description tags for a segment. This can be restricted with "waypointCatchingRange".
### round trip
"engineMode=4" generate routes returning to the start point.
This needs some parameter:
- roundTripDistance - in meters, how far to generate some helping points (default 1500)
- direction - in degree, the direction to the points (default -1, BRouter uses a random direction)
- roundTripPoints - how many helping point (default 5, 4 around the distance and one end point)
When direction = -1 and with a selection of the profile parameter consider_elevation, consider_forest or consider_river BRouter collects the information about this from the area defined in roundTripDistance and selects a random direction from the quadrant with the best choice of the values. Please keep in mind that the longer the distance, the longer this will take.