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

updated service doc

Browse source
This commit is contained in:
afischerdev 2024-01-21 16:48:14 +01:00
parent 7ffee3a911
commit 26879159da
1 changed files with 38 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
docs/developers/android_service.md
View file

@ -39,19 +39,52 @@ Please note: when they have a parameter 'weight' the result is not an absolute n
This parameters are needed to tell BRouter what to do.
### using profiles
For calulation BRouter uses a set of rules defined in a profile. See description of profile [rules](https://github.com/abrensch/brouter/blob/master/docs/developers/profile_developers_guide.md).
Here we talk about how we let BRouter know witch profile to use.
There are three ways:
1. use the parameter 'v' and 'fast'
```
"v"-->[motorcar|bicycle|foot]
"fast"-->[0|1]
This enables BRouter to look into the file serviceconfig.dat.
In there BRouter find the profile associated for e.g bicyle_fast trekking
This could be changed by the user calling the BRouter app server-mode.
```
2. use the profile parameter
```
profile=trekking
It needs an available file in the BRouter profile folder e.g. trekking.brf
```
3. use a remote profile
```
remoteProfile=a long string with routing rules
This is saved in BRouter profile folder temporary with the file name 'remote.brf'
```
### profile parameter
Profile parameters affect the result of a profile.
The variables inside a profile predefine a value e.g. avoidsteps=1
A parameter call gives the chance to change this start value without changing the profile e.g. avoidsteps=0
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
By using this parameter logic, there is no need to edit a profile before sending.
### using profile parameter inside an app
To be flexible it is possible to send a profile to BRouter - server or app.
Another variant is to send parameters for an existing profile that are different from the original profile.
With the version 1.7.1 it is possible to collect parameters from the profile.
With the version 1.7.1 it is possible to collect parameters from the profile.
The variable parameters are defined like this
```
assign avoid_path = false # %avoid_path% | Set to true to avoid pathes | boolean
@ -61,9 +94,9 @@ Now you could do that with an calling app.
What to do to get it work?
- First copy the [RoutingParam](brouter-routing-app/src/main/java/btools/routingapp/RoutingParam.java) class to your source - use the same name and package name.
- First copy the [RoutingParam](brouter-routing-app/src/main/java/btools/routingapp/RoutingParam.java) class to your source - use the same name and package name.
- Second analyze the profile for which you need the parameter.
This [BRouter routine](https://github.com/abrensch/brouter/blob/086503e529da7c044cc0f88f86c394fdb574d6cf/brouter-routing-app/src/main/java/btools/routingapp/RoutingParameterDialog.java#L103) can do that, just copy it to your source to use it in your app.
This [BRouter routine](https://github.com/abrensch/brouter/blob/086503e529da7c044cc0f88f86c394fdb574d6cf/brouter-routing-app/src/main/java/btools/routingapp/RoutingParameterDialog.java#L103) can do that, just copy it to your source to use it in your app.
It builds a List<RoutingParam> you could send to BRouter app.
- You find the call of BRouter app in comment at [RoutingParameterDialog](https://github.com/abrensch/brouter/blob/086503e529da7c044cc0f88f86c394fdb574d6cf/brouter-routing-app/src/main/java/btools/routingapp/RoutingParameterDialog.java#L33)
@ -79,7 +112,7 @@ intent.putExtra("runsilent", true);
startActivity(intent);
```
This suppress the first question after installation for the BRouter path, generates the BRouter folders in main space and starts the download dialog.
This suppress the first question after installation for the BRouter path, generates the BRouter folders in main space and starts the download dialog.
### silent app call
@ -92,7 +125,7 @@ intent.putExtra("runsilent", true);
startActivity(intent);
```
This suppress the first question after installation for the BRouter path, generates the BRouter folders in main space and starts the download dialog.
This suppress the first question after installation for the BRouter path, generates the BRouter folders in main space and starts the download dialog.
## other routing engine modes in app