Template:Networking rut manual gps
Summary
The Global Positioning System (GPS) is a space-based radionavigation system. This chapter is an overview of the GPS service in {{{name}}} routers.
Map
The Map page displays the device's current coordinates and position on the map. To see the device's location on the map, make sure to attach the GPS antenna on the router and enable GPS in the [[{{{name}}}_GPS#General|General]] page.
The figure below is an example of the Map page:
[[File:{{{file_map}}}]]
General
The General is used to enable the GPS service and the support for different types satellites. Once you turn on GPS, you can check the [[{{{name}}}_GPS#Map|Map]] page in order to see if the router has obtained a GPS fix. It is very important to attach the GPS antenna on the router and place it outside (not inside of a building). The router will not be likely to obtain a GPS fix otherwise.
The figure below is an example of the General page and the table below provides information on the fields contained in that page:
[[File:{{{file_general}}}]]
| Field name | Value | Description |
|---|---|---|
| Enabled | yes | no; Default: no | Turns the GPS service ON or OFF |
| Galileo NMEA support* | yes | no; Default: no | Turns support for Galileo satellites ON or OFF |
| Glonass NMEA support* | yes | no; Default: no | Turns support for Glonass satellites ON or OFF |
| BeiDou NMEA support* | yes | no; Default: no | Turns support for BeiDou satellites ON or OFF |
*Changing these options requires a modem reboot. Therefore, if you make changes to these options and save them, the router will lose cellular connectivity for about 30 seconds.
NMEA
The NMEA page is used to configure settings related to NMEA sentence collecting and forwarding.
NMEA forwarding
The NMEA forwarding section is used to configure and enable NMEA forwarding. The figure below is an example of the NMEA forwarding section and the table below provides information on the fields contained in that section:
[[File:{{{file_nmea_forwarding}}}]]
| Field name | Value | Description |
|---|---|---|
| Enabled | yes | no; Default: no | Turns NMEA forwarding ON or OFF |
| Hostname | ip | host; Default: 192.168.1.5 | IP address or hostname of the server to which NMEA data will be forwarded to |
| Port | integer [0..65535]; Default: 8500 | Port number to which NMEA data will be forwarded to |
| Protoocl | TCP | UDP; Default: TCP | Protocol that will be used to send NMEA data |
NMEA forwarding cache
The router caches NMEA forwarding information if NMEA forwarding is enabled. This section is used to select the memory type where the cache will be stored and the maximum amount of data that will be saved:
[[File:{{{file_nmea_cache}}}]]
| Field name | Value | Description |
|---|---|---|
| Type | ram | flash; Default: ram | Selects which type of memory will be used for storing NMEA forwarding cache |
| Maximum sentences | integer; Default: 5000 | Maximum amount of NMEA sentences that will be saved in the cache before older entries are replaced by new ones |
| File | filepath; default: none | Location of the file where NMEA forwarding cache information will be stored. This field becomes visible only when the selected memory type is "flash" |
NMEA collecting
The NMEA collecting section is used to enable NMEA sentence gathering and storing. The figure below is an example of the NMEA collecting section and the table below provides information on the fields contained in that section:
[[File:{{{file_nmea_collecting}}}]]
| Field name | Value | Description |
|---|---|---|
| Enabled | yes | no; Default: no | Turns NMEA sentence collecting ON or OFF |
| Location | filepath; Default: none | Location of the file where NMEA sentences will be stored. This field becomes visible only when NMEA collecting is enabled |
NMEA sentence settings
The NMEA sentence settings section provides the possibility to configure which NMEA sentences will be forwarded or collected and at what frequency. The figure below is an example of the NMEA sentence settings section and the table below provides information on the fields contained in that section:
[[File:{{{file_nmea_sentence}}}]]
| Field name | Value | Description |
|---|---|---|
| Forwarding enabled | yes | no; Default: no | Enables forwarding for selected NMEA sentence |
| Forwarding interval | integer; Default: 5 | NMEA sentence forwarding frequency in seconds |
| Collecting enabled | yes | no; Default: no | Enables collecting for selected NMEA sentences |
| Collecting interval | integer; Default: 5 | NMEA sentence collecting frequency in seconds |
NMEA sentence refference table:
| NMEA sentence name | Description |
|---|---|
| GPGSV | Number of GPS satellites in view |
| GPGGA | GPS fix data |
| GPVTG | Track made good and speed relative to the ground |
| GPRMC | Recommended minimum specific GPS/Transit data |
| GPGSA | GPS DOP and active satellites |
| GLGSA | GLONASS DOP and active satellites |
| GLGSV | Number of GLONASS satellites in view |
| GNGNS | GNSS position fix from more than one constellation (e.g., GPS + GLONASS) |
| GAGSV | Number of Galileo satelites in view |
| PQGSV | Detailed satellite data (used in BeiDou sentences) |
| PQGSA | Overall satellite data (used in BeiDou sentences) |
HTTPS
The HTTPS page can be used to configure data sending to an HTTP(S) server.
HTTPS/HTTP Server Settings
The HTTPS/HTTP Server Settings section is used to enable GPS data sending to an HTTP or HTTPS server:
[[File:{{{file_https_settings}}}]]
| Field name | Value | Description |
|---|---|---|
| Enabled | yes | no; Default: no | Turns data sending to HTTP/HTTPS ON or OFF |
| URL | ip | host; Default: 192.168.1.5 | IP address or hostname of the HTTP/HTTPS server |
TAVL Settings
The TAVL Settings section is used to select which data will be sent to the TAVL server:
[[File:{{{file_tavl_settings}}}]]
| field name | value | description |
|---|---|---|
| Send GSM signal | yes | no; Default: no | Includes GSM signal strength information in GPS data package to be sent to server |
| Send analog input | yes | no; Default: no | Includes analog input state in GPS data package to be sent to server |
| Send digital input (1) | yes | no; Default: no | Includes digital input #1 state in GPS data package to be sent to server |
| Send digital input (2) | yes | no; Default: no | Includes digital input #2 state in GPS data package to be sent to server |
AVL
The AVL page is used to set up GPS data sending to an AVL server.
AVL Server Settings
The AVL Server Settings section is used to configure the main parameters of data sending to an AVL server. The figure below is an example of the AVL Server Settings section and the table below provides information on the fields contained in that section:
[[File:{{{file_avl_settings}}}]]
| Field name | Value | Description |
|---|---|---|
| Enabled | yes | no; Default: no | Turns data sending to AVL server ON or OFF |
| Hostname | ip | host; Default: 192.168.1.5 | IP address or hostname of the AVL server |
| Port | integer [0..65535]; Default: 8500 | Port number of the AVL server to which router will be connecting to |
| Protoocl | TCP | UDP; Default: TCP | Protocol that will be used for communication with the AVL server |
Main rule
[[File:{{{file_main_rule}}}]]
Secondary Rules
[[File:{{{file_secondary_rules}}}]]
GPS Configuration
[[File:{{{file_gps_configuration}}}]]
TAVL Settings
The TAVL Settings section is used to select which data will be sent to the TAVL server:
[[File:{{{file_tavl_settings}}}]]
| field name | value | description |
|---|---|---|
| Send GSM signal | yes | no; Default: no | Includes GSM signal strength information in GPS data package to be sent to server |
| Send analog input | yes | no; Default: no | Includes analog input state in GPS data package to be sent to server |
| Send digital input (1) | yes | no; Default: no | Includes digital input #1 state in GPS data package to be sent to server |
| Send digital input (2) | yes | no; Default: no | Includes digital input #2 state in GPS data package to be sent to server |
GPS Geofencing
A geofence is a virtually defined boundary for a real-world geographic area. The GPS Geofencing page provides you with the possibility to set this custom area and apply rules that will inform you when the device leaves or enters the geofence.
[[File:{{{file_geofencing_add}}}]]
The figure below is an example of GPS Geofencing configuration and the table below provides information related to that configuration:
[[File:{{{file_geofencing_details}}}]]
| Field name | Value | Description |
|---|---|---|
| Enable | yes | no; Default: no | Turns the Geofence rule ON or OFF |
| Longitude (X) | degrees [-180.000000..180.000000]; Default: 0.000000 | East-west position of a point on the Earth's surface. Combining this and the Latitude information will produce a point on the world map that will serve as the center of the geofence area |
| Latitude (Y) | degrees [-90.000000..90.000000]; Default: 0.000000 | North-south position of a point on the Earth's surface. Combining this and the Longitude information will produce a point on the world map that will serve as the center of the geofence area |
| Radius | integer [1..999999]; Default: 200 | Radius (in meters) of the geofence area |
| Generate event on | Exit | Enter | Enter/Exit; Default: Exit | Specifies whether the rule should be triggered when the device enters the geofence area, leaves it or on both events |
| Get current coordinates | - (interactive button) | Obtains the device's current coordinates and places them in the Longitude and Latitude fields |
See also
- [[{{{name}}}_Protocols|{{{name}}} GPS protocols]]
[[Category:{{{name}}} WebUI]]