Template:Networking rut manual gps: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
m (Text replacement - "\{\{Template: Networking_rutos_manual_fw_disclosure (.*) \}\}" to "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }}")
 
(12 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
==Summary==
==Summary==


The <b>Global Positioning System</b> (<b>GPS</b>) is a space-based radionavigation system. This page is an overview of the GPS service in {{{name}}} routers.
The <b>Global Positioning System</b> (<b>GPS</b>) is a space-based radionavigation system. This page is an overview of the GPS service in {{{name}}} routers.
{{Template: Networking_rutxxx_manual_fw_disclosure
| fw_version = {{{fw_version}}}
}}


==Map==
==Map==
Line 13: Line 17:
The figure below is an example of the Map page:
The figure below is an example of the Map page:


[[File:{{{file_map}}}]]
[[File:Networking_rut_manual_gps_map.png]]


==General==
==General==
Line 21: Line 25:
The figure below is an example of the General page and the table below provides information on the fields contained in that page:
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}}}]]
[[File:Networking_rut_manual_gps_general.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 61: Line 65:
The <b>NMEA forwarding</b> 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:
The <b>NMEA forwarding</b> 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}}}]]
[[File:Networking_rut_manual_gps_nmea_nmea_forwarding.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 100: Line 104:
The router <b>caches NMEA forwarding</b> 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:
The router <b>caches NMEA forwarding</b> 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}}}]]
[[File:Networking_rut_manual_gps_nmea_nmea_forwarding_cache.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 129: Line 133:
The <b>NMEA collecting</b> 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:
The <b>NMEA collecting</b> 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}}}]]
[[File:Networking_rut_manual_gps_nmea_nmea_collecting.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 153: Line 157:
The <b>NMEA sentence settings</b> 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:
The <b>NMEA sentence settings</b> 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}}}]]
[[File:Networking_rut_manual_gps_nmea_nmea_sentence_settings.png]]
 
<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
Line 242: Line 247:
The <b>HTTPS/HTTP Server Settings</b> section is used to enable GPS data sending to an HTTP or HTTPS server:
The <b>HTTPS/HTTP Server Settings</b> section is used to enable GPS data sending to an HTTP or HTTPS server:


