Template:Networking rutos manual gps: Difference between revisions

From Teltonika Networks Wiki
No edit summary
 
(36 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
  | series = {{{series}}}
  | series = {{{series}}}
| name  = {{{name}}}
  }}
  }}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} GPS (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} GPS (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==


Line 15: Line 18:
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_rutos_manual_gps_general.png|border|class=tlt-border]]
{{#switch: {{{name}}}
 
| RUT906 | RUT956 | RUT955 = [[File:Networking_rutos_manual_gps_general_rut906_v1.png|border|class=tlt-border]]
| TRB256 = [[File:Networking rutos manual gps general trb256_v1.png|border|class=tlt-border]]
| #default = [[File:Networking_rutos_manual_gps_general_v3.png|border|class=tlt-border]]}}
<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
Line 25: Line 30:
     <tr>
     <tr>
         <td>Enabled</td>
         <td>Enabled</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns the GPS service on or off.</td>
         <td>Turns the GPS service on or off.</td>
    </tr>{{#switch:{{{name}}}|#default=|TRB256=
    <tr>
        <td>Mode</td>
        <td>GNSS Only {{!}} <span style="color: red;">WWAN + GNSS</span>; default: <b>GNSS Only</b></td>
        <td>
            <ul>
              <li><b>GNSS Only</b> - in this mode, the device only connects to the GNNS system, and the WWAN (mobile) function no longer works.</li>
              <li><b>WWAN + GNNS</b> - in this mode, the device connects to the GNNS system only at set intervals and the WWAN (mobile) function stops working for a certain period of time (timeout).</li>
            </ul>
        </td>
    </tr>
    <tr>
        <td><span style="color: red;">Interval</span></td>
        <td>integer [60..86400]; default: <b>300</b></td>
        <td>How frequently should GNSS be activated (seconds).</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td><span style="color: red;">Timeout</span></td>
        <td>integer [30..999]; default: <b>100</b></td>
        <td>Maximum GNSS position fix waiting time (seconds).</td>
    </tr>}}
    <tr>{{#switch:{{{name}}}|TRB256|RUT901|RUT906|RUT951|RUT956=|#default=
        <td>DPO enabled</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Enable dynamic power optimization (requires modem reboot). <b>This function is not supported on devices with Meig modems or Quectel BG95 modem</b> </td>
    </tr>}}
    <tr>{{#switch:{{{name}}}|TRB256=|#default=
         <td>Galileo NMEA support<span class="asterisk">*</span></td>
         <td>Galileo NMEA support<span class="asterisk">*</span></td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</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>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</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>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</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 53: Line 83:
The figure below is an example of the Map page:
The figure below is an example of the Map page:


[[File:Networking_rutos_manual_gps_map.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_map_v4.png|border|class=tlt-border]]


==NMEA==
==NMEA==
Line 63: Line 93:
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|border|class=tlt-border]]
[[File:Networking rutos manual gps nmea nmea forwarding v3.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 80: Line 110:
         <td>ip | host; default: '''none'''</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>
        <td>Protocol</td>
        <td>TCP | UDP; default: <b>TCP</b></td>
        <td>Protocol that will be used to send NMEA data.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 87: Line 122:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Protocol</td>
         <td>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 to send NMEA data.</td>
         <td>Contains active session with the remote server if turned on.</td>
    </tr>
    <tr>
        <td>Select prefix</td>
        <td>Custom | None |Serial | Mac address | IMEI; default: <b>None</b></td>
        <td>Prefix is added to the NMEA sentence before it is transmitted. </td>
     </tr>
     </tr>
</table>
</table>
===Hosts status===
----
This section displays hosts status information.
[[File:Networking_rutos_manual_gps_nmea_nmea_hosts_status.png|border|class=tlt-border]]


===NMEA forwarding cache===
===NMEA forwarding cache===
Line 126: Line 172:
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_rutos_manual_gps_nmea_nmea_collecting.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_nmea_nmea_collecting_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 150: Line 196:
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_rutos_manual_gps_nmea_nmea_sentence_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_nmea_nmea_sentence_settings_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 179: Line 225:
     </tr>
     </tr>
</table>
</table>
<br>
<b>Note:</b> Not all types of NMEA sentences in the module are compatible with all modems. More information about supported NMEA sentences can be found on the modem module manufacturer's page.
<br>
<br>
<b>NMEA sentence reference table</b>:
<b>NMEA sentence reference table</b>:
Line 196: Line 245:
     <tr>
     <tr>
         <td><b>GPVTG</b></td>
         <td><b>GPVTG</b></td>
         <td>Track made good and speed relative to the ground.</td>
         <td>GPS track made good and speed relative to the ground.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 207: Line 256:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GNGSA</b></td>
         <td><b>GLGSV</b></td>
         <td>GLONASS DOP and active satellites.</td>
         <td>Number of GLONASS satellites in view.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><b>GLGSV</b></td>
         <td><b>GNGSA</b></td>
         <td>Number of GLONASS satellites in view.</td>
         <td>GNNS DOP and active satellites.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 224: Line 273:
     <tr>
     <tr>
         <td><b>PQGSV</b></td>
         <td><b>PQGSV</b></td>
        <td>Number of BeiDou satellites in view.</td>
    </tr>
    <tr>
        <td><b>PQGSA</b></td>
        <td>BeiDou DOP and active satellites.</td>
    </tr>
    <tr>
        <td><b>GARMC</b></td>
        <td>Recomended minimum specific for Galileo data.</td>
    </tr>
    <tr>
        <td><b>GAGGA</b></td>
        <td>Galileo fix data.</td>
    </tr>
    <tr>
        <td><b>GAGSA</b></td>
        <td>Galileo DOP and active satellites.</td>
    </tr>
    <tr>
        <td><b>GAVTG</b></td>
        <td>Galileo track made good and speed information relative to the ground.</td>
    </tr>
   
    <tr>
        <td><b>GLGSA</b></td>
        <td>GLONASS DOP and active satellites.</td>
    </tr>
    <tr>
        <td><b>GLGNS</b></td>
        <td>GLONASS position fix from more than one constellation.</td>
    </tr>
    <tr>
        <td><b>GNGSV</b></td>
        <td>Multi-constellation - GNSS satellites in view, such as number of satellites in view and satellite ID number</td>
    </tr>
    <tr>
        <td><b>PQGGA</b></td>
        <td>BeiDou fix data.</td>
    </tr>
    <tr>
        <td><b>PQRMC</b></td>
        <td>Recommended minimum specific GNSS data.</td>
    </tr>
    <tr>
        <td><b>PQVTGC</b></td>
        <td>BeiDou course over ground and ground speed.</td>
    </tr>
    <tr>
        <td><b>GNGGA</b></td>
        <td>Multi-constellation - GPS fix data.</td>
    </tr>
    <tr>
        <td><b>GNRMC</b></td>
        <td>Multi-constellation - recommended minimum specific GNSS data.</td>
    </tr>
    <tr>
        <td><b>GNVTG</b></td>
        <td>Multi-constellation - course over ground and ground speed.</td>
    </tr>
    <tr>
        <td><b>GBGSV</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>GBGSA</b></td>
         <td>Overall satellite data (used in BeiDou sentences).</td>
         <td>BeiDou DOP and active satellites.</td>
    </tr>
    <tr>
        <td><b>GQGSV</b></td>
        <td>Detailed QZSS satellite data (QZSS regional GPS augmentation system (Japan)).</td>
    </tr>
    <tr>
        <td><b>GQGSA</b></td>
        <td>QZSS DOP and active satellites (QZSS regional GPS augmentation system (Japan)).</td>
    </tr>
    <tr>
        <td><b>GPGLL</b></td>
        <td>Geographic position, latitude, longitude.</td>
    </tr>
    <tr>
        <td><b>PQGLL</b></td>
        <td></td>
    </tr>
    <tr>
        <td><b>GBGGA</b></td>
        <td>BeiDou - GPS fix data.</td>
    </tr>
    <tr>
        <td><b>GBRMC</b></td>
        <td>BeiDou - recommended minimum specific GNSS data.</td>
    </tr>
    <tr>
        <td><b>GBVTG</b></td>
        <td>BeiDou - course over ground and ground speed.</td>
    </tr>
    <tr>
        <td><b>GBGLL</b></td>
        <td>BeiDou - longitude and latitude.</td>
    </tr>
    <tr>
        <td><b>GPGNS</b></td>
        <td>GPS position fix from more than one constellation.</td>
    </tr>
    <tr>
        <td><b>GAGNS</b></td>
        <td>Galileo position fix from more than one constellation.</td>
    </tr>
    <tr>
        <td><b>BDGGA</b></td>
        <td>BeiDou fix data.</td>
    </tr>
    <tr>
        <td><b>BDRMC</b></td>
        <td>BeiDou fix data.</td>
    </tr>
    <tr>
        <td><b>BDGSV</b></td>
        <td>BeiDou - Number of BeiDou satellites in view.</td>
    </tr>
    <tr>
        <td><b>BDGSA</b></td>
        <td>BeiDou DOP and active satellites.</td>
    </tr>
    <tr>
        <td><b>BDVTG</b></td>
        <td>BeiDou course over ground and ground speed.</td>
    </tr>
    <tr>
        <td><b>BDGNS</b></td>
        <td>BeiDou position fix from more than one constellation.</td>
     </tr>
     </tr>
</table>
</table>
Line 241: Line 415:
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_rutos_manual_gps_https_server_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_https_server_settings_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 251: Line 425:
     <tr>
     <tr>
         <td>Enabled</td>
         <td>Enabled</td>
         <td>off | <span style="color: #20C0D7;"><b>on</b></span> default: <b>off</b></td>
         <td>off {{!}} on; 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><span style="color: #20C0D7;">URL</span></td>
         <td>URL</td>
         <td>url string; default: <b>192.168.1.5</b></td>
         <td>url string; default: <b>none</b></td>
         <td>URL of remote server.<br><i>This field becomes visible when Enabled is set to 'on'.</i></td>
         <td>URL of the remote server (ex. example.com/xxxx).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color: #20C0D7;">Delay</span></td>
         <td>Interval</td>
         <td>integer; default: <b>5</b></td>
         <td>integer; default: <b>none</b></td>
         <td>Time interval in seconds between sending packages.<br><i>This field becomes visible when Enabled is set to 'on'.</i></td>
         <td>Interval on which collected NMEA sentences should be forwarded.</td>
     </tr>
     </tr>
</table>
</table>
===Servers status===
----
This section displays remote servers status information.
[[File:Networking_rutos_manual_gps_https_servers_status.png|border|class=tlt-border]]


===TAVL settings===
===TAVL settings===
----
----
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]]
{{#switch: {{{name}}}  
| [[File:Networking_rutos_manual_gps_https_tavl_settings.png|border|class=tlt-border]]
| RUT955 | RUT956 | RUT906 = [[File:Networking_rut955_manual_gps_https_tavl_settings_v3.png|border|class=tlt-border]]
| TRB245 | TRB246 | TRB255 | TRB256 = [[File:Networking_trb245_manual_gps_https_tavl_settings_v1.png|border|class=tlt-border]]
| #default = [[File:Networking_rutos_manual_gps_https_tavl_settings_v3.png|border|class=tlt-border]]
}}
}}
 
