Nothing Special   »   [go: up one dir, main page]

Quectel EC200U Series QuecOpen CSDK Quick Start Guide V1.0.0 Preliminary 20211209

Download as pdf or txt
Download as pdf or txt
You are on page 1of 34

EC200U Series QuecOpen

CSDK Quick Start Guide

LTE Standard Module Series

Version: 1.0.0

Date: 2021-12-09

Status: Preliminary
LTE Standard Module Series

At Quectel, our aim is to provide timely and comprehensive services to our customers. If you
require any assistance, please contact our headquarters:

Quectel Wireless Solutions Co., Ltd.


Building 5, Shanghai Business Park Phase III (Area B), No.1016 Tianlin Road, Minhang District, Shanghai
200233, China
Tel: +86 21 5108 6236
Email: info@quectel.com

Or our local offices. For more information, please visit:


http://www.quectel.com/support/sales.htm.

For technical support, or to report documentation errors, please visit:


http://www.quectel.com/support/technical.htm.
Or email us at: support@quectel.com.

Legal Notices
We offer information as a service to you. The provided information is based on your requirements and we
make every effort to ensure its quality. You agree that you are responsible for using independent analysis
and evaluation in designing intended products, and we provide reference designs for illustrative purposes
only. Before using any hardware, software or service guided by this document, please read this notice
carefully. Even though we employ commercially reasonable efforts to provide the best possible experience,
you hereby acknowledge and agree that this document and related services hereunder are provided to
you on an “as available” basis. We may revise or restate this document from time to time at our sole
discretion without any prior notice to you.

Use and Disclosure Restrictions


License Agreements
Documents and information provided by us shall be kept confidential, unless specific permission is granted.
They shall not be accessed or used for any purpose except as expressly provided herein.

Copyright
Our and third-party products hereunder may contain copyrighted material. Such copyrighted material shall
not be copied, reproduced, distributed, merged, published, translated, or modified without prior written
consent. We and the third party have exclusive rights over copyrighted material. No license shall be
granted or conveyed under any patents, copyrights, trademarks, or service mark rights. To avoid
ambiguities, purchasing in any form cannot be deemed as granting a license other than the normal non-
exclusive, royalty-free license to use the material. We reserve the right to take legal action for
noncompliance with abovementioned requirements, unauthorized use, or other illegal or malicious use of
the material.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 1 / 33
LTE Standard Module Series

Trademarks
Except as otherwise set forth herein, nothing in this document shall be construed as conferring any rights
to use any trademark, trade name or name, abbreviation, or counterfeit product thereof owned by Quectel
or any third party in advertising, publicity, or other aspects.

Third-Party Rights
This document may refer to hardware, software and/or documentation owned by one or more third parties
(“third-party materials”). Use of such third-party materials shall be governed by all restrictions and
obligations applicable thereto.

We make no warranty or representation, either express or implied, regarding the third-party materials,
including but not limited to any implied or statutory, warranties of merchantability or fitness for a particular
purpose, quiet enjoyment, system integration, information accuracy, and non-infringement of any third-
party intellectual property rights with regard to the licensed technology or use thereof. Nothing herein
constitutes a representation or warranty by us to either develop, enhance, modify, distribute, market, sell,
offer for sale, or otherwise maintain production of any our products or any other hardware, software, device,
tool, information, or product. We moreover disclaim any and all warranties arising from the course of
dealing or usage of trade.

Privacy Policy
To implement module functionality, certain device data are uploaded to Quectel’s or third-party’s servers,
including carriers, chipset suppliers or customer-designated servers. Quectel, strictly abiding by the
relevant laws and regulations, shall retain, use, disclose or otherwise process relevant data for the purpose
of performing the service only or as permitted by applicable laws. Before data interaction with third parties,
please be informed of their privacy and data security policy.

