Difference between revisions of "Dbus"

From Navit's Wiki
Jump to: navigation, search
(Navit Dbus details:)
(Updated functions)
Line 8: Line 8:
  
 
=Navit Dbus Methods:=
 
=Navit Dbus Methods:=
==Redraw==
+
==Set destination==
Forces a redraw of the current map section
+
Sets the destination. coord is a string containing the coordinates in a special format. pro contains the map projection while x and y define the position. descr is a description for the target
 +
 
 +
coord can be formatted like this:
 +
[Proj:]-0xX [-]0xX
 +
  - where Proj can be mg/garmin, defaults to mg
 +
[Proj:][D][D]Dmm.ss[S][S] N/S [D][D]DMM.ss[S][S]... E/W
 +
[Proj:][-][D]D.d[d]... [-][D][D]D.d[d]
 +
  - where Proj can be geo
 +
 
 +
Name: set_destination<br>
 +
Args: string coord, string descr<br>
 +
Args: (int pro, string coord), string descr<br>
 +
Args: (int pro, int x, int y), string descr<br>
 +
Returns: (none) <br>
 +
 
 +
==Zoom==
 +
Zooms into the map if f is positive, otherwise it zooms out. f is the zoom factor and has to be bigger than 1 or smaller than -1. Values between 1 and -1 have no effect. In addition, x and y can be set to zoom into a special point on the screen.
 +
 
 +
Name: zoom<br>
 +
Args: int f[, (int x, int y)]<br>
 +
Returns: (none)
 +
 
 +
==Set position==
 +
Sets the current position. See [[#Set destination|Set destination]].
  
Name: draw<br>
+
Name: set_destination<br>
Args: (none)<br>
+
Args: string coord<br>
Return: (none)<br>
+
Args: (int pro, string coord)<br>
 +
Args: (int pro, int x, int y)<br>
 +
Returns: (none) <br>
  
 
==Center map (coordinates)==
 
==Center map (coordinates)==
Centers the view to a absolute position on the map. Useful when looking up for some coordinates (e.g. for bookmarks). pro contains the [[Projections | map projection]] while x and y define the position.
+
Centers the view to a absolute position on the map. Useful when looking up for some coordinates (e.g. for bookmarks). See [[#Set destination|Set destination]].  
  
 
Name: set_center<br>
 
Name: set_center<br>
 +
Args: string coord<br>
 +
Args: (int pro, string coord)<br>
 
Args: (int pro, int x, int y)<br>
 
Args: (int pro, int x, int y)<br>
 
Returns: (none) <br>
 
Returns: (none) <br>
Line 36: Line 63:
 
Returns: (none)<br>
 
Returns: (none)<br>
  
==Zoom==
+
==Redraw==
Zooms into the map if f is positive, otherwise it zooms out. f is the zoom factor and has to be bigger than 1 or smaller than -1. Values between 1 and -1 have no effect. In addition, x and y can be set to zoom into a special point on the screen.
+
Forces a redraw of the current map section
  
Name: zoom<br>
+
Name: draw<br>
Args: int f[, (int x, int y)]<br>
+
Args: (none)<br>
Returns: (none)
+
Return: (none)<br>
 
 
==Set destination==
 
Sets the destination. pro contains the map projection while x and y define the position. descr is a description for the target
 
 
 
Name: set_destination<br>
 
Args: (int pro, int x, int y), string descr<br>
 
Returns: (none) <br>
 
 
 
==Set position==
 
Sets the current position. pro contains the map projection while x and y define the position.
 
 
 
Name: set_destination<br>
 
Args: (int pro, int x, int y)<br>
 
Returns: (none) <br>
 
  
==Getting current position (in coordinates)==
+
<!--==Getting current position (in coordinates)==
 
Not Implemented
 
Not Implemented
  
Line 69: Line 82:
 
Name: getCurrentSpeed<br>
 
Name: getCurrentSpeed<br>
 
Args: (none)<br>
 
Args: (none)<br>
Returns: speed in kph/mph<br>
+
Returns: speed in kph/mph<br>-->
  
 
[[category: navit dbus]]
 
[[category: navit dbus]]

Revision as of 15:43, 12 March 2009

This Document displays the requirements and implementation details of the navit dbus interface.

Navit Dbus details:

DBUS Service: "org.navit_project.navit"
DBUS Object Path: "/org/navit_project/navit"
DBUS Interface: "org.navit_project.navit.navit"
DBUS Bus: Session bus

Navit Dbus Methods:

Set destination

Sets the destination. coord is a string containing the coordinates in a special format. pro contains the map projection while x and y define the position. descr is a description for the target

coord can be formatted like this:

[Proj:]-0xX [-]0xX
 - where Proj can be mg/garmin, defaults to mg
[Proj:][D][D]Dmm.ss[S][S] N/S [D][D]DMM.ss[S][S]... E/W
[Proj:][-][D]D.d[d]... [-][D][D]D.d[d]
 - where Proj can be geo

Name: set_destination
Args: string coord, string descr
Args: (int pro, string coord), string descr
Args: (int pro, int x, int y), string descr
Returns: (none)

Zoom

Zooms into the map if f is positive, otherwise it zooms out. f is the zoom factor and has to be bigger than 1 or smaller than -1. Values between 1 and -1 have no effect. In addition, x and y can be set to zoom into a special point on the screen.

Name: zoom
Args: int f[, (int x, int y)]
Returns: (none)

Set position

Sets the current position. See Set destination.

Name: set_destination
Args: string coord
Args: (int pro, string coord)
Args: (int pro, int x, int y)
Returns: (none)

Center map (coordinates)

Centers the view to a absolute position on the map. Useful when looking up for some coordinates (e.g. for bookmarks). See Set destination.

Name: set_center
Args: string coord
Args: (int pro, string coord)
Args: (int pro, int x, int y)
Returns: (none)

Center map (pixel)

Centers the map to a specific position on the screen. x and y contain the pixel coordinates on the current map section starting from the upper left.

Name: set_center
Args: (int x, int y)
Returns: (none)

Set layout

Sets the map layout

Name: set_layout
Args: string layout_name
Returns: (none)

Redraw

Forces a redraw of the current map section

Name: draw
Args: (none)
Return: (none)