gpsGetAntennaStatus (Function)

Top  Previous  Next

Architecture:

X32 / NX32 / NX32L

Firmware version:

1.10 / 1.40.00


This returns the status for the GPS antenna. By using this function, it can be determined whether a GPS antenna is connected or if a short circuit is present.

 

Be aware that not all devices supports this functionality. Please refer to the technical manual of the device in question.

 

 

Input:

None

 

Returns:

0

- Unknown/unsupported or GPS power is OFF.

1

- GPS antenna present.

2

- GPS antenna is short-circuited.

3

- GPS antenna is missing.

 

Declaration:

FUNCTION gpsGetAntennaStatus INT;

 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
 
BEGIN
   ...
   // Test GPS antenne status
   IF gpsGetAntennaStatus() > 1 THEN
      // Something is wrong
      ...
   END_IF;
   ...
END;
 
END_PROGRAM;