Disclaimer
a) We acknowledge no liability for any injury or damage arising from the reliance upon the information.
b) We shall bear no liability resulting from any inaccuracies or omissions, or from the use of the
information contained herein.
c) While we have made every effort to ensure that the functions and features under development are
free from errors, it is possible that they could contain errors, inaccuracies, and omissions. Unless
otherwise provided by valid agreement, we make no warranties of any kind, either implied or express,
and exclude all liability for any loss or damage suffered in connection with the use of features and
functions under development, to the maximum extent permitted by law, regardless of whether such
loss or damage may have been foreseeable.
d) We are not responsible for the accessibility, safety, accuracy, availability, legality, or completeness of
information, advertising, commercial offers, products, services, and materials on third-party websites
and third-party resources.

Copyright © Quectel Wireless Solutions Co., Ltd. 2021. All rights reserved.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 2 / 33
LTE Standard Module Series

About the Document

Revision History

Version Date Author Description

- 2021-12-09 Neo KONG Creation of the document

1.0.0 2021-12-09 Neo KONG Preliminary

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 3 / 33
LTE Standard Module Series

Contents

About the Document .................................................................................................................................. 3


Contents ...................................................................................................................................................... 4
Table Index .................................................................................................................................................. 5
Figure Index ................................................................................................................................................ 6

1 Introduction ......................................................................................................................................... 7

2 CSDK Directory Structure .................................................................................................................. 8

3 Compilation Environment Setup ..................................................................................................... 10


3.1. Host System ............................................................................................................................. 10
3.2. Application Compilation Environment ...................................................................................... 10

4 Application Development ................................................................................................................. 11


4.1. Application Demo Description ...................................................................................................11
4.2. Add Application Feature Component ....................................................................................... 12
4.2.1. Create a Directory of Application Feature Component ................................................. 12
4.2.2. Create an Application Thread ....................................................................................... 12
4.2.3. Modify Configuration File .............................................................................................. 13
4.2.4. Add Compilation Task ................................................................................................... 13
4.2.5. Link Application Feature Component ............................................................................ 14
4.2.6. Feature Component Compilation Switch ...................................................................... 14

5 Application Compilation................................................................................................................... 17
5.1. Compilation Description ........................................................................................................... 17
5.2. Compilation Procedure ............................................................................................................ 17
5.3. Compilation Result ................................................................................................................... 19
5.4. Compiled File Clearance.......................................................................................................... 19

6 Feature Removal ............................................................................................................................... 20


6.1. Feature Removal in Kernel ...................................................................................................... 20
6.2. Feature Removal in BootLoader .............................................................................................. 23

7 Preset File .......................................................................................................................................... 25


7.1. Enable Preset File Package..................................................................................................... 25
7.2. Preset File Configuration ......................................................................................................... 26
7.3. Preset File Download and Upgrade ......................................................................................... 26

8 Flash Partition Adjustment .............................................................................................................. 28

9 Firmware Burning ............................................................................................................................. 29

10 FAQ ..................................................................................................................................................... 30
10.1. Common Compilation Error in Linux .................................................................................... 30

11 Appendix References ....................................................................................................................... 32

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 4 / 33
LTE Standard Module Series

Table Index

Table 1: CSDK Directory Structure .............................................................................................................. 8


Table 2: The Removable Libraries in Kernel .............................................................................................. 21
Table 3: The Removable Libraries in BootLoader...................................................................................... 23
Table 4: Related Documents ...................................................................................................................... 32
Table 5: Terms and Abbreviations .............................................................................................................. 32

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 5 / 33
LTE Standard Module Series

Figure Index

Figure 1: CSDK Directory Structure ............................................................................................................. 9


