Difference between revisions of "Manual:System/GPS"

From MikroTik Wiki
Jump to navigation Jump to search
 
(18 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Versions|v3, v4, v5 +}}
{{Versions|v3, v4, v5, v6 +}}
__TOC__
__TOC__


Line 5: Line 5:
==Summary==
==Summary==


<p id="shbox"><b>Sub-menu:</b> <code>/system gps</code>
<p id="shbox">
<b>Package requirement:</b> <code>gps</code>
<br />
<b>Sub-menu:</b> <code>/system gps</code>
<br />
<br />
<b>Standards:</b> <code>GPS, NMEA 0183, [http://www8.garmin.com/support/text_out.html Simple Text Output Protocol]</code>
<b>Standards:</b> <code>GPS, NMEA 0183, [http://www8.garmin.com/support/text_out.html Simple Text Output Protocol]</code>
Line 24: Line 27:
|default=0
|default=0
|desc=Port channel used by device
|desc=Port channel used by device
}}


{{Mr-arg-table
|arg=coordinate-format
|type=dd {{!}} dms {{!}} ddmm
|default=no
|desc=Which coordinate format to use, "Decimal Degrees", "Degrees Minutes Seconds" or "NMEA format DDDMM.MM[MM]"
}}
}}


{{Mr-arg-table
{{Mr-arg-table
Line 32: Line 42:
|default=no
|default=no
|desc=Whether GPS is enabled
|desc=Whether GPS is enabled
}}


{{Mr-arg-table
|arg=gps-antenna-select
|type=external {{!}} internal
|default=internal
|desc=Depending on model. Can be used to select internal antenna, if device has one.
}}
}}


{{Mr-arg-table
|arg=init-channel
|type=integer [0..4294967295]
|default=
|desc=Channel for init-string execution
}}
{{Mr-arg-table
|arg=init-string
|type=string
|default=
|desc=AT init string for GPS initialization
}}


{{Mr-arg-table
{{Mr-arg-table
Line 73: Line 105:
|arg=latitude
|arg=latitude
|type= none {{!}} string
|type= none {{!}} string
|desc=
|desc=Latitude in DM (Degrees Minute decimal) format
}}
}}


Line 79: Line 111:
|arg=longitude
|arg=longitude
|type=none {{!}} string
|type=none {{!}} string
|desc=
|desc=Longitude in DM (Degrees Minute decimal) format
}}
 
{{Mr-arg-ro-table
|arg=altitude
|type=none {{!}} string
|desc=Altitude based on GPS data
}}
}}


Line 85: Line 123:
|arg=speed
|arg=speed
|type=none {{!}} string
|type=none {{!}} string
|desc=
|desc=Current moving speed of the GPS unit
}}
 
{{Mr-arg-ro-table
|arg=destination-bearing
|type=none {{!}} string
|desc=The direction toward which a GPS is moving
}}
 
{{Mr-arg-ro-table
|arg=true-bearing
|type=none {{!}} string
|desc=The direction toward which a GPS is moving
}}
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=bearing
|arg=magnetic-bearing
|type=none {{!}} string
|type=none {{!}} string
|desc=
|desc=The direction toward which a GPS is moving
}}
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table
Line 100: Line 151:
}}
}}


