Garmin-FMI Manage Tool User Guide

Garmin-FMI
Manage Tool User Guide
TRACGarminMT001
Version: 1.06

TRACGarminMT001 - 0 -
Garmin-FMI Manage Tool User Guide

Document Title Garmin-FMI Manage Tool User Guide

Version 1.06

Date 2016-08-04

Status Release

Document Control ID TRACGarminMT001

General Notes

k
Queclink offers this information as a service to its customers, to support application and

n
engineering efforts that use the products designed by Queclink. The information provided is

i
based upon requirements specifically provided to Queclink by the customers. Queclink has not

l l
undertaken any independent search for additional relevant information, including any

c a
information that may be in the customer’s possession. Furthermore, system validation of this

i
product designed by Queclink within a larger electronic system remains the responsibility of the

e t
customer or the customer’s system integrator. All specifications supplied herein are subject to

u
change.

Q fide n
Copyright
This document contains proprietary technical information which is the property of Queclink
Wireless Solutions Co., Ltd. The copying of this document, distribution to others, and
communication of the contents thereof, are forbidden without express authority. Offenders are
liable to the payment of damages. All rights are reserved in the event of a patent grant or

n
registration of a utility model or design. All specifications supplied herein are subject to change
without notice at any time.

Co

TRACGarminMT001 - 1 -
Garmin-FMI Manage Tool User Guide

Contents

Contents ............................................................................................................................................ 2
0. Revision History ............................................................................................................................. 3
1. GARMIN-FMI Manage Tool Interface ............................................................................................ 4
1.1. System Requirements .......................................................................................................... 4
1.2. COM Setting ........................................................................................................................ 4
1.3. Professional Setting Windows ............................................................................................. 5
1.3.1. Title Bar ..................................................................................................................... 5
1.3.2. Menus ........................................................................................................................ 5

k
1.3.2.1. Start Menu ............................................................................................................................ 5

n
1.3.2.2. Tool Menu.............................................................................................................................. 6

i
1.3.2.3. Help Menu ............................................................................................................................. 7

l l
1.3.3. Toolbar ....................................................................................................................... 7

c
1.3.4. Status Bar................................................................................................................... 8

ia
1.3.5. Command Browser and Command Operation Space ................................................ 8

e t
1.3.5.1. Command Browser ............................................................................................................... 8
1.3.5.2. Command Operation Space ................................................................................................. 10

u n
1.4. Operation Result Interface ................................................................................................ 10
1.4.1. Operation Successful Interface ................................................................................ 10

Q fide
1.4.2. Operation Failed Interface ....................................................................................... 11
2. Operation Instructions ................................................................................................................ 12
2.1. Configuration in Professional Setting Mode ...................................................................... 12
2.2. Read/Save All Configurations ............................................................................................ 12

n
2.3. Load/Send All Configurations ............................................................................................ 14

Co

TRACGarminMT001 -2-
Garmin-FMI Manage Tool User Guide

0.Revision History

Version Date Author Description of Change

1.00 2012-11-28 Cindy Chen 1. Initial.
1.01 2014-03-07 Happy Peng 1. Added Protocol Version to “About” interface.
2. Added parameters <Auto Enable> and
<Command Store Mask> in the command
GTFMI-0.
1.02 2015-08-08 Penny Pei 1. Added another baud rate to COM setting.
2. Added auto-read password function.

k
1.03 2015-10-20 Happy Peng 1. Added the command GTFMI-33, GTFMI-34,
GTFMI-35, GTFMI-36 and GTFMI-37.

n
2. Added Bit28, Bit29, Bit30, and Bit31 to <FMI

l i
Report Mask> in the command GTFMI-0.

l
3. Added the parameter <Unicode Support> to

c a
the command GTFMI-0.

e i
4. Added Data Type 10 to the command

t
GTFMI-10.

u n
1.04 2015-12-28 Happy Peng 1. Added the command GTFMI-38.
2. Added Bit32 to <FMI Report Mask> in the

Q fide
command GTFMI-0.
1.05 2016-01-19 Sandy Wu 1. Added new commands GTFMI-39, GTFMI-40,
GTFMI-41, GTFMI-42 and GTFMI-43.
2. Added Bit33, Bit34, Bit35, Bit36 and Bit37 to
<FMI Report Mask> in the command

n
GTFMI-0.

o
1.06 2016-08-04 Sandy Wu 1. Added support for Protocol Version
Garmin-FMI Protocol V1.06.

C
TRACGarminMT001 -3-
 Garmin-FMI Manage Tool User Guide

1.GARMIN-FMI Manage Tool Interface

GARMIN-FMI Manage Tool is PC software which can be used to configure GARMIN-FMI through
UART. It is easy for the backend server developers to configure GARMIN-FMI with the Manage
Tool, which has friendly user interface. The correct command messages sent to GARMIN-FMI will
be displayed on the Manage Tool. (These messages can also be sent by SMS or GPRS).

