navAutoArrival (Function)

Top  Previous  Next

Architecture:

X32 / NX32 / NX32L

Device support:

MX2, AX9, CX1 pro/flex/warp, SX1, MX2 turbo/encore/warp, AX9 turbo, NX-200, NX-400, NX-900

Firmware version:

1.40 / 1.00.00

Nav. API level:

1


This function will change the auto-arrival criteria.

The auto-arrival feature is used to automatically detect that the user has arrived at a destination and then to prompt the user if they would like to mark the destination as done and start navigating to the next destination on the route.

Note that if the navigation device cannot find a street at the destination, it is not activated and the navigation device activates the next destination on the route. (Until a destination is OK or there are no more destinations on the route).

 

 

Input:

time : DINT (default: 30)

The number of seconds the navigation device should be stopped close to the destination before the auto-arrival feature is activated.

 

distance : DINT (default: 100)

How close to the destination, in meters, the navigation device has to be before the auto-arrival feature is activated.

 

 

Returns: INT

0

- Success.

-1

- Navigation interface is not opened.

-2

- Error communicating with navigation device.

-12

- Navigation interface is busy.

 

Declaration:

FUNCTION navAutoArrival : INT;
VAR_INPUT
  time     : DINT := 30;
  distance : DINT := 100;
END_VAR;

 

Example:

INCLUDE rtcu.inc
 
PROGRAM NavigationExample;
 
BEGIN
  ...
  // Set the criteria for the auto-arrival detection
  navAutoArrival(time := 20, distance := 75);
  ...
END;
END_PROGRAM;