Difference between revisions of "What debug information should be collected?"

From Wiki Knowledge Base | Teltonika GPS
 
(15 intermediate revisions by 4 users not shown)
Line 2: Line 2:
  
 
=='''<big>Introduction</big>'''==
 
=='''<big>Introduction</big>'''==
−
<big>This is a guide meant for technicians looking to optimize their work.</big>
+
<big>Efficiency is the ability to avoid wasting materials, energy, efforts, money, and time in doing something or in producing a desired result. Technical support department desired result is a resolved query, which leads to Your satisfaction.</big>
  
−
<big>Read it carefully if you want to learn what troubleshooting information you should consider getting about/from our devices before registering an issue with our technical support team.</big>
 
  
−
<big>Below you will also find a guide on how to get this information quickly and what you should consider.</big>
+
<big>This guide will walk you through the process what information helps answer queries more efficiently and accelerate the process of solving any questions you might have. Time will not be spent in search of details required to solve a query and this way You will save from 2 to 3 days of time.</big>
  
  
−
===Essential information===
+
<big>In the next page you can find a table with needed information in Query and instructions on how to gather that information.</big>
−
''The following will provide us with the minimum information, needed to start solving the issue:''
 
−
====What is the Device model====
 
  
−
====Configuration file====
+
<br />
−
====Firmware/Configurator Versions====
+
=Steps=
 +
'''1. Gather information about the issue, what is the Device model, Configuration, Firmware/Configurator'''
  
 +
Device: FMB0X0/FMB1XY/FMB920/FMB640 etc.;
  
−
''Example''
+
Configuration: Attach configuration file
  
−
'''Device:''' FMB0X0/FMB1XY/FMB920/FMB640 etc.;
+
Firmware version: 03.XX.YY.Rev.ZZ
  
−
'''Configuration:''' Attach configuration file
+
Status information: responses to relevant SMS/GPRS commands
  
−
'''Firmware version:''' 03.XX.YY.Rev.ZZ,
+
'''Provide IMEI and GSM number of 1-3 devices with the issue'''
  
−
'''Status information:''' responses to relevant SMS/GPRS commands
 
  
−
'''IMEI and GSM numbers:''' See file attached
+
'''2. Specify the number of devices and how often the issue repeats'''
  
 +
Repeating: Often/Randomly/Everyday/There is a pattern/Under certain conditions;
  
−
When dealing with issues inside the configurator software:
+
'''If the Repeating is specified as “Under certain conditions”–write on how to repeat those conditions'''
  
−
'''Configurator version:''' Teltonika.Configurator_1.XX.YY.ZZZZZ
 
  
−
<br />
+
'''3. Provide additional information'''
  
−
===Conditional information===
+
Log files - Provide live information when the issue is happening. They can be taken via the Configurator.
−
''The number of devices will help us to evaluate/assign the priority of the case while the type of the issue and understand the situation better and select the best course of action for solving it. '''Conditional information is consisted of:'''''
 
  
−
====Number of devices====
+
Dump files - Provide files that the device logged automatically. You have to make sure to take them from FOTA WEB or Configurator
−
====Type of the issue/How often the issue repeats:====
 
−
'''Repeating:''' Often/Randomly/Every day/There is a pattern/Under certain conditions;
 
  
−
If the Repeating is specified as “There is a pattern/Under certain conditions” – write on how to repeat the pattern/conditions.
 
  
 +
'''*If you cannot gather information from one of the steps, they can be skipped however inform the engineer in the query'''
  
