RUT955 GPS: Difference between revisions

From Teltonika Networks Wiki
No edit summary
No edit summary
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template: Networking_device_manual_gps
{{Template: Networking_rutos_manual_gps_rut2_rut9
| name                   = RUT955
<!------------------------DEVICE----------------------->
| series                 = RUT9xx
| name       = RUT955
| file_map                = Networking_device_manual_gps_map_v1.png
| series      = RUT9
| file_general            = Networking_device_manual_gps_general_v1.png
<!----------------------SEPARATORS--------------------->
| file_nmea_forwarding    = Networking_device_manual_gps_nmea_nmea_forwarding_v1.png
| analog     = 1
| file_nmea_cache        = Networking_device_manual_gps_nmea_nmea_forwarding_cache_v1.png
| config_io  = 0
| file_nmea_collecting    = Networking_device_manual_gps_nmea_nmea_collecting_v1.png
| input_types = Input(3) {{!}} Input(1) {{!}} Isolated Input(2,7) {{!}} Analog Input (6,9)
| file_nmea_sentence     = Networking_device_manual_gps_nmea_nmea_sentence_settings_v1.png
| file_https_settings    = Networking_device_manual_gps_https_https_server_settings_v1.png
| file_tavl_settings     = Networking_device_manual_gps_https_tavl_settings_v1.png
| file_avl_settings      = Networking_device_manual_gps_avl_avl_server_settings_v1.png
| file_main_rule          = Networking_device_manual_gps_avl_main_rule_v1.png
| file_secondary_rules    = Networking_device_manual_gps_avl_secondary_rules_v1.png
| file_gps_configuration  = Networking_device_manual_gps_avl_gps_configuration_v1.png
| file_geofencing_details = Networking_device_manual_gps_gps_geofencing_details_v1.png
}}
}}
==GPS==
[[Image:Services gps.PNG]]
==GPS Settings==
[[Image:Services gps configuration.PNG]]
<table class="nd-mantable">
    <tr>
        <th>field name</th>
      <th>value</th>
      <th>description</th>
    </tr>
    <tr>
      <td>Enable GPS service</td>
      <td>yes | no; Default: '''no'''</td>
      <td>Toggles GPS ON or OFF</td>
    </tr>
    <tr>
      <td>Enable GPS data to server</td>
      <td>yes | no; Default: '''no'''</td>
      <td>Enables automatic GPS data transferring to a remote server </td>
    </tr>
    <tr>
    <td>Remote host/IP address</td>
        <td>host | ip; Default: '''212.47.99.61'''</td>
        <td>Server IP address or domain name to send the coordinates to</td>
    </tr>
    <tr>
    <td>Port</td>
        <td>integer [0..65535]; Default: '''17050'''</td>
        <td>Server port used for data transfer</td>
    </tr>
    <tr>
    <td>Protocol</td>
        <td>TCP | UDP; Default: '''TCP'''</td>
        <td>Protocol to be used for data transfer to server</td>
    </tr>
</table>
===TAVL Settings===
----
[[Image:Services gps configuration tavl.PNG]]
<table class="nd-mantable">
    <tr>
        <th>field name</th>
      <th>value</th>
      <th>description</th>
    </tr>
    <tr>
      <td>Send GSM signal</td>
      <td>yes | no; Default: '''no'''</td>
      <td>Includes GSM signal strength information in GPS data package to be sent to server</td>
    </tr>
    <tr>
      <td>Send analog input</td>
      <td>yes | no; Default: '''no'''</td>
      <td>Includes analog input state in GPS data package to be sent to server</td>
    </tr>
    <tr>
    <td>Send digital input (1)</td>
        <td>yes | no; Default: '''no'''</td>
        <td>Includes digital input #1 state in GPS data package to be sent to server</td>
    </tr>
    <tr>
    <td>Send digital input (2)</td>
        <td>yes | no; Default: '''no'''</td>
        <td>Includes digital input #2 state in GPS data package to be sent to server</td>
    </tr>
