GSM/GPRS/GPS Tracker GL300

@Tracker Air Interface

Firmware Update Protocol
Application Notes: TRACGL300FTAN001
Revision: 1.01

http://www.queclink.com
[email protected]
GL300 @Track Air Interface Firmware Update Protocol

Contents

Contents ............................................................................................................................................1
0. Revision History ...........................................................................................................................2
1. Scope.............................................................................................................................................3
2. Message.........................................................................................................................................4
2.1. Command And Acknowledgement .....................................................................................4
2.1.1. Start the firmware update ........................................................................................4
2.1.2. Stop the firmware update ........................................................................................5
2.1.3. Acknowledgement...................................................................................................5

k
2.2. Report..................................................................................................................................7

n
2.2.1. Update Confirmation...............................................................................................7

l i
2.2.2. Package Downloading.............................................................................................7

l
2.2.3. Firmware Updating .................................................................................................8

c a
3. Firmware Update Process ...........................................................................................................10

i
3.1. Initiation of the update process .........................................................................................10

e t
3.2. Confirmation of the update process...................................................................................10

u
3.3. Downloading of the update package .................................................................................10

n
3.4. Updating of the firmware .................................................................................................. 11

Q fide
3.5. An example of successful updating ...................................................................................12

o n
C
TRACGL300FTAN001 -1-
GL300 @Track Air Interface Firmware Update Protocol

0. Revision History

Revision Date Author Description of change

1.00 2011-2-21 Ella Initial
1.01 2012-11-07 Evan.Tu 1)Modified the command protocol in “AT+GTUPD”

i n k
c l i al
u e n t
Q fide
o n
C
TRACGL300FTAN001 -2-
GL300 @Track Air Interface Firmware Update Protocol

1. Scope

This document describes the firmware update over the air for GL300. This enables to update the
firmware of GL300 remotely without having to require the end users to bring their device to the
service centre. Thus the service provider of GL300 could conveniently push new features or bug
fix to the end users and promote the customer experience.

During the firmware updating, three equipments are involved:

 the terminal: GL300 whose firmware is to be updated

k
 the backend server: the server which remotely controls the terminal and receives report from
the terminal

n
 the file server: the server which hosts the packages of the update

l i l
The file server and the backend server could host on the same machine.

c a
This document describes the process of the firmware update and the necessary message exchanged

e i
during the updating, while below information are not covered:

t
 The timing and the strategy that the backend server to initiate the updating.

u n
 The deployment method of the update package.
 How to setup a file server.

Q fide
 The communication between the backend server and the file server.

o n
C
TRACGL300FTAN001 -3-
GL300 @Track Air Interface Firmware Update Protocol

2. Message

2.1. Command And Acknowledgement

The command AT+GTUPD is used to start and stop the firmware update remotely.

2.1.1. Start the firmware update

k
To start the firmware update, the backend server sends AT+GTUPD (sub-command:0)

n
command to the device to apply firmware update. Upon this command, the device is informed of

l i
where to download the update package and how to download the package.

l
 Start: AT+GTUPD=

c a
Example:

e i
AT+GTUPD=gl300,0,1,10,0,,,http://116.228.146.250:8133/GL300/deltabin/,GL300R00A01

t
V03M128_NMX,,,,0001$

u n
Parameter Length(byte) Range/Format Default value
password 4~6 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’ gl300

Q fide
sub-command 1 0
max download retry 1 0–3 0
download timeout 2 10 – 30 min 10
download protocol 1 0 0

n
download user name <=6 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’
download password <=6 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’

o
download URL 100 legal URL
target version 32 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’

C
reserved 0
reserved 0
reserved 0
serial number 4 0000-FFFF
tail character 1 $ $
 <password>: the valid character of password is ‘0’-9’, ‘a’-‘z’, ‘A’-‘Z’. The default value is
“gl300”.
 <sub-command>: sub-command of AT+GTUPD, 0 means to start the firmware update.
 <max download retry>: specifies the maximum time of retrying to download the update
package upon downloading failure.
 <download timeout>: specifies the expiration timeout of one single downloading. If the
downloading expires, it is considered to be failure.
 <download protocol>: the protocol used to download the package. Only HTTP is supported
now. Set to 0.
 <download user name>: if the file server uses authentication, specifies the user name here.

TRACGL300FTAN001 -4-
GL300 @Track Air Interface Firmware Update Protocol

 <download password>: if the file server uses authentication, specifies the password here.
 <download URL>: specifies the URL to download the package when the parameter <target