The administrators can also use the Manage Tool to configure GARMIN-FMI before sale. But it is
strongly recommended to establish a backend server and control GARMIN-FMI by SMS or GPRS.

k
Please refer to “@Track Air Interface for Garmin-FMI Protocol” for details.

l i n l
Before using the Manage Tool, please install driver for the USB data cable (DATA CABLE_M). After

c
that, a new COM port can be found in the PC system. Then please follow the steps below:

ia
1. Connect GARMIN-FMI to 12VDC power supply to power on GARMIN-FMI.

e t
2. Connect GARMIN-FMI to the device via RS232.
3. Run “GARMIN-FMI Manage Tool Vx.xx.exe”.

u
Q fide n
1.1.System Requirements

Supported Microsoft .NET Framework 3.5 or above in all WIN OS.

o n
1.2.COM Setting

C
Select the COM port and baud rate (115200bps by default), input the password, and click “OK”
button. Then setting window will be displayed.

TRACGarminMT001 -4-
 Garmin-FMI Manage Tool User Guide

1.3.Professional Setting Windows

Title Bar
Menus

Toolbar

Command
Browser

k
Command

n
Operation

l i
Space

e c ia l
u n t
Q fide
Status Bar

n
1.3.1.Title Bar

o
Title Bar indicates current command title and the name of the Manage Tool.

C
1.3.2.Menus

There are “Start”, “Tool”, and “Help” in menus.

1.3.2.1.Start Menu

Start menu includes “COM Settings”.

[COM Setting]: It is used to set the COM information and password. For Setting details, please
refer to Chapter 1.2.

TRACGarminMT001 -5-
 Garmin-FMI Manage Tool User Guide

1.3.2.2.Tool Menu

Tool menu includes “Operation Log” and “Options” settings.

[Operation Log]: It is used to display/hide operation log.

i n k
cl ia l
e t
Operation

u n
Log

Q fide
[Options]: It is used to configure the basic settings of the Manage Tool.
“Basic Options” includes startup setting options and log save option.

o n
C
“Advanced Options” includes COM settings and other settings.
COM Settings is used to configure COM setting. It is recommended to use default
settings for these settings.

TRACGarminMT001 -6-
 Garmin-FMI Manage Tool User Guide

i n k
c
1.3.2.3.Help Menu

l ia l
e t
[About]: Select “About”. Then the following pop-up window is displayed.

u
Q fide n
o n
C
“Manage Tool Version” indicates the version of this Manage Tool.
“Device Version” indicates the firmware which connects to GARMIN-FMI.
“Protocol Version” indicates the protocol version of GARMIN-FMI.

1.3.3.Toolbar

It includes “COM Setting”, “Operation Log”, “Real All Configuration”, “Save All Configuration”,
and “Connect/Disconnect to COM”.

[COM Setting]: It is used to set the COM information and password. For Setting details, please
refer to Chapter 1.2.

TRACGarminMT001 -7-
 Garmin-FMI Manage Tool User Guide

[Operation Log]: It is used to display/hide operation log.

[Read All Configuration]: It is used to display/hide “Read From Device” and “Load Configuration
from File”.

“Read From Device”: It is used to read all configurations from the device which connects to
PC.
“Load Configuration From File”: It is used to load configuration file to the Manage Tool.

k
[Save All Configuration]: It is used to save all configurations in Command Operation Space to file.

n
[Connect/Disconnect to COM]: It is used to Connect/Disconnect COM manually.

cl i l
1.3.4.Status Bar

u e t ia
n
There are System Status and Current Status in status bar.

Q fide
[System Status]: It indicates the count of commands which are waiting and being executed.

[Current Status]: It indicates current COM status, IMEI, protocol version and software version
read from the device.

n
1.3.5.Command Browser and Command Operation Space

o
This area is mainly used to read and set parameters of the device.

C
1.3.5.1.Command Browser
Command Browser divides all @Track protocol commands into several parts. Click Function
in command Browser, parameters of this command will be shown in Command Operation Space.

Command Browser Function Description Related Command

Garmin FMI General Garmin FMI Feature Enable GTFMI-0
Feature Query Information about the PND GTFMI-2
Delete Data on the Garmin PND GTFMI-10
Enable/Disable PVT Reporting GTFMI-13
Set User Interface Text GTFMI-28
Send Ping to the Garmin PND GTFMI-29
Set Message Throttling GTFMI-30
Request Message Throttling Status GTFMI-31

TRACGarminMT001 -8-
Garmin-FMI Manage Tool User Guide

Set Speed Limit Alert GTFMI-32

