Documentation Index

Fetch the complete documentation index at: https://docs.eleostech.com/llms.txt

Use this file to discover all available pages before exploring further.

Turn-by-Turn Navigation

Prev Next

Turn-by-turn navigation provides users with real-time, directional guidance to their selected stops. The mobile app utilizes the routing data and the user location to guide the user step-by-step along the planned route.

IMPORTANT: Turn-by-turn navigation routes users from their current location to a specific stop. While the Trip Planner displays one continuous route, active navigation is strictly stop-to-stop. For example, if a user initiates navigation to the final stop on a load, the mobile app routes them directly to that final stop from their current location. The mobile app does not automatically route the user through any preceding stops.

Turn-by-turn navigation can be enabled or disabled by setting the prevent_navigation field within your Loads response to either true or false. This field is available on the load level and the stop level.

NOTE: Setting the prevent_navigation field on the load level, will override the field on the stop level.


Interface Features

To assist users while driving, the turn-by-turn navigation screen includes several interactive tools:

  • Hours of Service (HOS): View available Hours of Service for the user directly on the screen.

  • Voice Navigation Toggle: Mute or unmute the spoken turn-by-turn directions.

  • Textual Directions: Switch to a list of step-by-step textual directions if the users prefers to read the route instead of viewing the map.

  • Compass: View a dynamic compass that displays the current directional heading for the user.

  • Map Controls: Zoom and tilt the map manually to adjust the visual perspective while navigating.

  • Re-center Button: Tap a button to immediately snap the camera back to the current location indicator if the user previously zoomed or tilted the map.

  • Report Issue: Tap the Report Issue button to send diagnostic information and routing feedback to your servers.

NOTE: The Map Controls and Report Issue features are disabled by default. Set the enable_map_interaction_in_navigation boolean for Map Controls and the allow_reporting_issue_in_navigation boolean for Report Issue in the Loads API to true to enable them.


Resources

API