Getting Started

Hardware Prerequisites

Hardware Setup

1. Insert your μSIM card into HAT.

2. Attach the antenna to the HAT

3. Attach the HAT to the Raspberry Pi.

4. Connect the Micro-USB cable to the HAT and Raspberry Pi.

Software Setup

Enabling serial console

By default, the primary UART is assigned to the Linux console. If you wish to use the primary UART for other purposes, you must reconfigure Raspberry Pi OS. This can be done by using raspi-config:

  1. Start raspi-config: sudo raspi-config.
  2. Select option 5 - interfacing options.
  3. Select option P6 - serial.
  4. At the prompt Would you like a login shell to be accessible over serial? answer 'No'
  5. At the prompt Would you like the serial port hardware to be enabled? answer 'Yes'
  6. Exit raspi-config and reboot the Pi for changes to take effect.

Library Installation

  1. Download the Cellular IoT HAT repository.
git clone
  1. Goto directory Sixfab_RPi_CellularIoT_Library.
cd Sixfab_RPi_CellularIoT_Library
  1. Complete the installation.
sudo python3 install

Internet connection

We have two options to reach the internet using mini PCle module with our Base HAT and Raspberry Pi.
  1. PPP (Point to Point Protocol)
  2. QMI (Qualcomm MSM Interface)
So which one among PPP & QMI should I select?


PPP(Point-to-Point Protocol) is a data layer communication protocol that is established through the serial port of the modem. These Serial port communication could be either the UART(/dev/ttyS0) or the serial exposed to USB(/dev/ttyUSB3). This serial is also used for both modem commands (AT commands) and responses. This connection is established by dial-up (ATD*99#)

PPP is easy to establish, widely used protocol, and flexible with the devices. PPP may show a drop of the connection while using the AT command set for other functionality of modem.

The LTE radio protocol has native support of TCP/IP and IPv6, so there is no need to actually wrap TCP/IP into PPP over the radio interface. The PPP protocol is just used between the computer and the modem to make the connection look like a legacy dial-up modem-based network connection.
To get rid of the legacy cruft, newer ways to present USB-connected LTE modems like QMI and MBIM have been developed.

Quectel modules offer QMI(Qualcomm MSM Interface) which is established as a real network interface, such as ethernet(typically shows as wwan0). The QMI is also counted among the non-AT protocols which is communicated over /dev/cdc-wdm0 port.

In order to establish a connection, proper qmi/gobinet proxy should be installed, which again depends on the chipset of the module/modem and the kernel of linux, gets a bit complicated. The QMI offers more accessible and faster connection compared to the PPP protocol.

We recommend QMI, if you are looking for faster connection, and for longer duration.

If you need to establish an internet connection for a short period of time and the date to be transferred is not high, you may stick to PPP.

Follow the tutorials:

Updated 8 days ago

Getting Started

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.