Figure 2: Application Entry ..........................................................................................................................11
Figure 3: Directory Example of Application Feature Component .............................................................. 12
Figure 4: Create Feature Component Application Thread ......................................................................... 12
Figure 5: Modify Configuration File ............................................................................................................ 13
Figure 6: Add Compilation Tasks................................................................................................................ 13
Figure 7: Link New Application Feature Component and Add Option Switch Control............................... 14
Figure 8: Configure Compilation Switch..................................................................................................... 15
Figure 9: Add Macro Control ...................................................................................................................... 16
Figure 10: CSDK Original Firmware .......................................................................................................... 17
Figure 11: Compile Application................................................................................................................... 18
Figure 12: Compilation Results .................................................................................................................. 19
Figure 13: Removable Libraries in Kernel.................................................................................................. 20
Figure 14: Feature Removal in Kernel ....................................................................................................... 21
Figure 15: Feature Initialization Function ................................................................................................... 24
Figure 16: Preset File Package Compilation Configuration ....................................................................... 25
Figure 17: Add a Feature Switch for Preset File ........................................................................................ 25
Figure 18: Preset Package Configuration File ........................................................................................... 26
Figure 19: Ignore the Preset File in FOTA ................................................................................................. 27

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 6 / 33
LTE Standard Module Series

1 Introduction
Quectel EC200U series module supports QuecOpen® solution. QuecOpen® is an embedded development
platform based on RTOS, which is intended to simplify the design and development of IoT applications.

This document introduces CSDK directory structure, compilation environment setup, application
development and compilation process, feature removal, partition adjustment, firmware download and FAQ
of EC200U series module in QuecOpen® solution.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 7 / 33
LTE Standard Module Series

2 CSDK Directory Structure


The directory may differ depending on the actual released versions in the QuecOpen CSDK. The
QuecOpen CSDK directory is shown in Figure 1, with details in the following table.

Table 1: CSDK Directory Structure

Directory Name Description

cmake, prebuilts, tools Includes compilation tools, configuration files and compilation scripts.

components/appstart Includes source files of Kernel start program.

components/bootloader Includes source files of boot loader.

components/hal Includes partitions and Flash configuration files.

Includes the default Kernel firmware, original application firmware and


components/ql-config
preset files of the current version.

components/ql-kernel Includes all open API header files and library files.

Includes application reference routines and demos that implement various


components/ql-application
features.
components/libs
components/net Includes header files and library files required by the application.
components/newlib
⚫ Windows:
Compile the application in Windows CLI according to the configured
parameters. See Chapter 5 for details.
build_all.bat,
⚫ Linux:
build_all.sh
Compile the application in Linux CLI according to the configured
parameters. Administrator mode is required during compilation in Linux.
And the script should be executed by bash. See Chapter 5 for details.

CmakeLists.txt Top-level compilation configuration file.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 8 / 33
LTE Standard Module Series

cmake compilation
cma ke
configurations
app start

bt Bluetooth(BLE) demo
boo tloa der

dev Device information demo


hal

Internal header fs File application demo


...
files and libraries
ftp/http/mqtt FTP/HTTP/MQTT demo
libs

init App entry


net

nw Network, data call demo


newlib

osi OSI appliction demo

Peripheral hardwares, such as


componen ts peri pheral
GPIO, PWM and ADC

ql-app lica tion power Turn-on/off demo

sim (U)SIM application demo

CSDK ...

CMake Lists.txt
Compilation
configuration files,
ql_app_feature_config.cma ke ql_app_feature_config is
the switch of App
feature compilation
ql_app_feature_config.h.in

ql-config buil d Includes kernel libraries, nvitem and target.config

downlo ad pack Kernel and App default firmware

prep ack Preset files

boo t_ex Boot library file

drivers Kernel configuration and drivers

...
ql-kernel
ql_at Custom AT command

CMake Lists.txt Compilation configuration file

Version
out Files generated during compilation
number

preb uilts Compilation environment and software

tools Compilation script and tool


Directories/files generated
by compilation
Version
target Firmware
number
Original directory
Windows/Linux compilation script with parameters.
buil d_all.bat/buil d_all.sh
The script is executed on command line.
Original file

CMake Lists.txt Top-level compilation configuration file

Figure 1: CSDK Directory Structure

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 9 / 33
LTE Standard Module Series

3 Compilation Environment Setup

3.1. Host System

