Difference between revisions of "Getting Started"

From Wiki Knowledge Base | Teltonika GPS
(26 intermediate revisions by 5 users not shown)
Line 1: Line 1:
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>
 
 
__TOC__
 
__TOC__
 
 
=='''Device requirements'''==
 
=='''Device requirements'''==
{| style="width: 75%; text-align: center; vertical-align: top;"
+
{| class="wikitable" style="width: 100%;"
!colspan="5" style="text-align: center; vertical-align: top; background: white;" |<big>'''Supported Devices'''</big>
+
|-
 +
| style="border: 1px solid white; border-bottom: 2px solid white; text-align: left; vertical-align: center; background: white;" |[[File:Alert.png|50px|left|link=]]<br />
 +
| style="border: 1px solid white; border-bottom: 2px solid white; text-align: left; vertical-align: center; background: white;" |'''IMPORTANT!!!'''
 +
| style="border: 1px solid white; border-bottom: 2px solid white; text-align: left; vertical-align: center; background: white;" |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 />
 
|}
 
|}
  
{| class="main-table w-100" style="height:auto; width:80%;" align="center"
+
{| style="width: 100%; text-align: center; vertical-align: top;"
| style="height:5%; width:20%; text-align:center; vertical-align: top; font-weight:400; margin: 0 auto;" |
+
!colspan="5" style="text-align: center; vertical-align: top; background: white;" |<big>'''Supported Devices'''</big>
{| style="width: 70%"
 
![[Image:Basic_Trackers02.png|81x81px|link=|alt=]]
 
|-
 
|'''Basic Trackers'''
 
|-
 
|Rich tracking features at a competitive price
 
 
|-
 
|-
!<div class="mw-customtoggle-1" style="margin:0 auto; vertical-align: middle; text-align: center; overflow:auto;">
+
|style="vertical-align: top;"|'''FMB9YX'''
'''Product list [+/-]''' <span class="mw-collapsible mw-collapsed" id="mw-customcollapsible-1"> <Br>{{Template:Basic_Trackers}}</span>
+
[[File:FMB900 460x264.png|170px]]
</div>
+
|style="vertical-align: top;" | '''FMB96X'''
 +
[[File:FMB96X 540 264.png|170px]]
 +
|style="vertical-align: top;" | '''FMB1YX'''
 +
[[File:FMB125 600x448.png|170px]]
 +
|style="vertical-align: top;" | '''FMB0YX'''
 +
[[File:FMB003-4000x4000-5.png|150px]]
 +
|style="vertical-align: top;" | '''FMB64X'''
 +
[[File:450x433 FMB640.png|170px]]
 
|-
 
|-
 +
{| style="width: 100%; text-align: center; vertical-align: top;"
 +
|style="vertical-align: top;"|'''TMT250'''
 +
[[File:TMT250 small t.png|140px]]
 +
|style="vertical-align: top;" | '''FMT100'''
 +
[[File:FMT100-01.png|150px]]
 +
|style="vertical-align: top;" | '''FM36YX'''
 +
[[File:Fm3612.png|140px]]
 +
|style="vertical-align: top;" | '''FMx650'''
 +
[[File:547x437 FMC650.png|170px]]
 
|}
 
|}
| style="height:5%; width:20%; text-align:center; vertical-align: top; font-weight:400; margin: 0 auto;" |
+
<br><br>
{| style="width: 70%"
+
'''Please''' check [https://wiki.teltonika-gps.com/view/Firmware_versions Firmware Link] to find latest base firmware for your device.
![[Image:Easy_2.png|77x77px|link=|alt=]]
 
|-
 
|'''Fast & Easy Trackers'''
 
|-
 
|Fast installation and accurate tracking
 
|-
 
!<div class="mw-customtoggle-2" style="margin:0 auto; vertical-align: middle; text-align: center; overflow:auto;">
 
'''Product list [+/-]''' <span class="mw-collapsible mw-collapsed" id="mw-customcollapsible-2"> <Br>{{Template:Fast_&_Easy_Trackers}}</span>
 
</div>
 
|-
 
|}
 
| style="height:5%; width:20%; text-align:center; vertical-align: top; font-weight:400; margin: 0 auto;" |
 
{| style="width: 70%"
 
![[Image:Advanced.png|74x74px|link=|alt=]]
 
|-
 
|'''Advanced Trackers'''
 
|-
 
|Flexible and sophisticated all-rounders
 
|-
 
!<div class="mw-customtoggle-3" style="margin:auto; vertical-align: middle; text-align: center; overflow:auto; ">
 
'''Product list [+/-]''' <span class="mw-collapsible mw-collapsed" id="mw-customcollapsible-3"> <Br>{{Template:Advanced_Trackers}}</span>
 
</div>
 
|-
 
|}
 
|}
 
  
{| class="main-table w-100" style="height:auto; width:80%;" align="center"
+
=='''Network requirements'''==
| style="height:5%; width:20%; text-align:center; vertical-align: top; font-weight:400; margin: 0 auto;" |
+
'''<big>Default FOTA WEB configuration settings</big>'''
{| style="width: 70%"
 
![[Image:OBD Trackers-8.png|69x69px|link=|alt=]]
 
|-
 
|'''OBD Trackers'''
 
|-
 
|Compact Plug & Play models to read OBD II data
 
|-
 
!<div class="mw-customtoggle-4" style="margin:0 auto; vertical-align: middle; text-align: center; overflow:auto;">
 
'''Product list [+/-]''' <span class="mw-collapsible mw-collapsed" id="mw-customcollapsible-4"> <Br>{{Template:OBD_Trackers}}</span>
 
</div>
 
|-
 
|}
 
| style="height:5%; width:20%; text-align:center; vertical-align: top; font-weight:400; margin: 0 auto;" |
 
{| style="width: 70%"
 
![[Image:CAN Trackers & Adapters-8.png|69x69px|link=|alt=]]
 
|-
 
|'''CAN Trackers'''
 
|-
 
|Provide CAN bus data for all vehicle types
 
|-
 
!<div class="mw-customtoggle-5" style="margin:0 auto; vertical-align: middle; text-align: center; overflow:auto;">
 
'''Product list [+/-]'''  <span class="mw-collapsible mw-collapsed" id="mw-customcollapsible-5"> <Br>{{Template:CAN_Trackers}}</span>
 
</div>
 
|-
 
|}
 
| style="height:5%; width:20%; text-align:center; vertical-align: top; font-weight:400; margin: 0 auto;" |
 
{| style="width: 70%"
 
![[Image:Professional.png|74x74px|link=|alt=]]
 
|-
 
|'''Professional Trackers'''
 
|-
 
|Comprehensive solutions for professional use
 
|-
 
!<div class="mw-customtoggle-6" style="margin:0 auto; vertical-align: middle; text-align: center; overflow:auto;">
 
'''Product list [+/-]''' <span class="mw-collapsible mw-collapsed" id="mw-customcollapsible-6"> <Br>{{Template:Professional_Trackers}}</span>
 
</div>
 
|-
 
|}
 
|}
 
<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>
+
'''Domain:''' fm.teltonika.lt<br />
<br>
+
'''Port:''' 5000 <br />
 +
'''Period:''' 720 minutes (every 720 minutes device shall connect to FOTA WEB)<br />
 +
[[Image:Defaultwebft.png|400px|center]]<br />
  
=='''Network requirements'''==
+
<big>'''Using VPN SIM cards'''</big>
  
 
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:
 
  
*Domain: fm.teltonika.lt
+
*IP: 35.156.7.140
*Ports:
 
**5000 (TCP)
 
**6000 (TCP)
 
Network requirements for FT devices:
 
*Domain: fota.teltonika.lt
 
 
*Ports:
 
*Ports:
**5055 (UDP)
+
**2000<br />
**5005 (TCP)
+
**3000<br />
 +
**4000<br />
 +
**5000<br />
 +
**6000<br />
 +
**7000<br />
  
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 125: Line 70:
 
|-
 
|-
 
| style="width: 30%; border: 1px solid white; background: white;" |'''1.''' Invitation for FOTA WEB is being delivered to user e-mail. Press the URL to create a password for your account.
 
| style="width: 30%; border: 1px solid white; background: white;" |'''1.''' Invitation for FOTA WEB is being delivered to user e-mail. Press the URL to create a password for your account.
| style="width: 30%; border: 1px solid white; background: white; " |'''2.''' After pressing the URL Link you will be asked to create a password for your account.
+
| style="width: 30%; border: 1px solid white; background: white; " |'''2.''' After pressing the URL Link you will be asked to write your password for Your account.
| style="width: 30%; border: 1px solid white; background: white; " |'''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.
+
| style="width: 30%; border: 1px solid white; background: white; " |'''3.''' Last step is logging in FOTA WEB with your newly created account by entering e-mail address and password for your account. Email address is the same as where you've received the invitation.
 
|-
 
|-
| style="width: 30%; border: 1px solid white; background: white; text-align: center;" |[[File:FOTA Invitation.PNG|350px|center]]
+
| style="width: 30%; border: 1px solid white; background: white; text-align: center;" |[[File:FOTAInvitation.PNG|350px|center]]
 
| style="width: 30%; border: 1px solid white; background: white; text-align: center;" |[[File:FOTA Web Password.PNG|350px|center]]
 
| style="width: 30%; border: 1px solid white; background: white; text-align: center;" |[[File:FOTA Web Password.PNG|350px|center]]
 
| style="width: 30%; border: 1px solid white; background: white; text-align: center;" |[[File:FOTA Web Log in.PNG|350px|center]]
 
| style="width: 30%; border: 1px solid white; background: white; text-align: center;" |[[File:FOTA Web Log in.PNG|350px|center]]
Line 136: Line 81:
 
=='''Select company'''==
 
=='''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:
+
At the top-right corner you can find '''All Companies''' button. Pressing it will open a window with a list of all Main and Sub companies. There you can select each company and filter their information such as devices, tasks and files like configuration, firmwares or cerfiticates.
 
 
*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. <br>
 
'''Note''': Every company has to be selected individually.
 
  
 +
'''Note:''' If main company is selected it will only show devices that are assigned to that company and will not include the sub companies. Every company is selected individually.
 
[[File:FOTA Web Allcompanies.png]]
 
[[File:FOTA Web Allcompanies.png]]
  
Line 150: Line 91:
 
[[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:
 
  
'''Scheduled Updates''' - Devices should follow a configured schedule on your devices to avoid overwhelming the system.
+
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===
  
'''Staggered Deployment''' - Minimize simultaneous "web_connect" requests from multiple devices to maintain optimal system responsiveness and prevent peak server loads.
+
In the settings tab window you can select your preferred language.
 +
Currently there are 6 available languages:
 +
* English
 +
* Lithuanian
 +
* Russian
 +
* Spanish
 +
* Portuguese
 +
* France
  
By adhering to these guidelines, you can maximize the efficiency and reliability of your device's updates using FOTA WEB.
+
===API tokens===
<br />
+
 
 +
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 current password is too difficult to remember or not difficult enough 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 Sign Up window you can click forgot password. It will generate a link for resetting password and send it to your E-Mail address and from there you will only have to enter a new password.
 +
 
 +
===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'''.
 +
 
 +
[[File:FOTA Web Timezone.png|300px]]
 +
 
 +
<br>
 +
Next chapter '''[https://wiki.teltonika-gps.com/view/Dashboard <u>Dashboard</u>]'''

Revision as of 10:40, 7 June 2023

Device requirements

Alert.png

IMPORTANT!!! 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)
Supported Devices
FMB9YX

FMB900 460x264.png

FMB96X

FMB96X 540 264.png

FMB1YX

FMB125 600x448.png

FMB0YX

FMB003-4000x4000-5.png

FMB64X

450x433 FMB640.png

TMT250

TMT250 small t.png

FMT100

FMT100-01.png

FM36YX

Fm3612.png

FMx650

547x437 FMC650.png



Please check Firmware Link to find latest base firmware for your device.

Network requirements

Default FOTA WEB configuration settings

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

Defaultwebft.png


Using VPN SIM cards

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 write your password for Your account. 3. Last step is logging in FOTA WEB with your newly created account by entering e-mail address and password for your account. Email address is the same as where you've received the invitation.
FOTA Web Password.PNG
FOTA Web Log in.PNG

Select company

At the top-right corner you can find All Companies button. Pressing it will open a window with a list of all Main and Sub companies. There you can select each company and filter their information such as devices, tasks and files like configuration, firmwares or cerfiticates.

Note: If main company is selected it will only show devices that are assigned to that company and will not include the sub companies. Every company is 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 current password is too difficult to remember or not difficult enough 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 Sign Up window you can click forgot password. It will generate a link for resetting password and send it to your E-Mail address and from there you will only have to enter a new password.

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


Next chapter Dashboard