Upgrading the Quectel module firmware

From time to time, you may need to upgrade your Quectel module firmware.

Before you begin

You need:

  • A Windows computer (version 1909 or later), or up-to-date Linux system, with administrator access.
  • The Quectel module where you want to update the firmware.

  • The relevant cable with data transfer capability (such as a Micro USB cable) for connecting the Quectel module to the computer. Ensure the cable is connected to the device and the computer.

  • If required, a jumper wire to power up the Quectel module, for example if it is part of an LTE IoT 2 click.

  • Contact your Account Manager to receive a link to the Quectel module files. Please specify if you require Windows or Linux-based files.

Download and extract the following zip files using the supplied link, where <version> is the latest version:

  • For Windows users:
    • Quectel LTE&5G Windows USB Driver – Quectel_LTE&5G_Windows_USB_Driver_V<version>.zip
    • QFlash for Windows – QFlash_V<version>_EN_Windows.zip
  • For Linux users:
    • Quectel Linux USB driver – Quectel_Linux_USB_Serial_Option_Driver_V<version>.zip
    • QFirehose for Linux – Quectel_LTE_5G_QFirehose_Linux_Android_V<version>.zip

    Up-to-date Linux systems support a USB connection to the Quectel module.

You must also download and extract the Quectel module firmware for your specific Quectel module model (the model number is located at the top of the chip) – for example, BG96...zip.

If you are not using AnyNet SMARTconnect™, you must request a firmware update for your module from Quectel Support. If you are using AnyNet SMARTconnect™, Eseye will supply you with the firmware file as part of AnyNet SMARTconnect™ installation. For more information, see Installing AnyNet SMARTconnect™ on the Quectel module.

Installing the Windows USB drivers

To install the Windows USB drivers:

  1. In the extracted Quectel_LTE&5G_Windows_USB_Driver_V<version> folder, locate and run setup.exe to start the InstallShield Wizard.

  2. If required, change the destination location, then select Next.

  3. Select Next to copy the files into the specified location and install the drivers.

    Depending on your Windows security, a warning may appear. Select Install.

    The InstallShield Wizard Complete window appears when the drivers are successfully installed.

  4. Select Finish to exit the wizard.

Connecting to the Quectel module

Next, you must connect the Quectel module to the computer and power it up.

Consult your development board circuit diagram to find the pin that drives the PWR key. For example, use a jumper wire to power up the LTE IoT 2 click, using the PWK and 5V pins.

You need only touch the pins briefly to power up.

Do not disconnect the power supply to the Quectel module at any time. The module requires power at all times, even during sleep mode.

To check the USB DM port number:

  1. Using the computer, open Device Manager.

  2. Expand Ports (COM & LPT).

    If Ports (COM & LPT) does not exist, ensure that you have correctly installed the USB drivers, and that the cable can transfer data.

  3. Make a note of the Quectel USB DM Port number, which will vary depending on computer and USB port.

Updating the module firmware

To update the module firmware:

  1. In the extracted QFlash_<version>_EN_Windows folder, locate and run QFlash_V<version>.exe to launch the application.

  2. In the COM Port drop-down list, select the port number that matches the Quectel USB DM Port number.
  3. In the Baudrate drop-down list, select an appropriate rate, for example 460800.
  4. Select Load FW Files.
  5. In the Open window, browse to the supplied firmware folder, for example BG96....
  6. In the update folder, double-click apps.mbn to load the firmware files onto the connected Quectel module.

  7. Select Start to upgrade the module firmware.

  8. If the Do you need MBN autosel feature enabled by default? dialog appears, select OK.

    Do NOT select the MBN autosel feature enabled checkbox.

  9. Wait for the firmware upgrade to finish.

    When the process completes, a PASS message should appear in the QFlash_V<version> window.

  10. If a FAIL message appears, start the procedure again.

    If the upgrade consistently fails, ensure the DM Port is correct. Alternatively, contact Support.

Connecting to the Quectel module

Next, you must connect the Quectel module to the computer and power it up.

Consult your development board circuit diagram to find the pin that drives the PWR key. For example, use a jumper wire to power up the LTE IoT 2 click, using the PWK and 5V pins.

You need only touch the pins briefly to power up.

Do not disconnect the power supply to the Quectel module at any time. The module requires power at all times, even during sleep mode.

Checking the existing Linux USB drivers

Before installing the Linux USB drivers, check which drivers already exist on your Linux system.

To check your existing drivers:

  1. Using the Linux command terminal, run: sudo dmesg | grep tty

    If Linux correctly recognized the Quectel module, then four USB interfaces are listed in consecutive order, for example:

    If less than four USB interfaces exist, you must install the USB drivers.

    The initial two USB interfaces enable you to update the Quectel module firmware using QFirehose, and install AnyNet SMARTconnect™ using QExplorer. The last two USB interfaces enable you to connect to the Quectel module with a terminal emulator (such as PuTTY), in order to send AT commands.

Downloading the required files for Linux

To download the required Linux files:

  1. Go to: <dropbox link>

  2. Download and extract the following ZIP files for updating the module firmware (where <version> is the latest version):

    • Quectel_Linux_USB_Serial_Option_Driver_V<version>.zip

    • Quectel_LTE_5G_QFirehose_Linux_Android_V<version>.zip

      If you are not using AnyNet SMARTconnect™, you must request a firmware update for your module from Quectel Support. If you are using AnyNet SMARTconnect™, Eseye will supply you with the firmware file as part of AnyNet SMARTconnect™ installation. For more information, see Installing AnyNet SMARTconnect™ on the Quectel module.

Installing the USB drivers

To compile and install the USB drivers:

  1. Using the command terminal, run: uname -r

  2. Note your Linux kernel version.

  3. Navigate to the correct extracted subfolder: Quectel_LTE_5G_Linux_USB_Driver_V<version>/<kernelversion>

    where <kernelversion> matches your Linux kernel version.

    If your kernel version is higher than those available, use the latest version.

  4. Run: sudo make install

    This command compiles and installs the drivers.

  5. Restart Linux.

  6. Run: sudo dmesg | grep tty

    This command checks if Linux correctly recognises the Quectel module. The response should contain four USB interfaces, listed in consecutive order.

Updating the module firmware

To update the module firmware:

  1. Using the command terminal, navigate to the extracted Quectel_LTE_5G_QFirehose_Linux_Android_V<version> folder.

  2. Run: sudo make

    This command compiles QFirehose. If it is successful, you will see the QFirehose file.

  3. Run: sudo ./QFirehose -f <<Module>...>

    where <<Module>...> is the path to the supplied firmware folder, for example BG96....

  4. Reboot the Quectel module.
  5. Use a terminal emulator such as PuTTY to connect to the relevant USB interface, for example: ttyUSB2.

  6. Send: AT+QGMR

    If the connection is valid, the firmware version is returned. This should match the version you installed.

Where to next?