Link Search Menu Expand Document

Quickstart Guide

  1. Install PiloT scripts
  2. Power up the PiloT board
  3. PiloT modem check and set configuration
  4. Install required RPi apps
  5. Uninstall RPi apps not required
  6. Configure the cellular network connection
  7. Notes

This guide installs a universal IP cellular connectivity solution onto the Raspbian OS targeting the PiloT HAT board and Raspberry PI (RPi) hardware.

NetWorkManager, NetworkManager GUI and ModemManager are installed onto a Raspbian OS

NetworkManagers GUI (NetworkManager Applet) is used to configure cellular IP connectivity and to stop, start and monitor IP connections

This QuickStart guide requires

  • Raspberry Pi
  • Standard Raspian desktop installation ***
  • Pilot board and USB cable


Install PiloT scripts

  1. Clone the project into your RPi (maybe use a shell terminal). This creates a local copy of the project which includes this documentation and any project related scripts 
    git clone http://github.com/johnofleek/PiloT
  2. Install the minicom command line terminal emulation application 
    sudo apt-get install minicom

Power up the PiloT board

  1. From a shell terminal - power on the PiloT using a convenient script (doesn’t apply to uPiloT) 
    ./pilotOn.sh

    If this script fails to power up the PiloT
    Check that the wiringPi version installed on on your RPi Raspian is compatible with the RPi hardware in use. For example at the time of writing the RPi4 HW needs an updated wiringPi install

  2. For information on your PiloT’s LED behaviour click LED behaviour and follow the links to the module fitted to your PiloT


PiloT modem check and set configuration

  1. Run minicom (check the actual serial port to use)
    To enable AT commands to be sent to the PiloT modem - - note that if NetworkManager ModemManager is running then stop them before trying to send commands to the modem 
    sudo minicom -D /dev/ttyACM0
  2. Read the PiloT modem information
    Type the following AT command into minicom - the PiloT modem will report information about itself such as it’s Firmware version. On some modems the serial port times out when there is no activity - the first carriage return will wake the modem up 
    <CR>
ATi9<CR>
  3. Check the PiloT modem information
    A number of PiloT + RPi + Raspbian combinations have been tested, they are listed here
    Here are some things to check if a problem occurs at some point later in the QuickStart process
    • Does the modem appear in the list but the reported modem firmware is older than in the list? It’s possible to update the modem firmware by connecting the PiloT USB port to a Windows PC and use a one click .exe installer from here to install updated firmware into the PiloT modem
    • Check the reported PiloT modem type is listed?
    • Check if your RPi variant is listed?
    • Check if your Raspian version is listed
    • Check the NetworkManager version?
  4. Configure the PiloT modem as required (based on firmware identified above)
    • Carry out the modem specific configuration instructions
      Please pay particular attention to the usb composition setting - if in doubt check the AT command manual for the particular modem that is being used - if it’s supported by the modem a composition with an MBIM setting is recommended
  5. Power down the PiloT HAT by running the following script 
    ./pilotOff.sh
  6. Reboot the RPi


Install required RPi apps

  1. Power down the PiloT HAT 
    ./pilotOff.sh
  2. Install network-manager 
    sudo apt-get install network-manager
  3. Install the GUI network-manager-gnome 
    sudo apt-get install network-manager-gnome


Uninstall RPi apps not required

  1. Remove openresolv and dhcpcd as they interfere with the operation of network manager 
    sudo apt purge openresolv dhcpcd5

    It is also possible to uninstall the dhcpcd GUI as it’s no longer functional

  2. Reboot the RPi


Configure the cellular network connection

  1. From a shell terminal power on the PiloT by executing the script 
    ./pilotOn.sh
  2. Wait for Mobile Broadband to appear in the NetworkManager GUI this should be visible on the Rpi Panel (probably top right)
  3. It’s not advised to use the NetworkManager GUI to configure your wwan0 settings
    such as APN / username / password - this is because the GUI uses a complex storage method for the cellular credential “password”. This then causes issues (Buster) on startup with the GUI prompting for a password
  4. Instead follow the command line method described in detail here
    Further notes 1
  5. If everything is installed and configured correctly NetworkManager should connect the modem when the mobile broadband profile you created is clicked in the NetworkManager GUI
  6. To power down the PiloT run the following script 
    ./pilotOff.sh

Notes

  • The instructions assume that the git project has been cloned into the users home directory. To access or run the power control scripts

    cd ~/Pilot/scripts_pilotControl

  • The paths used in this guide - for example ./pilotOn.sh assumes that the user has changed directory to the directory which contains the pilotOn.sh script - the shell command [ls] will list what is available in a directory

  • To start a Raspbian shell terminal - hold down keys [CTRL] [ALT] T or use the RPi Terminal icon

  • Desktop installation was selected so that NetworkManager GUI can be used. NetworkManager GUI provides a simple way to control and observe NetManager behaviour, however, the underlying technology will work with a non-GUI system

  • The NetworkManager GUI is called the network manager applet in it’s about box

J Thompson 2022