[[File:{{{file_https_settings}}}]]
[[File:Networking_rut_manual_gps_https_https_server_settings.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 266: Line 271:
The <b>TAVL Settings</b> section is used to select which data will be sent to the TAVL server:
The <b>TAVL Settings</b> section is used to select which data will be sent to the TAVL server:


[[File:{{{file_tavl_settings}}}]]
[[File:Networking_rut_manual_gps_https_tavl_settings.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 304: Line 309:
The <b>AVL Server Settings</b> 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:  
The <b>AVL Server Settings</b> 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}}}]]
[[File:Networking_rut_manual_gps_avl_avl_server_settings.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 316: Line 321:
         <td>yes | no; default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns data sending to AVL server on or off.</td>
         <td>Turns data sending to AVL server on or off.</td>
    </tr>
    <tr>
        <td>Retry on Fail</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Specifies whether to keep attempting a connection in case one fails.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 331: Line 341:
         <td>TCP | UDP; default: <b>TCP</b></td>
         <td>TCP | UDP; default: <b>TCP</b></td>
         <td>Protocol that will be used for communication with the AVL server.</td>
         <td>Protocol that will be used for communication with the AVL server.</td>
    </tr>
    <tr>
        <td>Don't Contain Connection</td>
        <td>yes | no; default: <b>no</b></td>
        <td>When turned on, closes the TCP/UDP socket each time after transferring data.</td>
     </tr>
     </tr>
</table>
</table>
Line 338: Line 353:
The <b>Main rule</b> section defines how and when GPS data will be collected and sent to a specified AVL server. Refer to the figure and table below for information on the configuration fields of Main Rule.
The <b>Main rule</b> section defines how and when GPS data will be collected and sent to a specified AVL server. Refer to the figure and table below for information on the configuration fields of Main Rule.


[[File:{{{file_main_rule}}}]]
[[File:Networking_rut_manual_gps_avl_main_rule.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 396: Line 411:
Refer to the figure and table below for information on the configuration fields of the Secondary rules section.
Refer to the figure and table below for information on the configuration fields of the Secondary rules section.


[[File:{{{file_secondary_rules}}}]]
[[File:Networking_rut_manual_gps_avl_secondary_rules.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 406: Line 421:
     <tr>
     <tr>
         <td>Enable</td>
         <td>Enable</td>
         <td>yes | no; default: '''yes'''</td>
         <td>yes | no; default: <b>yes</b></td>
         <td>Turns the secondary rule on or off.</td>
         <td>Turns the rule on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 448: Line 463:
     <tr>
     <tr>
         <td>Min saved records</td>
         <td>Min saved records</td>
         <td>integer [1..32]; default: <b>20</b></td>
         <td>integer [1..32]; default: <b>10</b></td>
         <td>Minimum amount of gathered records before sending.</td>
         <td>Minimum amount of gathered records before sending.</td>
     </tr>
     </tr>
Line 462: Line 477:
The <b>AVL Configuration</b> section is used to add additional secondary GPS data sending rules.
The <b>AVL Configuration</b> section is used to add additional secondary GPS data sending rules.


[[File:{{{file_gps_configuration}}}]]
[[File:Networking_rut_manual_gps_avl_gps_configuration.png]]


===TAVL Settings===
===TAVL Settings===
Line 468: Line 483:
The <b>TAVL Settings</b> section is used to select which data will be sent to the TAVL server:
The <b>TAVL Settings</b> section is used to select which data will be sent to the TAVL server:


[[File:{{{file_tavl_settings}}}]]
[[File:Networking_rut_manual_gps_avl_tavl_settings.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 511: Line 526:
The <b>Check Analog</b> section is used to set how often the router checks the value of the analog input. This is relevant to input rules related to the analog input.
The <b>Check Analog</b> section is used to set how often the router checks the value of the analog input. This is relevant to input rules related to the analog input.


[[File:{{{file_avl_io_analog}}}]]
[[File:Networking_rut_manual_gps_avl_io_check_analog.png]]


===Input Rules===
===Input Rules===
Line 519: Line 534:
To configure an input rule click the 'Edit' button located next to it. The figure below represents a newly added rule with default settings. Refer to the table below for information on the fields contained in the input rule configuration section.
To configure an input rule click the 'Edit' button located next to it. The figure below represents a newly added rule with default settings. Refer to the table below for information on the fields contained in the input rule configuration section.


[[File:{{{file_avl_io_rules}}}]]
[[File:Networking_rut_manual_gps_avl_io_input_rule_configuration.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 559: Line 574:
A <b>geofence</b> 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.
A <b>geofence</b> 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}}}]]
[[File:Networking_rut_manual_gps_gps_geofencing_add_button.png]]


The figure below is an example of GPS Geofencing configuration and the table below provides information related to that configuration:
The figure below is an example of GPS Geofencing configuration and the table below provides information related to that configuration:


[[File:{{{file_geofencing_details}}}]]
[[File:Networking_rut_manual_gps_gps_geofencing_details.png]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 609: Line 624:
</ul>
</ul>


[[Category:{{{name}}} WebUI]]
[[Category:{{{name}}} Services section]]

Latest revision as of 11:28, 24 October 2023

The information in this page is updated in accordance with firmware version .

Summary

The Global Positioning System (GPS) is a space-based radionavigation system. This page 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:

General

The General section 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:

Field 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:

Field 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
Port integer [0..65535]; default: 8500 Port number off the server to which NMEA data will be forwarded
Protocol TCP | UDP; default: TCP Protocol that will be used to send NMEA data
Contain Connection yes | no; default: no Contain active session with a remote server

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:

Field 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 deleted and 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:

Field 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:

Field Value Description
Forwarding enabled yes | no; default: no Enables forwarding for the adjacent NMEA sentence.
Forwarding interval integer; default: 5 NMEA sentence forwarding frequency in seconds.
Collecting enabled yes | no; default: no Enables collecting for the adjacent NMEA sentence.
Collecting interval integer; default: 5 NMEA sentence collecting frequency in seconds.


NMEA sentence reference 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 satellites 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:

Field Value Description
Enabled yes | no; default: no Turns data sending to an HTTP/HTTPS server 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:

Field Value Description
Send GSM signal yes | no; default: no Includes GSM signal strength information in the GPS data 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 the GPS data 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:

Field Value Description
Enabled yes | no; default: no Turns data sending to AVL server on or off.
Retry on Fail yes | no; default: no Specifies whether to keep attempting a connection in case one fails.
Hostname ip | host; default: 192.168.1.5 IP address or hostname of an AVL server.
Port integer [0..65535]; default: 8501 TCP/UDP port number of the AVL server to which the router will be connecting.
Protocol TCP | UDP; default: TCP Protocol that will be used for communication with the AVL server.
Don't Contain Connection yes | no; default: no When turned on, closes the TCP/UDP socket each time after transferring data.

Main rule

The Main rule section defines how and when GPS data will be collected and sent to a specified AVL server. Refer to the figure and table below for information on the configuration fields of Main Rule.

Field Value Description
Enable yes | no; default: yes Turns the main rule on or off.
Rule priority Low priority level | High priority level | Panic priority level | Security priority level; default: Low priority level The rule's priority. Different priority settings add different flags to event packets, so they can be displayed differently in the receiving system. The router sends data of higher priority first. Priority levels from highest to lowest are as follows:
  1. Security
  2. Panic
  3. High
  4. Low
Collect period integer [1..999999]; default: 50 How often (in seconds) data will be collected.
Min distance integer [1..999999]; default: 50 Minimum distance change (in meters) before sending records.
Min angle integer [1..360]; default: 50 Minimum angle change (in degrees) before sending records.
Min saved records integer [1..32]; default: 20 Minimum amount of gathered records before sending.
Send period integer [0..999999]; default: 20 How often (in seconds) gathered data is sent.

Secondary Rules

The Secondary rules section provides you with the possibility to create additional data sending rules. The difference from the main rule is that the secondary rules only send data when the router uses a specified type of WAN and when the digital isolated output is in the specified state.

Refer to the figure and table below for information on the configuration fields of the Secondary rules section.

Field Value Description
Enable yes | no; default: yes Turns the rule on or off.
WAN Mobile Both | Mobile Home | Mobile Roaming | WiFi | Wired; default: Mobile Home Selects which type of WAN will trigger the rule.
Digital Isolated Input Low logic level | High logic level | Both; default: High logic level Selects which input state will trigger the rule.
Rule priority Low priority level | High priority level | Panic priority level | Security priority level; default: Low priority level The rule's priority. Different priority settings add different flags to event packets, so they can be displayed differently in the receiving system. The router sends data of higher priority first. Priority levels from highest to lowest are as follows:
  1. Security
  2. Panic
  3. High
  4. Low
Collect period integer [1..999999]; default: 10 How often (in seconds) data will be collected.
Min distance integer [1..999999]; default: 25 Minimum distance change (in meters) before sending records.
Min angle integer [1..360]; default: 25 Minimum angle change (in degrees) before sending records.
Min saved records integer [1..32]; default: 10 Minimum amount of gathered records before sending.
Send period integer [0..999999]; default: 10 How often (in seconds) gathered data is sent.

AVL Configuration

The AVL Configuration section is used to add additional secondary GPS data sending rules.

TAVL Settings

The TAVL Settings section is used to select which data will be sent to the TAVL server:

Field Value Description
Send GSM signal yes | no; default: no Includes GSM signal strength information in the GPS data 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 the GPS data 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.
Send digital input (3) yes | no; default: no Includes digital input #3 state in GPS data package to be sent to server.

AVL I/O

The AVL I/O tab provides you with the possibility to configure input rules.

Check Analog

The Check Analog section is used to set how often the router checks the value of the analog input. This is relevant to input rules related to the analog input.

Input Rules

The Input Rules section displays existing input rules. To create a new input rule look to the section below (AVL Input Configuration), select input type, trigger and click the 'Add' button.

To configure an input rule click the 'Edit' button located next to it. The figure below represents a newly added rule with default settings. Refer to the table below for information on the fields contained in the input rule configuration section.

Field Value Description
Enable yes | no; default: no Turns the input rule on or off.
Input type Digital | Digital isolated | analog; default: Digital Selects to which input the rule will apply.
Trigger Input open | Input shorted | Both; default: Input open The event that will trigger the rule.
Priority Low | High | Panic; default: Low The rule's priority. Different priority settings add different flags to event packets, so they can be displayed differently in the receiving system. The router sends data of higher priority first. Priority levels from highest to lowest are as follows:
  1. Panic
  2. High
  3. Low

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.

The figure below is an example of GPS Geofencing configuration and the table below provides information related to that configuration:

Field 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}}} GPS Protocols]]

[[Category:{{{name}}} Services section]]

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rut_manual_gps&oldid=115266"