Difference between revisions of "Configuration"

From Navit's Wiki
Jump to: navigation, search
(Graphical User Interface: formating)
(GPS: add null GPS)
Line 380: Line 380:
 
* source="pipe:/usr/bin/gpspipe -r" - any executable that produces NMEA output - gpsbabel, gpspipe, ...
 
* source="pipe:/usr/bin/gpspipe -r" - any executable that produces NMEA output - gpsbabel, gpspipe, ...
 
* source="demo://" : to use the demo vehicle. Set your Position and Destination, and vehicle will follow the calculated route. Useful if you have no nmea data source.
 
* source="demo://" : to use the demo vehicle. Set your Position and Destination, and vehicle will follow the calculated route. Useful if you have no nmea data source.
 +
* source="null://" : no GPS at all
  
 
===Logging tracks===  
 
===Logging tracks===  

Revision as of 09:23, 2 June 2013

Navit is highly modular and customizable. This page aims to point out the most common options which a first-time user may want to change - power users may want to consult the full list of options.

Setting up Navit is done by editing a configuration file called "navit.xml".Editing this file in a text editor is simple, it's just a plain text XML file, that can be edited with any editor. Just remember to turn off 'save UTF8 byte mark' in Preferences or navit may complain very much on the first byte of the file.
The file is splitted into sections within a hierachie:

<config>
  <plugins></plugins>
  <navit>
    <osd></osd>
    <vehicle></vehicle>
    <vehicleprofile></vehicleprofile>
    <mapset></mapset>
    <layout></layout>
  </navit>
</config>

Navit comes preshipped with an default navit.xml that is stored at various locations (depending on your system):

  • in ~/.navit/navit.xml : e.g : /home/myusername/.navit/navit.xml (This is probably to best place to customize your settings!)
  • in /usr/share/navit or /etc/navit

Navit will apply settings in the following order:

  • in the current directory (used on Windows)
  • location supplied as first argument on the command line, e.g.: navit /home/myusername/navittestconfig.xml (Used mainly for development)
  • in the current directory as navit.xml.local (Used mainly for development)

It is also possible to edit the navit.xml file for your Android device under Windows and Linux (Debian/Ubuntu derivates) with a third party application called NavitConfigurator.

Configurable Sections

General

Common options such as units, position, zoom and map orientation, ... be configured in this section.

General options.

Display

A large number of display properties can be configured, including desktop or touchscreen-optimised GUIs, on-screen display items and complete control over menu items.

Display options.


Vehicle

A number of vehicles can be defined within Navit, depending upon the device and/or operating system in use. Vehicle profiles for routing (eg: car, pedestrian, bicycle...) are also completely configurable.

Vehicle options.

Maps

You can use maps from a variety of sources, any number of maps can be configured and enabled at any one time.

Maps options.

Layout

Maps are displayedaccording to the rules defined in the layout. All aspects of the layout are configurable, from POI icons to colours for a particular type of highway.

Layout options.

Advanced

There are many more options, including debugging, specific plugins, speech announcements, trip logging, ...

Advanced options.


General Options

Settings which affect Navit's general behaviour are located within the <navit .. > tag. In a default installation, this is found on line 31 of navit.xml. By default, the navit tag is set as follows:

 <navit center="4808 N 1134 E" zoom="256" tracking="1" orientation="-1" recent_dest="10">

Some common attributes are discussed below. For more advanced features, see the full list of options.

Initial map position

On Navit's very first startup, it needs a center to look at on the map. By default this is set to Munich in Germany, which is conveniently covered by the sample map created on installation.

 center="4808 N 1134 E"

Latitude and longitude are multiplied by 100 (here Munich is at 48.08N 11.34E in decimal degrees). Coordinates must use the WGS-84 projection. You can use decimal degrees

center="[-][D]D.x[x]... [-][D][D]D.x[x]" 

where D = degrees and x = fractions of a degree. You can also use decimal minutes

center="[D]DMM.xxx N/S [D][D]DMM.yyy E/W"