If the host system running the compilation environment is Windows, ensure that the host system is 32-bit
or 64-bit Windows 7/10 and install the following software:

⚫ Visual C++ Redistributable for Visual Studio 2015 x86 or above (32-bit Windows)
⚫ Visual C++ Redistributable for Visual Studio 2015 x64 or above (64-bit Windows)

If the host system running the compilation environment is Linux, ensure that the operating system is
Ubuntu 16.04 or Ubuntu 20.04 and the language is Python 3.5 or above, and execute the following
commands to install the required components:

sudo apt install build-essential python3 python3-tk qtbase5-dev


sudo apt install libc6:i386 libstdc++6:i386 zlib1g:i386
sudo apt install protobuf-compiler

3.2. Application Compilation Environment

The application compilation tool chain of EC200U series QuecOpen module adopts gcc-arm-none-eabi,
which is the GCC tool chain of ARM bare metal system. The gcc-arm-none-eabi with version 7.2.1 is
integrated in the QuecOpen CSDK in the directory of prebuilts.

When compiling an application, only the gcc-arm-none-eabi tool chain integrated in the QuecOpen CSDK
is supported and the gcc-arm-none-eabi tool chain installed on the host system is not supported.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 10 / 33
LTE Standard Module Series

4 Application Development

4.1. Application Demo Description

QuecOpen CSDK provides application demos to which users can refer in the directory of components\ql-
application in CSDK for application development.

The application entry, appimg_enter(), is contained in the ql_init.c file in the directory of components\ql-
application\init in the QuecOpen CSDK. Start an initialization thread in this function, and then call the
initialization interface of each feature component in this initialization thread. Each feature component is
divided according to folders, and you can refer to the following figure to add feature component.

Figure 2: Application Entry

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 11 / 33
LTE Standard Module Series

4.2. Add Application Feature Component

This chapter takes the audio Application provided in QuecOpen CSDK as an example to introduce how to
add an application feature component.

4.2.1. Create a Directory of Application Feature Component

First, create a feature directory under the directory of components/ql-application in the QuecOpen CSDK.
Then store the source files, header files, and compilation configuration file CMakeLists.txt in the feature
directory. Taking an audio application as an example, the directory structure is as follows and the inc folder
is used to store header files:

Figure 3: Directory Example of Application Feature Component

4.2.2. Create an Application Thread

Use ql_rtos_task_create() to create the application thread of the feature component in ql_audio_app_init(),
the initialization function of the feature component source code file, as shown in the following example:

Figure 4: Create Feature Component Application Thread

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 12 / 33
LTE Standard Module Series

4.2.3. Modify Configuration File

Modify the application configuration file, components\ql-application\audio\CMakeLists.txt, as needed, with


the following three modifications:

Library name

Header file path

Source file list, supporting relative path

Figure 5: Modify Configuration File

4.2.4. Add Compilation Task

Modify the configuration file, components\ql-application\CMakeLists.txt to add the application feature


component directory to the file so as to compile the directory when compiling the firmware package, as
shown in the following example:

Figure 6: Add Compilation Tasks

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 13 / 33
LTE Standard Module Series

4.2.5. Link Application Feature Component

Modify the configuration file CMakeLists.txt in the directory of components/ql-application/init to add the
name of the library that links the new application feature components. If a feature component compilation
switch is added for the application, the option switch control needs to be added to the file CMakeLists.txt
as well, as shown in the following example:

Figure 7: Link New Application Feature Component and Add Option Switch Control

Compile the firmware according to Chapter 5 when the application feature component is added and the
relevant configuration files are configured.

4.2.6. Feature Component Compilation Switch

QuecOpen CSDK provides ql_app_feature_config.cmake and ql_app_feature_config.h.in under the


directory of components/ql-application to facilitate App side to configure or remove features.
ql_app_feature_config.cmake configures the feature components to be compiled by the compilation script.;

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 14 / 33
LTE Standard Module Series

