Difference between revisions of "Template:Networking rutos manual gps"

 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
<!-- Template uses {{{name}}}, {{{series}}}  -->
 
<!-- Template uses {{{name}}}, {{{series}}}  -->
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05
+
| fw_version = {{{series}}}_R_00.07.01
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
 
+
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} GPS (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT9XX_R_00.06.08.3 and earlier) user manual page.</i>|}}
 
==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}}} devices.
 
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}}} devices.
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
| series = {{{series}}}
 
}}
 
 
==Map==
 
 
The <b>Map</b> 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 device and enable GPS in the [[#General|General]] page.
 
 
The figure below is an example of the Map page:
 
 
[[File:Networking_rutos_manual_gps_map.png|border|class=tlt-border]]
 
  
 
==General==
 
==General==
Line 58: Line 46:
  
 
<span class="asterisk">*</span>Changing these options requires a modem reboot. Therefore, if you make changes to these options and save them, the device will lose cellular connectivity for about 30 seconds.
 
<span class="asterisk">*</span>Changing these options requires a modem reboot. Therefore, if you make changes to these options and save them, the device will lose cellular connectivity for about 30 seconds.
 +
 +
==Map==
 +
 +
The <b>Map</b> 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 device and enable GPS in the [[#General|General]] page.
 +
 +
The figure below is an example of the Map page:
 +
 +
[[File:Networking_rutos_manual_gps_map.png|border|class=tlt-border]]
  
 
==NMEA==
 
==NMEA==
Line 67: Line 63:
 
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:Networking_rutos_manual_gps_nmea_nmea_forwarding.png]]
+
[[File:Networking_rutos_manual_gps_nmea_nmea_forwarding.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 82: Line 78:
 
     <tr>
 
     <tr>
 
         <td>Hostname</td>
 
         <td>Hostname</td>
         <td>ip | host; default: '''192.168.1.5'''</td>
+
         <td>ip | host; default: '''none'''</td>
 
         <td>IP address or hostname of the server to which NMEA data will be forwarded.</td>
 
         <td>IP address or hostname of the server to which NMEA data will be forwarded.</td>
 
     </tr>
 
     </tr>
Line 144: Line 140:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Location</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 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>
Line 255: Line 251:
 
     <tr>
 
     <tr>
 
         <td>Enabled</td>
 
         <td>Enabled</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off | <span style="color: #20C0D7;"><b>on</b></span> default: <b>off</b></td>
 
         <td>Turns data sending to HTTP/HTTPS server on or off.</td>
 
         <td>Turns data sending to HTTP/HTTPS server on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>URL</td>
+
         <td><span style="color: #20C0D7;">URL</span></td>
         <td>string; default: '''192.168.1.5'''</td>
+
         <td>url string; default: <b>192.168.1.5</b></td>
         <td>URL of remote server.</td>
+
         <td>URL of remote server.<br><i>This field becomes visible when Enabled is set to 'on'.</i></td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: #20C0D7;">Delay</span></td>
 +
        <td>integer; default: <b>5</b></td>
 +
        <td>Time interval in seconds between sending packages.<br><i>This field becomes visible when Enabled is set to 'on'.</i></td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 268: Line 269:
 
----
 
----
 
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:
 
+
{{#ifeq: {{{name}}} | RUT955 | [[File:Networking_rut955_manual_gps_https_tavl_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_https_tavl_settings.png|border|class=tlt-border]]
+
| [[File:Networking_rutos_manual_gps_https_tavl_settings.png|border|class=tlt-border]]
 +
}}
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 278: Line 280:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Send GSM signal</td>
+
       <td>Signal</td>
 
       <td>off | on; default: <b>off</b></td>
 
       <td>off | on; default: <b>off</b></td>
 
       <td>Includes GSM signal strength information in the GPS data sent to server.</td>
 
       <td>Includes GSM signal strength information in the GPS data sent to server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
     <td>Send digital input</td>
+
     <td>Input/Output (<i>various</i>)</td>
 
         <td>off | on; default: <b>off</b></td>
 
         <td>off | on; default: <b>off</b></td>
         <td>Includes digital input state in the GPS data sent to server.</td>
+
         <td>Includes Input/Output status information in the GPS data sent to server.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 309: Line 311:
 
         <td>off | on; default: <b>off</b></td>
 
         <td>off | on; default: <b>off</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>off | on; default: <b>off</b></td>
 +
        <td>Turn retries in case of a failed attempts on or off. When turned on, the device will try to send the same data to the server until the transmission is successful.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Hostname</td>
 
         <td>Hostname</td>
         <td>ip | host; default: '''192.168.1.5'''</td>
+
         <td>ip | host; default: <b>192.168.0.1</b></td>
 
         <td>IP address or hostname of an AVL server.</td>
 
         <td>IP address or hostname of an AVL server.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Protocol</td>
 +
        <td>TCP | UDP; Default: <b>TCP</b></td>
 +
        <td>Protocol that will be used for communication with the AVL server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 321: Line 333:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Protocol</td>
+
         <td>Don't Contain Connection</td>
         <td>TCP | UDP; Default: <b>TCP</b></td>
+
         <td>off | on; default: <b>off</b></td>
         <td>Protocol that will be used for communication with the AVL server.</td>
+
         <td>When turned on, handles each AVL packet iteration as a new connection. When turned off, connects once and uses the same socket for future communication.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 389: Line 401:
 
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:Networking_rutos_manual_gps_avl_secondary_rules.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_gps_avl_secondary_rules_{{{series}}}_v1.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 408: Line 420:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Digital Isolated Input</td>
+
         <td>Ignore</td>
         <td>Low logic level | High logic level | Both; default: <b>Low logic level</b></td>
+
        <td>off | on; default: <b>off</b></td>
 +
        <td>If enabled, the rule ignores state of input.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>IO level</td>
 +
         <td>Low level {{!}} High level {{!}} Both; default: <b>High level</b></td>
 
         <td>Selects which input state will trigger the rule.</td>
 
         <td>Selects which input state will trigger the rule.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>IO type</td>
 +
        <td>GPIO; default: <b>GPIO</b></td>
 +
        <td>Selects input type.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>IO name</td>{{#switch:{{{series}}}
 +
| RUT9 =<td>Input (3) {{!}} Input (1) {{!}} Isolated Input (2,7); default: <b>Input (1)</b></td>
 +
| RUTX =<td>Input (4); default: <b>Input (3)</b></td>
 +
| TRB2 =<td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>}}
 +
        <td>Selects which specific input will trigger the rule.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 523: Line 552:
 
     <tr>
 
     <tr>
 
         <td>Trigger</td>
 
         <td>Trigger</td>
         <td>{{#ifeq:{{{analog}}}|1|<span style="color: blue;">Configurable I/O:</span>||}}Input active | Input low | Both{{#ifeq:{{{analog}}}|1|<br><span style="color: red;">Analog Input:</span> Inside range {{!}} Outside range||}}; default: <b>Input open</b></td>|
+
         <td>{{#ifeq:{{{analog}}}|1|<span style="color: blue;">Configurable I/O:</span>|}} Input active | Input low | Both{{#ifeq:{{{analog}}}|1|<br><span style="color: red;">Analog Input:</span> Inside range {{!}} Outside range|}}; default: <b>Input active</b></td>
 
         <td>The event that will trigger the rule.</td>
 
         <td>The event that will trigger the rule.</td>
 
     </tr>
 
     </tr>

Latest revision as of 10:16, 15 October 2021

The information in this page is updated in accordance with firmware version [[Media:{{{series}}}_R_00.07.01_WEBUI.bin|{{{series}}}_R_00.07.01]].

SummaryEdit

The Global Positioning System (GPS) is a space-based radionavigation system. This page is an overview of the GPS service in {{{name}}} devices.

GeneralEdit

The General is used to enable the GPS service and the support for different types satellites. Once you turn on GPS, you can check the [[{{{name}}}_GPS#Map|Map]] page in order to see if the device has obtained a GPS fix. It is very important to attach the GPS antenna on the device and place it outside (not inside of a building). The device 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:

Networking rutos manual gps general.png

Field Value Description
Enabled off | on; default: off Turns the GPS service on or off.
Galileo NMEA support* off | on; default: off Turns support for Galileo satellites on or off.
Glonass NMEA support* off | on; default: off Turns support for Glonass satellites on or off.
BeiDou NMEA support* off | on; default: off 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 device will lose cellular connectivity for about 30 seconds.

MapEdit

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 device and enable GPS in the General page.

The figure below is an example of the Map page:

Networking rutos manual gps map.png

NMEAEdit

The NMEA page is used to configure settings related to NMEA sentence collecting and forwarding.

NMEA forwardingEdit


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:

Networking rutos manual gps nmea nmea forwarding.png

Field Value Description
Enabled off | on; default: off Turns NMEA forwarding on or off.
Hostname ip | host; default: none 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.

NMEA forwarding cacheEdit


The device 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:

Networking rutos manual gps nmea nmea forwarding cache.png

Field Value Description
Save cache in RAM Memory | FLASH Memory; default: RAM Memory 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 collectingEdit


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:

Networking rutos manual gps nmea nmea collecting.png

Field Value Description
Enabled off | on; default: off Turns NMEA sentence collecting on or off.
File 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 settingsEdit


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:

Networking rutos manual gps nmea nmea sentence settings.png

Field Value Description
Forwarding enabled off | on; default: off Enables forwarding for the adjacent NMEA sentence.
Forwarding interval positive integer; default: 5 NMEA sentence forwarding frequency in seconds.
Collecting enabled off | on; default: off Enables collecting for the adjacent NMEA sentence.
Collecting interval positive 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.
GNGSA 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).

HTTPSEdit

The HTTPS page can be used to configure data sending to an HTTP(S) server.

HTTPS/HTTP server settingsEdit


The HTTPS/HTTP Server Settings section is used to enable GPS data sending to an HTTP or HTTPS server.

Networking rutos manual gps https server settings.png

Field Value Description
Enabled off | on default: off Turns data sending to HTTP/HTTPS server on or off.
URL url string; default: 192.168.1.5 URL of remote server.
This field becomes visible when Enabled is set to 'on'.
Delay integer; default: 5 Time interval in seconds between sending packages.
This field becomes visible when Enabled is set to 'on'.

TAVL settingsEdit


The TAVL settings section is used to select which data will be sent to the TAVL server: Networking rutos manual gps https tavl settings.png

Field Value Description
Signal off | on; default: off Includes GSM signal strength information in the GPS data sent to server.
Input/Output (various) off | on; default: off Includes Input/Output status information in the GPS data sent to server.

AVLEdit

The AVL page is used to set up GPS data sending to an AVL server.

AVL server settingsEdit


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:

Networking rutos manual gps avl avl server settings.png

Field Value Description
Enabled off | on; default: off Turns data sending to AVL server on or off.
Retry on Fail off | on; default: off Turn retries in case of a failed attempts on or off. When turned on, the device will try to send the same data to the server until the transmission is successful.
Hostname ip | host; default: 192.168.0.1 IP address or hostname of an AVL server.
Protocol TCP | UDP; Default: TCP Protocol that will be used for communication with the AVL server.
Port integer [0..65535]; default: 8501 TCP/UDP port number of the AVL server to which the device will be connecting.
Don't Contain Connection off | on; default: off When turned on, handles each AVL packet iteration as a new connection. When turned off, connects once and uses the same socket for future communication.

Main ruleEdit


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.

Networking rutos manual gps avl main rule.png

Field Value Description
Enable off | on; default: on 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 device 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: 5 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: 60 How often (in seconds) gathered data is sent.

Secondary rulesEdit


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 device 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:Networking_rutos_manual_gps_avl_secondary_rules_{{{series}}}_v1.png|border|class=tlt-border]]

Field Value Description
Enable off | on; default: off Turns the secondary rule on or off.
WAN Mobile Both | Mobile Home | Mobile Roaming | Wired; default: Mobile Home Selects which type of WAN will trigger the rule.
Ignore off | on; default: off If enabled, the rule ignores state of input.
IO level Low level | High level | Both; default: High level Selects which input state will trigger the rule.
IO type GPIO; default: GPIO Selects input type.
IO name Selects which specific input will trigger the rule.
Rule priority Low priority level | High priority level | Panic priority level | Security priority level; default: High 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 device 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.

TAVL settingsEdit


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

Networking rutos manual gps https tavl settings.png

Field Value Description
Send GSM signal off | on; default: off Includes GSM signal strength information in the GPS data sent to server.
Send digital input off | on; default: off Includes digital input state in the GPS data sent to server.

AVL I/OEdit

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

Input RulesEdit


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.

[[File:Networking_rutos_manual_gps_avl_io_input_rules_add_button_config_io_{{{config_io}}}.png|border|class=tlt-border]]

After this you should be redirected to configuration page of the newly added rule, which should look similar to this:

[[File:Networking_rutos_manual_gps_avl_io_input_rules_avl_input_rule_data_configuration_config_io_{{{config_io}}}.png|border|class=tlt-border]]

Field Value Description
Enable off | on; default: on Turns the input rule on or off.
Input type {{{input_types}}}; default: Input (3) Selects to which input the rule will apply.
Trigger Input active | Input low | Both; default: Input active The event that will trigger the rule.
Priority Low | High; 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 device sends data of higher priority first. Priority levels from highest to lowest are as follows:
  1. High
  2. Low

GPS GeofencingEdit

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.

To create a new geofence area, enter a custom name for it and click the 'Add' button. A new geofence area configuration with the given name should appear in the "Geofencing" list. Click the button that looks like a pencil next to it to begin editing.

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

Networking rutos manual gps gps geofencing geofencing details.png

Field Value Description
Enable off | on; default: off 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.

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