Garmin FMI Text Send Non-acknowledgeable Text Message GTFMI-3
Message Send Acknowledgeable Text Message GTFMI-4
Send Answerable Text Message GTFMI-5
Send Canned Response Text Message GTFMI-15
Set Canned Response List Text GTFMI-16
Delete Canned Response List Text GTFMI-17
Set Canned Message List Text GTFMI-18
Delete Canned Message List Text GTFMI-19
Request Message Status GTFMI-20
Server to Client Long Text Message Protocol GTFMI-38

k
Garmin FMI Stop Send New Stop to the Garmin PND GTFMI-6
Manage Stops on the Garmin PND GTFMI-7

i n
Request ETA of Active Stop from the Garmin GTFMI-8

l l
PND

c
Set Auto Arrival Criteria on the Garmin PND GTFMI-9

ia
Sort Stop List (FMI V2 Only) GTFMI-21

e t
Garmin FMI Driver Set Driver ID In the Garmin PND GTFMI-22
Request Driver ID from the Garmin PND GTFMI-23

u n
Set Driver Status List Text GTFMI-24

Q fide
Delete Driver Status List Text GTFMI-25
Set Driver Status (FMI V2 Only) GTFMI-26
Request Driver Status GTFMI-27
Garmin FMI Custom Set FTP server Information for Custom Form GTFMI-33
Transfer (FMI V3Only)

n
Download Custom Form from FTP Server (FMI GTFMI-34
V3 Only)

o
Delete Custom Form in Garmin PND (FMI V3 GTFMI-35
Only)

C
Custom Form Move Position (FMI V3 Only) GTFMI-36
Get Custom Form Position (FMI V3 Only) GTFMI-37
Garmin FMI Sensor Alert Popup Protocol
Configure Sensor Display Protocol
Update Sensor Display Status Protocol
Delete Sensor Display Protocol
Sensor Display List Position Protocol

TRACGarminMT001 -9-
 Garmin-FMI Manage Tool User Guide

1.3.5.2.Command Operation Space

Command
Description

Parameters
Area

i n k
cl ia l
Command

u e n t
Q fide
Display

[Command Description]: There is a short description for the related command.

n
[Parameters Area]: Set/Read parameters of this command in this area.

o
[Command Display]: Command with parameters in parameters area is displayed in this area.

C
[Send]: Click this button to send this command to the device.

1.4.Operation Result Interface

1.4.1.Operation Successful Interface

TRACGarminMT001 - 10 -
 Garmin-FMI Manage Tool User Guide

1.4.2.Operation Failed Interface

There should be something wrong with COM port connection if the failure reason is timeout.

k
There should be COM port that is occupied. Please close all other COM-related applications.

cl i n l
u e t ia
Q fide n
Please change to correct device password if Password Error occurs.

o n
C
TRACGarminMT001 - 11 -
 Garmin-FMI Manage Tool User Guide

2.Operation Instructions

2.1.Configuration in Professional Setting Mode

The Manage Tool is developed based on the @Track Air Interface Protocol. Please refer to
“@Track Air Interface for Garmin-FMI Protocol” for details.

The following shows a general procedure to configure GARMIN-FMI with the Manage Tool.

n k
Step_1

cl i a l
Step_3

u e n t i
Q fide
Step_2

n
Step_4

o
Step_1: Select “Garmin FMI Feature Enable”. After that, the parameters of AT+GTFMI are shown
in Command Operation Space.

C
Step_2: The command message which shall be sent to GARMIN-FMI will be generated based on
input and displayed here. Please note this command message can also be sent to
GARMIN-FMI through SMS or GPRS.

Step_3: Set Garmin FMI Feature Enable parameters. Please refer to “@Track Air Interface for
Garmin-FMI Protocol” for the meaning of each parameter.

Step_4: Click the “Send” button; download the parameters of AT+GTFMI to GARMIN-FMI.

2.2.Read/Save All Configurations

Step_1: It is recommended to read all configurations from the device before saving the

TRACGarminMT001 - 12 -
 Garmin-FMI Manage Tool User Guide

configuration. Select “Read All Configuration””Read From Device”.

Note: The command AT+GTDAT will not be read when clicking “Read From Device”.

Step_2: After reading successfully, click “Save All Configuration” in toolbar.

k
Step_3: Select a folder, type in the name of configuration file, and then click “Save” button.

cl i n l
u e t ia
Q fide n
o n
C
Step_4: Saved successfully.

TRACGarminMT001 - 13 -
 Garmin-FMI Manage Tool User Guide

2.3.Load/Send All Configurations

Step_1: Before sending all configurations, please load the configuration file or set all parameters
in commands. To load configuration file, please select “Read All Configuration” ” Load
Configurations From File”, and then select the configuration file you need.

i n k
cl ia l
u e n t
Q fide
o n
C
Queclink
Green Liang
2019.08.07

TRACGarminMT001 - 14 -