ql_app_feature_config.h.in generates macro used to enable component. The generated macros will be
used in the code. Configuration or removal of required feature requires simultaneous modifications in both
files (see Chapter 6 for details on the feature removal).

The content of ql_app_feature_config.cmake is shown in the following figure. If a feature component is set
to "ON", it indicates that the feature component will be compiled when the compilation script is executed;
If it is set to "OFF", it indicates that the feature component will not be compiled when the compilation script
is executed.

Figure 8: Configure Compilation Switch

The content of ql_app_feature_config.h.in is shown in the following figure. After adding the compilation
switch of feature components in ql_app_feature_config.cmake, refer to the following figure to add a macro

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 15 / 33
LTE Standard Module Series

of the corresponding feature components:

Figure 9: Add Macro Control

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 16 / 33
LTE Standard Module Series

5 Application Compilation

5.1. Compilation Description

In the directory of components\ql-config\download\pack in QuecOpen CSDK, a folder named after a


module model is included, which holds the default Kernel firmware of the current module version, the
original application firmware stored by Quectel, and the relevant .map and .elf files, as well as the merged
firmware with Kernel and application.

//Kernel firmware and


debugging files

//The merged firmware with


Kernel and App

//Original App firmware and


debugging files

Figure 10: CSDK Original Firmware

The source code of the application is located in directory of components\ql-application and is compiled by
using the compilation script file build_all.bat (the host system is Windows) or build_all.sh (the host system
is Linux) in the root directory of QuecOpen CSDK. Both script files use the same command parameters,
but build_all.sh should be executed by bash command, that is, bash build_all.sh. The following sections
take Windows host system as an example to introduce the application compilation process.

5.2. Compilation Procedure

1. Open CLI or PowerShell (only Windows 10 supports PowerShell) and execute build_all.bat -h to
query the usage. The common commands are as follows:

⚫ Compile command: build_all <r/new> <Project> <Version>[VOLTE] [DSIM] [debug/release]


<r/new> Compilation type. r indicates incremental compilation and w indicates new

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 17 / 33
LTE Standard Module Series

compilation.
<Project> Quectel module model in use. This parameter must be the same as the folder
name in the directory of components\ql-config\download\pack.
<Version> The name of the compiled application firmware, which can be customized.
[VOLTE] VoLTE feature (optional). VOLTE or NOVOLTE. Default: NOVOLTE.
[DSIM] Single/dual card (optional). SINGLESIM: single card. DOUBLESIM: dual card.
Default: SINGLESIM.
[debug/release] Version (optional). A debug firmware is generated if you choose debug and an
official releasable firmware is generated if you choose release. Default: release.

⚫ Clears files generated during the previous compilation: build_all clean.

2. In CLI or PowerShell (only Windows 10 supports PowerShell), enter QuecOpen CSDK root directory
and execute build_all <r/new> <Project> <Version>[VOLTE] [DSIM] [debug/release] to start
compiling.

After the command is executed, the compilation script first checks whether the directory of
components\ql-config\download\pack in QuecOpen CSDK contains a directory named <Project>, and
if so, the compilation script continues compiling; If not, an error is reported and the compilation fails.
The execution results are shown in the following figure:

Figure 11: Compile Application

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 18 / 33
LTE Standard Module Series

5.3. Compilation Result

During the compilation process, an out directory is generated in the QuecOpen CSDK root directory to
store the generated compilation files.

After a successful compilation, a target directory is generated in the QuecOpen CSDK root directory, which
stores the compiled Kernel firmware, target application firmware, and firmware containing Kernel and
application. If only the application firmware needs to be updated, burn the newly generated application
firmware; If both the application firmware and the Kernel firmware need updating, burn the newly generated
firmware package containing the Kernel and the application.

App firmware
Compilation output file

Kernel firmware
Firmware containing Kernel and App

Figure 12: Compilation Results

5.4. Compiled File Clearance

