FreeRTOS: FreeRTOS Cellular Library
FreeRTOS Cellular Library
FreeRTOS Cellular Library Documentation

FreeRTOS Cellular Library provides cellular network connectivity.
This documentation provides the following information about FreeRTOS Cellular Library.

  • API documentation for users of FreeRTOS Cellular Library
  • Porting guide about FreeRTOS Cellular Library for developers who want to port the library to new platform

FreeRTOS Cellular Library

  • Repository structure
    This library contains the following three components in three folders.
    FreeRTOS Cellular Library folders High Level Description
    include FreeRTOS Cellular Library APIs definitions help to abstract the control of cellular module.
    common FreeRTOS Cellular Library APIs implemenation with 3GPP TS v27.007 AT commands.
    modules FreeRTOS Cellular Library APIs implemenation with cellular module specific AT commands.
  • Supported cellular modules
    Three cellular modules are supported in this library.
    Cellular module
    quectel BG96
    Sierra HL7802
    Ublox SARA R4 series
    New cellular module can reference these module porting to be integrated into FreeRTOS Cellular Library.
    Please reference cellular common library document for detail information about porting new cellular module.
  • Currently Supported Features in FreeRTOS Cellular Library
    • User of FreeRTOS Cellular Library is able to use Cat-M1 cellular technology to connect to network.
    • User of FreeRTOS Cellular Library is able to perform control plane operations like (initialize modem, register on a network etc.) in a vendor agnostic way.
    • User of FreeRTOS Cellular Library is able to send and receive data using TCP/IP in a vendor agnostic way given that TCP/IP stack is running on the cellular modem.
    • User of FreeRTOS Cellular Library is able to put the modem in different low power modes (PSM and eDRX) in a vendor agnostic way.
    • User of FreeRTOS Cellular Library is able to receive asynchronous notifications about various events like "disconnected", "signal strength changed" etc. to enable them to take appropriate action as desired.
    • User of FreeRTOS Cellular Library is able to use the existing application protocol clients (MQTT, HTTP) over cellular seamlessly. i.e. any existing user application using MQTT which works over WiFi/Ethernet shall work over Cellular given the underlying cellular technology permits that.

Porting FreeRTOS Cellular Library