cGPSmapper User Manual

Number of levels (layers) in the map (at least 2, not more than 10).

Note: the last layer must always be empty, e.g. Levels=3 means that two layers only are available for map objects.

Grid size for layer # (layer 0 is the most detailed one).

Refer to section 9.3 (Creating preview map files), on page 87, for details.

N map designated for use with GPS will be created

Y map designated for use as preview map for

MapSource will be created

Default = N

No longer used / supported.

Value between 0 and 31 indicating the priority used by the

GPS to draw the map. The highest value – the highest priority is set.

Priority for the transparent maps is calculated by adding always 32 to the set priority by DrawPriority value.

Default = 25.

Indicates if the map is of marine type.

N or 0 non-marine map

Y or 1 marine map

B or 2 marine map – compatible with G2 devices

X or 3 non-marine map – compatible with G2 devices

– be aware – Garmin does not produce such non-marine maps compatible with G2 devices only

Default = N.

section (or [RGN80]) as described in section 4.2.4.2

http://cgpsmapper.com/ 14 of 130

cGPSmapper Manual

LeftSideTraffic=x

Indicates if driving side is right (default) or left.

N or 0 driving side is right

Y or 1 driving side is left

Default = N.

NT=x

[END]

Used for routable maps only – for proper display of roundabout icon / other maneuver icons.

Experimental. Changes storage format to NT-like. This is

NOT YET real Garmin NT format.

N or 0 normal storage format

Y or 1 Experimental NT format

Default = N.

Section terminator.

4.2.2 Declarations

The DECLARATION elements must be in the order shown herewith.

4.2.2.1 Countries

Although this section is obsolete, it is still supported.

[COUNTRIES]

Declares all countries used for city indexing

Country#=country_n ame~[0x1d]abbrevia tion

...

[END]

Name and abbreviation used to identify country #.

The first # must always be one.

E.g.: Country1=United States~[0x1d]US

80 characters maximum.

The statement above can be repeated as needed.

# must be in ascending order.

Section terminator

4.2.2.2 Regions

Although this section is obsolete, it is still supported.

[REGIONS]

Declares all regions used for city indexing

Region#=region_nam e~[0x1d]abbreviati on

CountryIdx#=countr y_index

Name and abbreviation used to identify region #.

The first # must always be one. Subsequent # must be ordered ascending.

E.g.: Region1=New York~[0x1d]NY

80 characters maximum.

The country_index represents the number in the corresponding

Country#

statement.

...

The first # (CountryIdx) must always be one.

Subsequent

# must be in ascending order.

If included, there must be at least 1 region per country. In theory, the limit is 13,107.

E.g.: CountryIdx1=1, means that the current region is located in country 1 (right side of the equals sign).

The statements above can be repeated as needed.

Unlikely, since each region normally is located in a single country. http://cgpsmapper.com/ 15 of 130

cGPSmapper Manual

[END]

Section terminator.

4.2.2.3 Cities

Although this section is obsolete, it is still supported.

[CITIES]

Declares all cities used for indexing

City#=ciy_name

Name used to identify the city #.

The first # must always be one. Subsequent # must be in ascending order.

E.g.: City1=New York

80 characters maximum.

RegionIdx#=region_ index

The region_index represents the number in the corresponding

Region#

statement.

The first # (RegionIdx) must always be one. Subsequent

...

[END]

# must be in ascending order.

If included, there must be at least 1 city per Region. In theory, the limit is 13,107.

E.g.: RegionIdx1=1, means that the current city is located in

Region 1 (right side of the equal sign).

The statements above can be repeated as needed.

Section terminator.

4.2.2.4 Chart Info

[CHART INFO]

Name=xxx

Number=xxx

Projection=xxx

Published=xxx

Scale=###

DeltaSN=###

DeltaWE=###

IALA=x

Print=mmyyyy

Declarations for marine charts, attached to the 'marine chart' object - which is created automatically as well (similar to the background object) - and also attached to the 'marine border' line.

This section should only be present if in the

[IMG ID] section, there is a definition

Marine=Y

Chart Name (e.g. La Plata to Nueva Palmira).

Chart Code (e.g. Gb3561(a)).

Chart Projection (e.g. Mercator).

Place where the chart was published (e.g. United Kingdom).

Map scale (e.g. 1:100000).

Longitude Delta.

Latitude Delta.

IALA system. The areas that use the 'B' system are the

Americas, Japan and the Philippines. The remainder of the world uses the 'A' system.

Default = A

Paper chart print date.

Note that MapSource will show the day as "01" (the day field is not available in the GPS).

Unlikely, since each city normally is located in a single region. http://cgpsmapper.com/ 16 of 130

₪

₪ cGPSmapper Manual

Edition=mmyyyy

Correction=ddmmyyy

Paper chart edition date.

Note that MapSource will show the day as "01" (the day field is not available in the GPS).

Paper chart correction date. y

Text=xxx

ReferenceEllipsoid

=###

Very long description / information.

There could be several

Text

entries in a single object.

16kb maximum (each entry).

TextFile=file_name

File containing a very long description / information.

There could be several

TextFile

entries in a single object.

The path could be either absolute or relative to the current directory.

For platform portability, it is recommended to use slashes "/" instead of backslashes "\" to separate directories in the path.

In Unix, file_name

is case sensitive.

16kb maximum (each entry).

Reference Ellipsoid.

0 Krassovsky

1 Airy

2 Modified Airy

3 Australian National

4 Bessel 1841

5 Bessel 1841 (Namibia)

6 Clarke 1866

7 Clarke 1880

8 Everest (Brunei)

9 Everest (India 1830)

10 Everest (India 1956)

11 Everest (W Malaysia 1948)

12 Everest (W Malaysia 1969)

13 Modified Everest

14 Fischer 1960/Mercury

15 Modified Fischer 1960

16 Fischer 1968

17 GRS 1967

18 GRS 1980

19 Helmert 1906

20 Hough

21 International

22 South American 1969

23 WGS-60

24 WGS-66

25 WGS-72

26 WGS-84

27 Unknown http://cgpsmapper.com/ 17 of 130

cGPSmapper Manual

[END]

Section terminator.

4.2.3 Advanced Declarations

The ADVANCED DECLARATIONS elements must be in the order shown herewith.

4.2.3.1 Background

[BACKGROUND]

Name=file_name

[END]

τ π ₪ Declares a custom shape for the map – another way to define a custom shape for the map is to use a [POLYGON]

Name of the ESRI file without extension

This should be the full or relative path for the ESRI file, without the extension (which should be .shp for files containing ESRI data)

Section terminator.

4.2.3.2 Dictionary

[DICTIONARY]

Level#RGNnn=bitmas k

[END]

Refer to section 4.5 (on page 47) for details.

bitmask mask used to show / hide the objects.

level on which the bitmask is applied.

type of object to which the bitmask is applied.

Section terminator.

4.2.3.3 Highways

♣ This section will be further documented in a future version of this manual.

[HIGHWAYS]

[END]

Section terminator.

4.2.3.4 ZIP Codes

Although this section is obsolete, it is still supported.

♣ This section will be further documented in a future version of this manual.

[ZIPCODES]

[END]

Section terminator.

4.2.3.5 Definitions

Refer to section 5.7, on page 55, for further details.

[DEFINITIONS]

[END]

Section terminator.

4.2.4 Body (Objects)

BODY objects may be specified in any order. http://cgpsmapper.com/ 18 of 130

cGPSmapper Manual

4.2.4.1 Point of Interest

[POI]

Point of interest section identifier.

[RGN10]

(meaning point of interest) and

[RGN20]

(meaning point) may be used instead.

Type=object_type

Type of element, may be written in hex or decimal or as a name (valid names are defined in file RGNtyps.txt which you can customised to your requirements).

SubType=object_typ e

SubType

defines the second byte of the

Type

value.

The type of element can be defined either by using the

Type key only or by using the

Type

and

SubType

keys.

Example:

Type=0x0211 can be also written as:

Type=0x02

SubType=0x11

Extended / marine types can be stored in 3 bytes as follow:

Type=0x010203

What correspond to:

Type=0x02

Marine=x

City=x

SubType=0x03

Marine=Y

Indicates if the object is extended / marine type.

N or 0 standard type

Y or 1 extended type

Default = N

Indicates if the POI is a city.

Only used if the

[POI]

alias is used.

N or 0 not a city (instead of

[RGN10])

Y or 1 city (instead of

[RGN20])

Default = N

Label=object_name

Name of the object to be shown on the map.

80 characters maximum.

EndLevel=#

The coordinates in the lowest numbered

Data#

line apply up to the specified

EndLevel=#

. http://cgpsmapper.com/ 19 of 130

cGPSmapper Manual

Data#=(lat,lon)

StreetDesc=xxx

HouseNumber=xxx

Origin#=(lat,lon)

may be used instead.

Object data for layer #.

12.2 (Exits), on page 105.

Coordinates are in degrees, using the datum defined in the header

(or default).

Applies to

[RGN10]

only.

Address for the

[RGN10]

object.

80 characters maximum.

Applies to

[RGN10]

only.

House number for POI defined by the object.

80 characters maximum.

Field is used to define POI address – number. Value should be defined as an integer number with eventual use of special codes which represent type of address.

Special sequence

Meaning (how it is translated in GPS device)

-0 #

-1 APT

-2 BLDG

-3 DEPT

-4 FL

-5 RM

-6 STE

-7 UNIT

Example:

HouseNumber=10-1103

This will be translated to: 10 APT 103

OvernightParking=x

Applies to

[RGN10]

only.

Highway=xxx

Indicates if 24 hr parking is allowed.

N or 0 No

Y or 1 POI at the exit of a highway will have an

'overnight parking' flag.

Default = N

Applies to

[RGN10]

only.

Name of the Highway.

This name will be added to the list of available highways, so it can be searched in some GPS devices.

Garmin does not support this feature.

80 characters maximum.

Refer to section 4.2.1, on page 9, for further details. http://cgpsmapper.com/ 20 of 130

₪ cGPSmapper Manual

CityName=xxx

₪

RegionName=xxx

CountryName=xxx

Zip=xxx

For

[RGN20] CityName

has the same meaning as

Label

If both

Label

and

CityName

are provided, the one which appears later in the file is used.

For

[RGN10] CityName

is the name of the city to which the object belongs.

Can be used only together with keys

RegionName

and

CountryName

80 characters maximum.

Name of region to which the object belongs.

Can be used only together with keys

CountryName

CityName

80 characters maximum.

CityName

Name of country to which the object belongs.

Can be used only together with keys

80 characters maximum.

Object Zip Code.

80 characters maximum.

and

RegionName

and

Exit#=(type_of_exi t_facility),(direc tion_to_facility),

(facilities),(labe l)

[END]

Applies to

[RGN10]

only.

Additional facilities available at the exit.

+ type_of_exit_facility

+ direction_to_facility facilities label

Integer hex or decimal values as indicated on section

80 characters maximum.

Section terminator.

4.2.4.2 Polygon

[POLYGON]

Type=object_type

SubType=object_typ e

Polygon section identifier.

[RGN80]

may also be used instead. It is used to define lakes, parks, forests, etc.

SubType

defines the second byte of the

Type

value.

The type of element can be defined either by using the

Type key only or by using the

Type

and

SubType

keys.

Example:

Type=0x0211 can be also written as:

Type=0x02

SubType=0x11 http://cgpsmapper.com/ 21 of 130

cGPSmapper Manual

Marine=x

Label=object_name

EndLevel=#

Background=x

Indicates if the object is extended / marine type.

N or 0 standard type

Y or 1 extended type

Default = N

Refer to section 10.6 for

Declare the custom shape of the map.

The background object defines the area of the basemap which is covered by this map.

It is recommended that background be only used with maps which have irregular boundaries.

If there is only one object set as the background, then the

EndLevel

is automatically set to 9.

If there is no background object, or more than one, then the

EndLevel

is not changed.

''It is a common mistake to use a background object when defining an island. An island is implemented simply as a hole in the containing polygon.

details. To create a background object in the shape of the island is quite wrong.

A background object is not a 'land'. It should only be used to describe the total area covered by your map.

Most maps do not require the use of this object at all!

The only exception is when you want to create map with an irregular boundary. In which case you should create ONLY ONE BACKGROUND OBJECT which covers the whole map.

If you create a lot of background objects - don't be surprised that map is 'strange', slow etc...

N No

Y Yes

Default = N http://cgpsmapper.com/ 22 of 130

cGPSmapper Manual

Data#=(lat1,lon1),

(lat2,lon2)...

[END]

Origin#=(lat1,lon1),(lat2,lon2)

may be used instead.

Object data for layer #.

Refer to section 10.6 for information on creating

Coordinates are in degrees, using the datum defined in the header

(or default).

Normally there will be no more than one data# line for each level. The exception is when creating a polygon with holes in it. Holes in polygons are used to represent islands in lakes or seas, clearings in woods etc.

polygons with holes.

Section terminator.

4.2.4.3 Polyline

[POLYLINE]

Type=object_type

SubType=object_typ e

Polyline section identifier.

[RGN40] may also be used instead. It is used to define linear objects such as streets, streams, etc.

SubType

defines the second byte of the

Type

value.

The type of element can be defined either by using the

Type key only or by using the

Type

and

SubType

keys.

Example:

Type=0x0211 can be also written as:

Type=0x02

SubType=0x11

Marine=x

Indicates if the object is extended / marine type.

N or 0 standard type

Y or 1 extended type

Default = N

Label=object_name

Label2=object_name

Secondary name of the object –only applies to roads.

EndLevel=#

Data#=(lat1,lon1),

Refer to section 4.2.4.2 (on page 21) for details.

(lat2,lon2)...

StreetDesc=xxx

