Jump to content

Terminal: Difference between revisions

From Teltonika Telematics Wiki
 
(14 intermediate revisions by the same user not shown)
Line 40: Line 40:
# Terminal tool can be launched in TCT start-up window or after connecting to the FTx platform device.
# Terminal tool can be launched in TCT start-up window or after connecting to the FTx platform device.
# To connect FTx platform device. Make sure that the device is connected to your computer and in Terminal tool press the “+” button on the left side of Terminal tool UI for a new connection, select the device from the dropdown list, and select the “Debug” port.
# To connect FTx platform device. Make sure that the device is connected to your computer and in Terminal tool press the “+” button on the left side of Terminal tool UI for a new connection, select the device from the dropdown list, and select the “Debug” port.
{| class="nd-othertables_2"
|+
! style="width: 200px; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: left;" | SERIAL COMMANDS
! style="width: 500px; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: left;" | DESCRIPTION
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | .info
| style="text-align: left; vertical-align: top;" | Returns device and firmware information
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | .reset
| style="text-align: left; vertical-align: top;" | Asks watchdog to instantly reset software
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @chrg_info
| style="text-align: left; vertical-align: top;" | Reads the battery charge level and checks the charging status
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @gps_pos
| style="text-align: left; vertical-align: top;" | Gets device GPS location
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @gps_nmea:<Value>
| style="text-align: left; vertical-align: top;" | Enables/Disables NMEA logging:
Values:
? - Print current status
0 - Disable NMEA output
1 - Enable NMEA output
2 - Enable NMEA logging to file delete - Delete NMEA log files
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @rec_count
| style="text-align: left; vertical-align: top;" | Shows the number of saved records
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @rec_deleteall
| style="text-align: left; vertical-align: top;" | Deletes all records from device memory
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @rec_send:<amount>
| style="text-align: left; vertical-align: top;" | Sends the specified number of records to the server
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @rec_save:<priority>
| style="text-align: left; vertical-align: top;" | Generates and saves record with selected priority
low - selects low priority for record generation
high - selects high priority for record generation
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @rec_save_io:<avl_id>
| style="text-align: left; vertical-align: top;" | Generates and saves eventual record as if specified IO element would have generated it
|-
! style="border-bottom: 1px solid #E8E8E8; vertical-align: top; text-align: left; color: black;" | @vfs_stat
| style="text-align: left; vertical-align: top;" | Provides information about internal device memory size and usage
|-


=== Converting internal device binary logs ===
=== Converting internal device binary logs ===
With 2.0.0 or later TCT version Terminal Tool can even convert internal device binary logs into human-readable text, enabling in-depth analysis of the device's previous behavior. When downloading logs (dump) from the FTx device using TCT, you will find both .bin and .txt files of the logs.
With 2.0.0 or later TCT version Terminal Tool can even convert internal device binary logs into human-readable text, enabling in-depth analysis of the device's previous behavior. When downloading logs (dump) from the FTx device using TCT, you will find both .bin and .txt files of the logs.
'''NOTES'''
Terminal is available in TCT desktop version only.
=== Terminal commands ===
|}

Latest revision as of 12:38, 23 April 2025

The Telematics Configuration Tool (TCT) introduces an easier way to debug FTx platform devices – Terminal tool. This new feature allows you to monitor their connected device actions and find possible issues related to the device’s functionality without using third-party tools.

Launching Terminal tool (Debug port) and connecting FTx device

Where to find terminal

Connecting to the "Debug" port allows you to read and save raw debug output directly from the connected device, providing valuable insights into its operation.

  1. To launch Terminal tool. At the top of the TCT window, click on “Settings” button and click then “Terminal”.
  2. Terminal tool can be launched in TCT start-up window or after connecting to the FTx platform device.
  3. To connect FTx platform device. Make sure that the device is connected to your computer and in Terminal tool press the “+” button on the left side of Terminal tool UI for a new connection, select the device from the dropdown list, and select the “Debug” port.
Connect terminal to the device
Note: Only one connection is available at the same time.
If everything is done correctly, you should see debug messages coming from the connected device.















Saving debug log into a file

Terminal tool holds about 500-1000 lines of debug messages in TCT UI, so if you want to gather more messages, we suggest saving debug messages into a file.

  1. When the debug messages are coming from the connected device, press “Save” icon on the right side of Terminal tool UI.
  2. Set a log file name and location where it should be saved.
  3. Debug messages will be saved into a file until the device is disconnected. For example, disconnecting the device using “Close” button next to the device connection.

Start/Pause log

When the debug messages are coming from the connected device, you can pause and resume incoming messages whenever you like using “Start/Pause” button on the right side of Terminal tool UI.

Note: If you are saving the debug log into a file, “Start/Pause” button doesn’t stop the log gathering in the file.

Resizing Terminal tool

For your convenience, Terminal tool can be resized using a button in the middle of Terminal tool window.

Minimizing Terminal tool

If Terminal tool takes too much of your screen real estate, at any given time you can minimize it using “Minimize” button on the right side of Terminal tool UI. Minimizing Terminal tool doesn’t stop debug messages logging.

Launching Terminal tool (Device port) and connecting FTx device

Connecting to the "Device" port allows you to send commands to the connected device and receive instant responses, allowing for precise troubleshooting.

  1. To launch Terminal tool. At the top of the TCT window, click on “Settings” button and click then “Terminal”.
  2. Terminal tool can be launched in TCT start-up window or after connecting to the FTx platform device.
  3. To connect FTx platform device. Make sure that the device is connected to your computer and in Terminal tool press the “+” button on the left side of Terminal tool UI for a new connection, select the device from the dropdown list, and select the “Debug” port.

Converting internal device binary logs

With 2.0.0 or later TCT version Terminal Tool can even convert internal device binary logs into human-readable text, enabling in-depth analysis of the device's previous behavior. When downloading logs (dump) from the FTx device using TCT, you will find both .bin and .txt files of the logs.

NOTES

Terminal is available in TCT desktop version only.

Terminal commands

SERIAL COMMANDS DESCRIPTION
.info Returns device and firmware information
.reset Asks watchdog to instantly reset software
@chrg_info Reads the battery charge level and checks the charging status
@gps_pos Gets device GPS location
@gps_nmea:<Value> Enables/Disables NMEA logging:

Values: ? - Print current status

0 - Disable NMEA output

1 - Enable NMEA output

2 - Enable NMEA logging to file delete - Delete NMEA log files


@rec_count Shows the number of saved records
@rec_deleteall Deletes all records from device memory
@rec_send:<amount> Sends the specified number of records to the server
@rec_save:<priority> Generates and saves record with selected priority

low - selects low priority for record generation

high - selects high priority for record generation

@rec_save_io:<avl_id> Generates and saves eventual record as if specified IO element would have generated it
@vfs_stat Provides information about internal device memory size and usage