TomTom Software Development Kit
Version 5.0
(for the TomTom GO)
Additional Configuration Options
- 1. Introduction
- 2. How to add a splash screen
- 3. How to customize the menu
- 4. How to add a colour scheme
1. Introduction
Several default configuration components of the TomTom GO can be adjusted, allowing users to modify the appearance of the TomTom GO.
By creating certain files to be placed on the SD card, the splash screen that is shown when switching on the TomTom GO can contain a picture of your choice, the appearance of the menu can be modified and the list of colour schemes can be extended with user-defined colour schemes.
This section explains how to replace the splash screen, how to define a customized menu and how to add a colour scheme.
2. How to add a splash screen
The Splash Screen of the TomTom GO, which is the window that welcomes the user when switching on the device, can contain a picture of your choice. By placing your own bitmap in the right place on the SD card, your picture will be displayed when turning on or off the TomTom GO.
2.1. Example splash screen
Warning: The file 'splash.bmp' could already be available in the root of the SD card. If so, make a copy of that file before completing this example.
Copy the file called 'splash.bmp' from the /TomTomGO-SDK/examples/additional_configuration/ folder to the root of the SD card. Turn the TomTom GO off and then on again. The splash screen will briefly show when turning the device on.
2.2. Adding a splash screen
When you want your own splash screen being displayed when turning on or off the TomTom GO, create a bitmap with the following name:
The bitmap should have the following attributes:
- height = 240 pixels
- width = 320 pixels
- bits per pixel = 24
It will be rotated -90 degrees when shown on the TomTom GO, so make sure you rotate it 90 degrees clockwise before you transfer it(the left-hand side of the bitmap will become the bottom of the Splash Screen).
After the bitmap has been created, copy it to the root of the SD card.
When switching on the TomTom GO, it searches for a file called 'splash.bmp' in the root of the SD card. If available and correct, the picture will be displayed in 65536 colours.
3. How to customize the menu
The way the menu items on the TomTom GO menu are arranged can be modified by defining your own menu. Furthermore, items can be deleted, default icons and descriptions can be replaced by user-defined ones and items can be greyed out.
A customized menu for the TomTom GO is defined in a text file, which is read at start-up. If available and correct, the menu defined in this file will show instead of the default menu. Don’t worry if your menu is not what you expected, just delete or rename it and the TomTom GO default menu will show again.
3.1. Example customized menu
Copy the following text into a file called 'TomTom.mnu' or use the corresponding file from the /TomTomGO-SDK/examples/additional_configuration/ folder.
Don’t worry if your menu is not what you expected, just delete or rename it and the TomTom Navigator default menu will show again.
3.2. Example customized menu
Copy the following text into a file called 'TomTom.mnu' or use the corresponding file from the \TomTomPPC-SDK\examples\additional_configuration\ folder.
MENUBLOCK|BLOCK_MAIN|BTM_GPS_POSITION| |
MENUPAGE|TASK_PAGE1|Custom menu 1|MENUITEM|TASK_MENU_PLAN_ATOB| MENUITEM|TASK_NAVIGATE_TO||"Go Somewhere"| MENUITEM|TASK_MENU_FIND_ALTERNATIVES|"none.bmp"|"Alternatives..."| MENUITEM|TASK_SDK1| MENUITEM|TASK_PAGE5|TASK_MENU_PREFERENCES|TASK_MENU_PREFERENCES| MENUITEM|TASK_PAGE2| |
MENUPAGE|TASK_PAGE2|Custom menu 2|MENUITEM|TASK_ADD_FAVORITE| MENUITEM|TASK_SHOW_MAP| MENUITEM|TASK_MENU_ROUTE_INSTRUCTIONS| MENUITEM|TASK_DIAL_POI| MENUITEM|TASK_ITINERARY| MENUITEM|TASK_PAGE3| |
MENUPAGE|TASK_PAGE3|Custom menu 3|MENUITEM|TASK_SHOW_WEATHER| MENUITEM|TASK_MENU_DOWNLOAD| MENUITEM|TASK_MENU_TRAFFIC| MENUITEM|TASK_TUTORIAL| MENUITEM|TASK_CONFIRM_DELETE_ROUTE| MENUITEM|TASK_PAGE4| |
MENUPAGE|TASK_PAGE4|Custom menu 4|MENUITEM|TASK_EXIT_APP| MENUITEM|TASK_PAGE1| |
MENUBLOCK|BLOCK_PREF|BTM_DONE| |
MENUPAGE|TASK_PAGE5|Custom preferences|MENUITEM|TASK_SET_COLOR_SCHEMES| MENUITEM|TASK_SET_CLOCK_TYPE| MENUITEM|TASK_SWITCH_BLUETOOTH| MENUITEM|TASK_SET_VOICE| MENUITEM|TASK_CONFIRM_DELETE_ROUTE| MENUITEM|TASK_PAGE1| |
Put the file in the directory SdkRegistry/ from the root of the SD card. The full path to this directory is /mnt/sdcard/SdkRegistry/ Also, make sure at least one of the previously defined capability files is available in /mnt/sdcard/SdkRegistry/. The command defined in the capability file will now show as the 5th menu item of the first main menu as defined by "MENUITEM|TASK_SDK1|". If you do not have a capability file available and you still want to complete the example, just remove that line from the 'TomTom.mnu' file.
If the connection with the SD card is made through HyperTerminal, the command 'sync' should be given at the terminal to force the changes to the disk. Now reboot the TomTom GO and browse through the main menu. The TomTom GO will now show a custom menu.
3.3. Defining the menu
To define a menu, a text file should be created with the following name:
In this file the menu items to be shown on each page of the menu are defined.
The format of the TomTom.mnu file is pipe-separated ASCII, where each line consists of at least a level and one of the predefined names defined for that level.
Three levels can be distinguished:
- MENUBLOCK: The definition of a menu block. Currently only the main menu block can be defined
- MENUPAGE: The definition of a menu page, i.e. page1, page2, etc.
- MENUITEM: The definition of a menu item, i.e. “Navigate to”, “Clear Route, etc.
To define a menu, you first have to define the menu block:
MENUBLOCK|BLOCK_MAIN|BTM_GPS_POSITION| |
where
- BLOCK_MAIN is the name of the main menu block
- BTM_GPS_POSITION is the GPS-information, to be shown on the bottom of the main menu
Every line after this will be interpreted as a page or an item of the main menu.
Then a page is defined, by:
MENUPAGE|TASK_PAGE1|Custom menu 1| |
where
- TASK_PAGE1 is the internal name of the menu page
- My Menu 1 is the name of the menu page, to be show on the top of the menu page
Note: The name of the menu page does not require doubles quotes.
Now, the menu items are defined for each page. The first item of the first page of the main menu is the predefined menu item "Advanced Planning":
MENUITEM|TASK_MENU_PLAN_ATOB| |
The second item of the menu says "Go Somewhere" and selecting it brings you to the default "Navigate To"-functionality:
MENUITEM|TASK_NAVIGATE_TO||"Go somewhere"| |
The description “Navigate to...” has been replaced with “Go somewhere”, the icon is the default TomTom GO icon.
The next menu item in the example is the predefined “Find Alternative”. In this case the icon for the menu option has been replaced by a user-defined icon and the description has been replaced by "Alternatives...":
MENUITEM|TASK_MENU_FIND_ALTERNATIVES|"none.bmp"|"Alternatives..."| |
To use your own bitmaps, place your .BMP file in the /TomTom/SdkRegistry/ folder on your Pocket PC. If the bitmap isn't available, the default icon will be displayed.
To browse through the menu, one of the 6 menu items of each page should be reserved for the next-screen item:
This shows the default arrow for going to the next page and selecting it from the menu will bring you to the next page.
Finally, an icon can be greyed out by adding 1 as a final argument:
MENUITEM|TASK_MENU_PHONE||”My Phone”|1| |
The menu option “My Phone” will show on the menu, but it is greyed out and can not be accessed.
Please note that the pages are interpreted in the order in which they are defined and not by the number of the TASK_PAGE, so make sure the pages are defined in following order.
For an overview of the predefined menu items, see :
A special item TASK_SDKn is defined:
This item represents the command to be sent to an external application, as defined in a capability file.
If you have several commands to send or several applications to start, you should define a different TASK_SDKn for each command. If you have three commands defined in capability files, these items should be defined in the menu: TASK_SDK1, TASK_SDK2, TASK_SDK3. Please note that adding an icon or a description to the SDK_TASK line, the icon and description specified in the capability file will be overwritten.
The external commands will be interpreted in the same order as they were on the extended menu.
After you have created the file and defined the menu, put it in the following directory from the root of the SD card:
The full path to this directory is /mnt/sdcard/SdkRegistry/
If the connection with the SD card is made through HyperTerminal, the following command should be given at the terminal to force the changed block to disk:
When the TomTom GO starts, the SdkRegistry directory will be searched for the file 'TomTom.mnu'. If available and correct, the customized menu will show instead of the default menu.
3.4. Summarize TomTom.mnu
A customized menu is defined by:
MENUBLOCK|«blockname»|«btm_option»|MENUPAGE|TASK_PAGE1|«title»| …. …. …. MENUPAGE|TASK_PAGE«n»|«title»| |
where
- «blockname» is one of the [Blocks]
- «btm_option» is one of the [BTM_option]
- «title» is the title of the menu page, to be shown at the top of the screen
- TASK_PAGE1 through TASK_PAGE«n» are the main menu pages, defined by:
MENUITEM|«taskname»|«icon»|«description»|«accessibility»|MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|TASK_PAGE«n+1» |
where
- «taskname» is one of the predefined Menu Items
- «icon» is the name of the bitmap for the menu item (optional). If left out, the default TomTom GO icon will show
- «description» is the description of the menu item (optional). If left out, the default TomTom GO description will show
- «accessibility» is 0 or empty for 'allow', any other integer for greyed out (optional). If left out, the default accessibility will show
- TASK_PAGE«n+1» is the reference to the next page. For the last menu page, define TASK_PAGE1 here in order to go to the first screen again
3.5. Custom Preferences
In your custom menu, you can also specify a set of preferences tailored to your needs. To do that, you have to do two things:
- specify the entry point for the preferences:
MENUITEM|TASK_PAGE5|TASK_MENU_PREFERENCES|TASK_MENU_PREFERENCES| |
- define the preferences block
MENUBLOCK|BLOCK_PREF|BTM_DONE|MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|«taskname»|«icon»|«description»|«accessibility»| MENUITEM|TASK_PAGE«n+1» |
The parameters are the same as for the main block.
The preferences block can have more than one page. You define navigation between pages in the similar fashion as for the main block: the last menuitem could be the next preferences page, the first preferences page or the first menu page.
3.6. Overview menu items
For more information on TomTom GO menu items, please refer to the manual that is provided with the TomTom GO.
Blocks
There are two blocks that can currently be defined in a menu file:
- BLOCK_MAIN , Main Menu Block
- BLOCK_PREF, Preferences Menu Block
BTM_options
At block-level, the following items can be defined to be shown at the bottom of the screen. Each menu-page of that block will show the BTM_options defined for that block.
- BTM_GPS_POSITION , GPS Information
- BTM_DONE , Done Button
- TRAFFIC_INFO , Traffic Information
Menu Items
The following menu items can be used in the customized menu file.
Special Tasks
- TASK_EMPTY, no task and this option will be shown as a blanc spot in the 6-option menu
- TASK_NONE, no task and no placeholder for it in the menu
- TASK_PAGEn, (n is in the range 1-20) a number identifying the custom menu page
- TASK_SDKn, (n is in the range 1-50) a command to be sent to a client application, as defined in a capability file
Navigation
- TASK_AVOID_ROUTE_LINE, Choose part of the route to avoid
- TASK_CONFIRM_DELETE_ROUTE , Clear Route with asking the user confirmation first
- TASK_DELETE_ROUTE, Clear Route immediately
- TASK_ITINERARY , Itinerary planning
- TASK_NAVIGATE_TO , Navigate to
- TASK_MENU_FIND_ALTERNATIVES , Go to "Find alternative" menu
- TASK_MENU_PLAN_ATOB , Advanced planning
- TASK_MENU_RECALC_BLOCK, Go to "Avoid roadblock" menu
- TASK_MENU_ROUTE_INSTRUCTIONS, Show the menu with options for vieuwing route
- TASK_PLAN_VIA, Calculate a route that goes via specified address
- TASK_SET_TOLL, Set the preferences for toll roads
- TASK_SET_PLANTYPE, Set the preferences for route planning
- TASK_SET_CRADLE, Set cradle preferences
- TASK_SHOW_ROUTE_DEMO, Demonstrate planned route
- TASK_SHOW_ROUTE_INSTRUCTIONS, Show the list with route instructions
- TASK_STEP_ROUTE_INSTRUCTIONS, Browse through the route instructions as images
- TASK_SWITCH_2D3D, Switch between 2D and 3D navigation view
Downloads
- TASK_MENU_DOWNLOAD , Download extras
- TASK_MENU_TRAFFIC , TomTom Traffic
- TASK_SHOW_WEATHER , TomTom Weather
Manage Maps
- TASK_DELETE_MAP, Delete a map
- TASK_SET_MAP, Choose a current map
- TASK_SET_HIDEMAP, Specifies whether the map should be replaced with a simpler view under certain conditions
- TASK_SHOW_MAP , Browse map
Favourites
- TASK_ADD_FAVORITE , Add favourite
- TASK_MAINTAIN_FAVORITES, Maintain the list of favorites
Preferences
- TASK_CHANGE_HOME_LOCATION, Specify new home location
- TASK_LEFTHANDED, Switch between lefthanded and righthanded UI
- TASK_MENU_PREFERENCES , Change Preferences
- TASK_RESET_SETTINGS, Restore original application settings
- TASK_ROTATE_DISPLAY, rotate display by 180 degrees
- TASK_SET_BRIGHTNESS, Adjust the brightness level for the device
- TASK_SET_BACKLIGHT, Adjust the backlight settings for the device
- TASK_SET_CLOCK_TYPE, Set clock type
- TASK_SET_COLOR_SCHEMES, Choose day and night color schemes
- TASK_SET_COMPASS, Specify how to show the compass in the navigation view
- TASK_SET_DAY_COLOR_SCHEME, Choose day color scheme
- TASK_SET_DIST_UNITS, Choose distance units
- TASK_SET_KEYBOARDSIZE, Set the size for the onscreen keyboard
- TASK_SET_KEYBOARDTYPE, Set the type for the onscreen keyboard
- TASK_SET_LANGUAGE, Choose application language
- TASK_SET_NIGHT_COLOR_SCHEME, Choose night color scheme
- TASK_SET_PROMPT, Specify the additional settings for voice promtps
- TASK_SET_STATUS, Specify the information to show at the bottom of navigation view
- TASK_SET_VOICE, Choose the voice for reading instructions
- TASK_SET_VOLUME, Adjust the voice volume
- TASK_SHOW_GPS_STATUS , Configure GPS
- TASK_SHOW_STATUS, Show route status
- TASK_SWITCH_ASN, Switch accelerometer on/off
- TASK_SWITCH_BLUETOOTH, Enable/disable bluetooth connectivity
- TASK_SWITCH_NIGHTVIEW, Switch to night view mode
- TASK_SWITCH_SOUND, Enable/disable sound
- TASK_SWITCH_TIPS, Enable/disable tips
POI
- TASK_CONFIGURE_POI, Choose which types of POI to show
- TASK_MAINTAIN_POI, Go to POI maintenance menu
- TASK_SWITCH_POI, shows/hides POI
Traffic
- TASK_MENU_TRAFFIC, go to traffic menu
- TASK_TRAFFIC_ENABLE, enable traffic support
- TASK_TRAFFIC_EXPLAIN, help for traffic
- TASK_TRAFFIC_REPLAN, replan current route
- TASK_TRAFFIC_SETTINGS, specify traffic settings
- TASK_TRAFFIC_UPDATE, update traffic information
- TASK_TRAFFIC_VIEW, go to traffic incidents view
Miscellanious tasks
- TASK_ABOUT, show Navigator information screen
- TASK_EXIT_APP, exit the application
- TASK_SET_NAME_DISPLAY, specify naming preferences for map/navigation views
Downloads
- TASK_DOWNLOAD_MAP, Download map
- TASK_DOWNLOAD_POI, Download POI
- TASK_DOWNLOAD_VOICE, Download voice
- TASK_DOWNLOAD_SCHEME, Download color scheme
- TASK_DOWNLOAD_VERSIONNUMBER, Upgrade the Navigator application
- TASK_MANAGE_MAPS, Go to "Manage maps" menu
- TASK_MENU_DOWNLOAD, Go to "Downloads" menu
- TASK_SERVICE_LOGIN, Perform login to the TomTom Plus services
- TASK_SHOW_WEATHER, Get the current weather information
Help
- TASK_HELP_GENERAL, General help
- TASK_HELP_ITINERARY, Help for itinerary
- TASK_HELP_MAINMENU, Help for the main menu
- TASK_HELP_MAPBROWSER, Help for the map view
- TASK_HELP_PLANNING, Help for route planning
- TASK_HELP_TRAFFIC, Help for traffic
- TASK_HELP_ZOOMING, Help for zooming
- TASK_TUTORIAL , Guided tour
Phone
- TASK_DIAL_POI, Dial the POI
- TASK_MENU_PHONE , Mobile phone
- TASK_PAIR_WITH_PHONE, Connect to the phone via Bluetooth
4. How to add a colour scheme
The TomTom GO comes with several map colour schemes, which can be selected by selecting 'Change Map Colour' from the Preferences menu. It is now also possible to create your own map colour scheme and add it to the list of schemes.
4.1. Example colour scheme
Copy the following code into a file called 'mycolours.clr' or use the corresponding file from the /TomTomGO-SDK/examples/additional_configuration/ folder.
;; Belgica ; 204,255,204 ; background 255,204,153 ; built-up area (city) 168,168,255 ; water solid 204,255,153 ; park 153,204,153 ; woodland 255,255,153 ; beach/dune/sand 204,153,255 ; industrial zone 204,204,204 ; harbor/marina 255,204,204 ; moor/heath 153,255,204 ; marsh 255,204,255 ; pedestrian zone 153,153,204 ; airport 204,204,204 ; runway 192,192,192 ; route background ('below' the road) 136,000,000 ; route foreground (on top of the road) 255,102,153 ; blocked road (dotted on top of any road) 255,000,153 ; traffic jam (dotted on top of any road) 000,136,000 ; highlighted / selected (line on top of any road) 255,153,255 ; unreachable / not allowed to drive (dotted on top of any road) 255,000,000 ; motorway solid 255,000,000 ; motorway edge 255,255,000 ; motorway inside 136,000,000 ; motorway text 153,051,000 ; major/international road solid 136,000,000 ; major/international road edge 255,255,000 ; international road inside 255,255,000 ; major road inside 051,051,000 ; major road text 255,255,000 ; secondary road small 255,255,000 ; secondary road solid 000,000,000 ; secondary road edge 255,255,000 ; secondary road inside 153,153,000 ; secondary road text 255,255,000 ; connecting road small 255,255,102 ; connecting road solid 000,000,000 ; connecting road edge 255,255,102 ; connecting road inside 153,153,000 ; connecting road text 255,255,255 ; (major)local road small 255,255,255 ; major local road solid 255,255,255 ; local road solid 000,000,000 ; local/destination road edge 255,255,255 ; local/destination road inside 085,085,085 ; local road text 255,255,255 ; destination road solid 085,085,085 ; destination road text 255,255,255 ; ferry background 000,000,136 ; ferry dots 000,000,136 ; ferry text 170,170,170 ; railroad dashed A 000,000,000 ; railroad dashed B 153,153,255 ; water edge outlines 000,000,000 ; borders (dot-dash) 000,000,000 ; arrows (road direction) 255,255,255 ; arrows border (road direction) 000,128,000 ; Route indication arrow color, normal 000,255,000 ; Route indication arrow color, highlighted 000,128,000 ; Tollroad edge color 133,227,135 ; Tollroad inside color 000,000,092 ; NavView: status/safeview panel background (default:dark blue) 080,080,190 ; NavView: status/safeview panel borders (default:blue) 255,255,255 ; NavView: status/safeview panel text (default:white) 206,207,255 ; NavView: status/safeview panel dim text (default:lightblue) 000,000,092 ; NavView: next highway background 255,255,255 ; NavView: next highway border 255,255,255 ; NavView: next highway text / iRouteDirectionArrowColor 000,128,000 ; NavView: next highway EXIT background 255,255,255 ; NavView: next highway EXIT border 255,255,255 ; NavView: next highway EXIT text 095,100,215 ; NavView: routeplanning progressbar color 192,092,092 // Distant route color |
Put the file ‘mycolours.clr’ in a directory called 'schemes' from the root of the SD card. First-time SDK users will probably have to create this directory. Please note that the full path to this directory is /mnt/sdcard/schemes/ . On the TomTom GO browse to Preferences => Change Map Colours. Tap on the arrows to cycle through the colour schemes. A plug-in scheme will be available and selecting it will show you the new scheme 'mycolours'.
4.2. Creating a colour scheme
Choose the name of your colour scheme and create a file with that name and the extension CLR. The name will be displayed on the scheme selection page, so choose a sensible name.
In the .CLR file define the colours of the different components of a map; what colour do you want a park to have, how do you want a motorway to look like, a city, etc. The colours are defined by their RGB values: the red, green, and blue intensity values that are used to define a colour. The comment behind each set of values, which is preceded by either '//' or ";", describe which component of the map that line defines.
Please note that the colour-definition on a line in the colour file is always assigned to the same component; the colour for woodland is always the 5th colour defined in the file, a runway always the 13th, etc. So, commenting out some line at the beginning of the file, should give you some funny results, as each component gets the previous component's colour-definition.
Refer to the comments of the example 'mycolours.clr' to see which component of a map each line represents.
4.3. Adding a colour scheme
Put a valid CLR file in the following directory from the root of the SD card:
The full path to this directory is /mnt/sdcard/schemes/
When selecting a colour scheme from the Preferences Menu, a plug-in scheme will be available. Selecting it will show the newly created colour scheme 'mycolours'. Selecting it will show the newly created colour scheme 'mycolours'. |