{{#switch: {{{name}}}
<table class="nd-mantable">
| #default = <table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Signal</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Includes GSM signal strength information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Input (3)</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes din1 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>HDOP</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes horizontal dilution of precision in the GPS data sent to server.</td>
    </tr>
</table>
| RUT955 | RUT956 | RUT906 = <table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Signal</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Includes GSM signal strength information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Input (3)</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes din1 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Digital Input (1)</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes din2 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Isolated Input (2,7)</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes iio status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Analog Input (6,9)</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Adc0 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Analog Current Loop (6,9)</td>
        <td><span style="color: red;">Current {{!}} Percent</span>; off {{!}} on; default: <b><span style="color: red;">Current</span>; off</b></td>
        <td>Includes Acl0 Current/Percent information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>HDOP</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes horizontal dilution of precision in the GPS data sent to server.</td>
    </tr>
</table>
| TRB245 | TRB246 | TRB255 | TRB256 = <table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>Field</th>
Line 281: Line 527:
     <tr>
     <tr>
       <td>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>Input/Output (<i>various</i>)</td>
     <td>Configurable Input/Output (2)</td>
         <td>off | on; default: <b>off</b></td>
        <td>off {{!}} on; default: <b>off</b></td>
         <td>Includes Input/Output status information in the GPS data sent to server.</td>
        <td>Includes Dio0 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Configurable Input/Output (3) </td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Includes Dio1 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Configurable Input/Output (4)</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Dio2 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Analog Input (11)</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Adc0 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>HDOP</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes horizontal dilution of precision in the GPS data sent to server.</td>
    </tr>
</table>}}
 