Open a CLI or PowerShell (only Windows 10 supports PowerShell) and execute build_all clean to clear
the compiled files in the out directory in QuecOpen CSDK but will not delete the target firmware in the
target directory. When the compilation command parameters are the same, the firmware generated in the
previous compilation version stored in the target directory will be automatically cleared before the current
compilation operation is successful. If the compilation command parameters are different, the firmware
generated in the previous compilation version stored in the target directory will not be cleared.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 19 / 33
LTE Standard Module Series

6 Feature Removal

6.1. Feature Removal in Kernel

QuecOpen CSDK opens all feature components by default, and the removable libraries are listed in
CMakeLists.txt in the root directory. Each library is removed according to the macro control of kernel
feature components, but the basic libraries are not allowed to be removed. You can remove the required
feature in components\ql-config\build\{project model}\8915DM_cat1_open\target.config. A new
compilation is required after removal, and Kernel firmware uses the files generated after compilation. See
the following table for the removable libraries.

Figure 13: Removable Libraries in Kernel

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 20 / 33
LTE Standard Module Series

You can see the following modification configuration file target.config for feature removal:

Figure 14: Feature Removal in Kernel

See the following table for the removable libraries in Kernel.

Table 2: The Removable Libraries in Kernel

Feature Macro Feature Dependency


CONFIG_QUEC_PROJECT_FEATURE
USBnet -
_USBNET
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
GNSS
_GNSS ATURE_UART
CONFIG_QUEC_PROJECT_FEATURE
RTC -
_RTC
CONFIG_QUEC_PROJECT_FEATURE
Virtual AT port -
_VIRT_AT
CONFIG_QUEC_PROJECT_FEATURE
FOTA -
_FOTA
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
SMS
_SMS ATURE_HTTP
CONFIG_QUEC_PROJECT_FEATURE
Voice call -
_VOICE_CALL
CONFIG_QUEC_PROJECT_FEATURE
FTP -
_FTP
CONFIG_QUEC_PROJECT_FEATURE
HTTP -
_HTTP
CONFIG_QUEC_PROJECT_FEATURE
SSH -
_SSH2
CONFIG_QUEC_PROJECT_FEATURE MQTT -

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 21 / 33
LTE Standard Module Series

_MQTT

CONFIG_QUEC_PROJECT_FEATURE
Ping -
_PING
CONFIG_QUEC_PROJECT_FEATURE
NTP -
_NTP
CONFIG_QUEC_PROJECT_FEATURE
MMS -
_MMS
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
LBS
_LBS ATURE_HTTP
CONFIG_QUEC_PROJECT_FEATURE
UART -
_UART
CONFIG_QUEC_PROJECT_FEATURE
I2C -
_I2C
CONFIG_QUEC_PROJECT_FEATURE
Matrix keyboard -
_KEYPAD
CONFIG_QUEC_PROJECT_FEATURE
LCD -
_LCD
CONFIG_QUEC_PROJECT_FEATURE
BT -
_BT
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
BT HFP
_BT_HFP ATURE_BT
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
A2DP
_BT_A2DP_AVRCP ATURE_BT
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
BLE
_BLE_GATT ATURE_BT
CONFIG_QUEC_PROJECT_FEATURE
Camera -
_CAMERA
CONFIG_QUEC_PROJECT_FEATURE
SPI -
_SPI
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
SPI4 Flash
_SPI_FLASH ATURE_SPI
CONFIG_QUEC_PROJECT_FE
CONFIG_QUEC_PROJECT_FEATURE ATURE_SPI
SPI4 NOR Flash
_SPI_NOR_FLASH CONFIG_QUEC_PROJECT_FE
ATURE_SPI_FLASH
CONFIG_QUEC_PROJECT_FE
CONFIG_QUEC_PROJECT_FEATURE ATURE_SPI
SPI4 NAND Flash
_SPI_NAND_FLASH CONFIG_QUEC_PROJECT_FE
ATURE_SPI_FLASH
CONFIG_QUEC_PROJECT_FEATURE
SDMMC -
_SDMMC
CONFIG_QUEC_PROJECT_FEATURE
PBK -
_PBK

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 22 / 33
LTE Standard Module Series

