31,703
edits
Changes
Template:Networking rut manual gps (view source)
Revision as of 14:57, 30 July 2019
, 14:57, 30 July 2019no edit summary
==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.
{{Template: Networking_rutxxx_manual_fw_disclosure
| fw_version = {{{fw_version}}}
}}
==Map==
==Map==
<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>
<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>
<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>
<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>
</table>
</table>
<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>
<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>
<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>
<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>
[[File:{{{file_nmea_sentence}}}]]
[[File:{{{file_nmea_sentence}}}]]
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</table>
</table>
===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:{{{file_main_rule}}}]]
<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. 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.
Refer to the figure and table below for information on the configuration fields of the Secondary rules section.
[[File:{{{file_secondary_rules}}}]]
[[File:{{{file_secondary_rules}}}]]
===GPS Configuration===
<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 secondary 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>Low 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>Selects the rule's priority. 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>25</b></td>
<td>How often (in seconds) data will be collected.</td>
</tr>
<tr>
<td>Min distance</td>
<td>integer [1..999999]; default: <b>200</b></td>
<td>Minimum distance change (in meters) before sending records.</td>
</tr>
<tr>
<td>Min angle</td>
<td>integer [1..360]; default: <b>30</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>50</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:{{{file_gps_configuration}}}]]
<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>
<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>
<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>
