Skip to content

Latest commit

 

History

History
131 lines (97 loc) · 7.66 KB

USAGE.md

File metadata and controls

131 lines (97 loc) · 7.66 KB

Usage of wahooMapsCreator

Usage of wahooMapsCreator

wahooMapsCreator can be used in two different ways:

Both ways support the same arguments to be used for the map-creation process. You can choose the arguments via GUI or as CLI-arguments.

Always activate environment first

conda activate gdal-user

Run wahooMapsCreator for your country

It might be a good idea to run wahooMapsCreator first for a small country e.g. Malta to check if everything is running fine. In a next step you can run it for your own country.

GUI (Graphical User Interface)

From the root folder of wahooMapsCreator, run:

  • python -m wahoomc gui

Set your arguments as required via the window:

wahooMapsCreator GUI

CLI (Command Line Interface)

From the root folder of wahooMapsCreator, run:

  • python -m wahoomc cli -co <country_name>

Examples:

  • for Malta: python -m wahoomc cli -co malta
  • for Ireland: python -m wahoomc cli -co ireland

Advanced CLI-Usage

wahooMapsCreator supports many arguments via command line. For a list of all supported arguments, run:

  • python -m wahoomc cli -h

wahooMapsCreator provides following arguments, later on, there are some example calls

Mandatory CLI arguments

One of them is mandatory for running in CLI mode.

Option Description Default Value
-co One or more Country to create maps or to create maps for. malta or malta,germany. -
-xy One or more X/Y coordinates to create maps for. 133/35 or 133/35,133/66. -

Optional arguments

If you like to run wahooMapsCreator with another value than the default, use the following arguments.

Option Description Default Value
-md Maximum age of source maps and other files in days. 24
-nbc Do not process border countries of tiles involving more than one country. Only useful when processing a country. false
-con Calculate contour lines (elevation) and integrate into generated maps. false
-fd Force download of files. Download all files new. false
-fp Force processing of files. Create all files new. false
-c Save uncompressed maps for Cruiser. false
-tag File with tags to keep in the output. tag-wahoo-poi.xml
-z Zip the country (and country-maps) folder. false
-v Output debug logger messages. false

Main arguments

Create maps for a country

  • python -m wahoomc cli -co <country>

Create maps for X/Y coordinates

In particular for testing adjustments in configuration-files or coding it is helpful to create maps for only one tile or a handful of tiles!

To create maps for only one tile and not a whole country, one can use the X/Y coordinates of that tile. X/Y coordinates can be retrieved from this in zoom-level 8: link.

  • python -m wahoomc cli -xy <xy_coordinate,xy_coordinate>

Examples

  • for Malta, download new maps if existing maps are older than 100 days and process files even if files exist
    • python -m wahoomc cli -co malta -md 100 -fp
  • for Germany, download and process whole tiles which involves other countries than the given
    • python -m wahoomc cli -co germany -bc
  • to create maps for only one tile
    • python -m wahoomc cli -xy 134/88
  • for multiple tiles
    • python -m wahoomc cli -xy 134/88,133/88

POIs - Points of Interest

For creating maps which include POIs and have them displayed on your Wahoo device, these steps need to be done:

  1. Create custom maps including POIs like normally, POI's are included per default.

Actually, wahooMapsCreator includes fuel stations, backeries, cafes and railway stations POI's into the generated maps.

  1. Copy POIs relevant files to your device
  1. Activate VTM rendering if needed

Contour lines

For creating maps which include contour lines and have them displayed on your Wahoo device, these steps need to be done:

  1. Enhance your Anaconda environment using these steps
  2. Create custom maps with the argument -con like normally. You will be asked for username/password on first run generating contour lines.
  3. Use a theme that renders contour lines

User specific configuration

You can control popular configuration with your own files in the home directory wahooMapsCreatorData/_config.

Actually, it is possible to control which OSM tags will stay on the map while filtering tags (documentation) with ~/wahooMapsCreatorData/_config/tags-to-keep.json . Furthermore, you can control which and how OSM tags will be included in the generated maps with tag-wahoo .xml (documentation) in directory ~/wahooMapsCreatorData/_config/tag_wahoo_adjusted/ and specify the file via -tag argument or via GUI.

You can start the tool with python -m wahoomc.init to copy the files from the python module to the user directory. You'll have a structure and can change the files to your needs.

The tool searches for configuration in your home directory first and secondly (fallback) in the python installation. If a file is in both directories with the same name, the file of the user directory will be used.

The structure of ~/wahooMapsCreatorData/_config/tag_wahoo_adjusted/ is analogue to the one in the repo: wahooMapsCreatorwahoomc/resources.