Municipal navigation programming


Municipal navigation is the feature that allows drivers to be navigated in the mode suitable for execution of municipal services. That is, when one needs the navigation in complicated trajectories not always matching the official road network. An example is the waste management service where the vehicle sometimes needs to go off-road or into a forbidden zone and where driver needs to be given custom instructions such as "collect the bin on the right side".
In order to support this kind of scenarios we provide API functions, which are dedicated to the navigation related to municipal services. In the following we will demonstrate programming of few usecases, which might be helpful for a solution provider.


The Municipal feature is supported by use of municipal API functions, which are under special licensing "guided routes".
The Municipal feature is represented by the special navigation mode called municipal navigation mode, which is triggered by use of LoadOFGRoute API function and alike.

Requirements and limitations

The feature is currently supported for the following OS platforms:

  • Android
  • WindowsCE ARM

and for the navigation version Sygic Fleet 2D release 15I or newer.

For navigation to support municipal mode:

  • the navigation license (mlm file) must contain the guided route permission: precomputed=yes


Operation Description
1. Load and unload OFG route load OFG route and get into municipal navigation mode and back to standard navigation mode
2. Navigate to beginning of OFG route navigate to beginning of OFG route in order to get ready for OFG navigation mode
3. Pause OFG route Pause OFG route navigation in order to resume later
4. Resume OFG route Resume OFG navigation mode at the point it has been previosuly paused
5. Handle off-route scenario React on off-route events in an appropriate way
6. Join OFG route Join OFG route in order to handle road obstacles
7. Missed segments  

Getting started


The municipal routes are input for the municipal navigation using the proprietary Sygic route format called OFG.
Therefore we technically refer to municipal routes as OFG routes and the municipal navigation mode as OFG navigation mode. The route format is described in Municipal routes.

The associated API functions are described in Android 2D API reference manual

1. Load and unload OFG route

In order to load OFG route, call ApiNavigation.loadOFGRoute(pathToOFGFile, 0, FLAG_OFG_DEFAULT, timeout). Navigation will switch to the OFG navigation mode. In this mode vehicle is not snapped to a road network but rather red thin line appears, showing the point on the OFG route closest from your vehicle. If you want to unload OFG route, call ApiNavigation.stopNavigation(timeout). Navigation is then switched back to the standard navigation mode (vehicle snapped to a road network).

2. Navigate to beginning of OFG route