version> is default, specifies the URL to download the package path when the parameter
<target version> is not default
 <target version> target version （eg：GL300R00A01V03M128_NMX or default）
 <reserved>: reserved for future extension.
 <serial number>: As the command reference, the exact serial number will be sent back to the
platform in ACK. It is in hexadecimal format. It should begin from 0000 and increases by
1 every time. It should roll back after “FFFF”.
 <tail character>: A character to indicate the end of the command. Must be “$”.


k
2.1.2. Stop the firmware update

l i n l
Before the device is downloading the update package, the backend server could use the
AT+GTUPD (sub-command:1) command to cancel the current firmware updating. If the

c a
package is downloaded successful, this command is ignored by device.

e i
 Stop: AT+GTUPD=

t
Example:

u n
AT+GTUPD=gl300,1,,,,,0001$
Parameter Length(byte) Range/Format Default value

Q fide
password 4~6 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’ gl300
sub-command 1 1
reserved 0
reserved 0

n
reserved 0
reserved 0

o
serial number 4 0000-FFFF
tail character 1 $ $

C
 <sub-command>: sub-command of AT+GTUPD, 1 means to cancel the current firmware
update process.

2.1.3. Acknowledgement

The acknowledgement message of AT+GTUPD command:

 +ACK:GTUPD,
Example:
+ACK:GTUPD,1A0102,135790246811220,,0001,20090201000002,11F0$
Parameter Length(byte) Range/Format Default
protocol version 6 XX0000 – XXFFFF,
X∈{'A' – 'Z', '0' – '9'}
unique ID 15 IMEI
device name <=10 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’

TRACGL300FTAN001 -5-
GL300 @Track Air Interface Firmware Update Protocol

serial number 4 0000-FFFF

send time 14 YYYYMMDDHHMMSS
count number 4 0000-FFFF
tail character 1 $ $
 <Protocol Version>: The protocol version that the terminal conforms to. The first two
characters XX point out the device type. 1A means GL300. The middle two characters point
out the main version number and the last two characters point out the minimum version
number. And both of the main version and the minimum version are hex digital. For example,
0102 means version 1.02
 <unique ID>: The terminal’s IMEI.
 <device name>: An ASCII string for the name of the device.

k
 <serial number>: The <serial number> in the AT+GTUPD command.
 <send time>: The terminal local time to send the message.

i n
 <count number>: The self-increasing count number will be put into every acknowledgment

l l
message. The count is beginning from 0000 and increases by 1 every time. It will roll back

c
after “FFFF”.

u e t i a
Q fide n
o n
C
TRACGL300FTAN001 -6-
GL300 @Track Air Interface Firmware Update Protocol

2.2. Report

During the firmware updating process, the device reports its status to the backend server by
message +RESP:GTUPD upon different phases, including the update confirmation information,
package downloading information and firmware updating information.

2.2.1. Update Confirmation

The device sends update confirmation information to the backend server if:
 The update command is confirmed by the device.

k
 The update command is refused by the device.

n
 The update process is canceled by the backend server.

i
 The update command is refused because the battery is low.

c l l
 Confirmation: +RESP:GTUPD,

i a
Example:

e t
+RESP:GTUPD,1A0102,135790246811220,,100,,20090201020000,11F0$
Parameter Length(byte) Range/Format Default

u n
protocol version 6 XX0000 – XXFFFF,
X∈{'A' – 'Z', '0' – '9'}

Q fide
unique ID 15 IMEI
device name <=10 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’
code 3 100|101|102|103
reserved 0

n
send time 14 YYYYMMDDHHMMSS
count number 4 0000-FFFF

o
tail character 1 $ $
 <code>: the confirmation information

C
 100: the update command is confirmed by the device.
 101: the update command is refused by the device.
 102: the update process is canceled by the backend server.
 103: the update process is refused because the battery is low.
 104: the update process is refused because target version is the latest.
 105: the update process is refused because the device type is not match
 106: the update process is refused because the flash type is not match.
 107: the update process is refused because the flash size is not match.
 108: the update process is refused because the other request is error.

2.2.2. Package Downloading

The device sends package downloading information to the backend server if:

TRACGL300FTAN001 -7-
GL300 @Track Air Interface Firmware Update Protocol

 the device starts to download the package

 the device finishes downloading the package successfully
 the device fails to download the package

 Downloading: +RESP:GTUPD,
Example:
+RESP:GTUPD,1A0102,135790246811220,,200,1,20090201020000,11F0$
Parameter Length(byte) Range/Format Default
protocol version 6 XX0000 – XXFFFF,
X∈{'A' – 'Z', '0' – '9'}
unique ID 15 IMEI
device name <=10