DirIndicator=x

Street alias or secondary street name.

80 characters maximum.

Show direction of the road when selecting intersection in

GPS

0 No

1 Yes

Default = 0

Refer to section 4.2.1, on page 9, for further details. http://cgpsmapper.com/ 23 of 130

₪

₪ cGPSmapper Manual

[email protected]@z zz

Refer to section 6.4 (on page 65) for details.

@zzz

CountryName=xxx

₪

Zip=xxx

₪

RoadID=xxx

Numbers#=xxx

₪

Routeparam=xxx

₪

NodID#=xxx

[END]

Name of city to which this object belongs.

Can be used only together with keys

RegionName

and

CountryName

80 characters maximum.

Since version 0.97 of cGPSmapper it is possible to assign more than one city as attribute to street – used for search purposes. That can be used for city name and quarter name – to enable search by both names.

Name of region to which this object belongs.

Can be used only together with keys

CityName

and

CountryName

80 characters maximum.

Name of country to which this object belongs.

Can be used only together with keys

RegionName

and

CityName

80 characters maximum.

Object Zip Code.

80 characters maximum.

Refer to section 4.2.6 (on page 31) for details.

Section terminator.

4.2.4.4 Point of Interest from OziExplorer

[WPT]

RgnType=object_cat egory

Type=object_type

EndLevel=#

File#=file_name

Point of interest section identifier, with data imported from an OziExplorer .wpt file.

The object labels are derived from the waypoint description field, not from the waypoint name field

0x10 POI

0x20 point

.wpt

file from which data will be imported to layer #.

The path could be either absolute or relative to the current directory.

For platform portability, it is recommended to use slashes "/" instead of backslashes "\" to separate directories in the path.

In Unix, file_name

is case sensitive. http://cgpsmapper.com/ 24 of 130

cGPSmapper Manual

[END]

Section terminator.

4.2.4.5 Polyline or Polygon from OziExplorer

[PLT]

RgnType=object_cat egory

Type=object_type

Label=object_name

DirIndicator=#

EndLevel=#

File#=file_name

[END]

Polygon / Polyline section identifier, with data imported from an OziExplorer .plt file.

0x40 polyline

0x80 polygon

If the track imported in the [PLT] section contains multiple segments (i.e. objects), all segments will take the same label

(name), as defined by the Label statement. However, it is possible to give a different name to each segment. To achieve this, omit the Label statement and specify the names in an additional file, which should have the same name as the

.plt file (including the extension) and the additional extension .txt, e.g. Highways.plt.txt). The file must be in the same directory as the .plt file. Each line in this file specifies the name for the corresponding track segment.

Direction indicator, only for streets, highways, etc.

0 no direction

1 the GPS will show direction of the road (calculated internally by GPS)

Default = 0

Refer to section 4.4 (on page 42) for details on the valid

.plt

file from which data will be imported to layer #.

The path could be either absolute or relative to the current directory.

For platform portability, it is recommended to use slashes "/" instead of backslashes "\" to separate directories in the path.

In Unix, file_name

is case sensitive.

Section terminator.

₪

4.2.4.6 Shapes

[SHP] name=file_name

ESRI shape file section identifier.

Name of the ESRI files without extension.

This should be the full or relative path for the ESRI files, without the extension (which should be .shp for files containing ESRI data). http://cgpsmapper.com/ 25 of 130

₪ cGPSmapper Manual

Type=xxx

LabelField=field_n ame

Label2Field=field_ name

TypeField=field_na me

SubTypeField=field

_name

DirField=field_nam e

Level=#

EndLevel=#

DefaultType=object

_type

CityName=field_nam e

Type of objects to be imported from the ESRI files

16 or RGN10 POI

32 or RGN20 cities

64 or RGN40 lines

128 or RGN80 polygons

2 or RGN02 marine polygons

3 or RGN03 marine lines

4 or RGN04 marine points

Name of the field - in the associated .dbf file - from which cGPSmapper will get the Label for each object.

Secondary name for roads. Used in cases where you want a road to have a numeric ID and a name.

The secondary name of the road (road number if highway for example) - is not visible in the GPS but is used when searching street by name.

Name of the field - in the associated .dbf file - from which cGPSmapper will get the object_type for each object.

The field_name field must contain a decimal or hexadecimal value representing the object type.

If both DefaultType and TypeField are specified, an error occurs, but at least one of them must be specified.

object types.

Name of the field – in associated .dbf file – from which cGPSmapper will get the second byte of the object_type this is an optional field because the object_type can be defined using only TypeField

N or 0 Hide street direction on crossroads

Y or 1 Show street direction on crossroads

Default = N

Level into which objects will be imported.

Refer to section 4.4 (on page 42) for details on the valid

The coordinates from Level=# line apply up to the specified EndLevel=#.

Decimal or hexadecimal value representing the object type to be applied when the TypeField is not specified.

If both DefaultType and TypeField are specified, an error occurs, but at least one of them must be specified.

object types.

Name of the field - in the associated .dbf file - from which cGPSmapper will get the CityName for each object.

Only used for polylines (i.e. when Type=RGN40 or

Type=64

) and POIs (i.e. when Type=RGN20 or Type=32 or Type=RGN10 or Type=16). http://cgpsmapper.com/ 26 of 130

cGPSmapper Manual

₪

RegionName=field_n ame

Name of the field - in the associated .dbf file - from which cGPSmapper will get the RegionName for each object.

Should not be present if the

DefaultRegionCountry element is present in the

[IMG ID]

section.

Only used for polylines (i.e. when Type=RGN40 or

Type=64

) and POIs (i.e. when Type=RGN20 or Type=32 or Type=RGN10 or Type=16).

₪

CountryName=field_ name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the CountryName for each object.

Should not be present if the element is present in the

DefaultCityCountry

[IMG ID]

section.

Only used for polylines (i.e. when Type=RGN40 or

Type=64

) and POIs (i.e. when Type=RGN20 or Type=32

₪

HouseNumber=field_ name

StreetDesc=field_n ame

PhoneNumber=field_ name

Zip=field_name or Type=RGN10 or Type=16).

House number written as a string.

Used for address search and routing.

Only used for POIs (Type=RGN10 or Type=16).

Street name or additional description.

Only used for POIs (Type=RGN10 or Type=16).

Phone number written as a string.

Only used for POIs (Type=RGN10 or Type=16).

Name of the field - in the associated .dbf file - from which cGPSmapper will get the Zip for each object.

Only used for polylines (i.e. when Type=RGN40 or

Type=64

) and POIs (Type=RGN10 or Type=16).

₪

RoadID=field_name

Unique ID number for the road. This is internally used by cGPSmapper to maintain routing data creation.

Used for routing.

₪

SpeedType=field_na me

This attribute defines the maximum allowed speed - it is used mainly for calculating fastest possible route.

There are 8 of them:

7 128 km/h

6 108 km/h - Can be adjusted in MapSource

5 93 km/h - Can be adjusted in MapSource

4 72 km/h - Can be adjusted in MapSource

3 56 km/h - Can be adjusted in MapSource

2 40 km/h - Can be adjusted in MapSource

1 20 km/h

0 8 km/h (ferry)

Used for routing. http://cgpsmapper.com/ 27 of 130

cGPSmapper Manual

₪

RoadClass=field_na me

OneWay=field_name

This attribute defines the importance of the road for routing.

It is one of the most important attributes for routing.

The lowest importance is 0, the highest is 4.

Road class 4 should be used for Major highways and other main roads.

Used for routing.

1 one way road, where the permitted direction is always from the beginning of the road to the end, considering the digitalisation direction.

-1 one-way road, opposite to the digitalisation direction.

0 two-way road.

Used for routing.

Defines that it is a toll road.

1 no emergency vehicles allowed on the road.

₪

Toll=field_name

₪

VehicleE=field_nam e

₪

VehicleD=field_nam

1 no delivery vehicles allowed on the road. e

₪

VehicleC=field_nam e

₪

VehicleB=field_nam

1 no cars allowed on the road.

1 no buses allowed on the road. e

₪

VehicleT=field_nam e

₪

VehicleP=field_nam

1 no taxis allowed on the road.

Position=field_nam

1 no pedestrians allowed on the road. e

₪

VehicleI=field_nam e

₪

VehicleR=field_nam e

TextFileLines=fiel

1 no bicycles allowed on the road.

1 no trucks allowed on the road. d_name

TextStart=line_num ber

TextEnd=line_numbe

Ending line number from TextFileLines file to be imported r

TextFile=file_name

Text file name to be imported

Color=field_name

Style=field_name

Height=field_name

Depth=field_name

DepthUnit=field_na

HeightUnit=field_n

ame

Name of the file with long text for very long description of the object

Starting line number from TextFileLines file to be imported

e http://cgpsmapper.com/ 28 of 130

₪

π cGPSmapper Manual

DepthFlag=field_na me

FoundationColor=fi eld_name

Light=field_name

LightType=field_na me

Note=field_name

LocalDesignator=fi eld_name

InternationalDesig nator=field_name

Period=field_name

HeightAboveFoundat ion=field_name

HeightAboveDatum=f ield_name

HeightAboveFoundat ionUnit=field_name

HeightAboveDatumUn it=field_name

LeadingAngle=field

_name

http://cgpsmapper.com/ 29 of 130

₪

π cGPSmapper Manual

Racon=field_name

DoubleLights=field

_name

DoubleLightsHorizo ntal=field_name

FacilityPoint=fiel d_name

[END]

4.2.1 on page 9). Since this is a global definition, all elevations on a map must be in the

Section terminator.

4.2.4.7 MapDekode file

♣ This section will be further documented in a future version of this manual.

[DBX] name=file_name

[END]

Name of a MapDekode file (including extension) to be processed in the current compilation.

Section terminator.

4.2.4.8 File

[FILE] name=file_name

[END]

Lists other PFM files to be included in the current compilation.

Name of a PFM file (including extension) to be processed in the current compilation.

The compiler processes all the objects (and sections) in the specified file as if they were part of the current file.

The file included may contain any section but the

[IMG

ID]

section.

You may specify either the full path or the path relative to the current directory.

Section terminator.

4.2.5 Object elevation

By default, the elevation is defined in feet in PFM. To define the elevation in metres, the

Elevation=m