CONFIG_QUEC_PROJECT_FEATURE
File compression -
_FILE_ZIP
CONFIG_QUEC_PROJECT_FE
ATURE_SPI
CONFIG_QUEC_PROJECT_FEATURE SPI4 NAND Flash CONFIG_QUEC_PROJECT_FE
_FS_NAND_FLASH (file system) ATURE_SPI_FLASH
CONFIG_QUEC_PROJECT_FE
ATURE_SPI_NAND_FLASH
CONFIG_QUEC_PROJECT_FEATURE SPI6 NOR FLASH
-
_SPI6_EXT_NOR (file system)
CONFIG_QUEC_PROJECT_FEATURE File system AT
-
_FILE_AT command
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
HTTP OTA
_CLOUDOTA ATURE_HTTP
CONFIG_QUEC_PROJECT_FEATURE
VoLTE -
_VOLTE
CONFIG_QUEC_PROJECT_FEATURE
Audio -
_AUDIO
CONFIG_QUEC_PROJECT_FEATURE
USB -
_USB
CONFIG_QUEC_PROJECT_FEATURE
LED&PWM -
_LEDCFG
CONFIG_QUEC_PROJECT_FEATURE
Wi-Fi Scan -
_WIFISCAN

6.2. Feature Removal in BootLoader

The following features in BootLoader are removable. If a feature is not required, disable it in target.config;
If a feature is required, enable the feature intarget.config and then call the feature initialization function in
boot2_start_8910.c. New compilation is required after feature removal.

Table 3: The Removable Libraries in BootLoader

Feature Macro Feature Dependency


CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
Boot LCD
_BOOT_LCD ATURE_LCD
CONFIG_QUEC_PROJECT_FEATURE
Boot FAT file system -
_BOOT_FAT
CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
Boot SDMMC
_BOOT_SDMMC ATURE_BOOT_FAT

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 23 / 33
LTE Standard Module Series

CONFIG_QUEC_PROJECT_FEATURE CONFIG_QUEC_PROJECT_FE
Boot NAND Flash
_BOOT_NAND_FLASH ATURE_BOOT_FAT

Figure 15: Feature Initialization Function

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 24 / 33
LTE Standard Module Series

7 Preset File
A preset file is a specified initial file packaged in a firmware package, which is written directly to the module
file system during firmware downloading. Preset files take up file system space, and the maximum size of
a single preset file is currently limited to 512 KB. If the file size exceeds 512 KB, the file will be skipped
when it is downloaded.

7.1. Enable Preset File Package

In the ql_app_feature_config.cmake file, you can configure whether to package the preset file through
QL_APP_PACK_FILE, as shown in the following figure:

Pre-set file switch

Path of the pre-set file to be packaged

Figure 16: Preset File Package Compilation Configuration

NOTE

The preset files package compilation configuration is affected by the GNSS in SDK. When GNSS is
enabled, the GNSS chip firmware (currently with the size about 238 KB) will be packaged into the APP
firmware as a preset file by default. For details about the GNSS supported by the EC200U series
QuecOpen module, see the hardware design documents corresponding to each module.

If other feature files need to be preset, you should add the corresponding feature switch. For example, if
you want to preset audio file, add a switch for audio.

Figure 17: Add a Feature Switch for Preset File

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 25 / 33
LTE Standard Module Series

7.2. Preset File Configuration

QL_APP_PACK_FILE_JSON_PATH in ql_app_feature_config.cmake file specifies the path of the specific


configuration of the preset file. The script packs the preset file according to the specified json file. The json
file in CSDK specifies the path of the GNSS chip firmware, which is represented by a relative path, that is,
it is located in the same path where the json file is stored. You can refer to this format in the json file to add
and modify in the "files" node in the figure below. Be careful not to preset too many files to avoid taking up
too much file system space.

Path and name of the specified file

The path where the file is located

