9,305
edits
Changes
Template:Networking rutos manual gps (view source)
Revision as of 10:17, 24 May 2022
, 10:17, 24 May 2022no edit summary
{{Template: Networking_rutos_manual_fw_disclosure
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| fw_version = {{{series}}}_R_00.02.03.1
| 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>|}}
==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.
==General==
==General==
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">
<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==
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|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<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>
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">
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">
</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>
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">
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_v1.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">
<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>none</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>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>
</tr>
</tr>
</table>
</table>
----
----
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:
{{#switch: {{{name}}}
[[File:Networking_rutx_manual_gps_avl_tavl_settings_v3.png|border|class=tlt-border]]
| RUT955|RUT956=[[File:Networking_rut955_manual_gps_https_tavl_settings_v1.png|border|class=tlt-border]]
| #default=[[File:Networking_rutos_manual_gps_https_tavl_settings_v1.png|border|class=tlt-border]]
}}
<table class="nd-mantable">
<table class="nd-mantable">
</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>
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_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<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>
</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>
<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>
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">
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_{{{series}}}_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</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>
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]]
{{#switch: {{{name}}}
| RUT955|RUT956=[[File:Networking_rut955_manual_gps_https_tavl_settings_v1.png|border|class=tlt-border]]
| #default=[[File:Networking_rutos_manual_gps_https_tavl_settings_v1.png|border|class=tlt-border]]
}}
<table class="nd-mantable">
<table class="nd-mantable">
</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>
</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>
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">
