Template:Networking rut manual gps: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
(Created page with "==Summary== The <b>Global Positioning System</b> (<b>GPS</b>) is a space-based radionavigation system. This chapter is an overview of the GPS service in {{{name}}} routers....")
 
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}}} }} }}")
 
(27 intermediate revisions by 4 users 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 chapter 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.


==Map==
==Map==
Line 9: 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==


The <b>General</b> 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 <b>General</b> 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:
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">
     <tr>
     <tr>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 27: Line 35:
     <tr>
     <tr>
         <td>Enabled</td>
         <td>Enabled</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns the GPS service ON or OFF</td>
         <td>Turns the GPS service on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Galileo NMEA support<span class="asterisk">*</span></td>
         <td>Galileo NMEA support<span class="asterisk">*</span></td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns support for Galileo satellites ON or OFF</td>
         <td>Turns support for Galileo satellites on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Glonass NMEA support<span class="asterisk">*</span></td>
         <td>Glonass NMEA support<span class="asterisk">*</span></td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns support for Glonass satellites ON or OFF</td>
         <td>Turns support for Glonass satellites on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>BeiDou NMEA support<span class="asterisk">*</span></td>
         <td>BeiDou NMEA support<span class="asterisk">*</span></td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns support for BeiDou satellites ON or OFF</td>
         <td>Turns support for BeiDou satellites on or off.</td>
     </tr>
     </tr>
</table>
</table>
Line 57: 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">
     <tr>
     <tr>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 67: Line 75:
     <tr>
     <tr>
         <td>Enabled</td>
         <td>Enabled</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns NMEA forwarding ON or OFF</td>
         <td>Turns NMEA forwarding on or off</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Hostname</td>
         <td>Hostname</td>
         <td>ip | host; Default: <b>192.168.1.5</b></td>
         <td>ip | host; default: <b>192.168.1.5</b></td>
         <td>IP address or hostname of the server to which NMEA data will be forwarded to</td>
         <td>IP address or hostname of the server to which NMEA data will be forwarded</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Port</td>
         <td>Port</td>
         <td>integer [0..65535]; Default: <b>8500</b></td>
         <td>integer [0..65535]; default: <b>8500</b></td>
         <td>Port number to which NMEA data will be forwarded to</td>
         <td>Port number off the server to which NMEA data will be forwarded</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Protoocl</td>
         <td>Protocol</td>
         <td>TCP | UDP; Default: <b>TCP</b></td>
         <td>TCP | UDP; default: <b>TCP</b></td>
         <td>Protocol that will be used to send NMEA data</td>
         <td>Protocol that will be used to send NMEA data</td>
    </tr>
    <tr>
        <td>Contain Connection</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Contain active session with a remote server</td>
     </tr>
     </tr>
</table>
</table>
Line 91: 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">
     <tr>
     <tr>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 101: Line 114:
     <tr>
     <tr>
         <td>Type</td>
         <td>Type</td>
         <td>ram | flash; Default: <b>ram</b></td>
         <td>ram | flash; default: <b>ram</b></td>
         <td>Selects which type of memory will be used for storing NMEA forwarding cache</td>
         <td>Selects which type of memory will be used for storing NMEA forwarding cache.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Maximum sentences</td>
         <td>Maximum sentences</td>
         <td>integer; Default: <b>5000</b></td>
         <td>integer; default: <b>5000</b></td>
         <td>Maximum amount of NMEA sentences that will be saved in the cache before older entries are replaced by new ones</td>
         <td>Maximum amount of NMEA sentences that will be saved in the cache before older entries are deleted and replaced by new ones.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>File</td>
         <td>File</td>
         <td>filepath; default: <b>none</b></td>
         <td>filepath; default: <b>none</b></td>
         <td>Location of the file where NMEA forwarding cache information will be stored. This field becomes visible only when the selected memory type is "flash"</td>
         <td>Location of the file where NMEA forwarding cache information will be stored. This field becomes visible only when the selected memory type is "flash".</td>
     </tr>
     </tr>
</table>
</table>
Line 120: 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">
     <tr>
     <tr>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 130: Line 143:
     <tr>
     <tr>
         <td>Enabled</td>
         <td>Enabled</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns NMEA sentence collecting ON or OFF</td>
         <td>Turns NMEA sentence collecting on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Location</td>
         <td>Location</td>
         <td>filepath; Default: <b>none</b></td>
         <td>filepath; default: <b>none</b></td>
         <td>Location of the file where NMEA sentences will be stored. This field becomes visible only when NMEA collecting is enabled</td>
         <td>Location of the file where NMEA sentences will be stored. This field becomes visible only when NMEA collecting is enabled.</td>
     </tr>
     </tr>
</table>
</table>
Line 144: 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>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 154: Line 167:
     <tr>
     <tr>
         <td>Forwarding enabled</td>
         <td>Forwarding enabled</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Enables forwarding for selected NMEA sentence</td>
         <td>Enables forwarding for the adjacent NMEA sentence.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Forwarding interval</td>
         <td>Forwarding interval</td>
         <td>integer; Default: <b>5</b></td>
         <td>integer; default: <b>5</b></td>
         <td>NMEA sentence forwarding frequency in seconds</td>
         <td>NMEA sentence forwarding frequency in seconds.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Collecting enabled</td>
         <td>Collecting enabled</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Enables collecting for selected NMEA sentences</td>
         <td>Enables collecting for the adjacent NMEA sentence.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Collecting interval</td>
         <td>Collecting interval</td>
         <td>integer; Default: <b>5</b></td>
         <td>integer; default: <b>5</b></td>
         <td>NMEA sentence collecting frequency in seconds</td>
         <td>NMEA sentence collecting frequency in seconds.</td>
     </tr>
     </tr>
</table>
</table>
<br>
<br>
<b>NMEA sentence refference table</b>:
<b>NMEA sentence reference table</b>:
<table class="nd-othertables_3">
<table class="nd-othertables_3">
     <tr>
     <tr>
         <th width=250>NMEA sentence name</th>
         <th width="250">NMEA sentence name</th>
         <th width=902>Description</th>
         <th width="902">Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GPGSV</b></td>
         <td><b>GPGSV</b></td>
         <td>Number of GPS satellites in view</td>
         <td>Number of GPS satellites in view.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GPGGA</b></td>
         <td><b>GPGGA</b></td>
         <td>GPS fix data</td>
         <td>GPS fix data.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GPVTG</b></td>
         <td><b>GPVTG</b></td>
         <td>Track made good and speed relative to the ground</td>
         <td>Track made good and speed relative to the ground.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GPRMC</b></td>
         <td><b>GPRMC</b></td>
         <td>Recommended minimum specific GPS/Transit data</td>
         <td>Recommended minimum specific GPS/Transit data.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GPGSA</b></td>
         <td><b>GPGSA</b></td>
         <td>GPS DOP and active satellites</td>
         <td>GPS DOP and active satellites.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GLGSA</b></td>
         <td><b>GLGSA</b></td>
         <td>GLONASS DOP and active satellites</td>
         <td>GLONASS DOP and active satellites.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GLGSV</b></td>
         <td><b>GLGSV</b></td>
         <td>Number of GLONASS satellites in view</td>
         <td>Number of GLONASS satellites in view.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GNGNS</b></td>
         <td><b>GNGNS</b></td>
         <td>GNSS position fix from more than one constellation (e.g., GPS + GLONASS)</td>
         <td>GNSS position fix from more than one constellation (e.g., GPS + GLONASS).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GAGSV</b></td>
         <td><b>GAGSV</b></td>
         <td>Number of Galileo satelites in view</td>
         <td>Number of Galileo satellites in view.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>PQGSV</b></td>
         <td><b>PQGSV</b></td>
         <td>Detailed satellite data (used in BeiDou sentences)</td>
         <td>Detailed satellite data (used in BeiDou sentences).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>PQGSA</b></td>
         <td><b>PQGSA</b></td>
         <td>Overall satellite data (used in BeiDou sentences)</td>
         <td>Overall satellite data (used in BeiDou sentences).</td>
     </tr>
     </tr>
</table>
</table>
Line 234: 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">
     <tr>
     <tr>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 244: Line 257:
     <tr>
     <tr>
         <td>Enabled</td>
         <td>Enabled</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns data sending to HTTP/HTTPS ON or OFF</td>
         <td>Turns data sending to an HTTP/HTTPS server on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>URL</td>
         <td>URL</td>
         <td>ip | host; Default: <b>192.168.1.5</b></td>
         <td>ip | host; default: <b>192.168.1.5</b></td>
         <td>IP address or hostname of the HTTP/HTTPS server</td>
         <td>IP address or hostname of the HTTP/HTTPS server.</td>
     </tr>
     </tr>
</table>
</table>
Line 258: 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">
     <tr>
     <tr>
         <th>field name</th>
         <th>Field</th>
       <th>value</th>
       <th>Value</th>
       <th>description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Send GSM signal</td>
       <td>Send GSM signal</td>
       <td>yes | no; Default: <b>no</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Includes GSM signal strength information in GPS data package to be sent to server</td>
       <td>Includes GSM signal strength information in the GPS data sent to server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Send analog input</td>
       <td>Send analog input</td>
       <td>yes | no; Default: <b>no</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Includes analog input state in GPS data package to be sent to server</td>
       <td>Includes analog input state in GPS data package to be sent to server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Send digital input (1)</td>
     <td>Send digital input (1)</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Includes digital input #1 state in GPS data package to be sent to server</td>
         <td>Includes digital input #1 state in the GPS data sent to server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Send digital input (2)</td>
     <td>Send digital input (2)</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Includes digital input #2 state in GPS data package to be sent to server</td>
         <td>Includes digital input #2 state in GPS data package to be sent to server.</td>
     </tr>
     </tr>
</table>
</table>
Line 296: 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">
     <tr>
     <tr>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 306: Line 319:
     <tr>
     <tr>
         <td>Enabled</td>
         <td>Enabled</td>
         <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>
         <td>Hostname</td>
         <td>Hostname</td>
         <td>ip | host; Default: <b>192.168.1.5</b></td>
         <td>ip | host; default: <b>192.168.1.5</b></td>
         <td>IP address or hostname of the AVL server</td>
         <td>IP address or hostname of an AVL server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Port</td>
         <td>Port</td>
         <td>integer [0..65535]; Default: <b>8500</b></td>
         <td>integer [0..65535]; default: <b>8501</b></td>
         <td>Port number of the AVL server to which router will be connecting to</td>
         <td>TCP/UDP port number of the AVL server to which the router will be connecting.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Protoocl</td>
         <td>Protocol</td>
         <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 328: Line 351:
===Main rule===
===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">
    <tr>
        <th>Field</th>
        <th>Value</th>
        <th>Description</th>
    </tr>
    <tr>
        <td>Enable</td>
        <td>yes | no; default: <b>yes</b></td>
        <td>Turns the main rule on or off.</td>
    </tr>
    <tr>
        <td>Rule priority</td>
        <td>Low priority level | High priority level | Panic priority level | Security priority level; default: <b>Low priority level</b></td>
        <td>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:
            <ol>
                <li>Security</li>
                <li>Panic</li>
                <li>High</li>
                <li>Low</li>
            </ol>
        </td>
    </tr>
    <tr>
        <td>Collect period</td>
        <td>integer [1..999999]; default: <b>50</b></td>
        <td>How often (in seconds) data will be collected.</td>
    </tr>
    <tr>
        <td>Min distance</td>
        <td>integer [1..999999]; default: <b>50</b></td>
        <td>Minimum distance change (in meters) before sending records.</td>
    </tr>
    <tr>
        <td>Min angle</td>
        <td>integer [1..360]; default: <b>50</b></td>
        <td>Minimum angle change (in degrees) before sending records.</td>
    </tr>
    <tr>
        <td>Min saved records</td>
        <td>integer [1..32]; default: <b>20</b></td>
        <td>Minimum amount of gathered records before sending.</td>
    </tr>
    <tr>
        <td>Send period</td>
        <td>integer [0..999999]; default: <b>20</b></td>
        <td>How often (in seconds) gathered data is sent.</td>
    </tr>
</table>


===Secondary Rules===
===Secondary Rules===
----
----
The <b>Secondary rules</b> 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.


[[File:{{{file_secondary_rules}}}]]
Refer to the figure and table below for information on the configuration fields of the Secondary rules section.


===GPS Configuration===
[[File:Networking_rut_manual_gps_avl_secondary_rules.png]]
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
        <th>Value</th>
        <th>Description</th>
    </tr>
    <tr>
        <td>Enable</td>
        <td>yes | no; default: <b>yes</b></td>
        <td>Turns the rule on or off.</td>
    </tr>
    <tr>
        <td>WAN</td>
        <td>Mobile Both | Mobile Home | Mobile Roaming | WiFi | Wired; default: <b>Mobile Home</b></td>
        <td>Selects which type of WAN will trigger the rule.</td>
    </tr>
    <tr>
        <td>Digital Isolated Input</td>
        <td>Low logic level | High logic level | Both; default: <b>High logic level</b></td>
        <td>Selects which input state will trigger the rule.</td>
    </tr>
    <tr>
        <td>Rule priority</td>
        <td>Low priority level | High priority level | Panic priority level | Security priority level; default: <b>Low priority level</b></td>
        <td>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:
            <ol>
                <li>Security</li>
                <li>Panic</li>
                <li>High</li>
                <li>Low</li>
            </ol>
        </td>
    </tr>
    <tr>
        <td>Collect period</td>
        <td>integer [1..999999]; default: <b>10</b></td>
        <td>How often (in seconds) data will be collected.</td>
    </tr>
    <tr>
        <td>Min distance</td>
        <td>integer [1..999999]; default: <b>25</b></td>
        <td>Minimum distance change (in meters) before sending records.</td>
    </tr>
    <tr>
        <td>Min angle</td>
        <td>integer [1..360]; default: <b>25</b></td>
        <td>Minimum angle change (in degrees) before sending records.</td>
    </tr>
    <tr>
        <td>Min saved records</td>
        <td>integer [1..32]; default: <b>10</b></td>
        <td>Minimum amount of gathered records before sending.</td>
    </tr>
    <tr>
        <td>Send period</td>
        <td>integer [0..999999]; default: <b>10</b></td>
        <td>How often (in seconds) gathered data is sent.</td>
    </tr>
</table>
 
===AVL Configuration===
----
----
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 345: 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">
     <tr>
     <tr>
         <th>field name</th>
         <th>Field</th>
       <th>value</th>
       <th>Value</th>
       <th>description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Send GSM signal</td>
       <td>Send GSM signal</td>
       <td>yes | no; Default: <b>no</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Includes GSM signal strength information in GPS data package to be sent to server</td>
       <td>Includes GSM signal strength information in the GPS data sent to server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Send analog input</td>
       <td>Send analog input</td>
       <td>yes | no; Default: <b>no</b></td>
       <td>yes | no; default: <b>no</b></td>
       <td>Includes analog input state in GPS data package to be sent to server</td>
       <td>Includes analog input state in GPS data package to be sent to server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Send digital input (1)</td>
     <td>Send digital input (1)</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Includes digital input #1 state in GPS data package to be sent to server</td>
         <td>Includes digital input #1 state in the GPS data sent to server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Send digital input (2)</td>
     <td>Send digital input (2)</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Includes digital input #2 state in GPS data package to be sent to server</td>
         <td>Includes digital input #2 state in GPS data package to be sent to server.</td>
    </tr>
    <tr>
    <td>Send digital input (3)</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Includes digital input #3 state in GPS data package to be sent to server.</td>
    </tr>
</table>
 
==AVL I/O==
 
The <b>AVL I/O</b> tab provides you with the possibility to configure input rules.
 
===Check Analog===
----
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:Networking_rut_manual_gps_avl_io_check_analog.png]]
 
