Difference between revisions of "Configuration"

From Navit's Wiki
Jump to: navigation, search
(General)
 
(71 intermediate revisions by 15 users not shown)
Line 1: Line 1:
Navit is highly configurable. Options such as cursor shape, map rendering, vehicle behaviour and display layouts can all be configured. This page aims to show the most common options which a first-time user may want to change - for the power user please also see [[Configuring_Navit/Full_list_of_options | the full list of options]].
+
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 [[Configuration/Full_list_of_options | the full list of options]].
 +
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]].
  
=Introduction=
+
Setting up Navit is done by editing a configuration file called "'''navit.xml'''".
Discuss the fact that configuring Navit is done through configuring an xml file. No GUI.
+
Editing XML configurations files in a text editor is simple, they are just plain text XML files, 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.<br>
 +
The XML configuration file is splitted into sections within a hierarchy:
 +
<source lang="xml">
 +
<config>
 +
  <plugins></plugins>
 +
  <navit>
 +
    <osd></osd>
 +
    <vehicle></vehicle>
 +
    <vehicleprofile></vehicleprofile>
 +
    <mapset></mapset>
 +
    <layout></layout>
 +
  </navit>
 +
</config>
 +
</source>
 +
 
 +
Navit comes '''preshipped''' with a default navit.xml together with navit_layout_*.xml files that are stored at various locations (depending on your system). For Linux-like OSes:
 +
* in ~/.navit/ : 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)
 +
 
 +
{{note
 +
|In any case, you have to '''adapt settings''' to your system!<br> This includes especially GPS, map provider and vehicle: [[Basic configuration]]
 +
}}
  
 
=Configurable Sections=
 
=Configurable Sections=
Line 15: Line 42:
 
| style="margin:2px; padding:10px;" |
 
| style="margin:2px; padding:10px;" |
  
Options such as starting position, 3D orientation and metric/imperial can be modified in the general Navit tag. Autozoom and map orientation can also be configured in this section.
+
Common options such as units, position, zoom and map orientation, ... be configured in this section.
  
[[#General| General options.]]
+
[[Configuration/General_Options| General options.]]
  
 
|}
 
|}
Line 33: Line 60:
 
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.
 
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| Display options.]]
+
[[Configuration/Display_Options| Display options.]]
  
 
|}
 
|}
Line 47: Line 74:
 
| style="margin:2px; padding:10px;" |
 
| style="margin:2px; padding:10px;" |
  
A number of vehicles can be defined within Navit, depending upon the device and/or operating system in use. Vehicle profiles (eg: car, pedestrian, bicycle...) are also completely configurable.
+
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| Vehicle options.]]
+
[[Configuration/Vehicle_Options| Vehicle options.]]
  
 
|}
 
|}
Line 65: Line 92:
 
| style="margin:2px; padding:10px;" |
 
| style="margin:2px; padding:10px;" |
  
Navit can use maps from a variety of sources, thought the most popular are OpenStreetMap derived maps. Any number of maps can be configured and enabled at any one time.
+
You can use maps from a variety of sources, any number of maps can be configured and enabled at any one time.
  
[[#Maps| Maps options.]]
+
[[Configuration/Maps_Options| Maps options.]]
  
 
|}
 
|}
Line 80: Line 107:
 
| style="margin:2px; padding:10px;" |
 
| style="margin:2px; padding:10px;" |
  
Maps are displayed on-screen according 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.
+
Maps are displayed according 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.
 +
 
 +
For all versions shipped after nov 2018, layout XML configuration is stored in dedicated XML files called with the prefix '''navit_layout_''' (one file per layout definition).
  
[[#Layout| Layout options.]]
+
[[Configuration/Layout_Options| Layout options.]]
  
 
|}
 
|}
Line 95: Line 124:
 
| style="margin:2px; padding:10px;" |
 
| style="margin:2px; padding:10px;" |
  
There are many more options, including debugging, specific plugins (such as Garmin maps), speech announcements and trip logging.
+
There are many more options, including debugging, specific plugins, speech announcementstrip logging, ...
  
[[#Advanced| Advanced options.]]
+
[[Configuration/Advanced_Options| Advanced options.]]
  
 
|}
 
|}
Line 104: Line 133:
 
|}
 
|}
 
</div>
 
</div>
 
==General==
 
Settings which affect Navit's general behaviour are located within the <tt><navit .. ></tt> tag. In a default installation, this is found on line 31 of <tt>navit.xml</tt>. By default, the <tt>navit</tt> 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 [[Configuring_Navit/Full_list_of_options | the full list of options]].
 
 
===Initial map center position===
 
On Navit's very first startup, it needs a position 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"
 
 
Note that the latitude and longitude are multiplied by 100 (i.e. 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 [[FAQ#Weird_coordinates_in_bookmarks.txt_and_centre.txt | 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 <tt>center.txt</tt> (located in the Navit home directory: <tt>~/.navit</tt>, for example). Upon startup, Navit will read this file and center the map to these coordinates, rather than those defined in the <tt>center</tt> attribute.
 
 
===Initial map zoom level===
 
When Navit starts, it will display the map at a pre-defined zoom level. This is configured using the <tt>zoom</tt> attribute. The default zoom level is 256. The lower the value, the closer you will be zoomed in. (Power2?).
 
 
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.
 
 
===Map orientation===
 
You can choose to orient the map in either the direction of travel, or oriented North. Use the <tt>orientation</tt> attribute. During typical navigation, most satellite navigation systems have the map oriented in the direction of travel. 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.
 
 
The map orientation is one of the options which can be changed from within the Navit menus, either from the main menu bar (GTK GUI), or <tt>Settings -> Rules -> Northing</tt> (Internal GUI).
 
 
===Autozoom===
 
Navit has the ability to zoom the map in or out dependent upon your speed. By default this option is not included within <tt>navit.xml</tt>, so it will have to be added. To active autozoom:
 
 
autozoom_active="1"
 
 
To de-activate autozoom:
 
 
autozoom_active="0"
 
 
or just remove the entry from the <tt>navit</tt> tag entirely.
 
===Initial 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 <tt>pitch</tt>.
 
 
The <tt>pitch</tt> 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.
 
 
Note that by default the <tt>navit</tt> tag does not contain the <tt>pitch</tt> attribute so you will have to add it.
 
 
For example, the following added to the <tt>navit</tt> tag will force Navit to start with a pitch of 30 degrees:
 
 
pitch="30"
 
 
The map pitch can also be altered using the GUIs, although only to an angle specified in the <tt>gui</tt> tag.
 
===Imperial units===
 
 
==Display==
 
 
==Vehicle==
 
 
==Maps==
 
 
==Layout==
 
 
==Advanced==
 
  
 
<!-- Following line disables table of contents -->
 
<!-- Following line disables table of contents -->
 
__NOTOC__
 
__NOTOC__
 +
 +
[[Category:Customizing]]
 +
[[Category:Configuration]]

Latest revision as of 22:39, 1 January 2019

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

Setting up Navit is done by editing a configuration file called "navit.xml". Editing XML configurations files in a text editor is simple, they are just plain text XML files, 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 XML configuration file is splitted into sections within a hierarchy:

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

Navit comes preshipped with a default navit.xml together with navit_layout_*.xml files that are stored at various locations (depending on your system). For Linux-like OSes:

  • in ~/.navit/ : 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)

Configurable Sections[edit]

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 displayed according 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.

For all versions shipped after nov 2018, layout XML configuration is stored in dedicated XML files called with the prefix navit_layout_ (one file per layout definition).

Layout options.

Advanced

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

Advanced options.