ben/brouter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

added new parameter doc

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

10
docs/developers/android_service.md
View file

@ -136,3 +136,13 @@ This suppress the first question after installation for the BRouter path, genera
### get info ### get info
"engineMode=3" allows a client to request the description tags for a segment. This can be restricted with "waypointCatchingRange". "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.

12
docs/developers/profile_developers_guide.md
View file

@ -145,6 +145,18 @@ Some variable names are pre-defined and accessed by the routing engine:
New is an additional block with information on the excluded ways, a list with New is an additional block with information on the excluded ways, a list with
name `noStartWay` and `name,value;...` entries. name `noStartWay` and `name,value;...` entries.
- `correctMisplacedViaPoints` default = true
Searches for incorrectly placed via points and removes the detours.
With the parameter `exportCorrectedWaypoints` adds these points to the output formats.
- `correctMisplacedViaPointsDistance` default=0
The default setting 0 removes the entire path, with a tolerance limit BRouter finds and removes only paths within this distance.
- `continueStraight` default = false
After a via point this goes on in the straight direction. This could avoid u-turns on misplaced via points.
- for the way section these are - for the way section these are