<b>Note:</b> TAVL signal rule indicates signal strength (RSSI) and returns numerical value according to this table:
 
<table class="nd-othertables_3">
    <tr>
        <th width=500>No. of Value</th>
        <th width=500>Signal strength</th>
    </tr>
    <tr>
        <td>0</td>
        <td>No signal</td>
    </tr>
    <tr>
        <td>1</td>
        <td><= -97 dBm</td>
    </tr>
    <tr>
        <td>2</td>
        <td>-82 dBm to -97 dBm</td>
    </tr>
    <tr>
        <td>3</td>
        <td>-67 dBm to -82 dBm</td>
    </tr>
    <tr>
        <td>4</td>
        <td>-52 dBm to -67 dBm</td>
    </tr>
    <tr>
        <td>5</td>
        <td>>= -52 dBm</td>
     </tr>
     </tr>
</table>
</table>
Line 294: Line 593:


The <b>AVL</b> page is used to set up GPS data sending to an AVL server.
The <b>AVL</b> page is used to set up GPS data sending to an AVL server.
===General status===
----
This section displays AVL general status information.
[[File:Networking_rutos_manual_gps_avl_avl_server_status.png|border|class=tlt-border]]
===Hosts status===
----
This section displays hosts status information.
[[File:Networking_rutos_manual_gps_avl_hosts_status.png|border|class=tlt-border]]


