API-Reference

This is an overview of all available commands of the remote interface. In case of an error, a specific Error value will be returned.

Warning

On devices using Android 10 (API level 29) and above, be sure to set the popup permission in the application permission settings. If you don't set it, the app will not come to foreground and some API functions will not work properly.

---

Android >= 11 related commands

Commands listed here have to be used as described in this paragraph to work with Android 11 and above!

• Load a preference file
• Load a given BCR file and set the target stops according to the stops

General commands

• Set compatibility mode
• Bring the Navigator to front
• Get the Id of the device
• Set the connection mode (online/hybrid)
• Allow/Forbid connection mode switching
• Allow/Forbid user interaction

Stop and waypoint management commands

• Add a stop to the target stop list
• Delete all stops in the target stop list
• Get all stops of the current tour
• Load a given BCR file and set the target stops according to the stops

Coordinate related commands

• Geocode a given address (retrieve the position)
• Inverse geocode (get the address from a position)

Navigation related commands

• Start a navigation
• Stop the current running navigation
• Get the current route trace

Profile related commands

• Get all available vehicle profiles
• Get the currently active vehicle profile
• Set an existing vehicle profile as active
• Import a profile
• Import a profile from an external directory

Preference related commands

• Get a preference value
• Set preference values
• Load preferences from file
• Set map data permissions

Licensing related commands

• Get the license key
• Set the license key
• Logout the navigator
• Get the device description
• Set the device description

Push service commands

• Register for event listening
• Unregister from event listening
• List of available push service events