</table>
==GPS Mode==
[[Image:Services gps mode.PNG]]
<table class="nd-mantable">
    <tr>
        <th>field name</th>
      <th>value</th>
      <th>description</th>
    </tr>
    <tr>
      <td>Min period</td>
      <td>integer [1..999999]; Default: '''5'''</td>
      <td>Period (in seconds) for data collection</td>
    </tr>
    <tr>
      <td>Min distance</td>
      <td>integer [1..999999]; Default: '''200'''</td>
      <td>Distance difference (in meters) between last registered and current coordinates to collect data (even if Min period has not passed yet)</td>
    </tr>
    <tr>
    <td>Min angle</td>
        <td>integer [1..999999]; Default: '''30'''</td>
        <td>Minimal angle difference between last registered and current coordinates to collect data (even if Min period has not passed yet)</td>
    </tr>
    <tr>
    <td>Min saved records</td>
        <td>integer [1..32]; Default: '''20'''</td>
        <td>Minimal amount of coordinates registered to send them to server immediately (even if Send period has not passed yet)</td>
    </tr>
    <tr>
    <td>Send period</td>
        <td>integer [1..999999]; Default: '''60'''</td>
        <td>Period for sending collected data to server</td>
    </tr>
</table>
The GPS configuration section allows to save several different configurations for GPS data collection. Active configuration is automaticaly selected when configured conditions are met.
<table class="nd-mantable">
    <tr>
        <th>field name</th>
      <th>value</th>
      <th>description</th>
    </tr>
    <tr>
      <td>WAN</td>
      <td>Mobile | Wired | WiFi; Default: '''Mobile'''</td>
      <td>Interface which needs to be used to activate this configuration</td>
    </tr>
    <tr>
      <td>Type</td>
      <td>Home | Roaming | Both; Default: '''Home'''</td>
      <td>Mobile connection state needed to activate this configuration</td>
    </tr>
    <tr>
    <td>Digital isolated input</td>
        <td>Low logic level | High logic level | Both; Default: '''Low'''</td>
        <td>Input state needed to activate this configuration</td>
    </tr>
</table>
==GPS I/O==
The '''GPS I/O''' window provides you with the possibility to configure GPS Input rules. To create a new Input rule select Input type and Trigger, both of which can be found in the GPS Input Configuration section, then click the '''Add''' button.
[[Image:Services gps io.PNG]]
<table class="nd-mantable">
    <tr>
        <th>field name</th>
      <th>value</th>
      <th>description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; Default: '''no'''</td>
      <td>Toggles the rule ON or OFF</td>
    </tr>
    <tr>
      <td>Input type</td>
      <td>Digital | Digital isolated | Analog; Default: '''Digital'''</td>
      <td>Which type of input the rule will apply to</td>
    </tr>
    <tr>
    <td>Trigger</td>
        <td>Input open | Input shorted | Both; Default: '''Input open'''</td>
        <td>Trigger event for your intended configuration</td>
    </tr>
    <tr>
    <td>Priority</td>
        <td>Low | High | Panic; Default: '''Low'''</td>
        <td>Different priority settings add different priority flags to event packets, and they can be displayed differently</td>
    </tr>