−
''Example''
+
<br />
 +
{| class="nd-othertables_2" style="width:100%;"
 +
! rowspan="1" style="width:10%; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |'''Information'''
 +
! rowspan="1" style="width:10%; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |'''How to get it'''
 +
! rowspan="1" style="width:10%; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |'''Why we need it'''
 +
! rowspan="1" style="width:10%; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |'''Example'''
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |'''Device information'''
 +
| style="vertical-align: middle; text-align: center;" |This information has to be gathered from your  platform or your system which monitors devices
 +
| style="vertical-align: middle; text-align: center;" |It will help to understand the scale of the issue  and also find the cause more quickly by finding the connection between  affected devices.
 +
| style="vertical-align: middle; text-align: center;" |Number  and model of affected device: 2 devices of FMB001
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |'''Firmware version'''
 +
| style="vertical-align: middle; text-align: center;" |[[FMB getver|SMS command]]
 +
[[FMB920 Status info|Configurator]]
  
−
'''Number of devices:''' We have received a new shipment of 1,000 pcs, and 1 of them is behaving strangely.
+
[[Devices|FOTA WEB]]
 +
| style="vertical-align: middle; text-align: center;" |The firmware version will allow us to analyze if the  said issue was not already fixed in a newer firmware version,
 +
| style="vertical-align: middle; text-align: center;" |Firmware: 03.25.15.Rev.05
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |'''Configuration'''
 +
| style="vertical-align: middle; text-align: center;" |Configuration can be downloaded directly from device  through FOTA WEB, FOTA or [[Teltonika Configurator|Configurator]].
 +
<br />
 +
| style="vertical-align: middle; text-align: center;" |The configuration used on the device allows us to  analyze if the issue is not caused by improperly configured settings or  features.
 +
| style="vertical-align: middle; text-align: center;" |Attach the device configuration to Query.
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |'''How to repeat'''
 +
| style="vertical-align: middle; text-align: center;" |Monitor the devices on the server and provide  information, under which conditions issue occurs.
 +
| style="vertical-align: middle; text-align: center;" |It will help the engineer better understand the  conditions and how to repeat it personally, which will lead to a faster  solution.
 +
| style="vertical-align: middle; text-align: center;" |Device goes into Deep Sleep, when device wakes up  from Accelerometer, event (Movement AVL I/O ID 240) is not sent to server.
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |'''Log files'''
 +
| style="vertical-align: middle; text-align: center;" |They can be taken  via the Configurator [[FMB920 Status info#Maintenance|Maintenance tab]] or via Terminal.
 +
| style="vertical-align: middle; text-align: center;" |The logs allow  the engineers to provide you with initial insights into your issue with first  response.
 +
| style="vertical-align: middle; text-align: center;" |Attach the taken Log file to Query.
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |'''Dump files'''
 +
| style="vertical-align: middle; text-align: center;" |You have to make sure to take them from [[FMB920 Status info#Maintenance|Configurator Maintenance tab]] or FOTA WEB after issue happened. '''And take them not more than 2 or 3 hours after the issue otherwise device overwrites those  files.'''
 +
| style="vertical-align: middle; text-align: center;" |The dump files  allow the engineers to provide you with initial insights into your issue with  first response.
 +
| style="vertical-align: middle; text-align: center;" |Attach the taken Dump files from FOTA WEB or  Configurator to Query.
 +
|-
 +
| style="vertical-align: middle; text-align: center;" |'''Status information'''
 +
| style="vertical-align: middle; text-align: center;" |SMS/GPRS commands such as
  
−
'''Type of issue:''' Repeats under certain conditions - the device goes into Deep Sleep when the device wakes up from Accelerometer, event (Movement AVL I/O ID 240) is not sent to the server.
+
[[FMB getinfo|''getinfo'']] [[FMB getver|''getver'']] [[FMB getstatus|''getstatus'']] [[FMB getgps|''getgps'']] can be used to provide valuable information.
 +
| style="vertical-align: middle; text-align: center;" |Depending on the issue, Status information will  allow us to analyze the issue more quickly and possibly provide a solution  immediately.
 +
| style="vertical-align: middle; text-align: center;" |SMS responses to [[FMB getver|''getver'']] from device:
  
 +
Ver:02.00.01_06 GPS:AXN_3.80_3333_16070400,0000,, Hw:FMB120  Mod:4 IMEI:352094082042885 Init: 2017-6-16 5:54 Uptime: 16574  MAC:002E43912EF7 SPC:0(0) AXL:0 OBD:0 BL:1.6 BT:4
 
<br />
 
<br />
−
 
+
|}
−
===Provide Advanced and additional information===
 
−
''The log/DUMP files allow the engineers to provide you with initial '''insights into your issue with the first response.''' Invest a few minutes of your time to get the log/DUMP files containing the issue to have the solution ASAP. '''Advanced and additional information is consisted of:'''''
 
−
 
 
−
====DUMP/LOG files====
 
−
Dump files - Provide files that the device logged automatically. They are useful if the issue happened already and not more then 3 hours passed after.
 
−
 
 
−
Log files - Provide live information when the issue is happening. They are useful when the device is currently having the issue or you can replicate it with log running.
 
−
 
 
−
====Raw server data====
 
−
RAW data in Hex is preferred, you should also specify the exact time when the issue in data can be seen (For example 2020.02.24 10:00 AM GMT +0 until 2020.02.24 13:00 PM GMT +0).
 
−
 
 
−
====Other relevant information====
 
−
What has been done to try and fix the issue
 
−
 
 
−
 
 
−
<big><br /></big>
 
−
''Example''
 
−
 
 
−
Please find logs and server data attached. We have tried to disable static navigation via setparam command to see if the device filters out the positions due to incorrect ignition, we will investigate if it helped.
 
−
 
 
−
 
 
−
 
 
  
 
=='''How to get Debug Information'''==
 
=='''How to get Debug Information'''==
Line 82: Line 98:
 
If you correctly perform all the steps and describe the issue clearly there is a high chance that we can solve it on our first reply. [[File:taking logs cfg and dumps.gif|center]]
 
If you correctly perform all the steps and describe the issue clearly there is a high chance that we can solve it on our first reply. [[File:taking logs cfg and dumps.gif|center]]
  
−
1.Open up your device via configurator and go to Status -> Maintenance window
+
1. Open up your device via configurator and go to Status -> Maintenance window
  
−
2.Click "Dump" to take the information from the device containing logs from the past that device made automatically. If the issue happened 2-3 hours ago we will see it in these files.  
+
2. Click "Dump" to take the information from the device containing logs from the past that device made automatically. If the issue happened 2-3 hours ago we will see it in these files.  
  
 
Note 2.1: If the device is installed in a vehicle and deployed in the field you can use FOTA WEB to download these files remotely.
 
Note 2.1: If the device is installed in a vehicle and deployed in the field you can use FOTA WEB to download these files remotely.
  
−
3.If you want to repeat the issue now, you can use logging functionality accessed in the same window. Just start logging by clicking "Log" replicate the issue and when the log ends attach it to the query. When logs are made they export your current configuration as well.
+
3. If you want to repeat the issue now, you can use logging functionality accessed in the same window. Just start logging by clicking "Log" replicate the issue and when the log ends to attach it to the query. When logs are made they export your current configuration as well.
  
 
Note 3.1: For example, you should send SMS during the logging period if you claim that your device is not receiving SMS.
 
Note 3.1: For example, you should send SMS during the logging period if you claim that your device is not receiving SMS.
  
−
Note 3.2: For troubleshooting remote vehicles download DUMP files via fota and download them as soon as possible after replicating the issue.
+
Note 3.2: For troubleshooting remote vehicles download DUMP files via FOTA and download them as soon as possible after replicating the issue.
  
 
4.After the logging is done  "Open directory" button in the configurator to find your DUMP and LOG+CFG files.  
 
4.After the logging is done  "Open directory" button in the configurator to find your DUMP and LOG+CFG files.  
  
−
5.If you have not made a log file in step 3, export your configuration file by using the "Save to file" button.
+
5. If you have not made a log file in step 3, export your configuration file by using the "Save to file" button.
 +
 
 +
Note 5.1: In the GIF file is save to Documents folder for quick access by pressing the "Open directory" button in the configurator.
 +
 
 +
=='''Log capturing using terminal'''==
 +
[[File:Devicemanager COM1.png|right]]
  
−
Note 5.1:In the GIF file is save to Documents folder for quick access by pressing the "Open directory" button in the configurator.
+
<p>All our devices are able to transmit their current state when they are connected to PC using USB cable.
 +
</p><p>Log file is used to detect errors and provide information when device is operating unexpectedly.<br />
 +
</p><p>Required Terminal application for log capturing can be downloaded here: [https://appdb.winehq.org/objectManager.php?sClass=version&iId=23025 Terminal]
 +
<br />
 +
</p><p>After connecting device to PC, it creates two ports:
 +
<br />
 +
<br />
 +
<br />
 +
</p>
 +
<ul><li><b>USB Debug Port</b> - used for modem trace.</li>
 +
<li><b>USB Modem Port</b> - used for <b>terminal log</b>.</li></ul>
 +
<p><br />
 +
<br />
 +
<br />
 +
</p><p>If connected device is not recognized by PC, please install appropriate drivers.<br />
 +
Download Teltonika COM port driver from the link: [https://wiki.teltonika-gps.com/images/d/d0/TeltonikaCOMDriver.zip COM port driver]
 +
<br />
 +
<br />
 +
</p>
 +
<table class="wikitable" style="background: #0054A6; color: black; border: 2px #0054A6; border-bottom: 1px solid #0054A6;border-top: 1px solid #0054A6;border-left: 1px solid #0054A6;border-right: 1px solid #0054A6;">
 +
<caption>
 +
</caption>
 +
<td style="width: auto; text-align: left; border: 1px solid #0054A6; border-bottom: 1px solid #0054A6; background: #0054A6; color: white;"><b>NOTE:</b>
 +
</td>
 +
<td style="width: auto; text-align: left; border: 1px solid #0054A6; border-bottom: 1px solid #0054A6; background: white;">
 +
[[File:390px-BaseCOM.png|right]]
 +
<p><br />
 +
<br /><br /><br />
 +
</p>
 +
<ul><li>Additionally, you can find your port when opening configurator.</li>
 +
<li>Do not forget to leave configurator in first page as shown in the example, because while device configuration page is open, you will not be able to start your logging process.</li></ul>
 +
</td></tr></table>
 +
<p><b>Follow these steps to start log:</b>
 +
</p>
 +
<ul><li>select COM port;</li>
 +
<li>select the baud rate;</li>
 +
<li>handshaking parameters;</li>
 +
<li>click connect and "<b>Start Log</b>" button.</li></ul>
 +
<p>If log is not running, please send .log:1 command (see picture below). Now you are able to monitor all internal processes happening in the device. All logged process is saved in the txt file.<br />
 +
<b>Note</b>: Send command .log:0 to stop logging.
 +
</p>
 +
[[File:Terminal log.png|center]]
  
 
=='''Quick links'''==
 
=='''Quick links'''==
Line 104: Line 166:
  
 
[[FMB_SMS/GPRS_Commands|FMB SMS/GPRS command list]]
 
[[FMB_SMS/GPRS_Commands|FMB SMS/GPRS command list]]
−
 
−
[[FMB_AVL_ID|FMB parameter list]]
 
  
 
[[Codec|Protocols]]
 
[[Codec|Protocols]]
−
 
−
 
−
 
 

Latest revision as of 14:27, 16 February 2023

Introduction

Efficiency is the ability to avoid wasting materials, energy, efforts, money, and time in doing something or in producing a desired result. Technical support department desired result is a resolved query, which leads to Your satisfaction.


This guide will walk you through the process what information helps answer queries more efficiently and accelerate the process of solving any questions you might have. Time will not be spent in search of details required to solve a query and this way You will save from 2 to 3 days of time.


In the next page you can find a table with needed information in Query and instructions on how to gather that information.


Steps

1. Gather information about the issue, what is the Device model, Configuration, Firmware/Configurator

Device: FMB0X0/FMB1XY/FMB920/FMB640 etc.;

Configuration: Attach configuration file

Firmware version: 03.XX.YY.Rev.ZZ

Status information: responses to relevant SMS/GPRS commands

Provide IMEI and GSM number of 1-3 devices with the issue


2. Specify the number of devices and how often the issue repeats

Repeating: Often/Randomly/Everyday/There is a pattern/Under certain conditions;

If the Repeating is specified as “Under certain conditions”–write on how to repeat those conditions


3. Provide additional information

Log files - Provide live information when the issue is happening. They can be taken via the Configurator.

Dump files - Provide files that the device logged automatically. You have to make sure to take them from FOTA WEB or Configurator


*If you cannot gather information from one of the steps, they can be skipped however inform the engineer in the query


Information How to get it Why we need it Example
Device information This information has to be gathered from your platform or your system which monitors devices It will help to understand the scale of the issue and also find the cause more quickly by finding the connection between affected devices. Number and model of affected device: 2 devices of FMB001
Firmware version SMS command

Configurator

FOTA WEB

The firmware version will allow us to analyze if the said issue was not already fixed in a newer firmware version, Firmware: 03.25.15.Rev.05
Configuration Configuration can be downloaded directly from device through FOTA WEB, FOTA or Configurator.


The configuration used on the device allows us to analyze if the issue is not caused by improperly configured settings or features. Attach the device configuration to Query.
How to repeat Monitor the devices on the server and provide information, under which conditions issue occurs. It will help the engineer better understand the conditions and how to repeat it personally, which will lead to a faster solution. Device goes into Deep Sleep, when device wakes up from Accelerometer, event (Movement AVL I/O ID 240) is not sent to server.
Log files They can be taken via the Configurator Maintenance tab or via Terminal. The logs allow the engineers to provide you with initial insights into your issue with first response. Attach the taken Log file to Query.
Dump files You have to make sure to take them from Configurator Maintenance tab or FOTA WEB after issue happened. And take them not more than 2 or 3 hours after the issue otherwise device overwrites those files. The dump files allow the engineers to provide you with initial insights into your issue with first response. Attach the taken Dump files from FOTA WEB or Configurator to Query.
Status information SMS/GPRS commands such as

getinfo getver getstatus getgps can be used to provide valuable information.

Depending on the issue, Status information will allow us to analyze the issue more quickly and possibly provide a solution immediately. SMS responses to getver from device:

Ver:02.00.01_06 GPS:AXN_3.80_3333_16070400,0000,, Hw:FMB120 Mod:4 IMEI:352094082042885 Init: 2017-6-16 5:54 Uptime: 16574 MAC:002E43912EF7 SPC:0(0) AXL:0 OBD:0 BL:1.6 BT:4

How to get Debug Information

Follow these quick steps to get all the necessary debug information in just over 10 minutes.

If you correctly perform all the steps and describe the issue clearly there is a high chance that we can solve it on our first reply.

Taking logs cfg and dumps.gif

1. Open up your device via configurator and go to Status -> Maintenance window

2. Click "Dump" to take the information from the device containing logs from the past that device made automatically. If the issue happened 2-3 hours ago we will see it in these files.

Note 2.1: If the device is installed in a vehicle and deployed in the field you can use FOTA WEB to download these files remotely.

3. If you want to repeat the issue now, you can use logging functionality accessed in the same window. Just start logging by clicking "Log" replicate the issue and when the log ends to attach it to the query. When logs are made they export your current configuration as well.

Note 3.1: For example, you should send SMS during the logging period if you claim that your device is not receiving SMS.

Note 3.2: For troubleshooting remote vehicles download DUMP files via FOTA and download them as soon as possible after replicating the issue.

4.After the logging is done "Open directory" button in the configurator to find your DUMP and LOG+CFG files.

5. If you have not made a log file in step 3, export your configuration file by using the "Save to file" button.

Note 5.1: In the GIF file is save to Documents folder for quick access by pressing the "Open directory" button in the configurator.

Log capturing using terminal

Devicemanager COM1.png

All our devices are able to transmit their current state when they are connected to PC using USB cable.

Log file is used to detect errors and provide information when device is operating unexpectedly.

Required Terminal application for log capturing can be downloaded here: Terminal


After connecting device to PC, it creates two ports:




  • USB Debug Port - used for modem trace.
  • USB Modem Port - used for terminal log.




If connected device is not recognized by PC, please install appropriate drivers.

Download Teltonika COM port driver from the link: COM port driver

NOTE:
390px-BaseCOM.png





  • Additionally, you can find your port when opening configurator.
  • Do not forget to leave configurator in first page as shown in the example, because while device configuration page is open, you will not be able to start your logging process.

Follow these steps to start log:

  • select COM port;
  • select the baud rate;
  • handshaking parameters;
  • click connect and "Start Log" button.

If log is not running, please send .log:1 command (see picture below). Now you are able to monitor all internal processes happening in the device. All logged process is saved in the txt file.
Note: Send command .log:0 to stop logging.

Terminal log.png

Quick links

FAQ

FMB SMS/GPRS command list

Protocols

Retrieved from "https://wiki.teltonika-gps.com/index.php?title=What_debug_information_should_be_collected%3F&oldid=80209"