GV350M Series @track Air Interface Firmware Update Protocol: EGPRS/LTE Cat-M1/LTE Cat-NB1/GNSS Tracker
GV350M Series @track Air Interface Firmware Update Protocol: EGPRS/LTE Cat-M1/LTE Cat-NB1/GNSS Tracker
Version 1.00
Date 2017-06-08
Status Released
General Notes
k
Queclink offers this information as a service to its customers, to support application and
engineering efforts that use the products designed by Queclink. The information provided is
n
based upon requirements specifically provided to Queclink by the customers. Queclink has not
i
undertaken any independent search for additional relevant information, including any
l l
information that may be in the customer’s possession. Furthermore, system validation of this
c
product designed by Queclink within a larger electronic system remains the responsibility of the
a
customer or the customer’s system integrator. All specifications supplied herein are subject to
e i
change.
t
Copyright
u n
This document contains proprietary technical information which is the property of Queclink.
Q fide
Copying of this document, distribution to others or using or communication of the contents
thereof is forbidden without express authority. Offenders are liable to the payment of damages.
All rights are reserved in the event of a patent grant or the registration of a utility model or
design. All specification supplied herein are subject to change without notice at any time.
on
C
QSZTRACGV350FTAN0100
GV350M Series @Track Air Interface Firmware Update Protocol
Contents
0. Revision History ............................................................................................................................. 1
1. Scope ............................................................................................................................................. 2
2. Message ........................................................................................................................................ 3
2.1. Command and Acknowledgement ...................................................................................... 3
2.1.1. Start the Firmware Update ........................................................................................ 3
2.1.2. Stop the Firmware Update ........................................................................................ 4
2.1.3. Acknowledgement ..................................................................................................... 5
2.2. Report.................................................................................................................................. 6
2.2.1. Update Confirmation ................................................................................................. 6
k
2.2.2. Package Downloading................................................................................................ 7
2.2.3. Firmware Update ....................................................................................................... 8
in
3. Firmware Update Process ............................................................................................................. 9
l l
3.1. Initiation of the Update Process .......................................................................................... 9
3.2. Confirmation of the Update Process ................................................................................... 9
c a
3.3. Download of the Update Package ....................................................................................... 9
i
3.4. Updating of the Firmware ................................................................................................. 10
e t
3.5. An Example of Successful updating ................................................................................... 10
u
Q fide n
on
C
QSZTRACGV350FTAN0100
0. Revision History
l in k
e c i a l
u n t
Q fide
on
C
QSZTRACGV350FTAN0100 1
GV350M Series @Track Air Interface Firmware Update Protocol
1. Scope
This document describes the over-the-air firmware update for GV350M Series. User can update
firmware of GV350M Series remotely without bringing device to the service centre. Thus, the
service provider of GV350M can conveniently promote new features or carry out debugging
for the end users to improve the customer experience.
k
The backend server: the server which remotely controls the terminal and receives report
from the terminal.
n
The file server: the server which stores the packages of the update.
i
The file server and the backend server could be hosted on the same machine.
c l l
This document describes the process of the firmware update and the necessary message
i a
exchanged during the update while not covering the information below:
e t
The time and the method that the backend server initiates the update.
The deployment method of the update package.
u n
How to set up a file server.
The communication between the backend server and the file server.
Q fide
on
C
QSZTRACGV350FTAN0100 2
GV350M Series @Track Air Interface Firmware Update Protocol
2. Message
To start the firmware update, the backend server sends the AT+GTUPD (sub-command:0)
command to the device. In this command, the device is informed of where and how to download
the update package.
k
Start: AT+GTUPD=
n
Example:
i
AT+GTUPD=GV350M,0,1,10,0,,,http://220.178.67.210:10096/GV350M/deltabin/GV350MR00
l l
A01V11M16.enc,,1,,,0001$
Parameter Length (Byte) Range/Format Default Value
c a
Password 4–6 ‘0’-‘9’, ‘a’-‘z’, ‘A’-‘Z’ gv350m
e i
Sub-Command 1 0
t
Max Download Retry 1 0–3 0
u n
Download Timeout 2 10 – 30 min 10
Download Protocol 1 0 0
Q fide
Download User Name <=6 ‘0’-‘9’, ‘a’-‘z’, ‘A’-‘Z’
Download Password <=6 ‘0’-‘9’, ‘a’-‘z’, ‘A’-‘Z’
Download URL 100 Legal URL
Reserved 0
Update Type 1 1 1
n
Reserved 0
Reserved 0
o
Serial Number 4 0000-FFFF
Tail Character 1 $ $
C
<Password>: The valid characters for the password include ‘0’-‘9’, ‘a’-‘z’, and ‘A’-‘Z’. The
default value is “gv350m”.
<Sub-Command>: The sub-command of AT+GTUPD. 0 means “Start the firmware update”.
<Max Download Retry>: It specifies the maximum number of retries to download the update
package upon downloading failure.
<Download Timeout>: If downloading is not finished within this time, it will be regarded that
the downloading failed.
<Download Protocol>: The protocol used to download the package. Only HTTP is supported
now. It is set to 0.
<Download User Name>: If the file server uses authentication, the user name is specified
here.
<Download Password>: If the file server uses authentication, the password is specified here.
<Download URL>: It specifies the URL to download the package.
<Update Type>: It specifies the type of the firmware to be updated. It is always 1.
QSZTRACGV350FTAN0100 3
GV350M Series @Track Air Interface Firmware Update Protocol
Before the update package has been downloaded to the device, the user can use AT+GTUPD
(sub-command:1) command to cancel current firmware updating. If update package
downloading finishes, this command will be ignored by the device.
k
Stop: AT+GTUPD=
Example:
n
AT+GTUPD=GV350M,1,,,,,0001$
l i
Parameter Length (Byte) Range/Format Default Value
l
Password 4–6 ‘0’-‘9’, ‘a’-‘z’, ‘A’-‘Z’ gv350m
c a
Sub-Command 1 1
i
Reserved 0
e t
Reserved 0
u
Reserved 0
n
Reserved 0
Serial Number 4 0000-FFFF
Q fide
Tail Character 1 $ $
<Sub-Command>: The sub-command of AT+GTUPD. 1 means “Cancel the current firmware
update process”.
on
C
QSZTRACGV350FTAN0100 4
GV350M Series @Track Air Interface Firmware Update Protocol
2.1.3. Acknowledgement
k
Serial Number 4 0000-FFFF
n
Send Time 14 YYYYMMDDHHMMSS
i
Count Number 4 0000-FFFF
l l
Tail Character 1 $ $
c i a
<Protocol Version>: The protocol version that the terminal conforms to. The first two
e t
characters XX indicate the device type. F1 means GV350M. The middle two characters
represent the major version number and the last two characters represent the minor version
u n
number. And both of the major version and the minor version are hex digits. For example,
0101 means version 1.01.
Q fide
<Unique ID>: The terminal’s IMEI.
<Device Name>: An ASCII string which represents the name of the device.
<Serial Number>: The <Serial Number> in the AT+GTUPD command.
<Send Time>: The local time (shown on the terminal) to send the message.
<Count Number>: A self-increasing count number in each acknowledgment message. It
n
counts from 0000 and increases by 1 every time. And it rolls back after “FFFF”.
C o
QSZTRACGV350FTAN0100 5
GV350M Series @Track Air Interface Firmware Update Protocol
2.2. Report
During the firmware update process, the device reports its status (including the update
confirmation information, package download information and firmware update information) to
the backend server via the message +RESP:GTUPD at different phases.
The device sends update confirmation information to the backend server if:
The update command is confirmed by the device.
The update command is refused by the device.
The update process is canceled by the backend server.
k
The update command is refused because the battery is low.
Confirmation: +RESP:GTUPD,
in
Example:
l l
+RESP:GTUPD,F10101,352948070074301,,100,,20161105074725,11F0$
Parameter Length (Byte) Range/Format Default
c a
Protocol Version 6 XX0000 – XXFFFF, X∈{'A' – 'Z', '0' – '9'}
i
Unique ID 15 IMEI
e t
Device Name <=10 ‘0’-‘9’, ‘a’-‘z’, ‘A’-‘Z’
u
Code 3 100|101|102|103
n
Reserved 0
Send Time 14 YYYYMMDDHHMMSS
Q fide
Count Number 4 0000-FFFF
Tail Character 1 $ $
<Code>: The code for the confirmation information.
100: The update command is confirmed by the device.
n
101: The update command is refused by the device.
102: The update process is canceled by the backend server.
o
103: The update process is refused because the battery is low.
C
QSZTRACGV350FTAN0100 6
GV350M Series @Track Air Interface Firmware Update Protocol
The device sends package download information to the backend server if:
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,F10101,352948070074301,,200,1,20161105074732,11F0$
Parameter Length (Byte) Range/Format Default
Protocol Version 6 XX0000 – XXFFFF, X∈{'A' – 'Z', '0' – '9'}
k
Unique ID 15 IMEI
Device Name <=10 ‘0’-‘9’, ‘a’-‘z’, ‘A’-‘Z’
in
Code 3 200|201|202
l l
Download Times 1 1|2|3|4
Send Time 14 YYYYMMDDHHMMSS
c a
Count Number 4 0000-FFFF
e i
Tail Character 1 $ $
u n t
<Code>: The code for the download information.
200: The device starts to download the package.
Q fide
201: The device finishes downloading the package successfully.
202: The device fails to download the package.
<Download Times>: The count of the package downloads.
on
C
QSZTRACGV350FTAN0100 7
GV350M Series @Track Air Interface Firmware Update Protocol
The device sends the firmware update information to the backend server if:
The device starts to update the firmware.
The device finishes updating the firmware successfully.
The device fails to update the firmware.
The update process does not start because the battery is low.
Updating: +RESP:GTUPD,
Example:
+RESP:GTUPD,F10101,352948070074301,,300,,20161105074742,11F0$
Parameter Length (Byte) Range/Format Default
k
Protocol Version 6 XX0000 – XXFFFF, X∈{'A' – 'Z', '0' – '9'}
Unique ID 15 IMEI
in
Device Name <=10 ‘0’-‘9’, ‘a’-‘z’, ‘A’-‘Z’
l l
Code 3 300|301|302|303
Reserved 0
c a
Send Time 14 YYYYMMDDHHMMSS
e i
Count Number 4 0000-FFFF
t
Tail Character 1 $ $
u n
<Code>: The code for the update information.
300: The device starts to update the firmware.
Q fide
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.
on
C
QSZTRACGV350FTAN0100 8
GV350M Series @Track Air Interface Firmware Update Protocol
The firmware update process includes four steps: initiation of the update process, confirmation
of the update process, downloading of the update package and updating of the firmware.
k
Backend server decides when and how to initiate the firmware update process of all the devices
it controls. As the response message receiver and the controller, the backend server has all the
n
information (including the current firmware version (to know via AT+GTRTO command) of the
i
devices, the version of the latest available firmware and the location of the proper update
l l
packages) it needs to start an update process.
c a
3.2. Confirmation of the Update Process
e ti
After receiving the AT+GTUPD (sub-command:0) command, the device will first check the
current battery capacity. If the battery capacity cannot support the update process, it will report
u n
+RESP:GTUPD (code: 103) to inform 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 with
Q fide
confirmation information to the backend server. Then the update process proceeds to the next
step.
If the update command is confirmed, the device will go in a non-interactive mode. In which, the
end user can no longer make phone calls and all incoming calls will be rejected automatically
until the update process finishes. In the meantime, the device will ignore all the commands and
n
stop all the reports not related to the update process.
o
When 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 as the
C
specified times in <Max Download Retry>. If all downloading attempts fail, the update process
will be aborted and the device will automatically reboot to go back to the normal working state.
The update process proceeds to the next step if the downloading is successful. Either way, the
device will send +RESP:GTUPD with downloading information to the backend server.
Before downloading the package, the user can send AT+GTUPD (sub-command:1) command to
cancel current update process. This is the only chance to abort the upgrading during the update
process.
QSZTRACGV350FTAN0100 9
GV350M Series @Track Air Interface Firmware Update Protocol
l in k
e c i a l
u n t
Q fide
on
C
QSZTRACGV350FTAN0100 10