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

From Teltonika Networks Wiki
 
(10 intermediate revisions by 3 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.03.1
+
| fw_version = {{{series}}}_R_00.02.06.1
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
Line 19: Line 19:
 
The figure below is an example of the Map page:
 
The figure below is an example of the Map page:
  
[[File:Networking_rutx_manual_gps_map_v1.png]]
+
[[File:Networking_rutos_manual_gps_map.png|border|class=tlt-border]]
  
 
==General==
 
==General==
Line 27: Line 27:
 
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:Networking_rutx_manual_gps_general_v2.png]]
+
[[File:Networking_rutos_manual_gps_general.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 67: Line 67:
 
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_rutx_manual_gps_nmea_nmea_forwarding_v2.png]]
+
[[File:Networking_rutos_manual_gps_nmea_nmea_forwarding.png]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 101: Line 101:
 
The device <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 device <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:Networking_rutx_manual_gps_nmea_nmea_forwarding_cache_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_gps_nmea_nmea_forwarding_cache.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 130: Line 130:
 
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:Networking_rutx_manual_gps_nmea_nmea_collecting_v1.png]]
+
[[File:Networking_rutos_manual_gps_nmea_nmea_collecting.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 154: Line 154:
 
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:Networking_rutx_manual_gps_nmea_nmea_sentence_settings_v2.png]]
+
[[File:Networking_rutos_manual_gps_nmea_nmea_sentence_settings.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 245: Line 245:
 
The HTTPS/HTTP Server Settings section is used to enable GPS data sending to an HTTP or HTTPS server.
 
The HTTPS/HTTP Server Settings section is used to enable GPS data sending to an HTTP or HTTPS server.
  
[[File:Networking_rutx_manual_gps_https_server_settings_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_gps_https_server_settings.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 260: Line 260:
 
     <tr>
 
     <tr>
 
         <td>URL</td>
 
         <td>URL</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.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Delay</td>
 +
        <td>integer; default: <b>5</b></td>
 +
        <td>Time interval in seconds between sending packages.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 269: Line 274:
 
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:Networking_rutx_manual_gps_avl_tavl_settings_v3.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 297: Line 302:
 
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:Networking_rutx_manual_gps_avl_avl_server_settings_v2.png]]
+
[[File:Networking_rutos_manual_gps_avl_avl_server_settings.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 331: Line 336:
 
The <b>Main rule</b> section defines how and when GPS data will be collected and sent to a specified AVL server. Refer to the figure and table below for information on the configuration fields of Main Rule.
 
The <b>Main rule</b> section defines how and when GPS data will be collected and sent to a specified AVL server. Refer to the figure and table below for information on the configuration fields of Main Rule.
  
[[File:Networking_rutx_manual_gps_avl_main_rule_v1.png]]
+
[[File:Networking_rutos_manual_gps_avl_main_rule.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 389: Line 394:
 
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_rutx_manual_gps_avl_secondary_rules_v1.png]]
+
[[File:Networking_rutos_manual_gps_avl_secondary_rules.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 455: Line 460:
 
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:Networking_rutx_manual_gps_avl_tavl_settings_v3.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 472: Line 477:
 
         <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 digital input state in the GPS data 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.
 +
{{#ifeq: {{{analog}}} | 1 |
 +
===Check Analog===
 +
----
 +
The <b>Check Analog</b> section is used to set how often the device checks the value of the analog input. This is relevant to input rules related to the analog input.
 +
 +
[[File:Networking_rutos_manual_gps_avl_io_check_analog.png|border|class=tlt-border]]
 +
|}}
 +
===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.
 +
 +
[[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]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Enable</td>
 +
        <td>off | on; default: <b>on</b></td>
 +
        <td>Turns the input rule on or off.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Input type</td>
 +
        <td>{{{input_types}}}; default: <b>{{#ifeq:{{{config_io}}}|1|Configurable Input/Output (3)|Input (3)}}</b></td>
 +
        <td>Selects to which input the rule will apply.</td>
 +
    </tr>{{#ifeq: {{{analog}}} | 1 |
 +
    <tr>
 +
        <td><span style="color: red;">Min voltage</span></td>
 +
        <td>float [0..40]; default: <b>none</b></td>
 +
        <td>Minimum analog input voltage range value that will trigger the rule.<br><b>Note:</b> this field is visible only when the selected 'Input type' is <i>Analog Input (11)</i>.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: red;">Max voltage</span></td>
 +
        <td>float [0..40]; default: <b>none</b></td>
 +
        <td>Maximum analog input voltage range value that will trigger the rule.<br><b>Note:</b> this field is visible only when the selected 'Input type' is <i>Analog Input (11)</i>.</td>
 +
    </tr>|}}
 +
    <tr>
 +
        <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 active</b></td>
 +
        <td>The event that will trigger the rule.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Priority</td>
 +
        <td>Low | High; 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 device 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 483: Line 552:
 
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:Networking_rutx_manual_gps_gps_geofencing_geofencing_details_v1.png]]
+
[[File:Networking_rutos_manual_gps_gps_geofencing_geofencing_details.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">

Latest revision as of 15:38, 5 March 2021

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

Summary[edit source]

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

If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Basic" button under "Mode", which is located at the top-right corner of the WebUI.

[[File:Networking_{{{series}}}_manual_webui_basic_advanced_mode.gif|border|class=tlt-border]]

Map[edit source]

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

General[edit source]

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.

NMEA[edit source]

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

NMEA forwarding[edit source]


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

NMEA forwarding cache[edit source]


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 collecting[edit source]


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.
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[edit source]


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).

HTTPS[edit source]

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

HTTPS/HTTP server settings[edit source]


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.
Delay integer; default: 5 Time interval in seconds between sending packages.

TAVL settings[edit source]


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[edit source]

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

AVL server settings[edit source]


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.
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 device will be connecting.
Protocol TCP | UDP; Default: TCP Protocol that will be used for communication with the AVL server.

Main rule[edit source]


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 rules[edit source]


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.

Networking rutos manual gps avl secondary rules.png

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.
Digital Isolated Input Low logic level | High logic level | Both; default: Low 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: 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 settings[edit source]


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/O[edit source]

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

Input Rules[edit source]


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 Geofencing[edit source]

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]]