Skip to content

Commit bd11f9d

Browse files
committed
quectel: Update readme and submodule.
Signed-off-by: Nikola Neskovic <nikola.neskovic@quectel.com>
1 parent d5b3496 commit bd11f9d

2 files changed

Lines changed: 16 additions & 12 deletions

File tree

lib/helios

Submodule helios updated 1 file

ports/quectel/README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ MicroPython on quectel port requires the HeliosSDK. The HeliosSDK includes the
2020
manage the quectel microcontroller, as well as a way to manage the required
2121
build environment and toolchains needed to build the firmware.
2222

23-
To install the HeliosSDK the full instructions can be found at the
24-
[HeliosSDK Development Guide](https://developer.quectel.com/doc/quecpython/Application_guide/en/helios-sdk/quick-start.html).
25-
2623
**Windows 10 Environment Setup**
2724

2825
*Step 1: Download Toolchain*
@@ -52,12 +49,15 @@ Enter the following command in the terminal to install `p7zip-full`, `git`, `mak
5249
```
5350
sudo apt install p7zip-full git make python3
5451
```
52+
The sdk tools require a specific version of the libicu library which can be installed with the following commands:
53+
```
54+
curl -L http://archive.ubuntu.com/ubuntu/pool/main/i/icu/libicu55_55.1-7ubuntu0.5_amd64.deb -o libicu55.deb
55+
sudo dpkg -i libicu55.deb || true
56+
```
5557

5658
*Source Code*
5759

58-
For HeliosSDK, please contact the [QuecPython technical team](https://developer.quectel.com/contact) for the source code of HeliosSDK(We are preparing to open source), You can also get supports through email QuecPython@quectel.com.
59-
60-
For MicroPython, You can directly pull the official code, but you need to pull MicroPython into the heliossdk directory, for example, create a services directory under heliossdk and place MicroPython in the services directory.
60+
For MicroPython, You can directly pull the official code, and follow the steps below.
6161

6262
Building the firmware
6363
---------------------
@@ -67,21 +67,25 @@ Before you start building the firmware, you must build the MicroPython cross com
6767
> If you are in a Windows environment, you need a Windows compilation toolchain, such as MinGW.
6868
6969
```bash
70-
# path: heliossdk/services/micropython
7170
$ make -C mpy-cross
7271
```
7372

7473
Then to build MicroPython for the quectel run:
7574

7675
```bash
77-
# path: heliossdk/services/micropython
7876
$ cd ports/quectel
7977
$ make submodules
80-
$ make
78+
$ make BOARD=<board_name>
8179
```
8280

83-
This will produce a combined `firmware.a` lib in the `build/`
84-
subdirectory directly.The compiled MicroPython library will be used by HeliosSDK to build a complete firmware package. Of course, you can also build the entire firmware directly using the following method.
81+
This will compile the firmware in `micropython/lib/helios/output/release/<board_name>` directory.
82+
83+
The firmware can also be built from the sdk directory by cloning the sdk from the https://github.com/QuecPython/Helios-SDK repository, and following the next steps to compile.
84+
85+
It may be necessary to create a symlink to the micropython folder in the services directory of HeliosSDK. To do this create a services folder in the sdk directory and create the link with the following command:
86+
```
87+
ln -s path/to/micropython path/to/HeliosSDK/services
88+
```
8589

8690
*Check the usage of the helios compilation commands*
8791

0 commit comments

Comments
 (0)