Municipal guided routes

1. About Municipal routes

This section explains how to work with municipal routes (a.k.a. offroad routes) using json file format.
Btw, the municipal routes is the category of guided routes.
One can send an imposed route to the navigation and the navigation can switch to the special navigation mode, in which it tries to navigate drivers using the defined geometry, i.e. even on the roads or trajectories not covered by current maps.
Such routes can be extended with additional information such as coloring for visualization and possible TTS messaging.
There is the SDK function LoadOFGRoute (currently available in a special release, please contact our sales), through which the json route can be injected into navigation.
Please note that the json imposed routes are currently only available with 2D versions of navigation.


2. Route format

The json specification of the supported structure is shown in the diagram bellow. The filenames of this type of route have the suffix ofg.
The fields denoted with * are mandatory.


The description of the json fields:

Field Type Default value Description
name string   caption on the point
version string n/a the file format version, supported:
lat int n/a latitude position defined as WGS84 multiplied by 100,000
lon int n/a longitude position defined as WGS84 multiplied by 100,000
color string #C0C0C080 the color string defined in the format RGBA format, example #FFA0522D. The color is applied on the point and the roadline starting from this point to the next one
instruction int -1 defines instruction to be given at the point, -1 denotes the instruction to be inferred automatically, -2 denotes no instruction is given, see the Instruction table bellow for details
roundaboutIndex int 1 the exit index defined for roundabout instructions
messageTts string   the text for the spoken instruction at the point


Instruction name int Index required
Remove Instruction -2 FALSE
Inferred Instruction -1 FALSE
Direction Keep Right 0 FALSE
Direction Keep Left 2 FALSE
Direction Easy Right 4 FALSE
Direction Easy Left 6 FALSE
Direction Right 8 FALSE
Direction Left 10 FALSE
Direction Sharp Right 12 FALSE
Direction Sharp Left 14 FALSE
Direction Straight 16 FALSE
Direction U Turn Right 17 FALSE
Direction U Turn Left 18 FALSE
Direction Roundabout SE 23 TRUE
Direction Roundabout E 24 TRUE
Direction Roundabout NE 25 TRUE
Direction Roundabout N 26 TRUE
Direction Roundabout NW 27 TRUE
Direction Roundabout W 28 TRUE
Direction Roundabout SW 29 TRUE
Direction Roundabout S 30 TRUE
Direction Roundabout SE_LS 32 TRUE
Direction Roundabout E_LS 33 TRUE
Direction Roundabout NE_LS 34 TRUE
Direction Roundabout N_LS 35 TRUE
Direction Roundabout NW_LS 36 TRUE
Direction Roundabout W_LS 37 TRUE
Direction Roundabout SW_LS 38 TRUE
Direction Roundabout S_LS 39 TRUE
Direction Ferry 40 FALSE
Direction State Boundary 41 FALSE
Direction Exit Right 43 FALSE
Direction Exit Left 44 FALSE


Version history:

Version Release date Change log 28.9.2015 1st official release 29.5.2015 beta release


3. Json example

An example of the route for waste management trip:

  "name": "Bratislava wastecollection route#1",
  "version": "",
  "guidePoints": [
      "lon": 1712838,
      "lat": 4816011
      "lon": 1712916,
      "lat": 4816097,
      "color": "#FFA0522D",
      "name": "New point",
      "instruction": 26,
      "roundaboutIndex": 3,
      "messageTts": "Collect left"
      "lon": 1712804,
      "lat": 4816143,
      "color": "#FFB8860B",
      "name": "New point",
      "instruction": 2,
      "messageTts": "Collect both sides"
      "lon": 1712750,
      "lat": 4816117,
      "lon": 1712630,
      "lat": 4816157,
      "color": "#FFFFD700",
      "name": "New point"
      "lon": 1712650,
      "lat": 4816260,
      "color": "#FFCD5C5C",
      "lon": 1712968,
      "lat": 4816158
      "lon": 1712998,
      "lat": 4816195
      "lon": 1712816,
      "lat": 4816258,
      "lon": 1712712,
      "lat": 4816294
      "lon": 1712727,
      "lat": 4816356


4. Usecase example

The format can be used to deliver routes to navigation from any web based solution, which allows construction and editing of routes, through e.g. a simple convert and Sygic API call.
Please note that Sygic offers such a functionality out-of-the-box through its Sygic FleetWork solution as shown in the picture bellow.


5. Navigation integration

The stand-alone navigation application can be integrated using our generic SDK functions. For management of Municipal routes the following functions were added to the standard SDK:

SDK Function previous SDK function name Description
loadOFGRoute loadGuidedRoute Loads an offroad guided route (OFG) and starts navigation following that route.
getOFGRouteStatus getGuidedRouteStatus Gets the status of currently loaded guided (OFG) route in JSON format.
saveOFGRoute saveGuidedRoute Saves sub-route of currently loaded guided (OFG) route.
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request