where D = degrees, M = minutes and x/y = fractions of a minute. You can use N or S to denote North or South, and E or W to denote East or West. Lastly, you can use hexadecimal coordinates

center="[-]0xX [-]0xX"

To determine a specific latitude and longitude for your location you can use http://itouchmap.com/latlong.html.

After Navit has started for the first time, it will write its current location to center.txt (located in the Navit home directory) and ignore the current center value.

When Navit starts, it will display the map at a pre-defined zoom. The default zoom level is 256. The lower the value, the closer you will be zoomed in.

zoom="256"

For those using the SDL GUI, a level of 128 is recommended.

zoom="128"

Note that once Navit has started, the zoom level can be altered using OSD or menu items.


Use the orientation attribute to orient the map in either the direction of travel, or oriented North. .To orient the map in the direction of travel:

orientation="-1"

or to orient North:

orientation="0"

Orienting the map North whilst in 3D mode will provide visually confusing results, and is not recommended. When in 3D mode, it's best to have the map oriented in the direction of travel.

Autozoom

Navit has the ability to autozoom the map in or out dependent upon your speed.

autozoom_active="1"

To de-activate autozoom:

autozoom_active="0"

3D pitch

Navit has the capability to display either a 2D map (bird's eye perspective) or a 3D map (some amount of tilt looking to the horizon). Navit's default configuration is to startup in the 2D perspective but it is possible to specify that Navit start with a 3D perspective. The amount of tilt is specified by setting the value of pitch.

The pitch value defines default camera tilting, with a value from 0 to 359. Note that usable values lie between 0 and 90 where 0 is bird's eye perspective looking down and 90 is human perspective looking forward. Also note that values closer to 90 will slow down map drawing, because the line of sight gets longer and longer and more objects are seen.

For example, the following added to the navit tag will force Navit to start with a pitch of 30 degrees:

pitch="30"

Imperial units

By default, Navit use the metric system of measurements when displaying or announcing distances, speeds etc. However, you can configure Navit to display and announce these values in imperial units. Simply add an imperial attribute to the Navit tag, and set its value to 1, as shown below:

imperial="1"

Speeds should now be displayed in units of miles-per-hour, whilst distances are converted to miles (large distances) and feet (small distances).

Display Options

The Navit display is highly customisabl and consists of the following components

  • Graphics driver (appropriate engine for your system, to draw everything)
  • GUI (enables user interaction and map display)
  • OSD (shows widgets on map screen)

Graphics Driver

Different technologies can be used, to let Navit draw it's visual components. Not all might be available at your specific system

The current list of available graphics drivers:

  • android, for the Android port
  • cocoa, for the iPhone port
  • gtk_drawing_area, usually most appropriate on Linux desktop systems
  • sdl, render inside an X window, or direct to the Linux framebuffer, with min dependencies on external libraries.
  • win32 - useable with gtk or internal GUIs for Windows systems only.

Experimental/less maintained drivers:

  • qt_qpainter, render inside X window or on top of Qt Palmtop Environment.
  • opengl, rendering via OpenGL
  • gtk_gl_ext, rendering via OpenGL using GTK+ OpenGL extension
  • gd, rendering using the GD Graphics Library

They can be activated and configured as following:

 <graphics type="gtk_drawing_area"/>

As mentioned, it's usually best to leave this as whatever the default is within your navit.xml, and only mess around with it if you know what you are doing, or have been told to by one of the developers.

Graphical User Interface

You can now choose which type of GUI you would like to use with Navit. Not all GUIs work with all Graphics drivers

GUI android cocoa gd gtk_drawing_are gtk_gl_ext opengl qt_qpainter sdl win32 preview
ceGUI
(unmaintained)
GTK GUI Yes Yes Navit-liberation.png
internal GUI Yes Yes Yes Yes Yes Yes Yes Yes Yes InternalGUI-Actions.png
QML GUI
(unmaintained)
Yes Qml point 20100404.png

Generic GUI Options

There are some options available for the gui tag which are used by all the GUI types. These include:

  • fullscreen - Enables Navit to start in fullscreen mode.
  • pitch - The pitch value to pitch the map to when selecting 3D mode from the menus.
  • dimensions - w="1024" h="600"

The following example uses the internal GUI, and starts Navit up in fullscreen mode, and will pitch the map to 35 degrees when 3D mode is selected from the menu. Note that to start Navit in 3D mode by default, change the pitch value in the navit tag:

 <gui type="internal" enabled="yes" fullscreen="1" pitch="35">

Internal GUI

The first GUI is embedded in Navit core and is primarily aimed at touchscreen devices, or those devices with small screens (such as netbooks). However, this GUI also works very well on desktops and laptops.

 <gui type="internal" enabled="yes">
Options

A number of options specific to the internal GUI are available. These include:

  • font_size - Base text size to use within the internal menu.
  • icon_xs - The size that extra-small style icons should be scaled to (e.g. country flag on town search).
  • icon_s - The size that small style icons should be scaled to (e.g. icons of internal GUI toolbar).
  • icon_l - The size that large style icons should be scaled to (e.g. icons of internal GUI menu).
  • menu_on_map_click - Toggles the ability to bring up the menu screen when clicking on the map. See the internal GUI page for more information.

An example gui tag using the previous options is shown below:

 <gui type="internal" enabled="yes" font_size="250" icon_xs="48" icon_s="48" icon_l="64">

More options are discussed on the Internal Gui and the full list of options.


GTK GUI

The second GUI is called gtk, and is most useful for those users who wish to use a traditional windowed GUI. This is one useful to desktop use.

 <gui type="gtk" enabled="yes" ... />


Options

A number of options specific to the gtk GUI are available. These include:

  • menubar - enable/disable the menubar
  • toolbar - enable/disable the toolbar
  • statusbar - enable/disable the statusbar


 <gui type="gtk" enabled="yes" menubar="1" toolbar="1" statusbar="1"/>

On Screen Display

OSD

Vehicle Options

It's important to understand the separate but linked Navit concepts of a vehicle and vehicleprofile element. A vehicle defines the source of positional data (suchas a USB GPS device), and how to present that data to the user on the map, where the vehicleprofile defines all aspects of routing.

A simple vehicle definition looks like this:

  <vehicle name="My" enabled="yes" source="file://dev/ttyS0"/ active="1"/>


Here some of the available options:

  • active: If set to 1, makes the vehicle the default active one. Routing, view centering and map redraw would be applied to this one by default.
  • enabled: If set to yes, Navit connects to the vehicle data source and shows the vehicle on the map.
  • follow: map follows after "n" gps updates (where n=0 means only when the vehicle leaves the map->saving CPU time)
  • source : source of GPS (required)
  • profilename: link the vehicleprofile for this vehicle.


GPS

Most esential detail is the gps source, that need to be adapted to your local setup.


Local:

Windows:

  • source="serial:COM2 baud=4800 parity=N data=8 stop=1"
    • For Locosys GT31 (or BGT31 plugged by USB), settings are: source="serial:COM3 baud=38400 parity=N data=8 stop=1" where COM3 should be replaced by the correct COM over USB number.

Windows Mobile:

  • source="wince:GPD1:" - using the internal GPS driver, configured from Windows Remote GPS Settings.
    • To use a BT GPS it must be configured as outgoing com port and paired, then selected as hardware port in GPS Settings.
    • To start bluetooth on navit startup add bluetooth="yes". When exiting navit, the previous bluetooth state is recovered.
  • source="wince:COM1: baudrate=4800"

There is useful SirfTech utility that can automatically scan existing serial ports trying different baudrates to detect GPS source.

Linux:

  • source="file:/dev/rfcomm0" - BlueTooth GPS
  • source="file:/dev/ttyS0" - serial GPS connected to the first serial port (you may need to add the correct baudrate eg.: freerunner source="file:/dev/ttySAC1" baudrate="9600")
  • source="gpsd_dbus:" - via dbus, postion reported by gpsd

Network based:
If you want to connect multiple tools to your GPS, you need an multiplexer tool, as gpsd or gypsy.

  • source="gpsd://host[:port]" - gpsd://localhost, the default one, will try to connect to gpsd on localhost
  • source="socket:ipaddr:post" - socket connection (expects nmea stream)
  • source="socket:ipaddr:2947:r=1" - connect to gpsd in nmea mode (gpsd versions 2.39 or older)
  • source='socket:ipaddr:2947:?WATCH={"enable":true,"nmea":true};' - connect to gpsd in nmea mode (gpsd versions newer than 2.39)
  • source="gypsy://connectstring" - gypsy

Tricks:

  • source="file:/home/myhome/mynmea.log" : here, navit will replay the nmea logfile (under Windows it is currently not possible in Navit)
  • source="pipe:/usr/bin/gpspipe -r" - any executable that produces NMEA output - gpsbabel, gpspipe, ...
  • source="demo://" : to use the demo vehicle. Set your Position and Destination, and vehicle will follow the calculated route. Useful if you have no nmea data source.
  • source="null://" : no GPS at all

Logging tracks

To record your trip , you can add a sub-instance "log" to the vehicle. It is possible to add multiple logs.

 <log type="gpx" data="track_%Y%m%d%i.gpx" flush_size="1048576" flush_time="900" />
 <log type="nmea" data="track_%Y%m%d%i.nmea" flush_size="1048576" flush_time="900" />


This will give a log file named YearMonthDaySequencenumber.gpx/.nmea which will be kept in memory and flushed to disk when it is 1048576 bytes large or the oldest data is older than 900 seconds.

To display your track for more than one hour, you must use binfile to create a cache file that get's display

 <log type="binfile" data="track.bin" flush_size="0"/>

For customizing what is stored, see GPX

Vehicleprofile

Profiles to add in the navit.xml
Defines the behaviour of the routing and are usually linked to a vehicle section, so switching the "vehicle" (type of mobility) from within Navit, routing also will change its behaviour. This way, it is possible to include steps for pedestrian routing, but to exclude it for bike, horse or car routing. Within the vehicleprofile section, roadprofile sections are used to describe the routing behaviour of different roads. Here's a very basic example:

<vehicleprofile name="bike" flags="0x40000000" flags_forward_mask="0x40000000" flags_reverse_mask="0x40000000" maxspeed_handling="1" route_mode="0">
  <roadprofile item_types="path,track_ground" speed="12" route_weight="5">
  </roadprofile>
  <roadprofile item_types="track_gravelled,track_paved,cycleway,street_service,street_parking_lane,street_0,street_1_city,living_street,street_2_city,street_1_land,street_2_land,street_3_city" speed="25" route_weight="15">
  </roadprofile>
  <roadprofile item_types="roundabout" speed="20" route_weight="10"/>
  <roadprofile item_types="ferry" speed="40" route_weight="40"/>
 </vehicleprofile>

For details on the flags, see Vehicle profile flags. The speeds are in km/h.

Only the vehicle profile names "car", "bike" and "pedestrian" are translated in the GUI.

Maps Options

Navit can read various map formats, and can even show multiple maps at a time. This is done by defining a mapset. Each mapset can have one or more maps. Using the GTK GUI, you can enable or disable specific maps at runtime.

 <mapset>
   <map type="binfile" enabled="yes" data="/var/navit/maps/uk.bin" />
   <map type="binfile" enabled="yes" data="/var/navit/maps/france.bin" />
   <map type="binfile" enabled="yes" data="/var/navit/maps/*.bin" />
 </mapset>

To get free maps, see OpenStreetMap

For different providers see Maps

Layout Options

A layout defines how to render a map. Layouts are fully customisable, from the road colours and widths to size and type of icons to display for specific POIs. The layout is also where the cursor (i.e. the shape which shows where you are) is defined.
A number of user-generated layouts and cursor definitions are available at Layout.

A layout consist of one or more layers which are each a set of rules on how and when to draw certain items. Those rules are called itemgra. The layers are rendered one by one in the order they appear in the navit.xml file, as are the items in each layer. If you can't see an item make sure there is not another one hiding it (z-ordering!). If your item is hidden, you can move your item further down in the layout section of the file.

 <layout name="Demo layout" color="#ffefb7" font="Liberation Sans" active="1">
	<cursor w="26" h="26">
	<layer name="layer_1">
		<itemgra item_types="water_poly" order="0-">
			<polygon color="#82c8ea" />
		 	<polyline color="#5096b8" />
		 </itemgra>
	</layer>
 <layout>


Here the available options:

  • item_types: Comma separated list of items (see navit/item.h for definitions)
  • order: Range for zoom levels.
  • speed_range: Range for vehicle speed, useful for cursors.
  • angle_range: Range for pitch angle.
  • sequence_range: Useful for animated cursors.

For infos about map icons, see Icons

Advanced Options

The rest of this webpage is meant for advanced/power users who'd like to fiddle a little more under-the-hood. The average user can safely ignore this section!

Speech

Navit makes use of external text-to-speech tools (TTS) to announce driving directions with voice. Thus, not all tools are available on your platform and they are invoked via commandline

wave
Navit is able to compose phrases if you give it a set of prerecorded samples. Directory /path/to/waves should contain audio files which names end with .wav. The names of the waves must give the complete sentence together. So for "turn right in 300 meters" you need turn.wav, right.wav, in.wav, 300.wav, meters.wav. If file turn_right.wav is present, it will be used even if you have turn.wav and right.wav.

Also you need a program, named in this example wavplay which should play a sequence of wave files given on its command line.

Note that if any file that is needed to compose the complete phrase is missing then Navit will be silent.

By default Navit is trying to announce street names. To disable this feature you can set vocabulary_name and vocabulary_name_systematic to 0 in the speech tag which will specify that the speech synthesizer isn't capable of speaking names. Also there is vocabulary_distances which you can set to 0 so only the minimum set of 1,2,3,4,5,10,25,50,75,100,150,200,250,300,400,500,750 as numbers is used. With these changes, last example will look like this:

 <speech type="cmdline" data="wavplay %s" sample_dir="/path/to/waves" sample_suffix=".wav" />

espeak

<speech type="cmdline" data="espeak -s 150 -v english_rp %s"/>

Will use espeak instead, for those who want Navit to speak to them in English, at 150 words per minute. The %s is filled in by Navit when sent to the speech synthesis software (with something like "Turn left" or whatever is appropriate at the time). If you need more features, you should use an external wrapper script which can contain anything supported by your shell (see Translations).

festival

flite

Mbrola

Android

 <speech type="android" cps="15"/>


Debugging

Bookmarks

Splitting navit.xml

Navit has support for a small subset of XInclude / XPath for including parts of external XML files. Supported is a tag like

 <xi:include href="some_file" xpointer="xpointer_stuff" />

You can leave out either href (xi:include refers to the same file it is in then) or xpointer (xi:include then refers the complete file), but not both. The href attribute refers to a file relative to the current directory. It is suggested to use the complete path, such as /home/root/.navit/navit-vehicles.xml.

href is expanded with wordexp internally, so you can do stuff like:

 <xi:include href="$NAVIT_SHAREDIR/maps/*.xml" />

Some examples on the supported syntax:

 <xi:include xpointer="xpointer(/config/navit/layout[@name='Car']/layer[@name='points'])" />

references to the XML-Tag "layer" with attribute "name" of value "points" within an XML-Tag "layout" with attribute "name" of value "Car" within an XML-Tag "navit" within an XML-Tag "config".

 <config xmlns:xi="http://www.w3.org/2001/XInclude">
 <xi:include href="$NAVIT_SHAREDIR/navit.xml" xpointer="xpointer(/config/*[name(.)!='navit'])"/>
 <navit center="4808 N 1134 E" zoom="256" tracking="1" cursor="1" orientation="0">
 <xi:include href="$NAVIT_SHAREDIR/navit.xml" xpointer="xpointer(/config/navit/*[name(.)!='vehicle'])"/>
 </navit>
 </config>

Use this as your $HOME/.navit/navit.xml and you will get everything under <config>..</config> except <navit>..</navit> (first xi:include), plus <navit> as specified plus everything from navit within config, except the vehicle definitions (second xi:include).