Reference docs and remove readmes
This commit is contained in:
Manuel Fuhr
parent
76feb56cdf
commit
6c5b1ddec6
11 changed files with 25 additions and 569 deletions
10
README.md
10
README.md
|
|
@ -15,7 +15,7 @@ You can install the BRouter app on your Android device from
|
||||||
Store](https://play.google.com/store/apps/details?id=btools.routingapp). You
|
Store](https://play.google.com/store/apps/details?id=btools.routingapp). You
|
||||||
can also [build BRouter](#build-and-install) yourself. You can find detailed
|
can also [build BRouter](#build-and-install) yourself. You can find detailed
|
||||||
documentation of the BRouter Android app in
|
documentation of the BRouter Android app in
|
||||||
[`misc/readmes/readme.txt`](misc/readmes/readme.txt).
|
[`docs/users/android_quickstart.md`](docs/users/android_quickstart.md).
|
||||||
|
|
||||||
<a href="https://f-droid.org/packages/btools.routingapp" target="_blank">
|
<a href="https://f-droid.org/packages/btools.routingapp" target="_blank">
|
||||||
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="90"/></a>
|
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="90"/></a>
|
||||||
|
|
@ -39,7 +39,7 @@ Alternatively, you can also use BRouter as the offline routing engine for
|
||||||
[OSMAnd](https://osmand.net/) on your Android device.
|
[OSMAnd](https://osmand.net/) on your Android device.
|
||||||
|
|
||||||
A full documentation on how to set this up is available at
|
A full documentation on how to set this up is available at
|
||||||
[`misc/readmes/osmand/README.md`](misc/readmes/osmand/README.md).
|
[`docs/users/osmand.md`](docs/users/osmand.md).
|
||||||
|
|
||||||
|
|
||||||
## BRouter on Windows/Linux/Mac OS
|
## BRouter on Windows/Linux/Mac OS
|
||||||
|
|
@ -106,7 +106,7 @@ You can also generate the segments files you need directly from a planet dump
|
||||||
of OpenStreetMap data (or a [GeoFabrik extract](https://download.geofabrik.de/)).
|
of OpenStreetMap data (or a [GeoFabrik extract](https://download.geofabrik.de/)).
|
||||||
|
|
||||||
More documentation of this is available in the
|
More documentation of this is available in the
|
||||||
[`misc/readmes/mapcreation.md`](misc/readmes/mapcreation.md) file.
|
[`docs/developers/build_segments.md`](docs/developers/build_segments.md) file.
|
||||||
|
|
||||||
|
|
||||||
### (Optional) Generate profile variants
|
### (Optional) Generate profile variants
|
||||||
|
|
@ -120,7 +120,7 @@ to help you quickly generate variants based on the default profiles, to create
|
||||||
a default set of profiles covering most of the basic use cases.
|
a default set of profiles covering most of the basic use cases.
|
||||||
|
|
||||||
Have a look at the
|
Have a look at the
|
||||||
[`misc/readmes/profile_developers_guide.txt`](misc/readmes/profile_developers_guide.txt)
|
[`docs/developers/profile_developers_guide.md`](docs/developers/profile_developers_guide.md)
|
||||||
for an in-depth guide on profiles edition and customization.
|
for an in-depth guide on profiles edition and customization.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -140,7 +140,7 @@ file.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
More documentation is available in the [`misc/readmes`](misc/readmes) folder.
|
More documentation is available in the [`docs`](docs) folder.
|
||||||
|
|
||||||
|
|
||||||
## Related Projects
|
## Related Projects
|
||||||
|
|
|
||||||
|
|
@ -63,7 +63,7 @@ To use BRouter in your map tool you have to configure the map tool to use
|
||||||
BRouter as navigation service.
|
BRouter as navigation service.
|
||||||
|
|
||||||
- [Instructions for LocusMap](https://docs.locusmap.eu/doku.php?id=manual:faq:how_to_navigate_offline)
|
- [Instructions for LocusMap](https://docs.locusmap.eu/doku.php?id=manual:faq:how_to_navigate_offline)
|
||||||
- [Instructions for OsmAnd](https://osmand.net/features/navigation-profiles#create_brouter)
|
- [Instructions for OsmAnd](osmand.md)
|
||||||
|
|
||||||
Note: OsmAnd only displays BRouter as navigation service if BRouter is
|
Note: OsmAnd only displays BRouter as navigation service if BRouter is
|
||||||
installed. You have to install BRouter before configuring OsmAnd.
|
installed. You have to install BRouter before configuring OsmAnd.
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,14 @@
|
||||||
Using BRouter on Android with OSMAnd
|
---
|
||||||
|
parent: Using BRouter
|
||||||
|
title: OsmAnd
|
||||||
|
---
|
||||||
|
|
||||||
|
Using BRouter on Android with OsmAnd
|
||||||
====================================
|
====================================
|
||||||
|
|
||||||
BRouter integration in OSMAnd changed a lot during the summer of 2019. This
|
BRouter integration in OsmAnd changed a lot during the summer of 2019. This
|
||||||
guide assumes you are using the BRouter Android app in version 1.5.0 or higher
|
guide assumes you are using the BRouter Android app in version 1.5.0 or higher
|
||||||
as well as OSMAnd in version 3.4 or higher.
|
as well as OsmAnd in version 3.4 or higher.
|
||||||
|
|
||||||
|
|
||||||
## Installing BRouter app on your Android device
|
## Installing BRouter app on your Android device
|
||||||
|
|
@ -26,9 +31,9 @@ the areas you want to route in. Then click "Start Download" and BRouter will
|
||||||
start downloading the [segments](http://brouter.de/brouter/segments4/) files
|
start downloading the [segments](http://brouter.de/brouter/segments4/) files
|
||||||
for the selected areas.
|
for the selected areas.
|
||||||
|
|
||||||
<img src="./brouter-main.png" alt="Main menu of BRouter android app"/>
|
<img src="osmand/brouter-main.png" alt="Main menu of BRouter android app"/>
|
||||||
|
|
||||||
<img src="./brouter-grid.png" alt="Grid selection of segments to download"/>
|
<img src="osmand/brouter-grid.png" alt="Grid selection of segments to download"/>
|
||||||
|
|
||||||
Note that you will have to repeat this step periodically, whenever you want to have an
|
Note that you will have to repeat this step periodically, whenever you want to have an
|
||||||
updated version of the OSM data used for the routing.
|
updated version of the OSM data used for the routing.
|
||||||
|
|
@ -41,24 +46,24 @@ entry on the main menu. Select the routing profile you want to use and click
|
||||||
"Server-Mode". Then, tick the boxes for the routing modes you want to use this
|
"Server-Mode". Then, tick the boxes for the routing modes you want to use this
|
||||||
profile for. You can use two different profiles per transportation mode, which
|
profile for. You can use two different profiles per transportation mode, which
|
||||||
will be mapped to the "shortest" and "fastest" presets (these are just
|
will be mapped to the "shortest" and "fastest" presets (these are just
|
||||||
labelling) in OSMAnd.
|
labelling) in OsmAnd.
|
||||||
|
|
||||||
<img src="./brouter-profiles.png" alt="Profiles selection"/>
|
<img src="osmand/brouter-profiles.png" alt="Profiles selection"/>
|
||||||
|
|
||||||
<img src="./brouter-profiles-summary.png" alt="Profiles selection summary"/>
|
<img src="osmand/brouter-profiles-summary.png" alt="Profiles selection summary"/>
|
||||||
|
|
||||||
|
|
||||||
## Configure OSMAnd to make use of BRouter offline navigation
|
## Configure OsmAnd to make use of BRouter offline navigation
|
||||||
|
|
||||||
You can now create an "Application profile" in OSMAnd which will be using
|
You can now create an "Application profile" in OsmAnd which will be using
|
||||||
BRouter for offline routing. Go to Settings -> Application profiles -> Add and
|
BRouter for offline routing. Go to Settings -> Application profiles -> Add and
|
||||||
create a new profile based on the base profile of your choice (cycling here,
|
create a new profile based on the base profile of your choice (cycling here,
|
||||||
for bicycle routing), with a custom name of your choice ("BRouter" on the
|
for bicycle routing), with a custom name of your choice ("BRouter" on the
|
||||||
screenshot below) and making use of "BRouter (offline)" for navigation.
|
screenshot below) and making use of "BRouter (offline)" for navigation.
|
||||||
|
|
||||||
<img src="./brouter-osmand.png" alt="BRouter configuration in OSMAnd
|
<img src="osmand/brouter-osmand.png" alt="BRouter configuration in OsmAnd
|
||||||
application profiles"/>
|
application profiles"/>
|
||||||
|
|
||||||
The BRouter app should be launched before OSMAnd for this specific entry to
|
The BRouter app should be launched before OsmAnd for this specific entry to
|
||||||
appear in OSMAnd. Therefore, if you cannot find "BRouter (offline)" navigation
|
appear in OsmAnd. Therefore, if you cannot find "BRouter (offline)" navigation
|
||||||
option, you should force quit OSMAnd and restart it.
|
option, you should force quit OsmAnd and restart it.
|
||||||
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
|
@ -1,66 +0,0 @@
|
||||||
Surviving with Android 4.4 (KitKat) or 5.x (Lollipop) using latest BRouter
|
|
||||||
=======================================================
|
|
||||||
|
|
||||||
BRouter has some basic support to reclaim your external SD card.
|
|
||||||
|
|
||||||
Brouter must be installed on internal drive ("SD card"), but maps could be moved to external SD card.
|
|
||||||
|
|
||||||
What's new is a configuration file located at:
|
|
||||||
|
|
||||||
brouter/segments4/storageconfig.txt
|
|
||||||
|
|
||||||
which has 2 configuration items:
|
|
||||||
|
|
||||||
"secondary_segment_dir" points to an additional directory containing
|
|
||||||
routing data files. This can be located anywhere.
|
|
||||||
|
|
||||||
"additional_maptool_dir" points to a base-directory that should
|
|
||||||
be scanned for maptool-installations in addition to the standard-guesses.
|
|
||||||
|
|
||||||
Initially, the value for "secondary_segment_dir" is "../segments3" to support the
|
|
||||||
file-format transition from 1.2 to 1.3, so that, after upgrading, your existing
|
|
||||||
datafiles are found via the secondary directory.
|
|
||||||
|
|
||||||
However, for surviving KitKatn and later, you are supposed to change that to the
|
|
||||||
absolute path to a directory on the external card, e.g.:
|
|
||||||
|
|
||||||
secondary_segment_dir=/storage/external_SD/brouter_segments4
|
|
||||||
|
|
||||||
When searching for datafiles, both the download manager and the router first look in the primary (brouter/segments4) and then in the secondary directory.
|
|
||||||
On the other hand, the download manager always writes new datafiles to the primary directory, so the secondary directory is read-only.
|
|
||||||
|
|
||||||
So you can move datafiles downloaded by the download-manager to the secondary directory, by using a file manager, in order to free disk space on the internal card. Or you ca download datafiles directly to the secondary directory by doing manual http downloads
|
|
||||||
from http://brouter.de/brouter/segments4
|
|
||||||
|
|
||||||
Depending on how your maptool handles the file-system structure, you are done.
|
|
||||||
|
|
||||||
However, e.g. for OsmAnd it is likely that BRouter still has no access to OsmAnd's waypoint database. The reason is:
|
|
||||||
|
|
||||||
When, after installing OsmAnd, you choose to move it's resources to the external SD Card,
|
|
||||||
it moves it to a special directory where it has write-access even with Android 4.4, e.g.:
|
|
||||||
|
|
||||||
/storage/external_SD/Android/data/net.osmand/files
|
|
||||||
|
|
||||||
The package name slightly differs for OsmAnd+.
|
|
||||||
|
|
||||||
This directory is not found automatically by BRouter, so you have to configure
|
|
||||||
it as "additional_maptool_dir".
|
|
||||||
|
|
||||||
However, you are still not done, because if BRouter finds a wayoint-database file
|
|
||||||
under:
|
|
||||||
|
|
||||||
/storage/external_SD/Android/data/net.osmand/files/osmand/favourites.gpx
|
|
||||||
|
|
||||||
then it decides to write it's tracks to:
|
|
||||||
|
|
||||||
/storage/external_SD/Android/data/net.osmand/files/osmand/tracks
|
|
||||||
|
|
||||||
But this directory is not writable by BRouter. So what you have to do is to create
|
|
||||||
a redirection-file (create the tracks folder if it does not exist!)
|
|
||||||
|
|
||||||
/storage/external_SD/Android/data/net.osmand/files/osmand/tracks/brouter.redirect
|
|
||||||
|
|
||||||
and that should contain a single line with the absolute path to the folder where
|
|
||||||
the tracks should be written (e.g. /mnt/sdcard/brouter ). Redirection file is normal file named brouter.redirect and containing single line pointing to folder writable by BRouter and readable by OsmAnd.
|
|
||||||
|
|
||||||
THEN you are done.
|
|
||||||
|
|
@ -1,262 +0,0 @@
|
||||||
BRouter - Version 1.4 - Setting up the Android App
|
|
||||||
====================================================
|
|
||||||
|
|
||||||
Choosing and Installing a Map-Tool
|
|
||||||
----------------------------------
|
|
||||||
|
|
||||||
BRouter just calculates tracks as GPX-Files, it
|
|
||||||
does not display any map or give any navigation
|
|
||||||
instuctions. Therefore you need a map-tool in
|
|
||||||
order for BRouter to be useful.
|
|
||||||
|
|
||||||
Currently, BRouter cooperates with three different
|
|
||||||
maptools, so you need to install, and get familiar with,
|
|
||||||
at least one of them:
|
|
||||||
|
|
||||||
- "OsmAnd": See http://www.osmand.net Get It from Google-Play
|
|
||||||
or get it as an APK from the release-build archive:
|
|
||||||
http://download.osmand.net/releases/
|
|
||||||
|
|
||||||
- "Locus": See http://www.locusmap.eu There's a "Pro"
|
|
||||||
Version which is ad-free and a free version with ads.
|
|
||||||
You can get it from Google-Play, but for the free-version
|
|
||||||
there's also an APK-Download.
|
|
||||||
|
|
||||||
- "Oruxmaps": See http://www.oruxmaps.com Oruxmaps is
|
|
||||||
Donation-Ware, which means it's free and you're supposed
|
|
||||||
to donate to the project if you want to support it.
|
|
||||||
|
|
||||||
Which one to use is a matter of taste. Maybe OsmAnd is
|
|
||||||
more plug&play and has a reasonable voice-guidig. Locus
|
|
||||||
and Oruxmaps are more powerful and better for outdoor
|
|
||||||
use. All three have elevation profile diagrams.
|
|
||||||
|
|
||||||
Locus and Oruxmaps are best used with third-party vector
|
|
||||||
maps, check http://www.openandromaps.org if you consider
|
|
||||||
to go for Locus or OruxMaps.
|
|
||||||
|
|
||||||
Installing the BRouter App
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
You can install the BRouter-App either from Google's Play Store
|
|
||||||
or directly from the APK-File contained within the "brouter_1_4.zip"
|
|
||||||
distribution zip-file.
|
|
||||||
|
|
||||||
Choosing a SD-Card Base Directory
|
|
||||||
---------------------------------
|
|
||||||
|
|
||||||
When first starting BRouter (or after deleting/moving
|
|
||||||
the brouter folder on the sd-card), it asks for a
|
|
||||||
sd-card base directory and gives you proposals plus
|
|
||||||
the option to enter any other base directory.
|
|
||||||
|
|
||||||
Most phones (namely those with Android 4.x) have 2 logical
|
|
||||||
"SD-Cards", where the first one is internal and not an actual
|
|
||||||
Card, and the second one is a an optional "external" micro-sd-card
|
|
||||||
that can be taken out of the device.
|
|
||||||
|
|
||||||
Navigation needs big data files that usually should go on an
|
|
||||||
external, big sd-card. You should accept the external card, which
|
|
||||||
is usually the one with the most space available.
|
|
||||||
|
|
||||||
However, on Android >= 4.4, write access to the external card
|
|
||||||
is restricted, and usually you will not get a proposal to use
|
|
||||||
the external card. Here you should accept to go with the
|
|
||||||
internal card - later on you can setup a "secondary" data
|
|
||||||
directory on the external card where you can move the datafiles
|
|
||||||
to.
|
|
||||||
|
|
||||||
*** see the kitkat_survival_readme.txt for special Android 4.4 and Android 5x issues ***
|
|
||||||
|
|
||||||
Try to make sure your map-tool uses the same base directory
|
|
||||||
to store the offline maps and other stuff, because BRouter
|
|
||||||
tries to access the maptool's waypoint-database and tracks-directory,
|
|
||||||
and this works only if they use either the same base directory
|
|
||||||
or if the maptool uses the standard, internal base /mnt/sdcard.
|
|
||||||
|
|
||||||
In OsmAnd, this works by choosing an "SD-Card base directory".
|
|
||||||
|
|
||||||
In OruxMaps, path configuration is only possible for the actual
|
|
||||||
map data, but the configuration database file that BRouter tries
|
|
||||||
to access is hardwired to the /mnt/sdcard/oruxmaps directory.
|
|
||||||
As a workaround for this specific setup, you can place a
|
|
||||||
redirection file in the directory where BRouter would normally
|
|
||||||
place the gpx-files (e.g. /mnt/sdcard/oruxmaps/tracklogs).
|
|
||||||
The first line of that redirection file called "brouter.redirect"
|
|
||||||
must contain the absolute path of the directory where you want
|
|
||||||
the gpx-files to go (e.g. /storage0/oruxmaps/tracklogs).
|
|
||||||
|
|
||||||
If you have a non-standard maptool location, that is not
|
|
||||||
detected by the default logic, you can configure an "additional maptool directory"
|
|
||||||
in a configuration file located unter brouter/segments3/storageconfig.txt
|
|
||||||
This is neccessary e.g. if you operate OsmAnd on the external SD card
|
|
||||||
under Android 4.4. Then this uses a special base directory to obey
|
|
||||||
Android 4.4's access restrictions, and this base directory is not found
|
|
||||||
by the default logic. See the kitkat_survival_readme.txt for details.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Completing your installation
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
After accepting a base-directory proposal, "BRouter" creates a subfolders
|
|
||||||
relative to this base directory, so you end up with e.g. the following structure:
|
|
||||||
(depending on base dir and your map-tool choice):
|
|
||||||
|
|
||||||
/mnt/sdcard/brouter
|
|
||||||
/mnt/sdcard/brouter/segments4 <- ** put routing data files (*.rd5) here **
|
|
||||||
/mnt/sdcard/brouter/profiles2 <- lookup-table and routing profiles
|
|
||||||
/mnt/sdcard/brouter/modes <- routing-mode/profile mapping
|
|
||||||
|
|
||||||
/mnt/sdcard/osmand <- OsmAnd's sd-card dir
|
|
||||||
/mnt/sdcard/osmand/track <- OsmAnd's track storage
|
|
||||||
|
|
||||||
/mnt/sdcard/Locus <- Locus's sd-card dir
|
|
||||||
/mnt/sdcard/Locus/mapitems <- Locus's track storage
|
|
||||||
|
|
||||||
/mnt/sdcard/oruxmaps <- Oruxmaps's sd-card dir
|
|
||||||
/mnt/sdcard/oruxmaps/tracklogs <- Oruxmaps's track storage
|
|
||||||
|
|
||||||
|
|
||||||
The "profiles2" and the "modes" directory get some reasonable default-configuration
|
|
||||||
from the installation procedure, but the "segments4" directory is basically empty
|
|
||||||
(except for the storageconfig.txt file) so you have to get routing-datafiles in
|
|
||||||
order to complete your installation.
|
|
||||||
|
|
||||||
After accepting the base directory, the download manager starts automatically to
|
|
||||||
help you with this download. Or you can download
|
|
||||||
them manually from the following location:
|
|
||||||
|
|
||||||
http://brouter.de/brouter/segments4
|
|
||||||
|
|
||||||
Routing data files are organised as 5*5 degree files,
|
|
||||||
with the Filename containing the south-west corner
|
|
||||||
of the square, which means:
|
|
||||||
|
|
||||||
- You want to route near West48/North37 -> get W50_N35.rd5
|
|
||||||
- You want to route near East7/North47 -> get E5_N45.rd5
|
|
||||||
|
|
||||||
From the above link you find routing data for all places in the world where OSM
|
|
||||||
data is available. The carsubset datafiles are needed only if you want to
|
|
||||||
calculate car-routes over long distances, otherwise you are fine with just the
|
|
||||||
normal (full) rd5's.
|
|
||||||
|
|
||||||
The minimum files BRouter needs to work are e.g.
|
|
||||||
|
|
||||||
/mnt/sdcard/brouter/segments4/E5_N45.rd5
|
|
||||||
/mnt/sdcard/brouter/profiles2/lookups.dat
|
|
||||||
/mnt/sdcard/brouter/profiles2/trekking.brf
|
|
||||||
|
|
||||||
But of course you can put as many routing data files
|
|
||||||
and routing profiles as you like.
|
|
||||||
|
|
||||||
|
|
||||||
Routing via the service interface
|
|
||||||
=================================
|
|
||||||
|
|
||||||
BRouter is best used via it's "service interface". No need to start the BRouter-App
|
|
||||||
in order to do that, it's just a services that sits in the background and can be
|
|
||||||
called by the map-tools very much like on online routing service.
|
|
||||||
|
|
||||||
To do that, you have to choose BRouter as a navigation service in your map-tool.
|
|
||||||
This is supported by OsmAnd, Locus-Maps and OruxMaps (In OsmAnd starting with version 1.7,
|
|
||||||
you see BRouter as a navigation service if BRouter is installed. You do not see the
|
|
||||||
option if BRouter is not installed).
|
|
||||||
|
|
||||||
There's a mapping between the "routing-mode" asked for by the map-tool
|
|
||||||
(on out of 6: car/bike/foot * fast/slow) and BRouter's routing-profiles.
|
|
||||||
This mapping is stored in the file brouter/modes/serviceconfig.dat and is
|
|
||||||
pre-configured by the installation process to the following mapping:
|
|
||||||
|
|
||||||
motorcar_fast -> car-test
|
|
||||||
motorcar_short -> moped
|
|
||||||
bicycle_fast -> fastbike
|
|
||||||
bicycle_short -> trekking
|
|
||||||
foot_fast -> shortest
|
|
||||||
foot_short -> shortest
|
|
||||||
|
|
||||||
This mapping, however, can be changed any time by starting the BRouter-APP and using
|
|
||||||
the "Server Mode" button (or by editing the serviceconfig.dat manually). You can also
|
|
||||||
change gthe profiles themselves or create new ones. Please refer to the
|
|
||||||
"profile_developers_guide.txt" (contained in the distribution-zip) if you plan to
|
|
||||||
adapt routing profiles to your preferences.
|
|
||||||
|
|
||||||
Note that if called via the service-interface, BRouter uses a timeout of 60 seconds,
|
|
||||||
which sets a limit on the distances you can calculate.
|
|
||||||
|
|
||||||
|
|
||||||
Calculate routes using the file interface
|
|
||||||
=========================================
|
|
||||||
|
|
||||||
The other option is using the BRouter-App to calculate a route. This is the prefered option
|
|
||||||
when calculating long-distance-routes that would not finish within the 60 seconds timout
|
|
||||||
if calculated via the service-interface.
|
|
||||||
|
|
||||||
To do this, start the BRouter-App, select two or more waypoints from the waypoint-database
|
|
||||||
of your map-tool and then start the route calculation. These waypoints are called "Favorites"
|
|
||||||
in OsmAnd, "POI"s in Locus or "Waypoints" in Oruxmaps and allow to store a location
|
|
||||||
on the map and give it a name.
|
|
||||||
|
|
||||||
No need anymore to create special "to", "from", "via1..via9" points, but they are still supported
|
|
||||||
and if a "from" and a "to" wayppoint is found in the database, you will not be prompted
|
|
||||||
to select waypoints from the database.
|
|
||||||
|
|
||||||
If a route is calculated, it is stored as "brouter0.gpx" in the map-tools track directory
|
|
||||||
(or, if there is no write-access, in brouter's base directory)
|
|
||||||
If started once more with identical input, BRouter will store a second route broute1.gpx
|
|
||||||
for the first alternative and so on.
|
|
||||||
|
|
||||||
If more than one of the supported maptools is installed, BRouter chooses the way-point database
|
|
||||||
with the most recent timestamp.
|
|
||||||
|
|
||||||
|
|
||||||
Using nogo-areas
|
|
||||||
================
|
|
||||||
|
|
||||||
There's a special naming-convention to specify nogo-areas:
|
|
||||||
|
|
||||||
"nogo[radius] [name]" defines a nogo-area, where radius (in Meter)
|
|
||||||
is optional and defaults to 20m, and the name is also optional.
|
|
||||||
So "nogo", "nogo1000", "nogo roadblock", "nogo200 badferry" are all valid
|
|
||||||
names for nogo-waypoints.
|
|
||||||
|
|
||||||
The effect is that BRouter searches a route that does not touch the disc
|
|
||||||
defined by the position and the radius of the nogo-area.
|
|
||||||
|
|
||||||
Nogo-Areas are effective in the service-interface and in the BRouter-App.
|
|
||||||
In the BRouter-App, you will get a nogo-dialog allowing to de-select them
|
|
||||||
if nogo-waypoints are found in the waypoint-database. This de-selection
|
|
||||||
can also be bound to a service mode using the "Server Mode" button to make
|
|
||||||
it effective in the service-interface as well, but initially, every nogo-area
|
|
||||||
is effective in the service-interface.
|
|
||||||
|
|
||||||
Nogo areas can be used either to account for real obstacles or to enforce
|
|
||||||
personal routing preferences.
|
|
||||||
|
|
||||||
|
|
||||||
Mixed operation: "timeout-free recalculations"
|
|
||||||
==============================================
|
|
||||||
|
|
||||||
You can combine both operation modes (service-interface + BRouter-App) to
|
|
||||||
become able to calculate very long distances, but make use of the advantages of
|
|
||||||
the service interface as well, especially the dynamic recalculations if you get
|
|
||||||
off the track, without running into the 60 seconds timeout.
|
|
||||||
|
|
||||||
To support this, BRouter can do "timeout free recalculations". It works by
|
|
||||||
initially calculating a track to your destination and binding it to one or
|
|
||||||
more routing-modes using the "Server Mode" button. This way, BRouter stores
|
|
||||||
a "reference track" in the "brouter/modes" subdirectory.
|
|
||||||
|
|
||||||
If afterwards a route to the exact same destination is calculated via the service interface,
|
|
||||||
BRouter uses a special calculation mode that makes use of the reference track for
|
|
||||||
faster processing that is guaranteed to give a result within 60 seconds.
|
|
||||||
"Exact same" destination means withing 5m, so best use the same waypoint for
|
|
||||||
re-calculating that you used for the initial calculation.
|
|
||||||
|
|
||||||
This way you can follow a long distance route via the service interface, enjoying
|
|
||||||
automatic recalculations if you get off the track.
|
|
||||||
|
|
||||||
|
|
||||||
Issues and bugs:
|
|
||||||
================
|
|
||||||
<https://github.com/abrensch/brouter/issues>
|
|
||||||
|
|
@ -1,221 +0,0 @@
|
||||||
BRouter - Version 1.6.2 - Setting up the Android App
|
|
||||||
====================================================
|
|
||||||
|
|
||||||
Choosing and Installing a Map-Tool
|
|
||||||
----------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
BRouter just calculates tracks as GPX- or Geojson-output, it
|
|
||||||
does not display any map or give any navigation
|
|
||||||
instuctions. Therefore you need a map-tool in
|
|
||||||
order for BRouter to be useful.
|
|
||||||
|
|
||||||
Currently, BRouter cooperates with any map tool that can use the BRouter
|
|
||||||
interface without file access. So you need to install some, and get familiar with,
|
|
||||||
at least one of them:
|
|
||||||
|
|
||||||
- "OsmAnd": See http://www.osmand.net Get It from Google-Play
|
|
||||||
or get it as an APK from the release-build archive:
|
|
||||||
http://download.osmand.net/releases/
|
|
||||||
|
|
||||||
- "Locus": See http://www.locusmap.eu There's a "Pro"
|
|
||||||
Version which is ad-free and a free version with ads.
|
|
||||||
You can get it from Google-Play, but for the free-version
|
|
||||||
there's also an APK-Download.
|
|
||||||
|
|
||||||
- "Oruxmaps": See http://www.oruxmaps.com Oruxmaps is
|
|
||||||
Donation-Ware, which means it's free and you're supposed
|
|
||||||
to donate to the project if you want to support it.
|
|
||||||
|
|
||||||
|
|
||||||
Installing the BRouter App
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
You can install the BRouter-App either from Google's Play Store
|
|
||||||
or directly from the APK-File contained within the "brouter-1.6.2.zip"
|
|
||||||
distribution zip-file.
|
|
||||||
|
|
||||||
Choosing a SD-Card Base Directory
|
|
||||||
---------------------------------
|
|
||||||
|
|
||||||
When first starting BRouter (or after deleting/moving
|
|
||||||
the brouter folder on the sd-card), it asks for a
|
|
||||||
sd-card base directory and gives you proposals plus
|
|
||||||
the option to enter any other base directory.
|
|
||||||
|
|
||||||
Most phones (namely those with Android 4.x) have 2 logical
|
|
||||||
"SD-Cards", where the first one is internal and not an actual
|
|
||||||
Card, and the second one is a an optional "external" micro-sd-card
|
|
||||||
that can be taken out of the device.
|
|
||||||
|
|
||||||
Navigation needs big data files that usually should go on an
|
|
||||||
external, big sd-card. You should accept the external card, which
|
|
||||||
is usually the one with the most space available.
|
|
||||||
|
|
||||||
Since Android 11 BRouter app uses only its local storage on
|
|
||||||
.../Android/media/btools.routingapp/
|
|
||||||
|
|
||||||
That means it can't access the folders from other apps like OsmAnd, OruxMaps or Locus.
|
|
||||||
|
|
||||||
|
|
||||||
Completing your installation
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
After accepting a base-directory proposal, "BRouter" creates a subfolders
|
|
||||||
relative to this base directory, so you end up with e.g. the following structure:
|
|
||||||
(depending on base dir and your map-tool choice):
|
|
||||||
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/brouter
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/brouter/segments4 <- ** put routing data files (*.rd5) here **
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/brouter/profiles2 <- lookup-table and routing profiles
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/brouter/modes <- routing-mode/profile mapping
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/import <- allow a small file exchange with other apps
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/import/tracks <- place the nogo* files here
|
|
||||||
|
|
||||||
|
|
||||||
The "profiles2" and the "modes" directory get some reasonable default-configuration
|
|
||||||
from the installation procedure, but the "segments4" directory is basically empty
|
|
||||||
(except for the storageconfig.txt file) so you have to get routing-datafiles in
|
|
||||||
order to complete your installation.
|
|
||||||
|
|
||||||
After accepting the base directory, the download manager starts automatically to
|
|
||||||
help you with this download. Or you can download
|
|
||||||
them manually from the following location:
|
|
||||||
|
|
||||||
http://brouter.de/brouter/segments4
|
|
||||||
|
|
||||||
Routing data files are organised as 5*5 degree files,
|
|
||||||
with the Filename containing the south-west corner
|
|
||||||
of the square, which means:
|
|
||||||
|
|
||||||
- You want to route near West48/North37 -> get W50_N35.rd5
|
|
||||||
- You want to route near East7/North47 -> get E5_N45.rd5
|
|
||||||
|
|
||||||
From the above link you find routing data for all places in the world where OSM
|
|
||||||
data is available. The carsubset datafiles are needed only if you want to
|
|
||||||
calculate car-routes over long distances, otherwise you are fine with just the
|
|
||||||
normal (full) rd5's.
|
|
||||||
|
|
||||||
The minimum files BRouter needs to work are e.g.
|
|
||||||
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/brouter/segments4/E5_N45.rd5
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/brouter/profiles2/lookups.dat
|
|
||||||
/mnt/sdcard/Android/media/btools.routingapp/brouter/profiles2/trekking.brf
|
|
||||||
|
|
||||||
But of course you can put as many routing data files
|
|
||||||
and routing profiles as you like.
|
|
||||||
|
|
||||||
Since folders on other apps are not longer available you could use the
|
|
||||||
import folder to place a favourites.gpx with waypoints or
|
|
||||||
in subfolder 'tracks' your nogo*.gpx files.
|
|
||||||
|
|
||||||
|
|
||||||
Routing via the service interface
|
|
||||||
=================================
|
|
||||||
|
|
||||||
BRouter is best used via it's "service interface". No need to start the BRouter-App
|
|
||||||
in order to do that, it's just a services that sits in the background and can be
|
|
||||||
called by the map-tools very much like on online routing service.
|
|
||||||
|
|
||||||
To do that, you have to choose BRouter as a navigation service in your map-tool.
|
|
||||||
This is supported by OsmAnd, Locus-Maps and OruxMaps (In OsmAnd starting with version 1.7,
|
|
||||||
you see BRouter as a navigation service if BRouter is installed. You do not see the
|
|
||||||
option if BRouter is not installed).
|
|
||||||
|
|
||||||
There's a mapping between the "routing-mode" asked for by the map-tool
|
|
||||||
(on out of 6: car/bike/foot * fast/slow) and BRouter's routing-profiles.
|
|
||||||
This mapping is stored in the file brouter/modes/serviceconfig.dat and is
|
|
||||||
pre-configured by the installation process to the following mapping:
|
|
||||||
|
|
||||||
motorcar_fast -> car-test
|
|
||||||
motorcar_short -> moped
|
|
||||||
bicycle_fast -> fastbike
|
|
||||||
bicycle_short -> trekking
|
|
||||||
foot_fast -> shortest
|
|
||||||
foot_short -> shortest
|
|
||||||
|
|
||||||
This mapping, however, can be changed any time by starting the BRouter-APP and using
|
|
||||||
the "Server Mode" button (or by editing the serviceconfig.dat manually). You can also
|
|
||||||
change gthe profiles themselves or create new ones. Please refer to the
|
|
||||||
"profile_developers_guide.txt" (contained in the distribution-zip) if you plan to
|
|
||||||
adapt routing profiles to your preferences.
|
|
||||||
|
|
||||||
Note that if called via the service-interface, BRouter uses a timeout of 60 seconds,
|
|
||||||
which sets a limit on the distances you can calculate.
|
|
||||||
|
|
||||||
|
|
||||||
Calculate routes using the file interface
|
|
||||||
=========================================
|
|
||||||
|
|
||||||
The other option is using the BRouter-App to calculate a route. This is the prefered option
|
|
||||||
when calculating long-distance-routes that would not finish within the 60 seconds timout
|
|
||||||
if calculated via the service-interface.
|
|
||||||
|
|
||||||
To do this, start the BRouter-App, select two or more waypoints from the favorite waypoint-database
|
|
||||||
in your import folder and then start the route calculation. These waypoints are called "Favorites"
|
|
||||||
in OsmAnd, "POI"s in Locus or "Waypoints" in Oruxmaps and allow to store a location
|
|
||||||
on the map and give it a name. Export them from the app to the import folder.
|
|
||||||
|
|
||||||
No need anymore to create special "to", "from", "via1..via9" points, but they are still supported
|
|
||||||
and if a "from" and a "to" wayppoint is found in the database, you will not be prompted
|
|
||||||
to select waypoints from the database.
|
|
||||||
|
|
||||||
If a route is calculated, it is stored as "brouter0.gpx" in the BRouter import/tracks directory.
|
|
||||||
If started once more with identical input, BRouter will store a second route broute1.gpx
|
|
||||||
for the first alternative and so on.
|
|
||||||
|
|
||||||
|
|
||||||
Using nogo-areas
|
|
||||||
================
|
|
||||||
|
|
||||||
There's a special naming-convention to specify nogo-areas:
|
|
||||||
|
|
||||||
"nogo[radius] [name]" defines a nogo-area, where radius (in Meter)
|
|
||||||
is optional and defaults to 20m, and the name is also optional.
|
|
||||||
So "nogo", "nogo1000", "nogo roadblock", "nogo200 badferry" are all valid
|
|
||||||
names for nogo-waypoints.
|
|
||||||
|
|
||||||
The effect is that BRouter searches a route that does not touch the disc
|
|
||||||
defined by the position and the radius of the nogo-area.
|
|
||||||
|
|
||||||
Nogo-Areas are effective in the service-interface and in the BRouter-App.
|
|
||||||
In the BRouter-App, you will get a nogo-dialog allowing to de-select them
|
|
||||||
if nogo-waypoints are found in the waypoint-database. This de-selection
|
|
||||||
can also be bound to a service mode using the "Server Mode" button to make
|
|
||||||
it effective in the service-interface as well, but initially, every nogo-area
|
|
||||||
is effective in the service-interface.
|
|
||||||
|
|
||||||
Nogo areas can be used either to account for real obstacles or to enforce
|
|
||||||
personal routing preferences.
|
|
||||||
|
|
||||||
Please note that nogo values can transfer also by new interface
|
|
||||||
parameter: polylines, polygons
|
|
||||||
see 'IBRouterService.aidl' for more information.
|
|
||||||
|
|
||||||
|
|
||||||
Mixed operation: "timeout-free recalculations"
|
|
||||||
==============================================
|
|
||||||
|
|
||||||
You can combine both operation modes (service-interface + BRouter-App) to
|
|
||||||
become able to calculate very long distances, but make use of the advantages of
|
|
||||||
the service interface as well, especially the dynamic recalculations if you get
|
|
||||||
off the track, without running into the 60 seconds timeout.
|
|
||||||
|
|
||||||
To support this, BRouter can do "timeout free recalculations". It works by
|
|
||||||
initially calculating a track to your destination and binding it to one or
|
|
||||||
more routing-modes using the "Server Mode" button. This way, BRouter stores
|
|
||||||
a "reference track" in the "brouter/modes" subdirectory.
|
|
||||||
|
|
||||||
If afterwards a route to the exact same destination is calculated via the service interface,
|
|
||||||
BRouter uses a special calculation mode that makes use of the reference track for
|
|
||||||
faster processing that is guaranteed to give a result within 60 seconds.
|
|
||||||
"Exact same" destination means withing 5m, so best use the same waypoint for
|
|
||||||
re-calculating that you used for the initial calculation.
|
|
||||||
|
|
||||||
This way you can follow a long distance route via the service interface, enjoying
|
|
||||||
automatic recalculations if you get off the track.
|
|
||||||
|
|
||||||
|
|
||||||
Issues and bugs:
|
|
||||||
================
|
|
||||||
<https://github.com/abrensch/brouter/issues>
|
|
||||||
Loading…
Reference in a new issue