</table>
==GPS Geofencing==
'''Geofencing''' is a feature which can detect whenever a device enters or leaves customized area.
[[Image:Services gps geofencing.PNG]]
<table class="nd-mantable">
    <tr>
        <th>field name</th>
      <th>value</th>
      <th>description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>yes | no; Default: '''no'''</td>
      <td>Toggles GPS Geofencing ON or OFF</td>
    </tr>
    <tr>
      <td>Longitude (X)</td>
      <td>real number [-180..180]; Default: '''0.000000'''</td>
      <td>Longitude of selected point</td>
    </tr>
    <tr>
    <td>Latitude (Y)</td>
        <td>real number [-90..90]; Default: '''0.000000'''</td>
        <td>Latitude of selected point</td>
    </tr>
    <tr>
    <td>Radius</td>
        <td>integer [1..999999]; Default: '''200'''</td>
        <td>Radius of selected area</td>
    </tr>
    <tr>
    <td>Generate event on</td>
        <td>Exit | Enter | Enter/Exit; Default: '''Exit'''</td>
        <td>Specifies whether event takes place on exiting or entering the specified area or both</td>
    </tr>
    <tr>
    <td>Get current coordinates</td>
        <td>-</td>
        <td>Gets current device coordinates from GPS</td>
    </tr>
</table>
==See also==
[http://wiki.teltonika-networks.com/index.php?title=RUT955_Protocols RUT955 GPS protocols]
[[Category:RUT955 WebUI]]

Latest revision as of 11:04, 9 April 2024

Main Page > EOL Products > RUT955 > RUT955 Manual > RUT955 WebUI > RUT955 Services section > RUT955 GPS

The information in this page is updated in accordance with firmware version RUT9_R_00.07.06.16.
Note: click here for the old style WebUI (FW version RUT9XX_R_00.06.09.5 and earlier) user manual page.

Summary

The Global Positioning System (GPS) is a space-based radionavigation system. This page is an overview of the GPS service in RUT955 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 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.

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.


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.
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.
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.
PQGSV Detailed satellite data (used in BeiDou and QZSS (Quectel Quirk) sentences).
PQGSA Overall satellite data (used in BeiDou and QZSS (Quectel Quirk) sentences).
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)).

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.

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.
Din2 off | on; default: off Includes Din2 status information in the GPS data sent to server.
Din2 off | on; default: off Includes Din2 status information in the GPS data sent to server.
Iio off | on; default: off Includes Iio status information in the GPS data sent to server.
Adc0 off | on; default: off Includes Adc0 status information in the GPS data sent to server.
Acl0 Current | Percent; off | on; default: Current; off Includes Acl0 Current/Percent information in the GPS data sent to server.

AVL

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

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.

Field Value Description
Enable off | on; default: off Turns the secondary rule on or off.
WAN Mobile Both | Mobile Home | Mobile Roaming | Wired; default: Mobile Home Selects which type of WAN will trigger the rule.
Ignore off | on; default: off If enabled, the rule ignores state of input.
IO level Low level | High level | Both; default: High level Selects which input state will trigger the rule.
IO type GPIO; default: GPIO Selects input type.
IO nameInput (3) | Input (1) | Isolated Input (2,7); default: Input (1) 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.
Din2 off | on; default: off Includes Din2 status information in the GPS data sent to server.
Din2 off | on; default: off Includes Din2 status information in the GPS data sent to server.
Iio off | on; default: off Includes Iio status information in the GPS data sent to server.
Adc0 off | on; default: off Includes Adc0 status information in the GPS data sent to server.
Acl0 Current | Percent; off | on; default: Current; off Includes Acl0 Current/Percent information in the GPS data sent to server.

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 Analog Current Loop (6,9) | Analog Input (6,9) | Input (3) | Digital Input (1) | Isolated Input (2,7); default: Analog Current Loop (6,9) Select type on your own intended configuration.
ACL Property Current | Percent; default: Current Select which property - ampere or percentage the condition listens to.
Min current float [4..20]; default: none Specifies minimum current of the range. Values between 4-20mA.
Max current float [4..20]; default: none Specifies maximum current of the range. Values between minimum-20mA.
Min voltage float [0..40]; default: none Specify minimum voltage range.
Max voltage float [0..40]; default: none Specify maximum voltage range.
Trigger Inside range | Outside range; Inside range | Outside range; Input active | Input low | Both; default: Inside range; Inside range; Input active Inside range - Input voltage falls in the specified region, Outside range - Input voltage drops out of the specified region; 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.