Difference between revisions of "Getting Started"

From Wiki Knowledge Base | Teltonika GPS
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{| align="right"
 +
|align="right"|__TOC__
 +
|}
 +
 
Here you will discover basic information on what FM devices support FOTA Web solution and where you can get started by following step by step guide from the invitation to your first login. Additionally you will find web sites basic settings such as changing language, API and more.
 
Here you will discover basic information on what FM devices support FOTA Web solution and where you can get started by following step by step guide from the invitation to your first login. Additionally you will find web sites basic settings such as changing language, API and more.
 
<br>
 
<br>
__TOC__
 
 
 
=='''Device requirements'''==
 
=='''Device requirements'''==
 
{| style="width: 75%; text-align: center; vertical-align: top;"
 
{| style="width: 75%; text-align: center; vertical-align: top;"
Line 93: Line 95:
 
<br>
 
<br>
  
'''Note''':  1. All FMBXXX devices except for FMB64X should have at least [[FMB_firmware_errata#01.03.03.Rev.00|01.03.03.Rev.00]] firmware version installed.<br />2. FMB64X should have at least [[FMB640 firmware errata#00.02.05|00.02.05]] version installed.<br />Please check [https://wiki.teltonika-gps.com/view/Firmware_versions Firmware Link] to find latest base firmware for your device.<br>
+
'''Note''':  1. All FMBXXX devices except for FMB64X should have at least [[FMB_firmware_errata#01.03.03.Rev.00|01.03.03.Rev.00]] firmware version installed.<br />2. FMB64X should have at least [[FMB640 firmware errata#00.02.05|00.02.05]] version installed.<br />3. FM36YX devices should have at least [[FM36 firmware errata#01.12.00.Rev.02|01.12.00.Rev.02]] version installed. (FM36YX FotaWeb functionality for firmware update only)<br />
 +
Please check [https://wiki.teltonika-gps.com/view/Firmware_versions Firmware Link] to find latest base firmware for your device.<br>
 
<br>
 
<br>
 +
 +
'''Default FOTA WEB configuration settings:'''
 +
 +
'''Domain:''' fm.teltonika.lt<br />
 +
'''Port:''' 5000 <br />
 +
'''Period:''' 720 minutes (every 720 minutes device shall connect to FOTA WEB)<br />
 +
[[File:FOTA_Web_Configuration.PNG|750px]]<br />
  
 
=='''Network requirements'''==
 
=='''Network requirements'''==
Line 100: Line 110:
 
If your SIM cards are within Mobile Operator’s VPN (private APN), the following must be ensured and paid special attention.
 
If your SIM cards are within Mobile Operator’s VPN (private APN), the following must be ensured and paid special attention.
 
<br />
 
<br />
'''1.''' Must ensure that domain or IP: 35.156.7.140 is whitelisted from network operator’s side.<br />
+
'''1.''' Must ensure that domain '''http://fota.teltonika.lt''' can be resolved from within Operator’s network.<br />
'''2.''' Following domain and ports (egress) must be allowed by the operator.
+
'''2.''' Following IP and ports (egress) must be allowed by the operator.
 +
<br />
  
Network requirements for FM devices:
+
*IP: 35.156.7.140
 
 
*Domain: fm.teltonika.lt
 
 
*Ports:
 
*Ports:
**5000 (TCP)
+
**2000<br />
**6000 (TCP)
+
**3000<br />
Network requirements for FT devices:
+
**4000<br />
*Domain: fota.teltonika.lt
+
**5000<br />
*Ports:
+
**6000<br />
**5055 (UDP)
+
**7000<br />
**5005 (TCP)
 
  
When using VPN SIM cards, you should still configure the domain in your configurator, not the plain IP address.
+
When using VPN SIM cards, you should still configure '''http://fota.teltonika.lt''' domain in your configurator, not the plain IP address.
  
 
=='''How to access FOTA WEB'''==
 
=='''How to access FOTA WEB'''==
  
FOTA WEB is reached using domain address '''[http://fota.teltonika.lt https://fota.teltonika.lt]'''. FOTA WEB uses HTTPS port 443, so if your network has HTTPS proxy service or is blocking outgoing traffic – make sure that this port is added to exceptions in network proxy service and firewall.
+
FOTA WEB is reached using domain address '''http://fota.teltonika.lt'''. FOTA WEB uses HTTP ports 80 and 85 for authentication so if your network has HTTP proxy service or is blocking outgoing traffic – make sure that those two ports are added to exceptions in network proxy service and firewall.
 
<br>
 
<br>
  
Line 150: Line 158:
 
[[File:FOTA Web Notifications.png]]
 
[[File:FOTA Web Notifications.png]]
  
=='''FOTA Web availability expectations'''==
+
=='''Settings'''==
Due to factors like system load and device network quality, Teltonika Telematics cannot guarantee immediate FOTA WEB task execution. To ensure optimal FOTA WEB performance, we recommend the following:
+
 
 +
You can find '''FOTA Web Settings''' at the top-right of the page, there you are able to change web page language, generate API tokens, change account password and set your own time zone. More details about the functions are explained below. <br>
 +
[[File:FOTA Web Settings.png]]
 +
===Language===
 +
 
 +
In the settings tab window you can select your preferred language.
 +
Currently there are 6 available languages:
 +
* English
 +
* Lithuanian
 +
* Russian
 +
* Spanish
 +
* Portuguese
 +
* France
 +
 
 +
===API tokens===
 +
 
 +
You can generate Token ID in the API Tokens window by clicking '''Add token''', set a Token name and then click generate. This will generate FOTA Web API Token with which you can use it to integrate FOTA Web functionalities on your existing software system. <br>
 +
[[File:FOTA Web API Token.png|600px]]
 +
 
 +
Full FOTA API documentation can be found [https://api.teltonika.lt/documents/index.html <u>'''HERE'''</u>].
 +
 
 +
===Change password===
 +
 
 +
If your current password is too difficult to remember or not secure enough and you want to change it, you can freely change your password by entering your current password and then the password you want it to be changed to.<br>
 +
[[File:FOTA Web ChangePassword.png|500px]]<br>
 +
If you do not remember your current password, in FOTA WEB initial window you can click forgot password. It will generate a link for resetting your password and send it to your email address.
 +
 
 +
===Time zone===
  
'''Scheduled Updates''' - Devices should follow a configured schedule on your devices to avoid overwhelming the system.
+
Time zone functionality lets you freely change how page will display time in different time zones. Changing it will change time information on when device was '''Seen at''', '''Created at''' or '''Updated at'''.
  
'''Staggered Deployment''' - Minimize simultaneous "web_connect" requests from multiple devices to maintain optimal system responsiveness and prevent peak server loads.
+
[[File:FOTA Web Timezone.png|300px]]
  
By adhering to these guidelines, you can maximize the efficiency and reliability of your device's updates using FOTA WEB.
+
<br>
<br />
+
{|style="width:100%;"
 +
|-
 +
|[https://wiki.teltonika-gps.com/view/FOTA_WEB'''Landing page'''] - Previous page
 +
|style="text-align:right;| Next page - [https://wiki.teltonika-gps.com/view/Dashboard '''Dashboard ''']
 +
|}

Revision as of 13:34, 27 June 2023

Here you will discover basic information on what FM devices support FOTA Web solution and where you can get started by following step by step guide from the invitation to your first login. Additionally you will find web sites basic settings such as changing language, API and more.

Device requirements

Supported Devices
Basic Trackers
Rich tracking features at a competitive price

Product list [+/-]
FMB900
FMB910
FMB920
FMC920
FMM920
FMB930
IP67 Trackers
FMB965
Fleet Telematics Trackers
FTC921
FTC961

Fast & Easy Trackers
Fast installation and accurate tracking

Product list [+/-]
FMP100
FMB010
FMB020
FMC800
FMM800
FMM80A
IP65 Trackers
FMT100
FMC880
FMM880
Fleet Telematics Trackers
FTC881

Advanced Trackers
Flexible and sophisticated all-rounders
OBD Trackers
Compact Plug & Play models to read OBD II data

Product list [+/-]
FMB001
FMB003
FMC003
FMM003
FMM00A

CAN Trackers
Provide CAN bus data for all vehicle types
Professional Trackers
Comprehensive solutions for professional use

Product list [+/-]
FMC650
FMM650
FMB125
FMC125
FMM125
IP67 Trackers
FMB225
FMC225


Note: 1. All FMBXXX devices except for FMB64X should have at least 01.03.03.Rev.00 firmware version installed.
2. FMB64X should have at least 00.02.05 version installed.
3. FM36YX devices should have at least 01.12.00.Rev.02 version installed. (FM36YX FotaWeb functionality for firmware update only)
Please check Firmware Link to find latest base firmware for your device.

Default FOTA WEB configuration settings:

Domain: fm.teltonika.lt
Port: 5000
Period: 720 minutes (every 720 minutes device shall connect to FOTA WEB)
FOTA Web Configuration.PNG

Network requirements

If your SIM cards are within Mobile Operator’s VPN (private APN), the following must be ensured and paid special attention.
1. Must ensure that domain http://fota.teltonika.lt can be resolved from within Operator’s network.
2. Following IP and ports (egress) must be allowed by the operator.

  • IP: 35.156.7.140
  • Ports:
    • 2000
    • 3000
    • 4000
    • 5000
    • 6000
    • 7000

When using VPN SIM cards, you should still configure http://fota.teltonika.lt domain in your configurator, not the plain IP address.

How to access FOTA WEB

FOTA WEB is reached using domain address http://fota.teltonika.lt. FOTA WEB uses HTTP ports 80 and 85 for authentication so if your network has HTTP proxy service or is blocking outgoing traffic – make sure that those two ports are added to exceptions in network proxy service and firewall.

1. Invitation for FOTA WEB is being delivered to user e-mail. Press the URL to create a password for your account. 2. After pressing the URL Link you will be asked to create a password for your account. 3. Last step is logging into FOTA WEB with the newly created account by entering your email address and password for your account. Email address is the same as the address you've received the invitation.
FOTA Invitation.PNG
FOTA Web Password.PNG
FOTA Web Log in.PNG

Select company

At the top-right corner, you can find the Company selector button. Pressing on a button will open a list of parent and child companies. Selecting a company allows for filtering resources available such as devices, task groups, groups, users, and files. It is an easy way to separate resources and make sure that you are working with the correct ones. Company selector button behavior:

  • When a single company is selected, you will see the company button label change to the selected company's name.
  • When two or more companies are selected, you will see a number of companies selected instead of an icon and "Companies" label.
  • When nothing is selected, you will see everything available and "All companies" label.

Note: Every company has to be selected individually.

FOTA Web Allcompanies.png

Notifications

Notifications is located at the top-right corner of the page. Notifications will inform you when certain actions are completed such as devices firmware got updated, configuration got uploaded to or downloaded from the device and also notifies when devices are transferred from one company to another or moved from main company to child company. FOTA Web Notifications.png

Settings

You can find FOTA Web Settings at the top-right of the page, there you are able to change web page language, generate API tokens, change account password and set your own time zone. More details about the functions are explained below.
FOTA Web Settings.png

Language

In the settings tab window you can select your preferred language. Currently there are 6 available languages:

  • English
  • Lithuanian
  • Russian
  • Spanish
  • Portuguese
  • France

API tokens

You can generate Token ID in the API Tokens window by clicking Add token, set a Token name and then click generate. This will generate FOTA Web API Token with which you can use it to integrate FOTA Web functionalities on your existing software system.
FOTA Web API Token.png

Full FOTA API documentation can be found HERE.

Change password

If your current password is too difficult to remember or not secure enough and you want to change it, you can freely change your password by entering your current password and then the password you want it to be changed to.
FOTA Web ChangePassword.png
If you do not remember your current password, in FOTA WEB initial window you can click forgot password. It will generate a link for resetting your password and send it to your email address.

Time zone

Time zone functionality lets you freely change how page will display time in different time zones. Changing it will change time information on when device was Seen at, Created at or Updated at.

FOTA Web Timezone.png


Landing page - Previous page Next page - Dashboard