statement should be defined in the header section ( refer to section

same units (either all in feet or all in metres).

Elevation can be specified for POI objects like summit (Type 0x6616) and depth / height points (Types 0x6200 to 0x6600) as well as for polyline objects like land / depth contours

(Types=0x20 to 0x25). http://cgpsmapper.com/ 30 of 130

cGPSmapper Manual

Whenever POI label starts with numbers or numbers are placed after ~[0x1f] separator, they are treated as elevation and might be converted (depends of Elevation setting in the header.

The elevation is entered in the label field of the objects. The following code extract defines a height point with elevation of 668 m (assuming Elevation=m is defined in the header section):

[RGN10]

Type=0x6300

Label=668

Origin0=(-33.93497,18.38925)

[END-RGN10]

A minor land contour with elevation of 1080 m can be defined like this:

[RGN40]

Type=0x20

Label=1080

Data0=(-33.96727,18.42540),(-33.96725,18.42557),

(-33.96709,18.42600),(-33.96693,18.42624),(-

33.96682,18.42630),

(-33.96662,18.42627),(-33.96646,18.42581),(-

33.96641,18.42557)

[END-RGN40]

Text can be combined with the elevation in the label by using the ~[0x1f] delimiter to indicate the elevation. Example of a summit with 1084 m elevation:

[RGN10]

Type=0x6616

Label=Table Mountain~[0x1f]1084

Origin0=(-33.96664,18.42569)

[END-RGN10]

Type 0x6616 require a special code separation before the height value – ~[0x1f] – in case

– there is no name of the summit – label should looks like:

Label=~[0x1f]1084

4.2.6 Road numbers

House numbers along the streets can be defined using NUMBERS# key within [RGN40] declaration. There could be up to 60 definitions of numbers for a single road.

Each definition consist from the NumbersX definition where X is increasing value from 1 up to 60

For using house numbering along streets when working with ESRI data please refer to

section 5.7, on page 55.

http://cgpsmapper.com/ 31 of 130

cGPSmapper Manual

[RGN40]

Type=6

Numbers1=0,E,1,9,O,4,20,2999,2999,Warszawa,Mazowieckie,Polska

,Warszawa,Mazowieckie,Polska

Numbers2=3,B,21,40,N,0,0,2999,2999,Warszawa,Mazowieckie,Polsk a,Warszawa,Mazowieckie,Polska

[END-RGN40]

Where –

NumbersX=

[index of point in the polyline – 0 based],

[left side numbering style],

[first number on left side],

[last number on left side],

[right side numbering style],

[first number on right side],

[last number on right side],

[left side zip code],

[right side zip code],

[left side city],

[left side region],

[left side country],

[right side city],

[right side region],

[right side country]

Some of the information are optional – if no zip code – it can be replaced by ‘-1’, if no city, region and country info – also it can be replaced by ‘-1’

Numbers1=0,E,1,9,O,4,20,-1,-1,-1,-1

First ‘-1’ replaces zip code on left side, second – zip code on the right side, then ‘-1’ replaces city/region/country info on left side and the last – on the right side.

This is equivalent of:

Numbers1=0,E,1,9,O,4,20

Numbering style can be: N,E,O,B – which suits to: None, Even, Odd, Both.

4.2.7 Special codes for object labels

It is possible to use some special codes for labialisation of the objects in the map – these special codes are responsible for both – adding graphics around the label and special behaviour of the label.

Special codes are different for 6-bit and 8-bit coding – for which LBLcoding parameter is responsible. http://cgpsmapper.com/ 32 of 130

cGPSmapper Manual

6-bit coding 8-bit coding

~[0x1b]

~[0x1b2b]

Code meaning

Used before a letter forces it to be a lower case

~[0x1b2c] ~[0x1c] section (when over 1km), with the mouse sees displayed one the word completely, not separated

Separation: on the map visible only the first section

(when over 1km), with the mouse sees displayed one the word completely, not separated on section (when over 1km), with the mouse sees displayed one the word completely, by blank separated

~[0x1f] ~[0x1f] Separation: on the map visible only the first section

(when over 1km), with the mouse sees displayed one the word completely, by blank separated.

Normally used as a separator before elevation

Example:

[RGN10]

Label=~[0x1f]500

~[0x2a] ~[0x01]

• Interstate symbol

name can consist only from digits!

allowed only at beginning of label

Example:

[RGN40]

Label=~[0x2a]11

~[0x2b] ~[0x02]

US Highway – shield

name can consist only from digits!

allowed only at beginning of label

~[0x2c] ~[0x03]

US Highway – round symbol

name can consist only from digits!

allowed only at beginning of label

~[0x2d] ~[0x04]

Highway – big

allowed only at beginning of label

~[0x2e] ~[0x05]

Main road – middle

allowed only at beginning of label

~[0x2f] ~[0x06]

Main road – small

allowed only at beginning of label http://cgpsmapper.com/ 33 of 130

cGPSmapper Manual

4.3 Marine Charts

Marine charts are a special kind of cartography - similar to Garmin's BlueChart - that is used as navigational aid and contains its own set of marine elements.

Although marine charts are generated, managed and compiled in the same way as ordinary

maps, certain restrictions apply to the attributes of the objects (e.g. extended attributes like

CityName, RegionName, StreetDesc are not applicable - marine objects are not searchable).

Such restrictions are explained in the present section.

All the attributes listed herewith are meant to be included in one of the following sections:

[POI]

[POLYLINE]

[POLYGON]

Refer to section 4.2 (on page 8) for details on these sections.

Marine maps cannot be transparent.

Most of marine types can be now used on usual ‘land’ maps.

Marine=x

Indicates if the object is of marine type.

N or 0 non-marine object

Y or 1 extended / marine object

Default =

Marine

value from the

[IMG ID]

section. If not present, default = N.

This key is no longer necessary if extended 3-bytes type definition is used:

Extended / marine types can be stored in 3 bytes as follow:

What correspond to:

Type=0x010203

Type=0x02

SubType=0x03

Marine=Y

Marine objects use many additional special attributes, which are listed below.

Marine objects have only the following keys in common:

Type=object_type

Type of element, may be written in hex or decimal or as a name (valid names are defined in file RGNtyps.txt which you can customised to your requirements). http://cgpsmapper.com/ 34 of 130

₪

₪ cGPSmapper Manual

SubType=object_typ e

SubType

defines the second byte of the

Type

value.

The type of element can be defined either by using the

Type key only or by using the

Type

and

SubType

keys.

Example:

Type=0x0211 can be also written as:

Type=0x02

SubType=0x11

Label=object_name

Optional name of the object to be shown on the map.

80 characters maximum.

Data#=(lat,lon)

Origin#=(lat,lon)

may be used instead.

Object data for layer #.

EndLevel=#

Coordinates are in degrees, using the datum defined in the header

(or default).

. This is annotated with the current scale, such as "800ft" or

Marine objects may also have the following keys, depending on the object_type

Text=xxx

Very long description / information displayed in the properties windows of the object.

There could be several

Text

entries in a single object.

Applies only to following marine types: polygons of types 0x0700 and 0x0704 points of types 0x0801 and 0x0902

16kb maximum (each entry).

TextFile=file_name

File containing a very long description / information displayed in the properties windows of the object.

There could be several

TextFile

entries in a single object.

The path could be either absolute or relative to the current directory.

For platform portability, it is recommended to use slashes "/" instead of backslashes "\" to separate directories in the path.

In Unix, file_name

is case sensitive.

16kb maximum (each entry).

Refer to section 4.2.1, on page 9, for further details. http://cgpsmapper.com/ 35 of 130

cGPSmapper Manual

Color=##

Style=## http://cgpsmapper.com/

Object colour.

Applies only to following marine types: polylines of types 0x04XX to 0x06XX points of types 0x0500 (coloured text)

Valid values - sum of:

0x00 to 0x03 (basic styles)

0x10 to 0x30 (extended styles)

0x00

0x01

0x02

0x03

0x10

0x11

0x12

0x13

0x20

0x21

0x22

0x23

0x30

0x31

0x32

0x33

Applies only to following marine types: polylines of types 0x04XX to 0x06XX polyline of type 0x0108 (Recommended Route - valid values are only between 0x00 and 0x03)

36 of 130

cGPSmapper Manual

Height=##.#

Depth=##.#

DepthUnit=x

HeightUnit=x

Position=#

Alias name for

Depth

Can not be present if

Depth

is present.

Point depth / height value with one decimal (e.g. 20.1).

The maximum value is 65535, when value is defined as integer; and 6553, when value is defined as real.

Warning:

This value is not displayed if the “Spot Soundings” setting in the GPS receiver is set to “Off”. Please note also that this setting affects also some of the objects (mainly soundings): they will not be displayed at all (because they have no visual representation except the depth/height value). This is dangerous for navigation since very important information will be hidden from the chart. There is also the “Spot

Soundings” setting in Preferences of MapSource.

Applies only to following marine types (as height / depth): polylines of types 0x0105 to 0x0107, 0x03XX polygon of types 0x0105 to 0x0107, 0x03XX points of types 0x03XX (soundings, building, spot height) points of types 0x04XX (obstruction)

Alias name for

HeightUnit

Can not be present if

HeightUnit

is present.

Allowed only when either

Depth

Height

is present. m metres f feet

Default =

Elevation

value from the

[IMG ID] section.

Allowed only when either

Depth

Height

is present.

Position of the obstruction.

0 unknown

1 (empty)

2 doubtful

3 existence doubtful

4 approximate

5 reported

Applies only to following marine types: points of types 0x04XX (obstruction) http://cgpsmapper.com/ 37 of 130

cGPSmapper Manual

DepthFlag=#

Depth info of the obstruction.

0 empty (no depth flag)

1 unknown, dangerous for navigation

2 awash at chart datum

3 unknown, safe for navigation

4 unknown

Applies only to following marine types: points of types 0x04XX (obstruction)

FoundationColor=#

Foundation colour.

0x00 (generic symbol)

0x01 red

0x02 green

0x03 yellow

0x04 white

0x05 black

0x06 black-yellow

0x07 white-red

0x08 black-red

0x09 white-green

0x0a red-yellow

0x0b red-green

0x0c orange

0x0d black-yellow-black

0x0e yellow-black

0x0f yellow-black-yellow

0x10 red-white

0x11 green-red-green

0x12 red-green-red

0x13 black-red-black

0x14 yellow-red-yellow

0x15 green-red

0x16 black-white

0x17 white-orange

0x18 orange-white

0x19 green-white

Applies only to following marine types: points of types 0x02XX http://cgpsmapper.com/ 38 of 130

₪ cGPSmapper Manual

Light=colour

Light=(colour,rang e)

Light=(colour,rang e,angle)...(colour

,range,angle)

Definition of light colour and range.

There are several accepted formats:

- Light=2 define colour of the light (valid for types

0x02XX)

- Light=(3,4) colour 3 and range 4 nm

Ranges always in nautical miles.

Light colours:

0x00 unlit

0x01 red

0x02 green

0x03 white

0x04 blue

0x05 yellow

0x06 violet

0x07 amber

Applies only to following marine types: points of types 0x02XX (accepts ONLY colour attribute!) points of types 0x01XX

Definition of light colour, nominal range and light sectors.

Light = (2,3,10.0), (3,3,205.0) defines colour 2, range 3 nm from angle 10.0 to 205.0 and colour 3, range 3 nm from angle 205.0 to 10.0

The true (geographic) angles should be used (as opposed to magnetic). Angles are arranged clockwise and are given from seaward toward the light. These are bearings of the light as seen from a vessel crossing the sector lines.

Please note that you can change the “Light sectors” setting both in MapSource and in your GPS receiver to suit your needs.

Applies only to following marine types: points of types 0x02XX (accepts ONLY colour attribute!)

- points of types 0x01XX http://cgpsmapper.com/ 39 of 130

cGPSmapper Manual

LightType=xxx

₪

Note=xxx http://cgpsmapper.com/

Definition of the light type.

Can be a number (as decimal or hex) or a letter.

If the value is a letter, then the light type is set to 0x0b

(Morse code) and letter is used as a Morse code letter.

Hex values:

0x00 unlit

0x01 fixed

0x02 isophase

0x03 flashing

0x04 group flashing

0x05 composite group flashing

0x06 occulting

0x07 group occulting

0x08 composite group occulting

0x09 long flashing

0x0a group long flashing

0x0b Morse letter - see above

0x0c quick

0x0d group quick

0x0e group quick and long flashing

0x0f interrupted quick

0x10 very quick

0x11 group very quick

0x12 group very quick and long flashing

0x13 interrupted very quick

0x14 ultra quick

0x15 interrupted ultra quick

0x16 fixed and occulting

0x17 fixed and group occulting

0x18 fixed and isophase

0x19 fixed and flashing

0x1a fixed and group flashing

0x1b fixed and long flashing

0x1c alternating

0x1d alternating occulting

0x1e alternating flashing

0x1f alternating group flashing

Applies only to following marine types: points of types 0x01XX and 0x02XX

Text visible in the properties window of the object.

Applies only to following marine types: points of types 0x01XX and 0x02XX

40 of 130

₪

₪ cGPSmapper Manual

LocalDesignator=xx x

InternationalDesig nator=xxx

Text visible in the properties window of the object.

Applies only to following marine types: points of types 0x01XX and 0x02XX

Text visible in the properties window of the object.

Applies only to following marine types: points of types 0x01XX and 0x02XX

Period=xxx

Period(s) of the light. Can be single value or series of values.

Examples:

Period=2.3

HeightAboveFoundat ion=##

Period=2.3,2.1,2.3,1.0

Applies only to following marine types: points of types 0x01XX

Height above foundation. Value visible in the properties window of the object.

Applies only to following marine types: points of types 0x01XX

HeightAboveDatum=#

Height above datum. Value visible in the properties window of the object.

Applies only to following marine types: points of types 0x01XX

HeightAboveFoundat ionUnit=##

HeightAboveDatumUn it=## m metres f feet

Default =

Elevation

value from the

[IMG ID] section.

Allowed only when

HeightAboveFoundation

is present. m metres f feet

Default =

Elevation

value from the

[IMG ID] section.

Allowed only when

HeightAboveDatum

is present.

LeadingAngle=##.#

Leading angle (in degrees) for the light, value with one decimal.

Racon=x

Example:

LeadingAngle=120.1

Applies only to following marine types: points of types 0x01XX

Y yes

N no

Default = N

Applies only to following marine types:

Points of types 0x01XX http://cgpsmapper.com/ 41 of 130

₪

₪ cGPSmapper Manual

DoubleLights=x

Additional info shown in the properties window. Number of light bubbles. Valid values are from 1 to 7.

Applies only to following marine types:

Points of types 0x01XX

DoubleLightsHorizo ntal=x

Additional info shown in the properties window. Double lights horizontal / vertical flag.

Y yes

N no

Default = N

Applies only to following marine types: points of types 0x01XX

FacilityPoint=xxx

Facility point, sum of flags.

0x000001 boat ramp

0x000002 drinking water

0x000004 restrooms

0x000008 picnic area

0x000010 campground

0x000020 marina

0x000040 fuel

0x000080 marine supply

0x000100 bait and tackle

0x000200 groceries

0x000400 restaurant

0x000800 water/electric hook-up

0x001000 boat/motor rental

0x002000 guide service

0x004000 lodging

0x008000 dump station

0x010000 handicap accessible

Applies only to following marine types: points of types 0x0903

4.4 Levels

4.4.1 Introduction

Every Garmin

GPS with mapping capability gives you the option to zoom in or out on the map page, either displaying a small area in great detail, or a larger area in less detail.

The selection of map objects which it is appropriate for the unit to display is dependent on the zoom level. For example, when you are zoomed in, you would probably want to see individual buildings on your map. As you zoom out, this level of detail would be inappropriate because it would make the map too cluttered.

Using levels in your PFM file allows you to dictate the zoom settings at which your map objects will be visible.

Levels also allow you to display map objects in different ways depending on the zoom level. For example, a lake might appear as a region at some zoom levels but a single point at others. This is achieved by creating two map objects to represent your lake - one a region http://cgpsmapper.com/ 42 of 130

cGPSmapper Manual and the other a single point, and choosing levels for them so that the appropriate one is displayed at each zoom setting.

You may also want to show only the most important objects like main roads and cities at a wide zoom level and include secondary roads - and other objects such as railroads - at more detailed zoom levels.

Figure 1: less detail map Figure 2: more detail example map example

You can even have different sets of coordinates for the same map object at different zoom levels. The most usual use for this is to include more detail - perhaps showing every bend in a river, when zoomed in and less detail when zoomed out. Normally this will not be necessary though, because cGPSmapper automatically reduces the number of points in higher zoom levels.

4.4.2 Concepts and Terminology

When you zoom in and out on your GPS' map page, a scale line is displayed in the bottom left corner of the map screen

†

"2km" or whatever. In a PFM file, these zoom levels are identified using an integer value called the Hardware Zoom Level. Hardware zoom levels are in the range 1-24. Note that there isn't a precise one-to-one mapping between the hardware zoom levels and all possible device zoom settings. The hardware zoom level is simply a guide.

Hardware zoom level 24 represents the most detailed map levels on the device. Each successively lower zoom level number maps onto twice the map scale of the previous number.

The approximate mapping of hardware zoom levels onto actual device zoom settings is shown in the table below. Note that this is only approximate. The matching of levels to

Garmin

display zoom levels is, unfortunately, not an exact science.

Level no.

GPS Equivalent (Metric) GPS Equivalent (Imperial)

Up to 120m

200m, 300m

Up to 500ft

800ft to 0.2 miles

22 500m

21 800m to 1.2km

20 2km

0.5 miles

0.8 miles to 1.2 miles

†

eTrex series. Other models may vary.

As previously indicated, the map level settings dictate the level at which objects are visible assuming the GPS user has their unit's map detail level set to Normal. http://cgpsmapper.com/ 43 of 130

cGPSmapper Manual

Level no.

GPS Equivalent (Metric)

GPS Equivalent (Imperial)

3km

5km to 8km

12km

20km to 30km

2 miles to 3 miles

5 miles

8 miles to 12 miles

20 miles to 30 miles

15 50km

14 80km to 120km

200km to 300km

500km to 800km

80 miles to 120 miles

200 miles to 300 miles

500 miles

The principle of doubling the map scale for each successive zoom number continues beyond level 12 but lower hardware zoom levels are not really useful. Zoom level 12 represents the most "zoomed out" setting for current Garmin

devices.

The hardware zoom levels described above are only ever referred to directly in the [IMG

ID] section of your PFM file. The remainder of the file uses a different level numbering scheme called Map Zoom Levels.

Map zoom levels are defined by the map author. Any map can use up to ten map zoom levels numbered 0 to 9. If you use fewer than ten map zoom levels you should use consecutive map zoom level numbers starting at zero.

Within your [IMG ID] section you specify the number of map zoom levels you will be using with a line of the form EndLevel=n. The relationship between your chosen map zoom levels and the hardware zoom levels using a set of Levelm=h lines, where m is the map zoom level and h is the corresponding hardware zoom level.

For example:

[IMG ID]

Levels=4

Level0=23

Level1=21

Level2=20

Level3=17

The above extract specifies that the map uses four map zoom levels. Map zoom level zero corresponds to hardware zoom level 23; map zoom level 1 corresponds to hardware zoom level 21 and so on.

The hardware zoom levels do not need to be consecutive, but each successive map zoom level must correspond to a smaller hardware zoom level number than the previous one.

The settings in our example specify that map objects and coordinates defined as map level zero, will be used at hardware zoom levels 23 and above. Objects defined as map level 1 will be used at hardware zoom levels 21 and 22, and so on.

The highest numbered map zoom level that you define dictates the zoom level at which your map replaces the GPS unit's base map. In our example, the highest numbered map zoom level is 3 and this corresponds to hardware zoom level 17. What this means is that if the GPS device user zooms in to level 17 or higher it will see your uploaded map. At hardware zoom levels 16 and below it will see the base map.

Your highest map zoom level is only used for the purpose of specifying when your map takes over from the base map. You are not allowed to define map objects and coordinates at this level. So, in our example, map zoom levels 0, 1 and 2 are the only ones available for http://cgpsmapper.com/ 44 of 130

cGPSmapper Manual defining map objects. Map zoom level 3 is only used to dictate when our map replaces the base map.

This means that you must always define one more map zoom level than you actually need for your map objects, and every map definition must therefore include at least two map zoom levels.

Having understood the relationship between map zoom levels and hardware zoom levels you can effectively ignore hardware zoom levels during the map design process. Within the rest of this section, the term level should be interpreted as meaning map zoom level unless explicitly stated to the contrary.

4.4.3 Using levels when defining map objects

Here is an extract from a PFM file defining the village of Remenham (Berkshire, UK) as a

Point of Interest:

[RGN10]

Type=3328

Label=Remenham

Data0=(51.551744,-0.889936)

[END]

Note that the coordinate definition line starts Data0=. The digit following the word Data specifies the level at which these coordinates will be used. This definition only specifies coordinates for level zero. That means that the village will only be visible on the user's GPS at zoom level zero.

Suppose we change this to:

[RGN10]

Type=3328

Label=Remenham

Data1=(51.551744,-0.889936)

[END]

Now we have defined coordinates for level 1 only. That means that the village will be visible only at zoom level 1. If the GPS user zooms out further than that, or if he zooms in closer, the village will not be visible.

Let's say you want the village to be visible at levels zero, one and two. You could write:

[RGN10]

Type=3328

Label=Remenham

Data0=(51.551744,-0.889936)

Data1=(51.551744,-0.889936)

Data2=(51.551744,-0.889936)

[END]

However there is an easier and better way. The above definition can be abbreviated using an EndLevel=n line: http://cgpsmapper.com/ 45 of 130

cGPSmapper Manual

[RGN10]

Type=3328

Label=Remenham

EndLevel=3

Data0=(51.551744,-0.889936)

[END]

What the EndLevel=n line says is that the coordinates in the highest numbered Datan= line apply up to the specified EndLevel=n, starting with the level number in the Datan= line. In our example, EndLevel=3, combined with Data0= means that the coordinates apply for three consecutive levels commending with level 0 (i.e. levels 0, 1, 2 and 3).

Levels and LevelsNumber are "old" equivalents of EndLevel.

4.4.3.1 Tailoring shape according to level.

In the previous example, our map object had the same coordinates at all the levels in which it was visible. For single point objects, there's no need for the coordinates to vary. You don't want your village moving around the countryside as the user zooms in or out on your map!

For lines and regions, you may wish to modify the coordinates according to zoom level.

Consider the following footpath:

[RGN40]

Type=22

Label=

EndLevel=3

Data0=(51.562624,-1.070283),(51.561637,-

1.070592),(51.561272,-1.069878), (51.560059,-1.064277)

[END]

This path will be visible, and have exactly the same shape, at levels 0 to 3. Now let's change it slightly:

[RGN40]

Type=22

Label=

EndLevel=2

Data0=(51.562624,-1.070283),(51.561637,-

1.070592),(51.561272,-1.069878), (51.560059,-1.064277)

Data1=(51.562624,-1.070283),(51.561272,-

1.069878),(51.560059,-1.064277)

[END]

The path is still visible at levels 0 to 3 but the shape changes subtly between level zero (the greatest detail) and level one. At level zero there are four vertices in the line. At levels one and two this reduces to three vertices. What we are actually doing here is specifying that we are only interested in the precise shape of the bend in the path at the highest zoom level.

Reducing the detail at higher zoom levels can reduce the size of your digital map, reducing upload times and helping to fit in memory where otherwise it wouldn't.

In practice, you don't normally need to specify reduced detail explicitly in this way because

cGPSmapper automatically detects when there is unnecessary detail for the target zoom http://cgpsmapper.com/ 46 of 130

cGPSmapper Manual level. cGPSmapper automatically averages out consecutive points which are too close to be distinguishable on the GPS screen and discards unnecessary points.

Nevertheless it is useful for the map author to understand how it is possible to take explicit control over the shape of map objects at different levels if and when necessary.

4.4.4 Idiosyncrasies of GPS hardware

The foregoing sections have explained how the map author can control the levels at which map objects are displayed. That's the theory. In practice things can be slightly different.

The first thing to note is that the map level settings dictate the level at which objects are visible assuming the GPS user has their unit's map detail level set to Normal. In the eTrex series, for example, the map set-up screen offers five choices for detail level: Most, More, Normal, Less and

Least.

Figure 3: Map Detail

Setup

At higher detail levels, map objects will continue to be visible even if the user zooms out further than the greatest level at which you have defined them. At lower detail levels the user will have to zoom in more than expected before the objects become visible. The extent to which the detail setting affects the levels at which objects become visible has not been determined by the authors of this guide. If this is important to you, you will just have to experiment.

Perhaps more bizarrely, the level at which things become visible can also be affected by what type of object it is. You may find, for example, that two points of interest with identical map level settings but different types (for example, one is a building and the other a village) become visible at different zoom settings on the GPS screen. Precise determination of how the object type affects its visibility is beyond the resources of the authors. Again, if this is important to you, you will just have to experiment. As mentioned near the start of this section, choosing correct zoom levels is not a precise science.

4.5 Dictionary

4.5.1 Introduction

Section 4.4 (Levels) explains how you can dictate the zoom settings at which your map

objects will be visible. However if you have a large map with many map objects and you need to change the display level for all objects of a specific type, changing the EndLevel= tag for each instance can be a cumbersome and time-consuming task. http://cgpsmapper.com/ 47 of 130

cGPSmapper Manual

Fortunately the Polish file format has a solution called 'Dictionary' which allows you to switch map objects of the same type on or off for each level. [DICTIONARY] is an optional section and follows after the [IMG ID] section.

4.5.2 Concepts and Terminology

[Dictionary] uses strings of 0's and 1's where the position of each digit in the string corresponds to a specific map object type and thus controls the display of that object type.

Programmers refer to this as a bit mask. (A bit is a binary digit. In binary there are only two digits, 0 and 1. In a bit mask 0 normally represents 'false' or 'off' and 1 represents 'true' or

'on').

In PFM each map object type has a code.

Refer to section 12.3 - on page 106 - for a list

of object types with codes in hexadecimal and decimal.

You do not have to be familiar with hexadecimal; the decimal equivalent works just as well. (In hexadecimal there are 16 digits, 0 to 9 plus a to f).

In the [Dictionary] 'bit mask' each bit (digit) refers to the object type code corresponding to the bit position, counting from the left of the string. E.g. the first bit refers to map object type 1, the second bit refers to map object type 2 and bit 20 refers to object type 20 and so on.

The PFM allows for a 'bit mask' to be defined for each map level.

The format is Level#RGNnn=<bit mask> where # indicates the level, nn the object class

(10, 20, 40 or 80) and <bit mask> is a string of 0's and 1's.

If you set the first bit in the 'bit mask' to 0, no objects of type 1 will display on the corresponding level, and if you set the first bit to 1 all objects of type 1 defined for the

specific level will display. This is explained much better by an example, see 4.5.3 below

Note that you still need to specify EndLevel=# or Data#= for each object to extend the object to the required level #. The dictionary 'bit mask' only filters out objects on layers they are defined on. However when using dictionary, you can set EndLevel= to your highest map level for all objects and control which type of objects display at which map levels with the dictionary 'bit mask'.

Since all object are by default displayed on the most detailed map level, level 0, it is not necessary to define a dictionary 'bit mask' for level 0.

The [Dictionary] tag is optional, but very useful to filter map objects per type per level.

4.5.3 Using Dictionary

The following is an extract from a PFM file defining a Dictionary 'bit mask' for polyline

[RGN40] objects. In this example major (thick) and principal (medium) highways (types 1,

2 & 3) will be displayed on levels 0 to 3, arterial roads (types 4 & 5) will be displayed on levels 0, 1 and 2 and residential streets (type 6) will be displayed on levels 0 and 1. No other polyline objects will be displayed. Level 4 is the last level of this map and cannot contain map objects. http://cgpsmapper.com/ 48 of 130

cGPSmapper Manual

The first two lines start with ';' indicating that these are comment lines and are ignored by

cGPSmapper. They are there so that you do not need to actually count the digits to determine which one refers to which object code.

[DICTIONARY]

; 0 1 2 3 4

; 1234567890123456789012345678901234567890123

Level1RGN40=1111110000000000000000000000000000000000000

Level2RGN40=1111100000000000000000000000000000000000000

Level3RGN40=1110000000000000000000000000000000000000000

Level4RGN40=0000000000000000000000000000000000000000000

[END DICTIONARY]

[RGN40]

Type=0x01

Label=Highway N1

EndLevel=3

Data0=(51.562624,-1.070283), (51.561637,-1.070592),

(51.561272,-1.069878), (51.560059,-1.064277)

[END]

...

In the same way we can use dictionary to filter polygon [RGN80] and point of interest

[RGN10 & 20] objects by defining 'bit masks' using Level#RGN80= and Level#RGN10=.

Dictionary for POI [RGN10 and 20] objects works slightly differently in that the POI objects are controlled in groups.

Refer to section 12.3 - on page 106 - for a list of object types with codes in

hexadecimal and decimal. Object type codes for POI consist of a group code and a subtype code. For the decimal codes the subtype is shown in brackets after the group code.

The hexadecimal POI object codes are of the form 0x##nn where ## is the group code and

nn the subtype code.

The Dictionary filter operates on the whole group and thus 'bit mask' position ## controls

POI group ##. As far as the Dictionary filter is concerned, you can ignore the nn subtype code.

The following PFM dictionary section will filter out all POI objects and display only dining type POIs 0x2A00 to 0x2AFF on levels 1 to 3.

In this example the comment lines count in hexadecimal, but you can count in decimal if you prefer. http://cgpsmapper.com/ 49 of 130

cGPSmapper Manual

[DICTIONARY]

; 0 1 2

; 123456789abcdef0123456789abcdef0123456789abcdef

Level1RGN10=00000000000000000000000000000000000000000100000

Level2RGN10=00000000000000000000000000000000000000000100000

Level3RGN10=00000000000000000000000000000000000000000100000

Level4RGN10=00000000000000000000000000000000000000000000000

[END DICTIONARY]

Note that the Dictionary 'bit mask' only operates on the objects defined on a layer. To define a specific object on a layer, a Data#= entry or an appropriate EndLevel= entry is required for the object.

Refer to section 5.9.5 - on page 61. Required DBF field names can be found there.

http://cgpsmapper.com/ 50 of 130

cGPSmapper Manual

5 Routable maps

5.1 Introduction

Preparing maps data for making routable maps is a challenge due to additional complexity of the source data comparing to non-routable maps. There are several additional rules that have to be followed in order to have a working map at the end.

The most important thing is to prepare a correct network for roads – assigning route class value to roads does this. Meaning of this attribute is – importance of the road for routing

(which usually follow type of the road – but not necessary).

Road network should never be broken – network of most important roads (which are defined by road class attribute) cannot be broken, with lower class attributes insertion – or route calculation will fail.

5.2 General remarks

When preparing routable maps – following rules should be followed:

IMG file should be created with Level 0 equal to 24 – otherwise distance calculation might be wrong

A street cannot intersect itself (i.e. a roundabout from one object is not possible as it has common begin with end)

The minimal distance between Node ID points is 5.4 meters

When preparing routable preview map (what is required when mapset is composed from more than one IMG file – if routing has to work properly under MapSource software)

Roundabouts are not permitted

Any 2 different streets cannot be connected to each other by both sides

The minimal distance between NodeID points is 10 meters

Neither CGPSmapper nor cpreview generates automatically routable preview IMG (or MP – in case cpreview) file. Such routable preview map has to be created manually – MP file generated by cpreview program can be used as initial step.

5.3 Concept of input data

The idea of preparing routable data for cGPSmapper base on network of roads – where each road can be defined by its ID number (RoadID) and virtual set of connection points – nod points – where each such node is having its unique ID value (NodeID).

Whenever any two points of roads are sharing same NodeID value – cGPSmapper will make a connection between these roads at given points. http://cgpsmapper.com/ 51 of 130

cGPSmapper Manual

Having above picture, if we define in our data:

RoadID Node(point) NodeID

This will be understood by the program as follow – at point with index 3 of road 520763

(where each point of the road is indexed starting from beginning with index 0) we define

NodeID: 25008, then at point with index 2 of road 532674 we define NodeID: 25008 – that means – these roads are connected there – as they are sharing same NodeID value.

To code it in PFM we would look like:

[RGN40]

Label=road 1

RoadID=520763

Data0=…

Nod1=3,25008

[END-RGN40] http://cgpsmapper.com/ 52 of 130

cGPSmapper Manual

[RGN40]

Label=road 2

RoadID=532674

Data0=…

Nod1=2,25008

[END-RGN40]

5.4 Road class

The main attribute for routing calculation – as it has been mentioned already – is road class attribute. On one hand it is important to prepare data with non broken road network keeping specific road class, on the other hand it is important to keep well balanced percentage of roads with highest versus other road class roads.

In ideal situation – for usual mixed area (with city and rural areas) – percentage of roads with specific road class should be:

Road Approximate number of class

roads

0.5% - 1.5%

3 1% - 3%

2 4% - 7%

1 10%-20%

0 60%-80%

Road Class attribute is used as a main indicator for ‘fastest route’ calculation

5.5 Speed attribute

Second in importance of attributes used for routing calculation is speed attribute – which is used for ‘fastest route’ calculation.

Speed class

Speed attribute Comment

108 km/h

93 km/h

72 km/h

56 km/h

Can be adjusted in MapSource

This attribute is independent of the route class attribute. http://cgpsmapper.com/ 53 of 130

cGPSmapper Manual

5.6 Routing attributes PMF

Routing attributes of the road in MP text format

[RGN40]

Label=road 1

RoadID=520763

Data0=…

RouteParam=2,3,1

Nod1=3,25008

[END-RGN40]

Route attributes are defined by a single key – RouteParam. Each attribute is separated by comma. At lease first two values has to be defined – rest of attributes is optional.

RouteParam=speed,road_class,one_way,toll,denied_emergency,den ied_delivery,denied_car,denied_bus,denied_taxi,denied_pedestr ain,denied_bicycle,denied_truck

Speed

Road_class

One_way

Toll

Denied_emergency

Denied_delivery

Denied_car

Denied_bus

Denied_taxi

Speed attribute

Road class attribute

0 both directions allowed

1 one way road, direction from beginning to end is allowed only

Default =

0 normal

1 toll road

Default =

0 normal

1 emergency car cannot use road

Default =

0 normal

1 delivery car cannot use road

Default = 0

0 normal

1 car cannot use road

Default = 0

0 normal

1 bus cannot use road

Default = 0

0 normal

1 taxi cannot use road

Default = 0 http://cgpsmapper.com/ 54 of 130

cGPSmapper Manual

Denied_pedestrian

Denied_bicycle

Denied_truck

0 normal

1 pedestrian cannot use road

Default = 0

0 normal

1 bicycle cannot use road

Default = 0

0 normal

1 truck cannot use road

Default = 0

For definition of connection – as it was written already –

Nod key is used. For each connection separate key is used :

[RGN40]

Label=road 1

RoadID=520763

Data0=…

RouteParam=2,3,1

Nod1=3,25008

Nod2=4,26005

Nod3=8,99330

[END-RGN40]

NodX=point_index,NodeID,bound

Point_index

NodeID

Bound

Index of the point in line definition. Starting point has index

Index of virtual routing point – NodeID

0 normal NodeID definition

1 bound point NodeID definition – this point will be used as entry/exit point of the map – connection to other separate IMG files

Default =

Bound attribute defines Entry/Exit points of single IMG file – if no NodeID point with such attribute is defined in the map – there is no way device can enter / exit the map. Typically every road crossing borders of the map, at the border, shall have NodeID point with this attribute set to ‘1’.

5.7 Restrictions

Restrictions define logical or physical turn restrictions in the map. Currently cGPSmapper is able to handle restrictions composed from two or three segments – respectively – 3 nod points or 4 nod points.

Restrictions can be defined either using MP text format or as ESRI import data. http://cgpsmapper.com/ 55 of 130

cGPSmapper Manual

Following our previous example

[RESTRICT]

TraffPoints=16968,25008,25009

TraffRoads=520763,532674

[END-RESTRICT]

Above definition will set a restriction when turning from road 520763 into road 532674.

However opposite direction will be still allowed – meaning – it will be allowed to go through road 532674 into road 520763 at crossing nod 25008.

Definition of the restriction is composed from set of 3 nod points – routable points – and two roads – with that we can define an unique route to be forbidden.

Second type of restriction cGPSmapper can handle at the moment, is a restriction composed from 3 roads. Such restriction will forbid route, which will follow only exactly the forbidden definition.

[RESTRICT]

TraffPoints=25009,25008,16968,16967

TraffRoads=532674,520763,520763

[END-RESTRICT]

Above definition will not allow creating a route going through roads 532674, 520763

(passing by nod 25009), 520763 (passing by nod 16968) and ending at node 16967. It will not of course forbid using a short cut of road 520762. http://cgpsmapper.com/ 56 of 130

cGPSmapper Manual

Restrictions – similar to roads – can apply only to certain vehicle types.

[RESTRICT]

Restriction section identifier.

TraffPoints=NodeID

1,NodeID2,NodeID3(

List of NodeID points composing the restrictions. Can be 3 points or 4 points.

,NodeID4)

TraffRoads=RoadID1

,RoadID2(,RoadID3)

RestrParam=restric tion_parameter_def inition

List of RoadID values composing the single restriction. Can be 2 or 3 roads, depending or restriction type.

Optional, defines vehicles to which apply the restriction.

This is a list of comma separated Boolean values (0,1).

By default restrictions apply to all kind of vehicles, if

RestrParam is used, then restriction will be ignored by specified types of vehicles.

[Emergency],[delivery],[car],[bus],[taxi],[pedestrian],[bicycl e],[truck]

Example:

RestrParam=0,1,1,0

Above definition will set the restriction to be applied for

Emergency, Bus, Taxi, Pedestrian and Bicycle. Restriction will NOT apply for Delivery and Car.

Restriction can be defined using ONLY neighboring nodes – there cannot be any additional nodes between

5.7.1 Restriction definition with ESRI format

Restriction can be defined also in a single DBF file – where all the parameters are stored.

To import them into the final IMG file – in the MP text file import section has to be defined

5.8 Road signs

It is possible to define road sign information, which is shown as a routing guideline during navigation. This can include an information like exit number to be taken from the highway or additional direction information which usually can be found on a real road signs – e.g. direction toward a specific city.

Definition of the road sign in sense of logic is very similar to definition of restriction. It is defined as 3 NodeID routing points and 2 RoadID roads. http://cgpsmapper.com/ 57 of 130

cGPSmapper Manual

[SIGN]

SignPoints=NodeID1

,NodeID2,NodeID3

SignRoads=RoadID1,

RoadID2

SignParam=Type,Lab el

Sign section identifier.

List of NodeID points composing the road sign. Road sign will be defined only for route, which will go through routing points in the same order as defined in the list.

List of RoadID values composing the road sign. Road sign will be defined only for route, which will go through roads in the same order as defined in the list. This has to be consistent with routing points.

Define type of road sign and label to be shown

T Toward

O Onto

E Exit

Example:

SignParam=T,Bone Ville

5.9 Routing data defined for ESRI files

When working with ESRI data, routing data can be defined directly for shape files and stored in a DBF file. There can be only one DBF file which defines routing information.

This file is used also to define house numbering along streets as well as some other attributes.

Maproute program which is available for free as a generator of routable data by default generates DBF file which is ready to use in the [DEFINITIONS] section of the MP file.

For declaring the MP format [DEFINITIONS] section needs to be used. It is important to note that this section defines only what DBF file should be used and which fields from this particular DBF shall be used to define input data.

Section [DEFINITIONS] declare use of one or two DBF files. First one (declared with field

ROUTING) can hold following attributes:

- Routing data

- City / Region / Country attributes

- Zip code attributes

Second DBF file (declared with field RESTRICTIONS) is strictly used for restrictions for routing definitions.

5.9.1 Segment of the road

Routing data – when declared in DBF file – as well as all the additional attributes for roads

– are referring to a ‘segment of road’. Segment is basically a part of road starting at certain http://cgpsmapper.com/ 58 of 130

cGPSmapper Manual point index of the road (where index 0 refers to a starting point of the road) and ending at the point where next segment starts or at the end of the road.

Let assume – we have a following data in the DBF file :

NodeID RoadID Node LeftStart LeftEnd

1 100 0 10 12

2 100 2 14 20

100 5 0 0

3 100 7 22 28

That define first segment of road (road id = 100) starting at the beginning of the road up to point with index 2 – there (as in above example) road numbers will change from 10 (at point index 0) up to 12 (at point index 2). Next segment of this road is starting at point index 2 and ends at point index 5…

As seen in above example, segment definitions does not really needs to be aligned to the routable notes (even if that’s most common).

It is not required that data in the input file are sorted in any specific way.

5.9.2 Defining routing data in [DEFINITIONS]

General rule is that each row in the DBF file used in the [DEFINITIONS] section corresponds to single NODID point definition.

For a proper NODID point definition – in the input DBF file must exists fields which will at least define :

NODEID ID of the routable node (Second parameter in the NodX of the MP format NODEID)

ROADID

NODE

ID of the road (RoadID in the MP format)

Index of the point in line definition. Starting point has index

0 (First parameter in the NodX of the MP format)

Optional fields are :

BOUND Entry / Exit point of the map -

5.9.3 Defining attributes of road segments in [DEFINITIONS]

Same DBF file which define routing data can hold also following additional data – City /

Region / Country information for each segment of the road (for left and right side of the road), zip code information and house numbering along the road. http://cgpsmapper.com/ 59 of 130

cGPSmapper Manual

Each segment is defined by the NODE field – which defines at which point of the road segment definition starts. Segment definition is valid till next definition of segment or up to end of the road.

City / Region / Country information definition require definitions of the following fields :

LEFTCITYNAME Field holding city name on the left side of the segment

RIGHTCITYNAME

LEFTREGIONNAME

RIGHTREGIONNAME

Field holding city name on the right side of the segment

Field holding region name on the left side of the segment

Field holding region name on the right side of the segment

RIGHTCOUNTRYNAME Field holding country name on the right side of the segment

5.9.4 Defining restriction data in [DEFINITIONS]

Restriction data needs to be defined in a different DBF file than all the other attributes

(routing definition, other road attributes)

Each single restriction is defined in a single row of data in the DBF file. Following fields are required in order to define restriction data:

RESTRICTIONS Name of the DBF file with restrictions

NODEID1

NODEID2

NODEID3

NODEID4

First NODEID point of restriction

Second NODEID point of restriction

Third NODEID point of restriction

Fourth (only for 4-points restrictions) NODEID point of restriction

ROADID2

ROADID3

VEHICLEE

VEHICLED

VEHICLEC

VEHICLEB

VEHICLET

VEHICLEP

VEHICLEI http://cgpsmapper.com/

Second road ID of the restriction

Third (only for 4-points restrictions) road ID of the restriction

Optional, field holding Boolean value (1,0) whether restriction should apply to emergency vehicles

Optional, field holding Boolean value (1,0) whether restriction should apply to delivery vehicles

Optional, field holding Boolean value (1,0) whether restriction should apply to cars

Optional, field holding Boolean value (1,0) whether restriction should apply to buses

Optional, field holding Boolean value (1,0) whether restriction should apply to taxis

Optional, field holding Boolean value (1,0) whether restriction should apply to pedestrians

Optional, field holding Boolean value (1,0) whether restriction should apply to bicycles

60 of 130

cGPSmapper Manual

VEHICLER Optional, field holding Boolean value (1,0) whether restriction should apply to trucks

5.9.5 Secton [DEFINITIONS]

[DEFINITIONS]

Routing data, house numbers and restrictions section identifier.

Routing and road attributes part

Routing=file_name

Name of the DBF files with extension for routing and attribute definition.

This should be the full or relative path for the DBF file.

Bound=field_name

0 normal NodeID definition

1 bound point NodeID definition – this point will be used as entry/exit point of the map – connection to other separate IMG files

Default =

NodeID=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the NodeID

RoadID=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the RoadID

Node=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the NODE

LeftCityName=field

_name

RightCityName=fiel

Name of the field - in the associated .dbf file - from which cGPSmapper will get the City name on left side of the road for the current segment d_name

LeftRegionName=fie ld_name

RightRegionName=fi

Name of the field - in the associated .dbf file - from which cGPSmapper will get the Region name on left side of the road for the current segment eld_name

LeftCountryName=fi eld_name

RightCountryName=f

Name of the field - in the associated .dbf file - from which cGPSmapper will get the Country name on left side of the road for the current segment ield_name

LeftZipName=field_ name

RightZipName=field

Name of the field - in the associated .dbf file - from which cGPSmapper will get the Zip code on left side of the road for the current segment

_name http://cgpsmapper.com/ 61 of 130

cGPSmapper Manual

LeftType=field_nam e

RightType=field_na

Name of the field - in the associated .dbf file - from which cGPSmapper will get the numbering type for the left side of the road. This field is optional – as type can be determined from LeftStart and LeftEnd fields.

0 No numbers

1 Even numbers only

2 Odd numbers only

3 Even and odd numbers on this side of the street me

LeftStart=field_na me

RightStart=field_n ame

LeftEnd=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the ending number for the left side of

RightEnd=field_nam the road. e

Name of the field - in the associated .dbf file - from which cGPSmapper will get the starting number for the left side of the road.

Restrictions part

Restrictions=file_ name

Name of the DBF files with extension for restrictions

This should be the full or relative path for the DBF file.

NodeID1=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the first point (NodeID) of the restriction

NodeID2=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the second point (NodeID) of the restriction

NodeID3=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the third point (NodeID) of the restriction

NodeID4=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the fourth (optional – for 4-point restrictions only) point (NodeID) of the restriction

RoadID1=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the first road (Road ID) of the restriction

RoadID2=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the second road (Road ID) of the restriction

RoadID3=field_name

Name of the field - in the associated .dbf file - from which cGPSmapper will get the third (optional – for 4-points

VehicleE=field_nam e restrictions only) road (Road ID) of the restriction

If from defined field TRUE or larger than 0 value is taken – then restriction apply to emergency vehicles. http://cgpsmapper.com/ 62 of 130

cGPSmapper Manual

VehicleD=field_nam e

VehicleC=field_nam e

VehicleB=field_nam e

VehicleT=field_nam e

VehicleP=field_nam e

VehicleI=field_nam e

VehicleR=field_nam e

If from defined field TRUE or larger than 0 value is taken – then restriction apply to delivery vehicles

If from defined field TRUE or larger than 0 value is taken – then restriction apply to cars

If from defined field TRUE or larger than 0 value is taken – then restriction apply to buses

If from defined field TRUE or larger than 0 value is taken – then restriction apply to taxis

If from defined field TRUE or larger than 0 value is taken – then restriction apply to pedestrians

If from defined field TRUE or larger than 0 value is taken – then restriction apply only to bicycles

If from defined field TRUE or larger than 0 value is taken – then restriction apply only to trucks http://cgpsmapper.com/ 63 of 130

cGPSmapper Manual

6 National characters - indexing

Garmin map format allows to use several different character coding schema, 6-bit coding which allow to use only basic character set, 8-bit coding and 2 bytes coding. There are however some important constrains when selecting coding schema.

6.1 Codepages

Only 8-bit coding and 2-byte coding allows to use specific codepages. Map format allow to use following codepages:

Codepage Name

932 Japanes

949 Korean

874 Thai

1251 Cyrilic

1256 Arabic

1257 Baltic

1253 Greek

1254 Turkish

1255 Hebrew

It is important to know however that the only codepage fully supported by all (or most of) receivers is 1252 – Western European. It is possible to use other codepages – but then national characters may not be shown correctly.

The only fully supported codepage is 1252 – Western European, only with this codepage it is possible to use lowercase characters

Codepage 1252 is the only one that allows using full character set – including lowercase characters. No other codepage is capable to show lowercase characters. While using any other codepage – in the input MP file – all labels should be uppercase – or they will not be correctly presented in receiver.

For every codepage except 1252 All labels must be written in CAPITALS

6.2 Indexing

http://cgpsmapper.com/ 64 of 130

cGPSmapper Manual

With certain versions of cGPSmapper it is possible to create indexes that allow searching for certain POI, city or road. With more advanced version it is possible to create global index which collect information from several separate IMG files.

When creating global index, it is possible to index in a simply way (whole labels) or multibody (if label consist of more than one word, each word is indexed separately).

6-bit coding does not allow to create multi-body indexes.

At the moment cGPSmapper starting from version 0.94 is capable to create maps which handles correctly for indexing only following codepages:

Codepage Name

1251 Cyrilic

1256 Arabic

1257 Baltic

More codepages will be implemented in the future.

6.3 Preparing maps for indexing

When maps are indented to support ‘find’ functionality – by city name, region and country

– it is very important to use consistent information when preparing source data for compilation. cGPSmapper starting from version 0.95 during normal IMG file generation is also creating additional IDX file which is used later by cpreview program. IDX file contain index information of objects which is normally lost during conversion from MP format to final

IMG format.

After index generation with use of cpreview program, all IDX files can be removed.

It is important to define CODEPAGE in every MP file in the section [IMG ID] – to assure that indexing will work correctly.

By intention there is a special meaning of opening bracket ‘{‘ – if first character of street name is such opening bracket – street will not be indexed.

If opening bracket will be not used as a first character – then street will be indexed.

Whenever multi word indexing is used – all words within the label will be indexed except words after opening bracket.

6.4 Multi attributes assignment

http://cgpsmapper.com/ 65 of 130

cGPSmapper Manual

Single street can be assigned to more than one city (region) – what is useful whenever we want to make possibility of searching by city name and (for example) by quarter name.

Program can handle up to 3 names assigned to a single street.

[RGN40]

Label=road 1

RegionName=region

CountryName=country

Data0=…

[END-RGN40]

In above example street will be searchable by both names – city1 and city2 – both belonging to region.

[RGN40]

Label=road 1

[email protected]@city3

CountryName=country

Data0=…

[END-RGN40]

Above example shows how to use multi city and multi region configuration. cGPSmapper will assign city1 to region1 and both - city2, city3 to region2.

Depreciated format with CityIdx is supported as well:

[RGN40]

Label=road 1

section 12.3.4 (Custom types name substitution), on page 122 for more information about supported language types.

Data0=…

[END-RGN40]

So the road will belongs to both cities – with index 2 and 3.

6.5 Indexing with cpreview program

Indexes for global search are prepared by cpreview external program. Cpreview program accepts same preview control file as one used by cgpsmapper with ‘pv’ command.

Cgpsmapper preview generation from now is considered as obsolete – however still available.

As for indexing it is important that a proper sort order – dependant of the codepage – is used, it is important that a proper codepage is defined in the control preview file. http://cgpsmapper.com/ 66 of 130

cGPSmapper Manual

[MAP]

…

CodePage=1252

FID=..

ProductCode=..

ID=..

The ID key defines map ID value of the preview IMG file. Usually it has to be set to 1. For the meaning of rest of the keys – please see next chapter.

Cpreview program should be used (same as cgpsmapper) from command line – windows shell: pv.txt

Where pv.txt is a control file for preview generation. As the result following files will be generated:

[name].mp

[name].tdb

[name].reg

And – with the version of the program able to generate global indexes:

[name].MDX

[name]_MDR.IMG

Global index file can be generated only with use of the Routable, Personal or Pro version of cGPSmapper.

If option ‘-r’ is used:

Cpreview pv.txt -r

Then first selection when searching for address is for region – instead country.

Refer to chapter on preparing preview files for rest of details.

If option ‘-m’ is used:

Cpreview pv.txt -m

Then each separate word in street name will be indexed. For example – Albert Einstein street can be found by ‘Albert’ and ‘Einstein’.

7 Protecting IMG files - locking

7.1 Responsibility

http://cgpsmapper.com/ 67 of 130

cGPSmapper Manual

It must be understood that author of the cGPSmapper did not implement locking mechanism by reverse engineering of any of the Garmin original software. All the work has been done basing on 3 rd

party software not coming originally from Garmin.

THERE IS NO RESPONSIBILITY ON THE AUTHOR SIDE FOR USING THE LOCK

TECHNOLOGY – END USER DECIDE ON OWN RESPONSIBILITY TO USE IT

KNOWING THAT THIS TOOL WAS NOT APPROVED BY GARMIN AND GARMIN

MAY NOT ACCEPT SITUATION THAT 3

PARTIES ARE CREATING LOCKED

MAPS.

7.2 Technology

Starting from the version 0.91 of the cGPSmapper it is possible to prepare locked IMG files. Such files can be used with GPS device only with unique unlock key generated exclusively for the given device. Special registration of cGPSmapper is required.

Locked IMG contains some portion of the data crypt – this data is used by the device to decide whether the end user pose rights to use the map or not. Locking base on using several user defined values – some of them cannot be changed while some of them can.

Each IMG file is locked using 3 values:

FID

– Family ID value – unique identifier for map creator. FID value is hard-coded into the cGPSmapper registration – to ensure that each map creator is using unique value. Some registrations are holding range of allowed FID values – then this value has to be defined in the header of map.

Product Code

- Unique value for product identification – maximum allowed value is 60 therefore map creator can create up to 60 separate products.

Region Code

- Each product can consist from several separate regions. There could be up to

255 regions within single product, each region can have its own unlock code as well as it is possible to generate universal unlock key for every region within a product. It is worth to note that single map set can be build from several different regions – allowing to unlock only specific part of the whole map.

In order to use map in device – it is necessary to use 4 th

value – GPS ID of the device. This ensure that each sold copy of the map requires unique unlock key. GPS ID value can be usually found in GPS menu under system entry.

It is not possible to use unlock key generated for different GPS ID. The exception is

MapSource – which allow to see the map with any valid unlock key – not important for what GPS ID generated. http://cgpsmapper.com/ 68 of 130

cGPSmapper Manual

Starting from cGPSmapper version 0.94 it is possible to generate unlock keys in 2 forms – basing on GPS ID value or locking map to SD card. For that a special key generator is delivered which is working only on Pocket PC platform.

7.3 Locking maps with cGPSmapper

Locking with cGPSmapper is as easy as adding few more entries into the [IMG ID] section.

This is:

[IMG ID]

…

Lock=Y

ProductCode=

RegionID=

FID=

…

[END]

Lock=Y

ProductCode=

RegionID=

FID= this will turn on generation of the locked IMG file value within a range of 1 up to 60 value within a range of 1 up to 255 key valid only with multi-FID registrations

IMG created with such additional keys will be locked – meaning – useless without a proper unlock key.

FID value defines general identification of the whole mapset – it has to be unique within all maps uploaded to GPS / used with MapSource.

ProductCode value defines product ID within one FID. Each product is visible as a separate map in MapSource / GPS – however all maps with same FID are sharing the same global index file (MDR file) – therefore it is very important to build a common index file for all the products within the FID.

RegionID value defines a single region within map – which might be unlocked separately.

It means that map can be unlocked only in a part – not the whole map at once. Please note – when preparing unlock key – if RegionID is set to 0 (zero) – then it will unlock all regions in the map at once.

7.4 Creating preview – mapset

As locking introduces several new possibilities of creating products, it is important to understand differences. http://cgpsmapper.com/ 69 of 130

cGPSmapper Manual

As it has been mentioned already – single product (mapset) can contain several different regions. Each region may be unlocked separately or end user can use universal unlock key.

To achieve that – there are some changes in the preview control file.

First of all – section [MAP]

[MAP]

…

Lock=Y

ProductCode=

FID=

Lock=Y this will turn on generation of the preview for locked IMG files

ProductCode= value within a range of 1 up to 60 – must be consistent with detail

IMG files – all IMG files must belongs to same product

FID=

Unique map creator identification, if value used is inconsistent with the one defined by the cGPSmapper registration – it is automatically fixed

Section [FILES]

[Files] region=1,region1 img=10002011.img img=10002012.img img=10002013.img region=2,region2 img=10003011.img

...

[END-Files]

It is important to note one new key – region – which is used to define to which region belong following IMG files. In the example above – files 10002011, 10002012, 10002013 belongs to region ID = 1 with name ‘region1’. File 10003011 belongs to region ID = 2 with region name ‘region2’.

It is important to ensure that region ID and product code values are consistent with IMG files itself – as during creation of the IMG file in the [IMG ID] such values are defined.

Failure to do so will result in not working mapsets! http://cgpsmapper.com/ 70 of 130

cGPSmapper Manual

7.5 Unlock codes

Along with cGPSmapper there is another program – cGPSmapperKey – which is used to generate unlock codes for products. Program can work in a batch mode or user enter mode.

To check how it can work in a batch mode just start the program and examine the help screen.

To generate unlock key following information needs to be provided:

FID

ProductCode

RegionID

GPSID

Expiration date (if exist)

Note on RegionID – to generate universal unlock code working for every region within a given Poduct Code put ‘0’.

Note on Expiration date – if unlock code shall not expire – then put ‘0’

7.6 Unlocking maps on SD card

Second method of unlocking maps is to distribute them on SD memory cards with

GMAPSUPP.UNL file.

Whole process of distributing maps should be similar – create locked detailed IMG files, prepare appropriate preview files and at the end – creation of GMAPSUPP.IMG file. This file should be then placed in a GARMIN folder at SD card.

In order to enable the map on this particular card, unlock code specific to the card has to be created (in opposite to unlock code specific to the GPS ID value). For that SDLock tool has to be used. This tool is able to retrieve SD serial ID value and generate GMAPSUPP.UNL file that will unlock map on a particular SD card.

SDLock tool – as an optional part of cGPSmapper package – is a Windows Mobile software running on a PocketPC. This special platform requirement comes from the fact that usual PC is not able to read the serial ID value of SD card – while all PocketPC devices have access to this value (of course when the SD slot is built-in into device).

SD card can be processed with SDLock tool before or after putting on the card

GMAPSUPP.IMG file. If GARMIN folder is not yet existing on the card – it will be created automatically by the tool.

In addition to the GMAPSUPP.UNL file – SDLocker will create also id.txt file which contains serial ID value of SD card. This file is only for information.

8 Creating custom type file

cGPSmapper creates custom TYP files when invoked with the ‘typ’ switch. For example, http://cgpsmapper.com/ 71 of 130

cGPSmapper Manual cGPSmapper.exe typ MyCustomTypes.txt

Your custom .TYP file may be combined with .IMG files into GMAPSUPP.IMG for uploading into a compatible Garmin GPSr using SendMap 2.0 v3.3 or later, available at

http://cgpsmapper.com/en/buy.htm. We believe that any Garmin receiver which works with Garmin’s POILoader may have custom type definitions installed with your .IMG file.

Installed .TYP files do not affect the rendering of Garmin maps – only GMAPSUPP.IMG files uploaded by SendMap.

The generated .TYP file may also be added to your Windows registry enabling MapSource to display your custom types. All installed mapsets are rendered with your .TYP file. This is useful for quickly testing and evaluating your custom types under development.

8.1 Creating the source file

The custom type input file is a simple text file. At this time we recommend using the .TXT extension so it will open with your default text editor.

[_ID] Section

The [_ID] section defines the Family ID (FID) that associates this custom type file with your map file. Product Code should be 1; your FID should match the FID declared in the

[MAP] section of your preview source file. This definition is used when viewing your custom types in MapSource.

[_id]

ProductCode=1

FID=888

CodePage=1252

[End]

[_drawOrder] Section

At a minimum, your input file must define the draw order for ALL polygon types – not just your custom ones. Even if you don’t define any custom polygon types in your source file, this section is mandatory. If a polygon type is not defined in the [_drawOrder] section, it will not be rendered on your GPSr. If a polygon type is not showing up, check to make sure that it is listed in your [_drawOrder] section, and that it has a higher priority number than any other overlapping polygons.

Each statement in the [_drawOrder] section includes the hex ID of the defined polygon type and its relative draw order. Higher numbers are rendered later. Therefore, a polygon defined with a priority of 1 will be drawn first, and overwritten by an overlapping polygon defined with a higher number (2-8). Priority numbers are between 1 and 8. For example, http://cgpsmapper.com/ 72 of 130

cGPSmapper Manual in the [_drawOrder] section below, a Shopping center (Type 8, priority 3) will be shown on top of a large urban area (Type 0x01, priority 1). http://cgpsmapper.com/ 73 of 130

cGPSmapper Manual

[_drawOrder]

;Type=POLYGON_CODE(HEX),PRIORITY

Type=0x01,1 ; Large urban area >200k

Type=0x02,1

Type=0x03,1

Type=0x04,1

Type=0x05,1

Type=0x06,1

; Small urban area <200k

; Rural housing area

; Military base

; Parking lot

; Parking garage

Type=0x08,3 ; Shopping center

Type=0x0c,2

Type=0x0e,2

Type=0x13,2

Type=0x14,2

Type=0x15,2

Type=0x16,2

Type=0x17,3

Type=0x18,3

Type=0x19,3

Type=0x1e,2

Type=0x1f,2

Type=0x20,2

; Industrial complex

; Airport runway

; Building/Man-made area

; National park

; City park

; Golf course

; Sports complex

; State park

Type=0x3c,8

Type=0x3d,8

Type=0x3e,8

Type=0x3f,8

Type=0x40,8

Type=0x41,8

Type=0x42,8

Type=0x43,8

Type=0x44,4

Type=0x46,2

Type=0x47,2

Type=0x48,3

Type=0x49,4

Type=0x4c,5

; Large lake (250-600 km2)

; Large lake (77-250 km2)

; Medium lake (25-77 km2)

; Medium lake (11-25 km2)

; Small lake (0.25-11 km2)

; Small lake (<0.25 km2)

; Major lake (>3.3tkm2)

; Major lake (1.1-3.3tkm2)

; Large lake (0.6-1.1tkm2)

; Major river (>1km)

; Large river (200m-1km)

; Medium river (20-200km)

; Small river (<40m)

; Intermittent water http://cgpsmapper.com/ 74 of 130

cGPSmapper Manual

Type=0x53,5

[end]

; Sand/tidal/mud flat

8.2 Custom Type Definition

Your custom type definitions will replace the default imagery on your GPSr or Mapsource.

All other objects will be rendered with their default imagery.

[_point] Definitions

Points (POIs) define your replacement bitmap for the associated POI type using the XPM format. For example,

[_point]

Type=0x01

Dayxpm=”16 16 2 1”

"XXXXXXXXXXXXXXXX"

"X X"

"XXXXXXXXXXXXXXXX"

[end] defines a daytime replacement image for POI type 0x01 (Large city). The rendered image will be a 16 pixel square rectangle with a 1 pixel black border and a transparent interior, as shown in the rendering above.

Extended / marine types can be customized using full, 3-byte type definition :

Type=0x010402 (wreck) http://cgpsmapper.com/ 75 of 130

cGPSmapper Manual

In addition, you may also specify up to four language strings defining the default name for the POI category. This is the name displayed when the cursor is over an unlabeled object.

For example, string1=0x04,Large city string2=0x08,Ciudad grande

; 0x04 = English

; 0x08 = Spanish defines the string ‘Large city’ when the GPSr is set for English, and ‘Ciudad grande’ when the GPSr is set for Spanish. Refer to

Point bitmap definitions may be up to 24 x 24 pixels and 254 colors. There may be different definitions for the daytime bitmap and the nighttime bitmap. For nighttime definitions, use Nightxpm=. If you do not plan to use Nightxpm, it is better to use xpm=

for a single bitmap definition which will be used in both day and night modes. The first line of the definition describes the bitmap dimensions, number of colors, and number of ASCII characters used to represent each pixel. We will use the following simple definition to describe the individual parts of the definition:

[_point]

Type=0x01

Dayxpm=”4 4 2 1”

"XXXX"

"X X"

"XXXX"

[end]

Dayxpm=”4 4 2 1” declares that the definition is 4 pixels wide x 4 pixels tall, with 2 defined colors, and 1 character representing each pixel in the bitmap.

Bitmap colors are defined using hex RGB values. Each color should be declared explicitly

– cGPSmapper does not support reserved literals representing standard colors. The only literal allowed is ‘None’ for transparent pixels.

“ c None” color

;Special declaration for transparent

“X c #000000” ;Black

The first character is the ASCII character used to represent the associated color in the bitmap. In this example, we are using a space to represent transparent pixels and an ‘X’ to represent black pixels. Next is a tab, then the letter ‘c’ which indicates a color definition, followed by a space, ‘#’, then the hex RGB color value. http://cgpsmapper.com/ 76 of 130

cGPSmapper Manual

Following the color declarations is the bitmap description.

"XXXX"

"X X"

"XXXX"

This definition describes a 4x4 rectangle with a black 1-pixel border and a transparent center.

Refer to

section 12.3.5 (How do I create XPM definitions?), on page 123 for a

discussion of how to create XPM descriptions using a graphics editor and conversion tools. http://cgpsmapper.com/ 77 of 130

cGPSmapper Manual

[_line] Definitions

Line definitions are used to replace the standard polyline types, including roads. There are two ways to define a line. You may either declare the line’s color and thickness attributes for its interior and border, or you may provide a custom bitmap. Both methods allow transparency in the definitions.

Line declaration method 1: Declare a line thickness and border thickness.

[_line]

Type=0x01

LineWidth=5

BorderWidth=1 xpm="0 0 4 0"

"1 c #20c818"

"2 c #309838"

"3 c #20c818"

"4 c #086808" string1=0x04,Toll Road string2=0x08,Carretera de pago

[end]

This definition specifies a replacement for polyline 0x01, Major highway. LineWidth is specified as 5 pixels, BorderWidth is specified as 1 pixel. xpm="0 0 4 0" ; Define both day and night colors

(4)

This line indicates that there is no pixel bitmap, only color definitions. There are 4 colors defined, 2 for daytime, and 2 for nighttime.

"1 c #20c818" ; Daytime interior color

"2 c #309838" ; Daytime border color

"3 c #20c818"

"4 c #086808"

; Nighttime interior color

; Nighttime border color

When describing lines using LineWidth and BorderWidth, note that the color declarations use a different format. The first character represents either daytime interior (1), daytime border (2), nighttime interior (3) or nighttime border (4).

As with POIs and polygons, you may use up to four language substitution strings for the generic type description. http://cgpsmapper.com/ 78 of 130

cGPSmapper Manual

Line declaration method 2: Describe a bitmap using XPM.

[_line]

Type=0x0a

Xpm="32 5 4 1"

"= c #b0b0b0"

" c none"

"3 c #585858"

"4 c none"

"================================"

" ======= ======= "

"================================"

;12345678901234567890123456789012 string1=0x04,Unpaved string2=0x08,Camino revistida

[end]

The first line of the xpm declaration indicates a definition 32 pixels wide, 5 pixels tall, with

4 colors, using 1 character for the pixel representations in the bitmap. This declaration uses a transparent background, represented by the space character in the ASCII bitmap. In the image above, notice that the transparency reveals whatever texture is underneath the line.

[_polygon] Definitions

Polygon definitions are limited to 32x32 xpm bitmaps using using 2 colors each for the daytime and nighttime definitions. They are tiled when rendered. http://cgpsmapper.com/ 79 of 130

cGPSmapper Manual

In this screen capture from a Garmin nüvi, four polygon types are shown. The one on the left is a custom definition (described below), and the following three are standard type

0x4F, 0x50 and 0x51. The black boxes show 32x32 tiles. Notice that the leftmost tile uses two colors, while the next three tiles use transparency. When defining a polygon bitmap, transparency may be used in either the foreground or background color position.

You may define 2 colors, which will be used for both day and night rendering, or 4 colors with colors 3 and 4 used for nighttime rendering. http://cgpsmapper.com/ 80 of 130

cGPSmapper Manual

[_polygon]

Type=0x4e string1=0x04,Wilderness string1=0x08,Yermo xpm="32 32 4 1"

"! #faf889" ;

"# #77c1c2" ;

"3 #77c1c2" ;

"4 Nighttime

"!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"

"#!!!!!!!!!!!!!!!!!!!#!!!!!!!!!!!"

"#!!!!!!!!!!!!!!!!!!##!!!!!!!!!!!"

"!!!!##!!!!!!!!!!!!!!!!!!!#!!!!!!"

"!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!#!!!!!!!!!!!!!!!!!"

"#!!!!!!!!!!!!!!!!!##!!!!!!!!!!!!"

"!!!##!!!!!!!!!!!!!!!!!!#!!!!!!!!"

"!!!!#!!!##!!!!!!!!!!!!!#!!!!#!!!"

"!!!!!!!!##!!!!!!!!!!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!!##!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!!!!!!!##!!!!!!!!"

"!!!!!!!#!!!!!!!!!!!!!!#!!!!#!!!!"

"!!!!!!!!!!!##!!!!!!!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!#!!!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!!!!!!#!!!!!!!!!!"

"!!!!!##!!!!!!!!!!!!!##!!!!!!!!!!"

"!!!!!!#!!!##!!!!!!!!!!!!!!!!!!!!"

"!!!!!!!!!!##!!!!!!!!!!!!!!!!!!#!"

"!!!!!!!!!!!!!!!#!!!!!!!!!!!!!!!!"

"##!!!!!!!!!!!!!!!!!##!!!!!!!!!!!"

"!!!!##!!!!!!!!!!!!!!#!!!!!!!!!!!"

"!!!!!#!!!!!!!!!!!!!!!!!!!!!!!#!!"

"!!!!!!!!!!!!!!#!!!!!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!#!!!##!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!!!##!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!!!!!!!!#!!!!!!!!"

"!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"

"!!!!!!!!!!!!!!!!!##!!!!!!!!!!!!!"

"!!#!!!!!!!!!!!!!!!!!!!#!!!!!!!!!"

[end] http://cgpsmapper.com/ 81 of 130

cGPSmapper Manual

8.3 Putting it all together

If you are serious about creating custom types, I recommend that you prepare a small Polish format test file so that you can quickly check your work. Once you have things the way you want them, then you should apply your TYP file to your larger maps.

I use MapSource to test my work in progress, as it is much quicker than making a

GMAPSUPP.IMG file and downloading it to the unit. Once I’m satisfied with the appearance in MapSource, then I proceed to do the download and inspect the results on the

GPSr. Working with small files makes this process much, much easier.

I’ve also created a template .MP file formatted to fill the nuvi screen exactly. This makes it easy to compose test images that won’t be blocked by the menu and on-screen zoom buttons. It’s fairly simple to create such a template for your specific unit, and it will save you a lot of time in the long run. I recommend it.

Workflow

• Create a .MP file with the object types you are customizing. See CustomDemo.mp for an example. Select all of the objects in the file and drag them a location near where your GPSr thinks it is. When you look at your files on the GPSr, you’ll only have to drag the map a little bit to see the results. Compile your .MP file.

• Create a .TXT file with your custom type definitions. Use CustomTypesDemo.txt as a starting point to create your own variations.

• Compile your custom type file with cGPSmapper, using the typ switch: cGPSmapper typ CustomTypesDemo.txt

• Use Sendmap 2.0 v 3.3 to assemble your .img file and your .typ file into a single

GMAPSUPP.IMG.

• Download GMAPSUPP.IMG into your GPSr. Turn off any loaded mapsets other than your .IMG file to make it easier to find and view your work.

• Repeat. http://cgpsmapper.com/ 82 of 130

cGPSmapper Manual

Sample screens from MapEdit of CustomDemo.mp:

http://cgpsmapper.com/ 83 of 130

cGPSmapper Manual

Sample screen from MapSource of CustomDemo.img:

http://cgpsmapper.com/ 84 of 130

cGPSmapper Manual

Sample screens from nüvi:

Standard roads and cities Custom roads and cities

Standard Scrub, camping, mountain range Custom scrub, camping, mountain range http://cgpsmapper.com/ 85 of 130

cGPSmapper Manual

9 MapSource

MapSource is Garmin's Windows (and only Windows!) PC based GPS interface program.

As with most similar programs, it allows upload and download of waypoints, routes and tracks.

Of more interest to us, is the fact that it is also capable of displaying vector-based mapping on the PC, and also uploading the map data to mapping-capable GPS units.

The MapSource program is included with maps bought from Garmin. The same program is shared between the various map sets that Garmin supplies. Recently, Garmin have been supplying MapSource 'Trip and Waypoint manager' free with their mapping GPS units.

This program can also be configured to read custom maps.

It was largely the fact that MapSource has to be able to read these maps, that enabled cGPSmapper to be written because the developer was able to use MapSource as a diagnostic tool.

9.1 Installing maps to be used with MapSource

With the most recent version of cGPSmapper sample installation script for Gdansk

Routable map is distributed. It requires use of Inno Setup. It simplify installation of map to be used by MapSource to the following steps:

- Build detailed IMG files with use of cGPSmapper

- Build preview files with use of cpreview

- Build preview IMG file from MP file created by cpreview using cGPSmapper

- Prepare installation setup using prepared Inno Setup script

- Distribute map

Below topics are still valid – to be aware of issues when installing maps to be used by

MapSource – however in most of the cases use of installation script will be just enough.

The only thing to take care is to update FID value in the script as well as names of files to be installed.

9.2 MapSource Data structure

MapSource arranges its map sets as 'products'. Each product - such as 'Metroguide Europe' or 'U.S. Topo' has a top-level 'preview' map, and several/many 'detail' maps. The detail maps can be graphically selected with the program, for upload to the GPS.

Internally, these map sets are configured using data in the Windows registry. Each product requires three registry entries. One entry points at the preview map, one at a 'tdb' file, and one at the location of the detail maps. If you wish to install a custom map set into

MapSource, you will need to (a) create the preview map and the tdb file, and (b) create the registry entries to tell MapSource where your files are located.

More recent map products, with routing information - such as Metroguide - are registered in a slightly different way. http://cgpsmapper.com/ 86 of 130

cGPSmapper Manual

9.3 Creating preview map files

To create the preview and tdb file, you will need to run cpreviw program responsible for creating all the control files required by MapSource software.

From version 0.98 of cGPSmapper it is no longer possible to use cGPSmapper program to generate preview files. Only cpreview program can be used.

C:\mymaps> cpreview mypv.mp

It is important to note that cpreview does not generate final preview IMG file – instead it does create an MP preview file which has to be converted to IMG file using cGPSmapper.

The main gain is that now it is possible to edit / change the preview IMG file – doing all the edits in the MP generated file.

It is required to compile MP file created by cpreview in order to get IMG file. As IMG file used for preview usually is named by name – not by numbers, preferred method of compilation is:

C:\mymaps> cgpsmapper mymap.mp

From version 0.99 of cGPSmapper, cpreview program does allow to create ‘empty preview’ files – all the detailed IMG files are processed without reading details – no spatial data are processed, only generic boundary is taken. No index file is created. Option ‘-x’ will switch cpreview into such generic mode.

C:\mymaps> cpreview mypv.mp –x

9.4 PFM format of preveiw control file

The preview control file – used with cpreview program is a text file with two sections inside – [MAP] section which defines general attributes of the map-set to be generated and

[FILES] – variable length section which lists all the detailed IMG files to be included into the map-set.

Cpreview program after processing the control file will generate at least following files –

MP file and TDB file – that’s are extension of the created files, because exact naming depends of the [MAP] configuration section.

For further details of index creation see section 6, on page 64 which explain more about

global index file creation done by cpreview.

9.4.1 Structure of the preview control file.

The basic structure of the preview control file is shown below: http://cgpsmapper.com/ 87 of 130

cGPSmapper Manual

[MAP]

FileName=..

MapSetName=..

ProductCode=..

ID=00000001

Levels=..

Level0=..

[END-MAP]

[FILES] img=.. img=..

[END-FILES]

Exact format of the preview control file -

[MAP]

FileName=xxxxxx x

MapsourceName=x xxxxxx

MapSetName=xxxx xxx

CDSetName=xxxxx xx

Name of the filename to be created – excluding extension, which is added automatically – TDB, MDX. Cannot use period ‘.’ as well as it is strongly recommended to not to use space character.

Example:

FileName=MyMaps

The Product name. This field is not displayed on the GPS unit. This field is displayed on the product menu bar and product menu in the MapSource software.

The Area name. This field is the second field displayed on the GPS unit under the "Map Information" section. It is displayed in the MapSource software on the "maps" tab when the map is selected and in the Map Properties window.

The CD Set Name. This field is not displayed on the GPS unit. This field is displayed in the MapSource software when displaying the Product Information. http://cgpsmapper.com/ 88 of 130

cGPSmapper Manual

MapVersion=nnn

The software version of the CDSetName. This field is not displayed on the GPS unit. This field is displayed in the

MapSource software when displaying the Product

Information. It will be displayed as n.nn.

For example:

MapVersion=153 will be displayed as

Data Version 1.53

Copy1=xxxxxx

This field can only contain numeric characters and must be three characters long (i.e. 000 through 999).

The first line of the copyright text associated with the

CDSetName. This field is not displayed on the GPS unit.

This field is displayed in the MapSource software when displaying the Product Information.

Copy2=xxxxxx

If you wish to include a copyright symbol ("©") in your text, you can do in your favourite text editor. Hold down the ALT key, type the numbers 0169 on the numeric keypad and then release the ALT key. You must use the numbers on the numeric keypad as opposed to the numbers across the top of the keyboard. You must also have Num Lock turned on.

The second line of the copyright text associated with the

CDSetName. See above.

Copy3=xxxxxx

CodePage=nnn

LblCoding=n

FID=n

ProductCode=n

The third line of the copyright text associated with the

CDSetName. See above.

Code page for the index files. Has to be consistent with coding in all IMG files included into map-set. Important when global index file is created.

Refer to section 6 (on page 64) for details.

Label coding for the index files. Has to be consistent with coding in all IMG files included into map-set. Important when global index file is created.

Refer to section 6 (on page 64) for details.

FID identifier used for map-set. Has to be consistent with coding in all IMG files included into map-set. Important when using lock feature of cGPSmapper.

Refer to section 7 (on page 67) for details.

Product code of the map-set. Allow creating several separate products (map-sets) within one FID. This value cannot be higher than 60. Has to be consistent with coding in all IMG files included into map-set. http://cgpsmapper.com/ 89 of 130

cGPSmapper Manual

ID=n

ID value of the preview IMG file. It is strongly recommended to set this value always to 1

Example:

ID=1

HeightProfile=x

Allow to see height profile under MapSource. Height profile is defined by use of contour lines – types 0x20, 0x21, 0x22.

Levels=n

Definition of basic parameters for the preview IMG file. For the preview files it is recommended to use only 2 layers maps.

Example:

Levels=1

Level#=g

Level0=14

Level1=13

Refer to section 4.2.1 (on page 9) for details.

Grid size for layer # (layer 0 is the most detailed one). It is very important to set the levels setting to lower details than the most generic (lowest detail) layer of any of the IMG file included into the map-set.

It means that, if header of the detailed IMG file defines levels as below:

[IMG ID]

Levels=4

Level0=24

Level1=22

Level2=20

Level3=19

Then the highest allowed level setting for level0 of the preview map is 18

Levels=1

Level0=18

Level1=17

Refer to section 4.2.1 (on page 9) for details.

Second required section is a list of IMG files to be included into the map-set. Section

[FILES] contains references (filenames) of all the IMG files to be used to create a complete map-set. If available – cpreview file will build a complete global index for all the IMG files included. http://cgpsmapper.com/ 90 of 130

cGPSmapper Manual

There must be at least one input file.

It is required that detail IMG files are named with DIGITS only and extension .IMG

This limitation is not valid for preview IMG file only.

Due to MapSource special requirements, it is forbidden to use name 00000008.img for any detailed IMG map file.

[FILES]

IMG=xxxxxxx

Full filename of the IMG file to be included into the map-set.

Can be defined as relative path or absolute path name.

Example – list of included IMG files with absolute paths

[FILES]

IMG=c:\myMaps\imgs\00000021.img

IMG=c:\myMaps\imgs\00000022.img

IMG=c:\myMaps\imgs\00000023.img

Example – list of included IMG files with relative paths

[FILES]

IMG=.\..\img\00000021.img

IMG=00000022.img

IMG=00000023.img

Relative paths are processed according to execution of the cpreview program from the command line.

9.5 Making the registry entries

To make the registry entries, you can use 3 different methods:-

1. Use the windows registry editor ( Start/run/regedit ) to directly edit the registry - take EXTREME care doing this, as you can completely destroy your PC configuration if you do something silly.

2. Create or edit a registry file, which you can simply double-click to create your entries. You can get a template for this file by doing a registry export. Note that you need double slashes in filenames. If you are distributing your maps to others, this is the simplest way to get them to make the necessary registry changes.

3. Use a GUI program such as MapManager - http://vip.hyperusa.com/~dougs/GPSSM/index.html#GPSMM

The entries are stored in the registry under:

HKEY_LOCAL_MACHINE\SOFTWARE\Garmin\MapSource\Products\## http://cgpsmapper.com/ 91 of 130

cGPSmapper Manual

Where ## is the unique product ID, and must correlate with the number you specified with

ProductCode=##

in your mypv.mp file.

The 3 entries are;

• Tdb : the name of the tdb file

• Bmap : the name of the preview img file

• Loc : the directory where the detail img files are stored.

An example registry file:

REGEDIT4

[HKEY_LOCAL_MACHINE\SOFTWARE\Garmin\MapSource\Products\6

67]

"Loc"="D:\\maps\\garmin\\NZ Topo\\"

"Bmap"="D:\\maps\\garmin\\NZ Topo\\NZTopo.img"

"Tdb"="D:\\maps\\garmin\\NZ Topo\\NZTopo.tdb"

You only need to do this registration once - for each 'product' that you create. As you edit or create more detail maps, and/or update your preview maps, as long as they stay in the same place on your disk, you do not need to do anything to your registry. http://cgpsmapper.com/ 92 of 130

cGPSmapper Manual

9.6 Loading the maps into the GPS

1. Choose the map(s)

Once in MapSource, the map(s) to be loaded in the GPS must be chosen first.

This is done via any of the following methods:

Under Switch to Product, in the View menu.

Via the corresponding combo located in the View Toolbar.

The quantity of maps available will vary depending on the maps installed. http://cgpsmapper.com/ 93 of 130

cGPSmapper Manual

2. Select the map(s)

The map(s) to be loaded in the GPS must be selected.

This is done via any of the following methods:

Under Map, in the Tools menu.

Via the respective button located in the Tools Toolbar.

Once this is done, the map to be selected must be clicked (in order to select it).

The maps to be transferred to the GPS (and the bytes they occupy) will be shown to the left of the screen.

3. Send the map(s) to the GPS

This is done via any of the following methods:

Under Send To Device, in the Transfers menu.

Via the respective button located in the Transfer Toolbar.

Once the transfer is done, the program will confirm the map(s) transfer finished successfully. http://cgpsmapper.com/ 94 of 130

cGPSmapper Manual

10 FAQs

10.1 Name variables and where they show up

10.1.1 Introduction

There are three locations where the names of maps, map sets, and related information

("name data") are specified:

• the PFM file;

• the PFM Preview file; and

• sendmap options.

There are various locations where the name data is displayed both on the GPS unit and in

the Garmin MapSource software. Figure 4 shows the relationship between where the name

data is specified and where it is displayed.

11.2.2 Sendmap

The name data specified when using Sendmap is used to describe a collection of PFM files.

The name data is specified as command line options.

Sendmap –M

The Area name. This field is the second field displayed on

"MapSetName" filename1.img

[filename2.img] […] the GPS unit under the "Map Information" section. Sendmap is not used with the MapSource software. http://cgpsmapper.com/ 95 of 130

cGPSmapper Manual

Figure 4: How name variables are shown

10.2 Activation of maps in the GPS

1. Activation of the map(s) in the GPS

If the map image is not shown in the GPS, check that the map is selected to be shown.

The method for doing this depends on the GPS model. For example you may find it on the MapSource Info screen, accessed from the unit's main menu or on the information page of the Setup Map screen. Consult your unit's documentation to find out how to access this screen display. http://cgpsmapper.com/ 96 of 130

cGPSmapper Manual

2. Activation / Deactivation of the GPS' base map

Loaded maps usually have more detail of the zone than the base map (which comes from the factory with the GPS).

Some GPS models allow you to deactivate the base map in the GPS (so that zoom levels do not mix up with the other loaded maps). Depending on the GPS model, this is done via the option Basemap in the Map tab, in the Setup Map menu (which can be accessed by pressing the key Menu once in the map page).

Note that you can also use the Transparent= line in your PFM file header section.