{{Mr-arg-ro-table-end
{{Mr-arg-ro-table
|arg=satellites
|type=integer
|desc=Number of satellites seen by the device.
}}
 
{{Mr-arg-ro-table
|arg=fix-quality
|type=integer
|desc=Quality of the signal
}}
 
 
{{Mr-arg-ro-table
|arg=satellites
|arg=satellites
|type=integer
|type=integer
|desc=Number of satellites seen by the device.
|desc=Number of satellites seen by the device.
}}
}}
{{Mr-arg-ro-table-end
|arg=horizontal-dilution
|type=integer
|desc=Horizontal dilution of precision (HDOP);
}}
''Note: The time is not stratum 1 as RouterBOARD devices do not have [http://en.wikipedia.org/wiki/Pulse_per_second PPS] implemented'' as of RouterOS v6. This might change with new NTP server in v7.


==Basic examples==
==Basic examples==


Adjust port settings specific for your device
Check port usage, only one instance can use serial port simultaneously
<pre>
[admin@MikroTik] /port print
Flags: I - inactive
#  DEVICE NAME                    CHANNELS USED-BY                  BAUD-RATE
0          serial0                        1 Serial Console            auto 
</pre>
In case there is one port and it is used by console, release it from console menu:
<pre>
[admin@MikroTik] > /system console print
Flags: X - disabled, U - used, F - free
#  PORT                                                                      TERM                                                                   
0 U serial0                                                                    vt102
 
[admin@MikroTik] > /system console disable 0 
</pre>
 
Adjust port settings specific for your device (leave "auto" for LtAP mini)
<pre>
<pre>
[admin@MikroTik] /port> set 0 baud-rate=4800 parity=odd
[admin@MikroTik] /port> set 0 baud-rate=4800 parity=odd
[admin@MikroTik] /port> print detail  
[admin@MikroTik] /port> print detail  
Flags: I - inactive  
Flags: I - inactive  
  0  name="usb1" used-by="GPS" channels=1 baud-rate=4800 data-bits=8 parity=odd stop-bits=1 flow-control=none
  0  name="usb1" used-by="" channels=1 baud-rate=4800 data-bits=8 parity=odd stop-bits=1 flow-control=none
</pre>
</pre>


Line 123: Line 212:
             port: usb1
             port: usb1
           channel: 0
           channel: 0
    init-channel: 0
      init-string:
   set-system-time: no
   set-system-time: no


Line 130: Line 221:
<pre>
<pre>
[admin@MikroTik] /system gps> monitor   
[admin@MikroTik] /system gps> monitor   
   date-and-time: sep/05/2011 07:28:54
   date-and-time: jul/02/2015 14:36:08
      latitude: N 56 57' 32.568''
            latitude: N 56 57' 32.262''
      longitude: E 24 9' 11.568''
            longitude: E 24 9' 7.262''
      altitude: -23.600000m
            altitude: 36.700001m
          speed: 0.000000 km/h
                speed: 0.000000 km/h
        bearing: none
  destination-bearing: none
          valid: yes
        true-bearing: 0.000000 deg. True
    satellites: 3
    magnetic-bearing: 0.000000 deg. Mag
                valid: yes
          satellites: 7
</pre>
 
 
Port and GPS settings for '''LtAP'''
<pre>
/port set serial1 baud-rate=115200
</pre>
<pre>
/system gps set port=serial1 channel=0 enabled=yes
</pre>
</pre>


We have also created an in-depth article about live GPS tracking, using scripting and a web server: [[Manual:GPS-tracking]].


{{cont}}
== Troubleshooting ==
 
Note that sometimes in order to make GPS module to be recognized under RouterOS you need to change the baud-rate setting in the '/port' menu.
 
[https://mikrotik.com/product/ltap_mini LtAP mini] has low gain GPS antenna build in, for better experience we suggest using additional [https://mikrotik.com/product/acgpsa external antenna]
 
Switch between internal and external antennas under GPS menu:
<pre>
[admin@MikroTik] > /system gps set gps-antenna-select=external
</pre>


On some modems with GPS support you need to send multiple init commands for the continuous GPS monitoring, for example, for Huawei cards you need to send "AT^WPDST=1,AT^WPDGP" init string to get continuous monitoring.


[[Category:Manual|G]]
[[Category:Manual|G]]
[[Category:System|G]]
[[Category:System|G]]
{{cont}}

Latest revision as of 05:48, 21 August 2019

Version.png

Applies to RouterOS: v3, v4, v5, v6 +


Summary

Package requirement: gps
Sub-menu: /system gps
Standards: GPS, NMEA 0183, Simple Text Output Protocol

Global Positioning System (GPS) is used for determining precise location of a GPS receiver.

Configuration Properties

Property Description
channel (integer [0..4294967295]; Default: 0) Port channel used by device
coordinate-format (dd | dms | ddmm; Default: no) Which coordinate format to use, "Decimal Degrees", "Degrees Minutes Seconds" or "NMEA format DDDMM.MM[MM]"
enabled (yes | no; Default: no) Whether GPS is enabled
gps-antenna-select (external | internal; Default: internal) Depending on model. Can be used to select internal antenna, if device has one.
init-channel (integer [0..4294967295]; Default: ) Channel for init-string execution
init-string (string; Default: ) AT init string for GPS initialization
port (string; Default: ) Name of the USB/Serial port where GPS receiver is connected
set-system-time (yes | no; Default: no) Whether to set router's date and time to one received from GPS.

Monitoring Status

Command: /system gps monitor


This command is used for monitoring the data received from a GPS receiver

Parameters:

Property Description
date-and-time (date) Date and time received from GPS
latitude (none | string) Latitude in DM (Degrees Minute decimal) format
longitude (none | string) Longitude in DM (Degrees Minute decimal) format
altitude (none | string) Altitude based on GPS data
speed (none | string) Current moving speed of the GPS unit
destination-bearing (none | string) The direction toward which a GPS is moving
true-bearing (none | string) The direction toward which a GPS is moving
magnetic-bearing (none | string) The direction toward which a GPS is moving
valid (yes | no)
satellites (integer) Number of satellites seen by the device.
fix-quality (integer) Quality of the signal
satellites (integer) Number of satellites seen by the device.
horizontal-dilution (integer) Horizontal dilution of precision (HDOP);

Note: The time is not stratum 1 as RouterBOARD devices do not have PPS implemented as of RouterOS v6. This might change with new NTP server in v7.

Basic examples

Check port usage, only one instance can use serial port simultaneously

[admin@MikroTik] /port print
Flags: I - inactive 
 #   DEVICE NAME                     CHANNELS USED-BY                   BAUD-RATE
 0          serial0                         1 Serial Console            auto   

In case there is one port and it is used by console, release it from console menu:

[admin@MikroTik] > /system console print 
Flags: X - disabled, U - used, F - free
 #   PORT                                                                       TERM                                                                     
 0 U serial0                                                                    vt102 

[admin@MikroTik] > /system console disable 0  

Adjust port settings specific for your device (leave "auto" for LtAP mini)

[admin@MikroTik] /port> set 0 baud-rate=4800 parity=odd
[admin@MikroTik] /port> print detail 
Flags: I - inactive 
 0   name="usb1" used-by="" channels=1 baud-rate=4800 data-bits=8 parity=odd stop-bits=1 flow-control=none

Enable GPS

[admin@MikroTik] /system gps> set enable=yes port=usb1
[admin@MikroTik] /system gps> print 
          enabled: yes
             port: usb1
          channel: 0
     init-channel: 0
      init-string:
  set-system-time: no

Monitor status

[admin@MikroTik] /system gps> monitor  
  date-and-time: jul/02/2015 14:36:08
             latitude: N 56 57' 32.262''
            longitude: E 24 9' 7.262''
             altitude: 36.700001m
                speed: 0.000000 km/h
  destination-bearing: none
         true-bearing: 0.000000 deg. True
     magnetic-bearing: 0.000000 deg. Mag
                valid: yes
           satellites: 7


Port and GPS settings for LtAP

/port set serial1 baud-rate=115200
/system gps set port=serial1 channel=0 enabled=yes

We have also created an in-depth article about live GPS tracking, using scripting and a web server: Manual:GPS-tracking.

Troubleshooting

Note that sometimes in order to make GPS module to be recognized under RouterOS you need to change the baud-rate setting in the '/port' menu.

LtAP mini has low gain GPS antenna build in, for better experience we suggest using additional external antenna

Switch between internal and external antennas under GPS menu:

[admin@MikroTik] > /system gps set gps-antenna-select=external

On some modems with GPS support you need to send multiple init commands for the continuous GPS monitoring, for example, for Huawei cards you need to send "AT^WPDST=1,AT^WPDGP" init string to get continuous monitoring.

[ Top | Back to Content ]