===Input Rules===
----
The <b>Input Rules</b> section displays existing input rules. To create a new input rule look to the section below (<i>AVL Input Configuration</i>), 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.
 
[[File:Networking_rut_manual_gps_avl_io_input_rule_configuration.png]]
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
        <th>Value</th>
        <th>Description</th>
    </tr>
    <tr>
        <td>Enable</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Turns the input rule on or off.</td>
    </tr>
    <tr>
        <td>Input type</td>
        <td>Digital | Digital isolated | analog; default: <b>Digital</b></td>
        <td>Selects to which input the rule will apply.</td>
    </tr>
    <tr>
        <td>Trigger</td>
        <td>Input open | Input shorted | Both; default: <b>Input open</b></td>
        <td>The event that will trigger the rule.</td>
    </tr>
    <tr>
        <td>Priority</td>
        <td>Low | High | Panic; default: <b>Low</b></td>
        <td>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:
            <ol>
                <li>Panic</li>
                <li>High</li>
                <li>Low</li>
            </ol>
        </td>
     </tr>
     </tr>
</table>
</table>
Line 379: 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">
     <tr>
     <tr>
         <th>Field name</th>
         <th>Field</th>
         <th>Value</th>
         <th>Value</th>
         <th>Description</th>
         <th>Description</th>
