Merge pull request #779 from afischerdev/docs

Update for the Docs

brouter-routing-app/src/main/aidl/btools/routingapp/IBRouterService.aidl

@@ -30,13 +30,18 @@ interface IBRouterService {
     //  "profile"         = profile file name without .brf
     //  "alternativeidx"  = [0|1|2|3] (optional, default 0)
     //  "exportWaypoints" = 1 to export them (optional, default is no export)
+    //  "exportCorrectedWaypoints" = 1 to export them (optional, default is no export)
     //  "pois"            = lon,lat,name|... (optional)
     //  "extraParams"     = Bundle key=value list for a profile setup (like "profile:")
     //  "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, default 0, 2 = get elevation, 3 = get segment info)
-
+    //  "direction"       = angle (optional, used like "heading" on a recalculation request by Locus as start direction, is also used for round trip as start direction - on value = -1, BRouter uses a random direction)
+    //  "engineMode"      = 0 (optional, default 0, 2 = get elevation, 3 = get segment info, 4 = round trip)
+    //
+    //  extra round trip parameter
+    //  "roundTripDistance" = distance to the round trip points (default 1500)
+    //  "roundTripPoints"   = number of used points (default 5)
+    //
     // 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
     // call in a background thread, heavy task!

docs/developers/android_service.md

@@ -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.

docs/developers/profile_developers_guide.md

@@ -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
        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

docs/revisions.md

@@ -7,6 +7,25 @@
 Android
 
 - enable edit for unused profiles
+- use parameter changed in the BRouter app
+- reuse parameter for repeat:profile function
+- use unordered values for profile listbox (e.g. fastbike profile)
+- Android 16
+
+
+Library
+
+- round trip function (engineMode = 4)
+- get way info (engineMode = 3)
+- voice hint for motorway exit
+- dynamic range for searching way points
+- enable a check for the start way
+- avoid u-turns on via points (if not corrected)
+- correct via points on or near roundabouds
+- enable export of the corrected way points
+- new method for pseudo-tags generation
+
+[Solved issues](https://github.com/abrensch/brouter/issues?q=is%3Aissue+milestone%3A%22Version+1.7.8%22+is%3Aclosed)
 
 
 ### [brouter-1.7.7.zip](../brouter_bin/brouter-1.7.7.zip) (current revision, 23.07.2024)

misc/scripts/mapcreation/readme_database.md

@@ -32,7 +32,7 @@ Import new tags for noise, green and water feature
 
 - prepare generation of pbf
 
-  - when using database and new tagging an other lookups.dat is needed, use lookups_db.dat and rename
+  - lookups.dat has to contain the new tags from the database
 
   - script needs a jdbc in the classpath (on UNIX and Linux use a colon `:` as delimiter)
 
@@ -44,8 +44,12 @@ Import new tags for noise, green and water feature
 
     `JDBC="jdbc:postgresql://localhost/osm?user=postgres&password=xyz&ssl=false"`
 
-    call it with OsmFastCutter as last parameter (behind pbf file)
+  - export the tags from database to filesystem
 
-    `... btools.mapcreator.OsmFastCutter ... ../planet-new.osm.pbf $(JDBC)`
+    `java -Xmx6144M -Xms6144M -Xms6144M -cp %CLASSPATH% btools.mapcreator.DatabasePseudoTagProvider $(JDBC) db_tags.csv.gz`
+
+  - call it with OsmFastCutter as last parameter (behind pbf file)
+
+    `... btools.mapcreator.OsmFastCutter ... ../planet-new.osm.pbf db_tags.csv.gz`