Remotely controlling Navigator 10
COM/TCPIP connection has to be set up in Pocket/PC Navigator settings (go to Main menu 2 -> Settings 2/2 -> Remote communication).
This page refers only to "no VTU" type of connection.
Every command starts with '$' and ends with '\n' or "\r\n".
-----------------------------------------------------------------------------------------------------
DISPLAY A TEXT MESSAGE
Format:
$message="message";instant
Description:
- shows a message on remote device
Protocol version:
- 1.0.0 or later
- 2.0.3 or later for "instant parameter"
Availability:
- tcp/ip or com
Parameters:
- parameter is a text enclosed in quotation marks to display on remote device
- when parameter "instant" is used the message is shown immediatelly; placeholder icon is displayed otherwise
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
DISPLAY A QUESTION
Format:
$message="message";ask;instant
Description:
- shows a question on remote device (can be answered with "yes" or "no)
Protocol version:
- 1.0.0 or later
- 2.0.3 or later for "instant parameter"
Availability:
- tcp/ip or com
Parameters:
- parameter is a text enclosed in quotation marks to display on remote device
- when parameter "instant" is used the message is shown immediatelly; placeholder icon is displayed otherwise
Return values:
- "yes" or "no" as the answer to question on success or "error" when failed
- "busy" when the remote device is busy responding to another command
DISPLAY A CHAT MESSAGE
Format:
$chat="message"
Description:
- sends a new message to chat window
Protocol version:
- 2.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- parameter is a text enclosed in quotation marks to display on remote device
Return values:
- none
SEND DESTINATION AND/OR WAYPOINT(S) AND/OR DEPARTURE
Format:
$destination=50.074525,14.409428;...;50.074421,14.409226;"Text";ask;navigate;departure;instant
$destination=clear
Description:
- sends routing points with posible text message/question and possibility to start navigation on remote device
- clear to clear all waypoints
Protocol version:
- 1.0.0 or later
- 1.4.1 or later for $destination=clear
- 2.0.1 or later departure parameter added (first coordinate is departure point)
- 2.0.3 or later for "instant parameter"
Availability:
- tcp/ip or com
Parameters:
- route points order is waypoint1;..;waypointN;destination
- use parameter "Text" to display text
- use parameters "Text";ask to display question
- parameter "navigate" to start navigation on remote device
- when parameter "instant" is used the message is shown immediatelly; placeholder icon is displayed otherwise
Return values:
- for a message "ok" on success or "error" when failed
- for a question "yes" or "no" as the answer to question on success or "error" when failed
- "busy" when the remote device is busy responding to another command
NAVIGATION ROUTE STATISTICS
Format:
$navigation_statistics
Description:
- returns distance (in meters) or time (in seconds) to destination and nearest waypoint
Protocol version:
- 2.0.2 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- distanctance to waypoint, time to waypoint, distance to destination, time to destination
- example: 1000,60,2000,122
- "not navigating" when not currently navigating
NAVIGATION INFORMATION
Format:
$navigation_info=recalculation_warning:on
$navigation_info=recalculation_warning:off
$navigation_info=sound_warning:on
$navigation_info=sound_warning:off
Description:
- turns specific navigation informations on or off
- "recalculation_warning:on" - returns "recalculating" whenever the route is recalculated
- "sound_warning:on" - enables sound warning before every navigation voice command (same as $sound_warning=start)
Protocol version:
- 2.0.2 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
- "sound" when a navigation voice command occurs
- "recalculating" when a recalculation occurs
STOP NAVIGATION
Format:
$stop_navigation
Description:
- stops navigation on remote device
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
GET LAST KNOWN GPS POSITION
Format:
$last_position
Description:
- get last known gps data from remote device
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- when last position is known: latitude(degrees),longitude(degrees),altitude(meters),speed(km/h),course(degrees)
- when last position is unknown: "unknown"
- "error" when an error occured
- "busy" when the remote device is busy responding to another command
NAVIGATION SOUND
Format:
$sound_volume=volume
Description:
- set sound volume on remote device
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- "on" - system volume does not change and navigation messages are played
- "off" - system volume does not change and navigation messages are not played
- volume values from 0 to 100 set operation system sound volume to 0-100 percent
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
SOUND WARNINGS (OBSOLETE - SEE NAVIGATION INFORMATION)
Format:
$sound_warning=start
$sound_warning=stop
Description:
- request to send warning before a sound is played
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- start - starts sending sound warning
- stop - stops sending sound warning
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
CHANGE APPLICATION WINDOW SIZE
Format:
$window=left,top,width,height,[border|noborder]
Description:
- set remote device application window size
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- values are in pixels
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
MINIMIZE APPLICATION WINDOW
Format:
$minimize
Description:
- minimize remote device application window
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
MAXIMIZE APPLICATION WINDOW
Format:
$maximize
Description:
- maximize remote device application window
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
RESTORE MINIMIZED/MAXIMIZED APPLICATION WINDOW SIZE
Format:
$restore
Description:
- restore remote device minimized or maximizaed application window
Protocol version:
- 1.1.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command si
EXIT THE APPLICATION
Format:
$exit
Description:
- exits the application
Protocol version:
- 2.0.2 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
START/STOP SENDING GPS POSITIONS
Format:
$gps_sending=start;nmea
$gps_sending=stop
Description:
- start/stop sending current nmea data
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- start;nmea: start sending gps positions in nmea format
- stop: stop sending gps positions
Return values:
- for start;nmea: gps positions in nmea format or "error" when failed
- for stop: "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
START/STOP RECEIVING GPS POSITIONS
Format:
$gps_receiving=start
$gps_receiving=stop
Description:
- start/stop receiving nmea data
Protocol version:
- 1.3.0 or later
Availability:
- tcp/ip or com
Parameters:
- start: start receiving gps positions in nmea format
- stop: stop receiving gps positions
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
SET APPLICATION MODE
Format:
$set_mode=day
$set_mode=night
Description:
- set application mode
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- day: show application in day mode colors
- night: show application in night mode colors
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
MAP ICONS
Format:
$icon_new=42;50.074525,14.409428;"C:\My Pictures\Icons\icon1.ico"
$icon_new=42;50.074525,14.409428;"C:\My Pictures\Icons\icon1.ico";"Text"
$icon_move=42;50.074800,14.409627
$icon_move=42;50.074800,14.409627;"Text"
$icon_delete=42
$icon_delete=all
Description:
- create, move and delete an icon on map
Protocol version:
- 1.4.0 or later
Availability:
- tcp/ip or com
Parameters:
- icon_new command : icon number, coordinate, path, [text]
- icon_move command : icon number, coordinate
- icon_delete command : icon number
- icon_delete command : "all" to remove all icons
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
GET REMOTE SOFTWARE VERSION
Format:
$software_version
Description:
- returns remote device application software version
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- software version (e.g. 8.0.42) or "error" when failed
- "busy" when the remote device is busy responding to another command
GET COMMUNICATION PROTOCOL VERSION
Format:
$protocol_version
Description:
- returns communication protocol version
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- protocol version (e.g. 1.0.0) or "error" when failed
- "busy" when the remote device is busy responding to another command
This page refers only to "no VTU" type of connection.
Every command starts with '$' and ends with '\n' or "\r\n".
-----------------------------------------------------------------------------------------------------
DISPLAY A TEXT MESSAGE
Format:
$message="message";instant
Description:
- shows a message on remote device
Protocol version:
- 1.0.0 or later
- 2.0.3 or later for "instant parameter"
Availability:
- tcp/ip or com
Parameters:
- parameter is a text enclosed in quotation marks to display on remote device
- when parameter "instant" is used the message is shown immediatelly; placeholder icon is displayed otherwise
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
DISPLAY A QUESTION
Format:
$message="message";ask;instant
Description:
- shows a question on remote device (can be answered with "yes" or "no)
Protocol version:
- 1.0.0 or later
- 2.0.3 or later for "instant parameter"
Availability:
- tcp/ip or com
Parameters:
- parameter is a text enclosed in quotation marks to display on remote device
- when parameter "instant" is used the message is shown immediatelly; placeholder icon is displayed otherwise
Return values:
- "yes" or "no" as the answer to question on success or "error" when failed
- "busy" when the remote device is busy responding to another command
DISPLAY A CHAT MESSAGE
Format:
$chat="message"
Description:
- sends a new message to chat window
Protocol version:
- 2.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- parameter is a text enclosed in quotation marks to display on remote device
Return values:
- none
SEND DESTINATION AND/OR WAYPOINT(S) AND/OR DEPARTURE
Format:
$destination=50.074525,14.409428;...;50.074421,14.409226;"Text";ask;navigate;departure;instant
$destination=clear
Description:
- sends routing points with posible text message/question and possibility to start navigation on remote device
- clear to clear all waypoints
Protocol version:
- 1.0.0 or later
- 1.4.1 or later for $destination=clear
- 2.0.1 or later departure parameter added (first coordinate is departure point)
- 2.0.3 or later for "instant parameter"
Availability:
- tcp/ip or com
Parameters:
- route points order is waypoint1;..;waypointN;destination
- use parameter "Text" to display text
- use parameters "Text";ask to display question
- parameter "navigate" to start navigation on remote device
- when parameter "instant" is used the message is shown immediatelly; placeholder icon is displayed otherwise
Return values:
- for a message "ok" on success or "error" when failed
- for a question "yes" or "no" as the answer to question on success or "error" when failed
- "busy" when the remote device is busy responding to another command
NAVIGATION ROUTE STATISTICS
Format:
$navigation_statistics
Description:
- returns distance (in meters) or time (in seconds) to destination and nearest waypoint
Protocol version:
- 2.0.2 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- distanctance to waypoint, time to waypoint, distance to destination, time to destination
- example: 1000,60,2000,122
- "not navigating" when not currently navigating
NAVIGATION INFORMATION
Format:
$navigation_info=recalculation_warning:on
$navigation_info=recalculation_warning:off
$navigation_info=sound_warning:on
$navigation_info=sound_warning:off
Description:
- turns specific navigation informations on or off
- "recalculation_warning:on" - returns "recalculating" whenever the route is recalculated
- "sound_warning:on" - enables sound warning before every navigation voice command (same as $sound_warning=start)
Protocol version:
- 2.0.2 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
- "sound" when a navigation voice command occurs
- "recalculating" when a recalculation occurs
STOP NAVIGATION
Format:
$stop_navigation
Description:
- stops navigation on remote device
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
GET LAST KNOWN GPS POSITION
Format:
$last_position
Description:
- get last known gps data from remote device
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- when last position is known: latitude(degrees),longitude(degrees),altitude(meters),speed(km/h),course(degrees)
- when last position is unknown: "unknown"
- "error" when an error occured
- "busy" when the remote device is busy responding to another command
NAVIGATION SOUND
Format:
$sound_volume=volume
Description:
- set sound volume on remote device
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- "on" - system volume does not change and navigation messages are played
- "off" - system volume does not change and navigation messages are not played
- volume values from 0 to 100 set operation system sound volume to 0-100 percent
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
SOUND WARNINGS (OBSOLETE - SEE NAVIGATION INFORMATION)
Format:
$sound_warning=start
$sound_warning=stop
Description:
- request to send warning before a sound is played
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- start - starts sending sound warning
- stop - stops sending sound warning
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
CHANGE APPLICATION WINDOW SIZE
Format:
$window=left,top,width,height,[border|noborder]
Description:
- set remote device application window size
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- values are in pixels
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
MINIMIZE APPLICATION WINDOW
Format:
$minimize
Description:
- minimize remote device application window
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
MAXIMIZE APPLICATION WINDOW
Format:
$maximize
Description:
- maximize remote device application window
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
RESTORE MINIMIZED/MAXIMIZED APPLICATION WINDOW SIZE
Format:
$restore
Description:
- restore remote device minimized or maximizaed application window
Protocol version:
- 1.1.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command si
EXIT THE APPLICATION
Format:
$exit
Description:
- exits the application
Protocol version:
- 2.0.2 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- "ok" on success or "error" when failed
START/STOP SENDING GPS POSITIONS
Format:
$gps_sending=start;nmea
$gps_sending=stop
Description:
- start/stop sending current nmea data
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- start;nmea: start sending gps positions in nmea format
- stop: stop sending gps positions
Return values:
- for start;nmea: gps positions in nmea format or "error" when failed
- for stop: "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
START/STOP RECEIVING GPS POSITIONS
Format:
$gps_receiving=start
$gps_receiving=stop
Description:
- start/stop receiving nmea data
Protocol version:
- 1.3.0 or later
Availability:
- tcp/ip or com
Parameters:
- start: start receiving gps positions in nmea format
- stop: stop receiving gps positions
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
SET APPLICATION MODE
Format:
$set_mode=day
$set_mode=night
Description:
- set application mode
Protocol version:
- 1.2.0 or later
Availability:
- tcp/ip or com
Parameters:
- day: show application in day mode colors
- night: show application in night mode colors
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
MAP ICONS
Format:
$icon_new=42;50.074525,14.409428;"C:\My Pictures\Icons\icon1.ico"
$icon_new=42;50.074525,14.409428;"C:\My Pictures\Icons\icon1.ico";"Text"
$icon_move=42;50.074800,14.409627
$icon_move=42;50.074800,14.409627;"Text"
$icon_delete=42
$icon_delete=all
Description:
- create, move and delete an icon on map
Protocol version:
- 1.4.0 or later
Availability:
- tcp/ip or com
Parameters:
- icon_new command : icon number, coordinate, path, [text]
- icon_move command : icon number, coordinate
- icon_delete command : icon number
- icon_delete command : "all" to remove all icons
Return values:
- "ok" on success or "error" when failed
- "busy" when the remote device is busy responding to another command
GET REMOTE SOFTWARE VERSION
Format:
$software_version
Description:
- returns remote device application software version
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- software version (e.g. 8.0.42) or "error" when failed
- "busy" when the remote device is busy responding to another command
GET COMMUNICATION PROTOCOL VERSION
Format:
$protocol_version
Description:
- returns communication protocol version
Protocol version:
- 1.0.0 or later
Availability:
- tcp/ip or com
Parameters:
- none
Return values:
- protocol version (e.g. 1.0.0) or "error" when failed
- "busy" when the remote device is busy responding to another command