Line 393: Line 588:
     <tr>
     <tr>
         <td>Enable</td>
         <td>Enable</td>
         <td>yes | no; Default: <b>no</b></td>
         <td>yes | no; default: <b>no</b></td>
         <td>Turns the Geofence rule ON or OFF</td>
         <td>Turns the Geofence rule on or off</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Longitude (X)</td>
         <td>Longitude (X)</td>
         <td>degrees [-180.000000..180.000000]; Default: <b>0.000000</b></td>
         <td>degrees [-180.000000..180.000000]; default: <b>0.000000</b></td>
         <td>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</td>
         <td>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.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Latitude (Y)</td>
         <td>Latitude (Y)</td>
         <td>degrees [-90.000000..90.000000]; Default: <b>0.000000</b></td>
         <td>degrees [-90.000000..90.000000]; default: <b>0.000000</b></td>
         <td>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</td>
         <td>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.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Radius</td>
         <td>Radius</td>
         <td>integer [1..999999]; Default: <b>200</b></td>
         <td>integer [1..999999]; default: <b>200</b></td>
         <td>Radius (in meters) of the geofence area</td>
         <td>Radius (in meters) of the geofence area.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Generate event on</td>
         <td>Generate event on</td>
         <td>Exit | Enter | Enter/Exit; Default: <b>Exit</b></td>
         <td>Exit | Enter | Enter/exit; default: <b>Exit</b></td>
         <td>Specifies whether the rule should be triggered when the device enters the geofence area, leaves it or on both events</td>
         <td>Specifies whether the rule should be triggered when the device enters the geofence area, leaves it or on both events.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Get current coordinates</td>
         <td>Get current coordinates</td>
         <td>- (interactive button)</td>
         <td>- (interactive button)</td>
         <td>Obtains the device's current coordinates and places them in the Longitude and Latitude fields</td>
         <td>Obtains the device's current coordinates and places them in the Longitude and Latitude fields.</td>
     </tr>
     </tr>
</table>
</table>
Line 426: Line 621:


<ul>
<ul>
     <li>[[{{{name}}}_Protocols|{{{name}}} GPS protocols]]</li>
     <li>[[{{{name}}} GPS Protocols]]</li>
</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"