k
‘0’-‘9’,’a’-‘z’,’A’-‘Z’
code 3 200|201|202

n
download times 1 1|2|3|4

l i
send time 14 YYYYMMDDHHMMSS

l
count number 4 0000-FFFF

c a
tail character 1 $ $

e i


t
<code>: the downloading information
 200: the device starts to download the package

u n
 201: the device finishes downloading the package successfully
 202: the device fails to download the package

Q fide
 <download times>: the count number of the package downloading

2.2.3. Firmware Updating

n
The device sends firmware updating information to the backend server if:
 the device starts to update the firmware

o
 the device finishes update the firmware successfully
 the device fails to update the firmware

C
 the update process does not start because the battery is low

 Updating: +RESP:GTUPD,
Example:
+RESP:GTUPD,1A0102,135790246811220,,300,,20090201020000,11F0$
Parameter Length(byte) Range/Format Default
protocol version 6 XX0000 – XXFFFF,
X∈{'A' – 'Z', '0' – '9'}
unique ID 15 IMEI
device name <=10 ‘0’-‘9’,’a’-‘z’,’A’-‘Z’
code 3 300|301|302|303
reserved 0
send time 14 YYYYMMDDHHMMSS
count number 4 0000-FFFF
tail character 1 $ $

TRACGL300FTAN001 -8-
GL300 @Track Air Interface Firmware Update Protocol

 <code>: the updating information

 300: the device starts to update the firmware
 301: the device finishes updating the firmware successfully
 302: the device fails to update the firmware
 303: the update process does not start because the battery is low

i n k
c l i al
u e n t
Q fide
o n
C
TRACGL300FTAN001 -9-
GL300 @Track Air Interface Firmware Update Protocol

3. Firmware Update Process

The firmware update process includes four steps.

3.1. Initiation of the update process

The backend server sends the AT+GTUPD (sub-command:0) command to the device to initiate
the update process. Along with this command, the backend server sends necessary information for
the device to start the update process.

k
It’s the backend server’s duty to decide when and how to initiate the firmware update process to

i n
all the devices which backend server controls. As the response messages collector and the

l l
controller, the backend server has all the information it needs to start an update process including
the current firmware versions of the devices (current firmware can retrieve with the AT+GTRTO

c a
command), the version of the latest available firmware and the location of the proper update

e t i
packages.

u n
3.2. Confirmation of the update process

Q fide
Upon the AT+GTUPD (sub-command:0) command, the device will first check the current
battery capacity. If the battery capacity can not support the update process, it will report
+RESP:GTUPD (code: 103) to notify the backend server that the update process is to be aborted
because of low battery. If the battery capacity is ample, the device will send +RESP:GTUPD

n
with confirmation information to the backend server. Then the update process proceeds to the next
step.

o
If the update command is confirmed, the device will turn into a non-interactive mode. That is, the

C
end user can no longer make phone call, all incoming call are rejected automatically until the
update process finishes. At the meantime, the device will ignore all the command received from
the backend server if it is not related to the update process. Also the device will stop all the reports
that are not related to the update process.

3.3. Downloading of the update package

If the update command is confirmed, the device will use the information sent by the backend
server to download the update package. If the downloading fails, it will retry the specified times.
If all attempts fail, the updating process is aborted and the device will automatically reboot to go
back to the normal working mode. If the downloading successes, the update process proceeds to
the next step. Either way, the device will send +RESP:GTUPD with downloading information to
the backend server.

TRACGL300FTAN001 - 10 -
GL300 @Track Air Interface Firmware Update Protocol

Before the package is downloaded, the backend server could send AT+GTUPD (sub-command:1)
command to cancel the current update process. This is the only chance to abort during the update
process.

3.4. Updating of the firmware

After downloading the package successfully, the device will check the battery capacity again. If
the battery can not support the update process, the device will report +RESP:GTUPD (code: 303)
to notify the backend server that the update process is to be aborted because of low battery. If
the battery capacity is ample, the device will send +RESP:GTUPD (code:300) to the backend
server to inform of the start of the updating. Then it uses the update package to update the

k
firmware. After the updating, success or failure, the device will reboot automatically. After the
device boots up, it sends +RESP:GTUPD with updating information to the backend server and

i n
woks as usual.

c l i al
u e n t
Q fide
o n
C
TRACGL300FTAN001 - 11 -
GL300 @Track Air Interface Firmware Update Protocol

3.5. An example of successful updating

i n k
c l i al
u e n t
Q fide
o n
C
TRACGL300FTAN001 - 12 -