Before loading OFG route, you can consider that driver should be navigated to the beginning of the OFG route using standard navigation mode. First, you will have to discover the start point of the OFG route and the direction of the first OFG segment, so that you are navigated to this point in a correct direction. To get these values, you have to parse the OFG file by yourself or you can use the helper class OfgSegmentInfo (shown in the appendix) to support this functionality. Then you can call ApiNavigation.startNavigation(startOfOFGRoute, 0, false, routeComputeSettings, timeout), where routeComputeSettings is instance of the RouteComputeSettings class and contains the direction angle information. If you want to see the OFG route during navigation to its start, but you don't want to be switched to the OFG navigation mode, call loadOFGRoute with FLAG_OFG_SHOW_ONLY. This will ensure that an OFG route will be visible, but you will stay in standard navigation mode. When arriving to the start point, you will receive EVENT_ROUTE_FINISH. To switch to the OFG navigation just call loadOFGRoute with flag FLAG_OFG_DEFAULT.
Note: You may consider whether to use or not the navigation to the start point of the OFG route. For example if the vehicle is close to the start of an OFG route, you may want to skip navigating to the start point.

	OfgSegmentInfo ofgInfo = new OfgSegmentInfo(sRoutePath, 0); 
	try {
		if (isCloseToCurrentPosition(ofgInfo.startWp)) {                
                   // start point is close, load OFG route
		   ApiNavigation.loadOFGRoute(mStrCurrentRoutePath, 0, ApiNavigation.FLAG_OFG_DEFAULT, API_CALL_TIMEOUT);
		else {
                   // only show OFG route
		   ApiNavigation.loadOFGRoute(mStrCurrentRoutePath, 0, ApiNavigation.FLAG_OFG_SHOW_ONLY, API_CALL_TIMEOUT);
                   // navigate to start point
		   RouteComputeSettings rcs = new RouteComputeSettings(ofgInfo.directionAngle);
		   ApiNavigation.startNavigation(ofgInfo.startWp, 0, false, rcs, API_CALL_TIMEOUT);
	  catch (GeneralException e) {

3. Pause OFG route

For some cases you may want to pause the current OFG navigation, get navigated from it in a standard navigation mode and return to the pause point later to continue. First you have to get the current status of the OFG navigation. Use ApiNavigation.getOFGRouteStatus(). From the resulting JSON string you can parse out the current index of OFG route (represents state and the progress of the OFG route execution) and GPS coordinates of vehicle's current position on OFG route. Store these values for the purpose of resuming the route and call ApiNavigation.stopNavigation().

    	try {
    	    String routeStatus = ApiNavigation.getOFGRouteStatus(API_CALL_TIMEOUT); 
            // store these values for Resume
    	    mPauseRouteIndex = getRouteIndex(routeStatus);
    	    mPauseRouteWaypoint = getPointOnRoute(routeStatus);

    	    OfgSegmentInfo segInfo = new OfgSegmentInfo(mStrCurrentRoutePath, mPauseRouteIndex);
            // store also this value for Resume
    	    mPauseRouteAngle = segInfo.directionAngle;
    	catch (GeneralException e) {

    	try {
	catch (GeneralException e) {

4. Resume OFG route

If you want to return back to the previously paused point, use the same routine as for navigation to start point, but use the values retrieved and stored at Pause route.

    	try {
    		ApiNavigation.loadOFGRoute(mStrCurrentRoutePath, mPauseRouteIndex, 0, API_CALL_TIMEOUT);
  		RouteComputeSettings rcs = new RouteComputeSettings(mPauseRouteAngle);
  		ApiNavigation.startNavigation(mPauseRouteWaypoint, 0, false, rcs, API_CALL_TIMEOUT);
    	catch(GeneralException e) {

5. Handle off-route situation

If the driver gets too far from an OFG route, EVENT_OFF_ROUTE is triggered. Event data is equal to "1". If the driver comes back in a near proximity to the route, the same event is triggered but with the data equal to "0".
Note that driver will be guided to the point where he left the route. If this point is not reachable, he should be given the possibility to "join" the route (see this usecase in a next section).

public void onEvent(final int event, final String data) 
    if(event == ApiEvents.EVENT_OFF_ROUTE)
	if(data != null)
           if(data.compareTo("1") == 0)
               // driver got too far from OFG route
               // driver is back on OFG route

6. Join OFG route

If the user is off route and he cannot reach his abandoned position on the OFG route, he should be able to continue following the route from his current position. In this case call loadOFGRoute with startIndex -1. This will reset driver's current position on the OFG route to the closest point on route to vehicle.

    ApiNavigation.loadOFGRoute(pathToOFGFile, -1, FLAG_OFG_DEFAULT, API_CALL_TIMEOUT)

7. Missed segments

If the driver avoids a part of the route (e.g. due to it was not reachable), you may want to store this part of the route as a missed segment for future handling. Use saveOFGRoute(fileName, fromIndex, fromPos, toIndex, toPos, timeout) to save a particular subroute of the currently loaded OFG route. There are 3 scenarios for this case:

1. Driver could not reach the start point (Start following)
Driver should be able to join the route. After joining the route, get the current OFG route status. This will give you his current position and route index. Use these values as parameters (toPos and toIndex) for saveOFGRoute. Setting start point to null and start index to -1 will ensure that the saved subroute will have the start in the same point as the original route.

    ApiNavigation.saveOFGRoute(fileName, -1, null, toIndex, toPos, API_CALL_TIMEOUT)

2. Driver could not reach the end of the route
Driver should be able to end the route prematurely (e.g. due to the end point is not reachable). Before unloading the route, get the route status to get actual point and index. Use these values as parameters (fromPos and fromIndex) for saveOFGRoute. Setting end point to null and end index to -1 will ensure that the saved subroute will the end in the same point as the original route.

    ApiNavigation.saveOFGRoute(fileName, fromIndex, fromPos, -1, null, API_CALL_TIMEOUT)

3. Driver had to avoid an inner part of the route
In this situation you have to work with Off route event. If the driver gets too far from a route, get the route status to get current point and current index on the OFG route (start of missed segment) and store it. After joining the route, do the same to get the end point and end index of missed segment.

    ApiNavigation.saveOFGRoute(fileName, fromIndex, fromPos, toIndex, toPos, API_CALL_TIMEOUT) 

Note: You can set the minimal length of the missed segment in the application's settings.ini file (m_nGuidedMinSaveRouteLength). If you try to save a shorter subroute, function will fail and will give you a notification about this.

Appendix: OfgSegmentInfo helper class

package com.sygic.routeloader;


import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import com.sygic.sdk.api.model.Position;
import com.sygic.sdk.api.model.WayPoint;

public class OfgSegmentInfo {

	public WayPoint startWp = null;
	public int directionAngle = -1;
	public OfgSegmentInfo(String filePath, int segment) {
		parse(filePath, segment);
	private void parse(String filePath, int segment) {
    	StringBuilder sb = new StringBuilder();
    	File file = new File(filePath);
    	FileReader reader;
		try {
			reader = new FileReader(file);
	    	BufferedReader br = new BufferedReader(reader);
	    	String line;
	    	while((line = br.readLine()) != null) {
		} catch (Exception e) {
    	        try {
			JSONObject jRoute = new JSONObject(sb.toString());
			JSONArray jPoints = jRoute.getJSONArray("guidePoints");
			if(jPoints.length() > segment) {
				JSONObject jPoint = jPoints.getJSONObject(segment);
				int lon = jPoint.getInt("lon");
				int lat = jPoint.getInt("lat");
				startWp = new WayPoint("Start", lon, lat);
			if(jPoints.length() > segment + 1) {
				JSONObject jPoint = jPoints.getJSONObject(segment + 1);
				int lon = jPoint.getInt("lon");
				int lat = jPoint.getInt("lat");
				Position startPos = startWp.getLocation(); 
				directionAngle = getDirectionAngle(startPos.getX(), startPos.getY(), lon, lat);
		} catch (JSONException e) {
	private int getDirectionAngle(int fromX, int fromY, int toX, int toY) {
		double dFromX 	= (double)fromX;
		double dToX 	= (double)toX;
		double dFromY 	= (double)fromY;
		double dToY 	= (double)toY;
		double dWorkX = dToX - dFromX;
		double dWorkY = dToY - dFromY;
		double dAngle = Math.atan(dWorkY / dWorkX);
		dAngle *= 57.29578; 	// to degrees
		if(dWorkX < 0)
			dAngle += 180.0;

		int nAngle = 90 - (int)dAngle;

		// normalize angle:
		nAngle %= 360;
		if(nAngle < 0)
			nAngle += 360;
		return nAngle;	
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request