Figure 18: Preset Package Configuration File

The preset files usually are downloaded to the directory of user. which is convenient for you to query
through the FILE API of module. Note that the total length of the file path and file name to be written cannot
exceed 192 bytes.

7.3. Preset File Download and Upgrade

The preset file can also be downloaded, upgraded or deleted by FOTA.

⚫ Upgrade the preset file in the old firmware version to that in the new firmware version.
⚫ If the old firmware version does not have a preset file, you can add a preset file by FOTA.
⚫ If the old firmware version has a preset file and the new firmware version does not have a preset file,
the preset files will be deleted after FOTA upgrade;

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 26 / 33
LTE Standard Module Series

⚫ If the preset files need to be ignored in FOTA upgrade, you can modify the value of method to “ignore”
from “diff” in <paccpio id="PREPACK" method="diff"> </paccpio> of xml configuration file. See
document [2] for details.

Figure 19: Ignore the Preset File in FOTA

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 27 / 33
LTE Standard Module Series

8 Flash Partition Adjustment


Quectel EC200U Series QuecOpen module supports adjusting embedded flash partitions, including Kernel,
application and file system partition size. See document [3] for specific implementation.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 28 / 33
LTE Standard Module Series

9 Firmware Burning
Quectel EC200U Series QuecOpen module supports burning firmware with QFlash. See document [1]
for QFlash usage.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 29 / 33
LTE Standard Module Series

10 FAQ
10.1. Common Compilation Error in Linux

1. If the error shown in the following figure occurs, it indicates that the required software is not installed
on the host system. Just reinstall the software and see Chapter 3.1 for details.

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 30 / 33
LTE Standard Module Series

2. If there is an error message "dtools: error while loading shared libraries: libicui18n.so.55:canot
openShared object file:No such file or directory. Ninja:build stopped:subcommand failed", it indicates
dtools is missing a component. You can install the component by executing the following command in
sequence.

wget http://security.ubuntu.com/ubuntu/pool/main/i/icu/libicu55_55.1-7_amd64.deb
sudo dpkg -i libicu55_55.1-7_amd64.deb

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 31 / 33
LTE Standard Module Series

11 Appendix References
Table 4: Related Documents

Document Name

[1] Quectel_QFlash_User_Guide

[2] Quectel_EC200U_Series_QuecOpen_FOTA_API_Reference_Manual

[3] Quectel_EC200U_Series_QuecOpen_Embeded_Flash_Partition_Adjustment_Guide

Table 5: Terms and Abbreviations

Abbreviation Description

(U)SIM (Universal) Subscriber Identity Module

A2DP Advanced Audio Distribution Profile

ADC Analog-to-Digital Converter

API Application Programming Interface

App Application

BLE Bluetooth Low Energy

BT Bluetooth

CLI Command-line Interface

FOTA Firmware Over-The-Air

FTP File Transfer Protocol

GCC GNU Compiler Collection

GNSS Global Navigation Satellite System

GPIO General-Purpose Input/Output

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 32 / 33
LTE Standard Module Series

HFP Hands-free Profile

HTTP Hypertext Transfer Protocol

I2C Inter-Integrated Circuit

IoT Internet of Things

LBS Location Based Services

LCD Liquid Crystal Display

LED Light Emitting Diode

MMS Multimedia Messaging Service

MQTT Message Queuing Telemetry Transport

NTP Network Time Protocol

OSI Open System Interconnection Reference Model

PBK Phonebook

PWM Pulse Width Modulation

RTC Real Time Clock

RTOS Real-Time Operating System

SDMMC Secure Digital/MultiMediaCard

SMS Short Message Service

SPI Serial Peripheral Interface

SSH Secure Shell

UART Universal Asynchronous Receiver/Transmitter

USB Universal Serial Bus

VoLTE Voice (voice calls) over LTE

Wi-Fi Wireless Fidelity

EC200U_Series_QuecOpen_CDSK_Quick_Start_Guide 33 / 33

You might also like