===AVL server settings===
===AVL server settings===
Line 299: Line 610:
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_rutos_manual_gps_avl_avl_server_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_avl_avl_server_settings_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 336: Line 647:
         <td>off | on; default: <b>off</b></td>
         <td>off | on; default: <b>off</b></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>
         <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>
        <td>Static Navigation</td>
        <td>off | on; default: <b>off</b></td>
        <td>Stop collecting NMEA data if object is stationary. Ignores data when speed equals to 0 or same as previous coordinates (rounded to 4 decimals).</td>
     </tr>
     </tr>
</table>
</table>
Line 343: Line 659:
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_rutos_manual_gps_avl_main_rule.png|border|class=tlt-border]]
[[File:Networking rutos manual gps avl main rule v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 382: Line 698:
         <td>integer [1..360]; default: <b>50</b></td>
         <td>integer [1..360]; default: <b>50</b></td>
         <td>Minimum angle change (in degrees) before sending records.</td>
         <td>Minimum angle change (in degrees) before sending records.</td>
    </tr>
    <tr>
        <td>Min accuracy</td>
        <td>integer [1..999999]; default: <b>10</b></td>
        <td>Minimum accuracy (in meters) required before saving record. The lower the accuracy value, the better.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 401: Line 722:
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_{{{series}}}_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_avl_secondary_rules_{{{series}}}_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 430: Line 751:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>IO type</td>
         <td>IO type</td>{{#switch:{{{name}}}
        <td>GPIO; default: <b>GPIO</b></td>
| RUT955 | RUT956 | RUT906 =<td>GPIO {{!}} ADC {{!}} ACL; default: <b>GPIO</b></td>
| TRB245 | TRB246 | TRB255 | TRB256 =<td>GPIO {{!}} ADC; default: GPIO <b></b></td>
| #default =<td>GPIO; default: GPIO <b></b></td>}}
         <td>Selects input type.</td>
         <td>Selects input type.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>IO name</td>{{#switch:{{{series}}}
         <td>IO name</td>{{#switch:{{{name}}}
| RUT9 =<td>Input (3) {{!}} Input (1) {{!}} Isolated Input (2,7); default: <b>Input (1)</b></td>
| RUT955 | RUT956 | RUT906 =<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>
| TRB245 | TRB246 | TRB255 | TRB256 =<td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>
| TRB2 =<td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>}}
| #default =<td>Input (4); default: <b>Input (3)</b></td>}}
         <td>Selects which specific input will trigger the rule.</td>
         <td>Selects which specific input will trigger the rule.</td>
     </tr>
     </tr>
Line 467: Line 790:
         <td>integer [1..360]; default: '''25'''</td>
         <td>integer [1..360]; default: '''25'''</td>
         <td>Minimum angle change (in degrees) before sending records.</td>
         <td>Minimum angle change (in degrees) before sending records.</td>
    </tr>
    <tr>
        <td>Min accuracy</td>
        <td>integer [1..999999]; default: <b>10</b></td>
        <td>Minimum accuracy (in meters) required before saving record. The lower the accuracy value, the better.</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 484: Line 812:
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]]
{{#switch: {{{name}}}  
| [[File:Networking_rutos_manual_gps_https_tavl_settings.png|border|class=tlt-border]]
| RUT955 | RUT956 | RUT906 = [[File:Networking_rut955_manual_gps_https_tavl_settings_v2.png|border|class=tlt-border]]
| TRB245 | TRB246 | TRB255 | TRB256 = [[File:Networking_trb245_manual_gps_https_tavl_settings.png|border|class=tlt-border]]
| #default = [[File:Networking_rutos_manual_gps_https_tavl_settings_v2.png|border|class=tlt-border]]
}}
}}
 
{{#switch: {{{name}}}
<table class="nd-mantable">
| #default = <table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Signal</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Includes GSM signal strength information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Din1</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Din1 status information in the GPS data sent to server.</td>
    </tr>
</table>
| RUT955 | RUT956 | RUT906 = <table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Signal</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Includes GSM signal strength information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Din1</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Din1 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Din2</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Din2 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Din2</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Din2 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Iio</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Iio status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Adc0</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Adc0 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Acl0</td>
        <td><span style="color: red;">Current {{!}} Percent</span>; off {{!}} on; default: <b><span style="color: red;">Current</span>; off</b></td>
        <td>Includes Acl0 Current/Percent information in the GPS data sent to server.</td>
    </tr>
</table>
| TRB245 | TRB246 | TRB255 | TRB256 = <table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>Field</th>
Line 496: Line 885:
     <tr>
     <tr>
       <td>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>Input/Output (<i>various</i>)</td>
     <td>Dio0</td>
         <td>off | on; default: <b>off</b></td>
        <td>off {{!}} on; default: <b>off</b></td>
         <td>Includes Input/Output status information in the GPS data sent to server.</td>
        <td>Includes Dio0 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Dio1</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Dio1 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Dio2</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Includes Dio2 status information in the GPS data sent to server.</td>
    </tr>
    <tr>
    <td>Adc0</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Includes Adc0 status information in the GPS data sent to server.</td>
    </tr>
</table>}}
 
<b>Note:</b> TAVL signal rule indicates signal strength (RSSI) and returns numerical value according to this table:
 
<table class="nd-othertables_3">
    <tr>
        <th width=500>No. of Value</th>
        <th width=500>Signal strength</th>
    </tr>
    <tr>
        <td>0</td>
        <td>No signal</td>
    </tr>
    <tr>
        <td>1</td>
        <td><= -97 dBm</td>
    </tr>
    <tr>
        <td>2</td>
        <td>-82 dBm to -97 dBm</td>
    </tr>
    <tr>
        <td>3</td>
        <td>-67 dBm to -82 dBm</td>
    </tr>
    <tr>
        <td>4</td>
        <td>-52 dBm to -67 dBm</td>
    </tr>
    <tr>
        <td>5</td>
        <td>>= -52 dBm</td>
     </tr>
     </tr>
</table>
</table>
Line 509: Line 946:


The <b>AVL I/O</b> tab provides you with the possibility to configure input rules.
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===
===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.
The <b>Input Rules</b> section displays existing input rules. To create a new input rule click the 'Add' button.


[[File:Networking_rutos_manual_gps_avl_io_input_rules_add_button_config_io_{{{config_io}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_avl_io_input_rules_add_button.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:
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]]
{{#switch: {{{name}}}  
| RUT955 | RUT956 | RUT906 = [[File:Networking_rutos_manual_gps_avl_io_input_rules_avl_input_rule_data_configuration_rut955.png|border|class=tlt-border]]
| TRB245 | TRB246 | TRB255 | TRB256 = [[File:Networking_rutos_manual_gps_avl_io_input_rules_avl_input_rule_data_configuration_trb245.png|border|class=tlt-border]]
| #default = [[File:Networking_rutos_manual_gps_avl_io_input_rules_avl_input_rule_data_configuration.png|border|class=tlt-border]]}}


<table class="nd-mantable">
<table class="nd-mantable">
Line 539: Line 973:
     <tr>
     <tr>
         <td>Input type</td>
         <td>Input type</td>
         <td>{{{input_types}}}; default: <b>{{#ifeq:{{{config_io}}}|1|Configurable Input/Output (3)|Input (3)}}</b></td>
         <td>{{#switch:{{{name}}}| RUT955|RUT956|RUT906 = <span style="color: red;">Analog Current Loop (6,9)</span> {{!}} <span style="color: blue;">Analog Input (6,9)</span> {{!}}  Input (3) {{!}} Digital Input (1) {{!}}  Isolated Input (2,7); default: <b>Analog Current Loop (6,9)</b>| TRB245|TRB246|TRB255|TRB256 = <span style="color: red;">Analog Input (11)</span> {{!}} Configurable Input/Output (2) {{!}} Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Analog Input (11)</b>| #default = Input (3); default: <b>Input (3)</b>}}</td>
         <td>Selects to which input the rule will apply.</td>
         <td>Select type on your own intended configuration.</td>
     </tr>{{#ifeq: {{{analog}}} | 1 |
     </tr>{{#switch:{{{name}}}| RUT955|RUT956|RUT906 =
    <tr>
        <td><span style="color: red;">ACL Property</span></td>
        <td>Current {{!}} Percent; default: <b>Current</b></td>
        <td>Select which property - ampere or percentage the condition listens to.</td>
    </tr>
    <tr>
        <td><span style="color: red;">Min current</span></td>
        <td>float [4..20]; default: <b>none</b></td>
        <td>Specifies minimum current of the range. Values between 4-20mA.</td>
    </tr>
    <tr>
        <td><span style="color: red;">Max current</span></td>
        <td>float [4..20]; default: <b>none</b></td>
        <td>Specifies maximum current of the range. Values between minimum-20mA.</td>
    </tr>
    <tr>
        <td><span style="color: blue;">Min voltage</span></td>
        <td>float [0..40]; default: <b>none</b></td>
        <td>Specify minimum voltage range.</td>
    </tr>
        <tr>
        <td><span style="color: blue;">Max voltage</span></td>
        <td>float [0..40]; default: <b>none</b></td>
        <td>Specify maximum voltage range.</td>
    </tr>| TR245|TRB246|TRB255|TRB256 =   
     <tr>
     <tr>
         <td><span style="color: red;">Min voltage</span></td>
         <td><span style="color: red;">Min voltage</span></td>
         <td>float [0..40]; default: <b>none</b></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>
         <td>Specify minimum voltage range.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td><span style="color: red;">Max voltage</span></td>
         <td><span style="color: red;">Max voltage</span></td>
         <td>float [0..40]; default: <b>none</b></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>
         <td>Specify maximum voltage range.</td>
     </tr>|}}
     </tr>| #default =}}
     <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 active</b></td>
         <td>{{#switch:{{{name}}}| RUT955|RUT956|RUT906 = <span style="color: red;">Inside range</span> {{!}} <span style="color: red;">Outside range</span>; <span style="color: blue;">Inside range</span> {{!}} <span style="color: blue;">Outside range; </span> Input active {{!}} Input low {{!}} Both; default: <b><span style="color: red;">Inside range</span>; <span style="color: blue;">Inside range</span>; Input active</b>|TRB245|TRB246|TRB255|TRB256 = <span style="color: red;">Inside range</span> {{!}} <span style="color: red;">Outside range; </span> Input active {{!}} Input low {{!}} Both; default: <b><span style="color: red;">Inside range</span>; Input active</b>|#default = Input active {{!}} Input low {{!}} Both; default: <b>Input active</b>}}</td>
         <td>The event that will trigger the rule.</td>
         <td>{{#switch:{{{name}}}| RUT955|RUT956|RUT906|TRB245|TRB246|TRB255|TRB256=<span style="color: red;">Inside range - Input voltage falls in the specified region, Outside range - Input voltage drops out of the specified region</span>; Select trigger event for your own intended configuration.|#default = Select trigger event for your own intended configuration.}}</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Priority</td>
         <td>Priority</td>
         <td>Low | High; default: <b>Low</b></td>
         <td>Low | High | Panic | Security; 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:
         <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.</td>
            <ol>
                <!--<li>Panic</li>-->
                <li>High</li>
                <li>Low</li>
            </ol>
        </td>
     </tr>
     </tr>
</table>
</table>
Line 578: Line 1,031:
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_rutos_manual_gps_gps_geofencing_geofencing_details.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_gps_gps_geofencing_geofencing_details_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 610: Line 1,063:
         <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>
        <td>Switch profile</td>
        <td>configuration profiles; default: <b>none</b></td>
        <td>Selects a profile to switch to on this geofencing event.</td>
     </tr>
     </tr>
     <tr>
     <tr>

Latest revision as of 15:24, 21 November 2024

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}}} devices.

General

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:

Field Value Description
Enabled off | on; default: off Turns the GPS service on or off.
DPO enabled off | on; default: off Enable dynamic power optimization (requires modem reboot). This function is not supported on devices with Meig modems or Quectel BG95 modem
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.

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

The figure below is an example of the Map page:

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 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.
Protocol TCP | UDP; default: TCP Protocol that will be used to send NMEA data.
Port integer [0..65535]; default: 8500 Port number off the server to which NMEA data will be forwarded.
Contain connection off | on; default: off Contains active session with the remote server if turned on.
Select prefix Custom | None |Serial | Mac address | IMEI; default: None Prefix is added to the NMEA sentence before it is transmitted.

Hosts status


This section displays hosts status information.

NMEA forwarding cache


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:

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


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


Note: Not all types of NMEA sentences in the module are compatible with all modems. More information about supported NMEA sentences can be found on the modem module manufacturer's page.


NMEA sentence reference table:

NMEA sentence name Description
GPGSV Number of GPS satellites in view.
GPGGA GPS fix data.
GPVTG GPS track made good and speed relative to the ground.
GPRMC Recommended minimum specific GPS/Transit data.
GPGSA GPS DOP and active satellites.
GLGSV Number of GLONASS satellites in view.
GNGSA GNNS DOP and active satellites.
GNGNS GNSS position fix from more than one constellation (e.g., GPS + GLONASS).
GAGSV Number of Galileo satellites in view.
PQGSV Number of BeiDou satellites in view.
PQGSA BeiDou DOP and active satellites.
GARMC Recomended minimum specific for Galileo data.
GAGGA Galileo fix data.
GAGSA Galileo DOP and active satellites.
GAVTG Galileo track made good and speed information relative to the ground.
GLGSA GLONASS DOP and active satellites.
GLGNS GLONASS position fix from more than one constellation.
GNGSV Multi-constellation - GNSS satellites in view, such as number of satellites in view and satellite ID number
PQGGA BeiDou fix data.
PQRMC Recommended minimum specific GNSS data.
PQVTGC BeiDou course over ground and ground speed.
GNGGA Multi-constellation - GPS fix data.
GNRMC Multi-constellation - recommended minimum specific GNSS data.
GNVTG Multi-constellation - course over ground and ground speed.
GBGSV Detailed satellite data (used in BeiDou sentences).
GBGSA BeiDou DOP and active satellites.
GQGSV Detailed QZSS satellite data (QZSS regional GPS augmentation system (Japan)).
GQGSA QZSS DOP and active satellites (QZSS regional GPS augmentation system (Japan)).
GPGLL Geographic position, latitude, longitude.
PQGLL
GBGGA BeiDou - GPS fix data.
GBRMC BeiDou - recommended minimum specific GNSS data.
GBVTG BeiDou - course over ground and ground speed.
GBGLL BeiDou - longitude and latitude.
GPGNS GPS position fix from more than one constellation.
GAGNS Galileo position fix from more than one constellation.
BDGGA BeiDou fix data.
BDRMC BeiDou fix data.
BDGSV BeiDou - Number of BeiDou satellites in view.
BDGSA BeiDou DOP and active satellites.
BDVTG BeiDou course over ground and ground speed.
BDGNS BeiDou position fix from more than one constellation.

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 off | on; default: off Turns data sending to HTTP/HTTPS server on or off.
URL url string; default: none URL of the remote server (ex. example.com/xxxx).
Interval integer; default: none Interval on which collected NMEA sentences should be forwarded.

Servers status


This section displays remote servers status information.

TAVL settings


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

Field Value Description
Signal off | on; default: off Includes GSM signal strength information in the GPS data sent to server.
Input (3) off | on; default: off Includes din1 status information in the GPS data sent to server.
HDOP off | on; default: off Includes horizontal dilution of precision in the GPS data sent to server.

Note: TAVL signal rule indicates signal strength (RSSI) and returns numerical value according to this table:

No. of Value Signal strength
0 No signal
1 <= -97 dBm
2 -82 dBm to -97 dBm
3 -67 dBm to -82 dBm
4 -52 dBm to -67 dBm
5 >= -52 dBm

AVL

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

General status


This section displays AVL general status information.

Hosts status


This section displays hosts status information.

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 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.
Static Navigation off | on; default: off Stop collecting NMEA data if object is stationary. Ignores data when speed equals to 0 or same as previous coordinates (rounded to 4 decimals).

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 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 accuracy integer [1..999999]; default: 10 Minimum accuracy (in meters) required before saving record. The lower the accuracy value, the better.
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


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}}}_v2.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 typeGPIO; default: GPIO Selects input type.
IO nameInput (4); default: Input (3) 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 accuracy integer [1..999999]; default: 10 Minimum accuracy (in meters) required before saving record. The lower the accuracy value, the better.
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


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

Field Value Description
Signal off | on; default: off Includes GSM signal strength information in the GPS data sent to server.
Din1 off | on; default: off Includes Din1 status information in the GPS data sent to server.

Note: TAVL signal rule indicates signal strength (RSSI) and returns numerical value according to this table:

No. of Value Signal strength
0 No signal
1 <= -97 dBm
2 -82 dBm to -97 dBm
3 -67 dBm to -82 dBm
4 -52 dBm to -67 dBm
5 >= -52 dBm

AVL I/O

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

Input Rules


The Input Rules section displays existing input rules. To create a new input rule click the 'Add' button.

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

Field Value Description
Enable off | on; default: on Turns the input rule on or off.
Input type Input (3); default: Input (3) Select type on your own intended configuration.
Trigger Input active | Input low | Both; default: Input active Select trigger event for your own intended configuration.
Priority Low | High | Panic | Security; 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.

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.

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:

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.
Switch profile configuration profiles; default: none Selects a profile to switch to on this geofencing event.
Get current coordinates - (interactive button) Obtains the device's current coordinates and places them in the Longitude and Latitude fields.

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