source: subversion/applications/utils/export/osmgarminmap/README @ 28719

Last change on this file since 28719 was 5103, checked in by jochen, 12 years ago

warning to use mkgmap

File size: 5.2 KB
Line 
1
2OSMGarminMap
3------------
4
5****************************************************************************
6
7  IMPORTANT!
8
9  OSMGarminMap has not been updated to work with API 0.5 files. We recommend
10  you use the "Mkgmap" program instead which works with API 0.5 files and
11  is faster and easier to use.
12
13  See: http://wiki.openstreetmap.org/index.php/Mkgmap
14
15****************************************************************************
16
17By Jochen Topf <jochen@remote.org>
18
19
20This program will convert OpenStreetMap .osm-Files into maps that can be
21loaded into Garmin GPS devices.
22
23It supports showing nodes, segments, ways and areas using Garmin icons etc.
24
25You will also need the "cGPSmapper" program and its companion "sendmap".
26These programs are not Open Source but there is a free version for
27personal use which you can download from http://www.cgpsmapper.com/ .
28
29
30CREATING A MAP
31--------------
32Download some data from OpenStreetMap Server and save it into a file called
33"data.osm". You can then call "make" and it will generate the Garmin map
34file in several steps. The makefile uses xsltproc, but it is easy to change
35to use other XSLT engines. You also have to change the location of the
36cGPSmapper program in the Makefile.
37
38If there is a problem or you want to know about the details, here is a
39step-by-step description:
40
411. OSM -> MPX
42   In the first step this data will be converted from the OSM XML format
43   into an XML format that is much nearer to the format that Garmin
44   devices can understand. Mapping from the OSM format to the Garmin
45   format you have to decide which OSM features should be mapped to which
46   Garmin features. To describe this process, you can change the osm2mpx.xml
47   File. It uses the same rules as Osmarender uses. In fact I "stole"
48   some of the Osmarender code for this.
49
50   xsltproc osm2mpx.xml >map.mpx
51
522. MPX -> MPL
53   The second step will convert this XML format to a legacy format called
54   the Polish format which can then be read by cGPSmapper. This is where
55   the symbolic names in the .mpx file will get translated into hex codes.
56
57   xsltproc feature-list.xml >map.mpl
58
593. MPL -> MP
60
61   Remove zero length segments from polylines.
62
63   mpl2mp.pl map.mpl >map.mp
64
654. MP -> IMG
66   This file can then be read by cGPSmapper, which will create a .img file.
67
68   cgpsmapper-static map.mp
69
70   This will take a moment. You'll see some output from cGPSmapper ending
71   with:
72    Done!
73    File :map.img is ready to use
74
75
76TRANSFERRING MAP TO GPS UNIT
77----------------------------
78Now you can take this file and transfer it to your GPS unit using the
79sendmap program which is also available from the cGPSmapper website.
80
81  sendmap20 map.img
82
83You might need to use some options depending on where your GPS unit is
84attached (serial port/USB). You might need to be root. Call sendmap
85without any parameters to get help.
86
87
88DEVICES
89-------
90
91This was tested on my Garmin GPSmap 60CSx. Works reasonably well.
92
93
94MAP FEATURES
95------------
96
97The list of map features is created from the OpenOffice spreadsheet file
98called feature-list.ods. To change anything, change this spreadsheet file,
99save as CSV with the vertical bar (|) as field delimiter and no text
100delimiter. Then run the feature-list-csv2xml.pl file like this:
101
102./feature-list-csv2xml.pl feature-list.csv >feature-list.xml
103
104
105KNOWN ISSUES
106------------
107
108* The list of map features that Garmin offers is not complete. The list
109  was created from some incomplete stuff I found on the web. If you find
110  any other code for other features please tell me.
111
112* Currently the conversion of OSM features into Garmin features is very
113  basic. The usual highways are included as well as parks and forests
114  and some amenities like parking lots and telephones. I welcome any
115  additions.
116
117* Ways will be put into the Garmin map not one segment at a time, but
118  as a complete way. If the segments are not ordered properly along the
119  way (something which can easily happen in OSM when adding new segments
120  to a way) you'll get spurious segments zigzaggin around the map. I'll
121  probably not fix this in OSMGarminMap, because it should be fixed in
122  the database itself. That way the fix will help everybody, regardless
123  in which way they are using the data.
124 
125  If you have bad data, you can use the included fix.xsl style sheet
126  created by Ludwig Max Brinckmann to first fix your OSM data files. This
127  will find all non-contiguous ways and split them into one way per segment.
128  Use it like this:
129  xsltproc fix.xsl data.osm >data-with-fix.osm
130
131* OSMGarminMap ignores tagged segments.
132
133
134LICENSE
135-------
136Copyright (C) 2006, 2007  Jochen Topf <jochen@remote.org>
137
138This program is free software; you can redistribute it and/or modify
139it under the terms of the GNU General Public License as published by
140the Free Software Foundation; either version 2 of the License, or
141(at your option) any later version.
142
143This program is distributed in the hope that it will be useful,
144but WITHOUT ANY WARRANTY; without even the implied warranty of
145MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
146GNU General Public License for more details.
147
148You should have received a copy of the GNU General Public License
149along with this program; if not, write to the Free Software
150Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
151
Note: See TracBrowser for help on using the repository browser.