Awesome

<b>Dear ubxlib community</b>,

After careful consideration, we have decided to discontinue the ubxlib project. This decision was not made lightly, and we want to thank everyone who has contributed, used, and supported this project over the years.

The repository will be archived on 2024-11-08. This means it will become read-only, but you will still be able to fork and clone it. Open issues will be closed till end of 2024. Afterwards no more support for ubxlib is available. For any questions please use our support portal.

Thank you for your understanding.

Best regards, The ubxlib team

<i>Note: if you are reading this from a package-file created by a third-party [e.g. PlatformIO] and the links do not work, please try reading it at the original ubxlib Github site instead.</i>

Introduction to ubxlib

This repository contains an add-on to microcontroller and RTOS SDKs for building embedded applications with u-blox products and services. It provides portable C libraries which expose APIs with examples. ubxlib supports u-blox modules with cellular (2G/3G/4G), short-range (Bluetooth and Wi-Fi) and positioning (GNSS) functionality. The ubxlib libraries present high level C APIs for use in customer applications (e.g. connect to a network, open a TCP socket, establish location, etc.) and implements these APIs on selected popular MCUs, also available inside u-blox modules.

The goal of ubxlib is to deliver a single tested solution, with examples, which provides uniform easy-to-use APIs across several u-blox products. Releases of ubxlib are tested automatically for all configurations on multiple boards in a test farm.

The easiest way to quickly explore ubxlib is to start with a board listed in the test farm. u-blox EVKs (evaluation kits) or application boards can be found here or at major electronics distributors and code examples which run on the u-blox XPLR-IOT-1 platform can be found here. If you've heard enough and want to get started with the XPLR-IOT-1 platform, or maybe with PlatformIO, jump straight to How To Use This Repo below.

ubxlib runs on a host microcontroller and has a peripheral attached. This setup is very common in embedded applications. An example of such a host-peripheral configuration with EVK-NINA-B301 (Bluetooth 5.0) and EVK-R4 (SARA-R4 with 2G/3G/4G) in which the ubxlib host sets up a TCP connection is shown in the following figure. Many other combinations can be achieved, with the supported hosts and peripherals in the tables in the next section.

APIs

The key APIs provided by this repo, and their relationships with each other, are shown in the picture below.

• If you wish to bring up a device/network and don't care about the details, use the common device and network APIs, which can bring up cellular, BLE/Wi-Fi or GNSS network(s) at your choosing.
• If you wish to use a socket over that network, use the common sock API.
• If you wish to use security, use the common security API.
• If you wish to contact an MQTT broker over that network, use the common mqtt_client API.
• If you wish to use HTTP, use the common http_client API.
• If you wish to get a location fix use the common location API.
• If you wish to build a geofence that can be used with gnss, wifi and cellular, see the common geofence API.
• If you wish to take finer control of cellular, ble, wifi or gnss, use the respective control API directly.
• GNSS may be used via the gnss API.
• The BLE and Wi-Fi APIs are internally common within u-blox and so they both use the common short_range API.
• The at_client API is used by the cellular and short range APIs to talk to AT-based u-blox modules.
• The ubx_protocol API implements the necessary encoding/decoding to talk to u-blox GNSS modules.
• The port API permits all of the above to run on different hosts; this API is not really intended for customer use - you can use it if you wish but it is quite restricted and is intended only to provide what ubxlib needs in the form that ubxlib needs it.

All APIs are documented with Doxygen compatible comments: simply download the latest Doxygen and either run it from the ubxlib directory at a command prompt or open Doxyfile in the Doxygen GUI and run it to obtain the output.

Supported ubxlib host platforms and APIs

Hosts run ubxlib and interact with an attached periperal. A host platform contains an MCU, toolchain and RTOS/SDK as listed in the table below. Hosts are typically u-blox open CPU (standalone) modules or other MCUs. To use a host you need a development board or an EVK. Currently ubxlib supports and tests the following purchasable boards out-of-the box.

• u-blox XPLR-IOT-1
• u-blox XPLR-HPG-1
• u-blox XPLR-HPG-2
• u-blox C030-U201 board
• u-blox NINA-W1 EVK
• Nordic nRF52840 DK board
• Nordic nRF5340 DK board
• ESP32-DevKitC
• STM32F4 Discovery board
• STM32F7 Nucleo board
• STM32U5 Nucleo board
• NXP FRDM-MCXN947 board

If your MCU is on the list but your board is not:

• just set the HW pins in the source file of the example to match how your MCU is wired to the u-blox peripheral.

If your MCU is not on the list:

• if you are using PlatformIO and Zephyr then any MCU that Zephyr supports should work with ubxlib, just follow the instructions here to bring ubxlib into your existing PlatformIO environment,
• otherwise, to port ubxlib to a new host platform follow the DIY instructions for the port API.

^{1: For development/test purposes only.}</br> ^{2: Only SPS API provided for native (on-chip) BLE interface, other APIs for native (on-chip) access, e.g. WiFi support, are a work in progress.}

Supported modules as ubxlib peripherals and APIs

Peripherals are u-blox modules which accept commands (e.g. AT-commands) over a serial interface and have no open MCU environment. To run the APIs they need to be attached to a host which runs ubxlib. For example in the test farm combinations of hosts and peripherals are listed.

^{3: Through the u-blox CellLocate mobile network-based location service.}<br /> ^{4: Beta support: please add short_range_gen2 to the UBXLIB_FEATURES variable in your make or CMake file when building ubxlib for NORA-W36; NORA-W36 comes with a second generation u-connectExpress, please see the release notes for NORA-W36 for the supported features.}<br /> ^{5: Except SARA-R422 (non-S), which supports no form of security, and LEXI-R5/LEXI-R4/LEXI-R10/SARA-R52, which support only TLS security.}<br />

Structure of ubxlib

The APIs for each type of u-blox module can be found in the relevant directory (e.g. cell for cellular modules and ble/wifi for BLE/Wi-Fi modules). The common directory contains APIs and 'helper' modules that are shared by u-blox modules, most importantly the device API, the network API and the sockets API. All APIs are documented in the API header files.

Examples demonstrating the use of the APIs can be found in the example directory. If you are using Zephyr or the u-blox XPLR-IOT-1 platform you will find examples that are very simple to install and use in https://github.com/u-blox/ubxlib_examples_xplr_iot.

Each API includes a test sub-directory containing the tests for that API which you may compile and run if you wish.

Build information for each platform can be found in the platform sub-directory of port; more on this below.

In order for u-blox to support multiple platforms with this code there is also a port API. This is not intended to be a generic porting API, it is simply sufficient to support the APIs we require. If you have not chosen a supported platform you may still be able to use the high level APIs here unchanged by implementing the port API for your platform.

+---example                    <-- examples that introduce the main features 
+---cfg                        <-- global configuration header files
+---common                     <-- APIs that are common across u-blox modules
¦   +---device                 <-- the simple device API for opening cell, short-range (i.e. BLE or Wi-Fi) and GNSS modules
¦   ¦   +---api                <-- all folders, in general, have an API directory
¦   ¦   +---src                    containing public headers, a source directory with
¦   ¦   +---test                   the implementation and a test directory with the tests
¦   +---network                <-- the simple network API for BLE, cell, Wi-Fi and GNSS
¦   +---sock                   <-- the sockets API for cell, Wi-Fi (and in the future BLE)
¦   +---security               <-- common API for u-blox security and TLS security/credential storage
¦   +---mqtt_client            <-- common MQTT client API
¦   +---http_client            <-- common HTTP client API
¦   +---location               <-- common location API, can use GNSS, Cell Locate, Cloud Locate and in the future Wi-Fi/BLE stations, etc.
¦   +---short_range            <-- internal API used by the BLE and Wi-Fi APIs (see below)
¦   +---at_client              <-- internal API used by the BLE, cell and Wi-Fi APIs
¦   +---ubx_protocol           <-- internal API used by the GNSS API
¦   +---geofence               <-- common geofence API that can be used with GNSS, cellular and Wi-Fi-based positioning
¦   +---spartn                 <-- message validation utilities for SPARTN
¦   +---error                  <-- u_error_common.h: error codes common across APIs
¦   +---assert                 <-- assert hook
¦   +---utils                  <-- contains common utilities
¦   ...
+---cell                       <-- API for cellular (if you need more than network provides)
+---wifi                       <-- API for Wi-Fi (if you need more than network provides)
+---ble                        <-- API for BLE
+---gnss                       <-- API for GNSS
+---port                       <-- port API: maps to SDKs and MCU platforms, includes build metadata
    +---api
    +---test
    +---clib
    +---platform               <-- look here for the supported SDKs and MCU platforms
        +---<platform>         <-- e.g. esp-idf
        ¦   +---app            <-- main() for this platform: runs all examples and tests
        ¦   +---src            <-- implementation of the port API for this platform
        ¦   +---mcu            <-- configuration and build metadata for the MCUs supported on this platform
        ¦       +---<mcu>      <-- e.g. esp32
        ¦           +---cfg    <-- platform specific config (pins, OS things, MCU HW blocks)
        ¦           +---runner <-- a build which compiles and links all examples and tests
        +---static_size        <-- a build that measures RAM/flash usage
        +---common             <-- things common to all platforms, most notably...
            +---automation     <-- the internal Python automation scripts that test everything
            ...

How to use this Repo

There are a few possible approaches to adopting ubxlib. If you do not have a fixed environment (MCU, toolchain, RTOS, etc.) then the first two options offer an easy start; if you are constrained in how you must work (i.e. you must use a particular MCU or toolchain or RTOS), or you are happy to dive into the detail from the outset, then the third way is for you.

The Easy Way 1: XPLR IoT

If you would like to explore cellular, positioning, Wi-Fi and BLE, along with a suite of sensors, all at once, you might consider purchasing a u-blox XPLR-IOT-1 platform and using the associated ubxlib examples repo, which allows you to install, build and run Zephyr-based applications.

The Easy Way 2: PlatformIO

ubxlib is supported as a PlatformIO library; if you have a board that either (a) runs Zephyr or (b) contains an ESP32 chip (running ESP-IDF or Arduino), then just follow the instructions here to load ubxlib directly into the PlatformIO Visual Studio Code-based IDE.

The Hard Way: Down in the Detail

This repo uses Git submodules: make sure that once it has been cloned you do something like:

git submodule update --init --recursive

...to obtain the submodules.

The native SDKs for each supported platform are used directly, unchanged, by this code. To use this repo you must first choose your MCU and associated platform. For instance, you might choose an STM32F4 MCU, which is supported via ST's STM32Cube IDE. Instructions for how to install and use each platform can be found in your chosen MCU sub-directory; for an STM32F4 MCU this would be port/platform/stm32cube/mcu/stm32f4.

Having chosen your MCU and installed the platform tools, navigate to the directories below your chosen MCU directory to find the required build information. For instance, you may find a runner directory, which is a generic build that compiles any or all of the examples and tests that can run on a given platform. In that directory you will find detailed information on how to perform the build.

Configuration information for the examples and the tests can be found in the cfg directory of your chosen MCU. Depending on how you have connected your MCU to a u-blox module you may need to override this configuration, e.g. to change which MCU pin is connected to which pin of the u-blox module. The README.md in the runner directory of your chosen MCU will tell you how to override conditional compilation flags in order to do this.

Examples

A number of examples are provided with this repo:

You may use the code from any of these examples as a basis for your work as follows:

• Copy the source files for the example that is closest to your intended application to your project directory.
• Remove all definitions and include files that are related purely to the ubxlib test system; for example you only need to include the ubxlib.h file and you will want the entry point to be something like int main() rather than U_PORT_TEST_FUNCTION(...).
• Adapt the definitions needed for your example, see the include file u_cfg_app_platform_specific.h for your platform; some examples of definitions that need to be set are:
  • UART/I2C/SPI number and UART/I2C/SPI pins (i.e. for whichever transport is being used) connecting the MCU to the target module,
  • network credentials (e.g. Wi-Fi SSID and password).
• Copy the make or cmake files from the runner directory of the port (port/platform/) of your chosen MCU and adapt them to your application:
  • point out the ubxlib directory by setting the UBXLIB_BASE variable,
  • remove any definitions related to the ubxlib test environment as you wish,
  • if needed, add the source file(s) of your application to the make/cmake files.
• Build and flash your adapted example using your IDE of choice or command-line make/cmake.

General information about how to integrate ubxlib into a build system is available in the port directory and platform specific information is available in the platform specific port directory for your chosen MCU.

Where is ubxlib used?

The following table showcases repositories which build applications and use ubxlib.

Feature Request and Roadmap

New features can be requested and up-voted here. The comments of this issue also contains an outlook about features of upcoming releases. Also it is the right place to discuss features and their priority.

License

The software in this repository is Apache 2.0 licensed and copyright u-blox with the following exceptions:

• The heap management code (heap_useNewlib.c), required because the STM32Cube platform doesn't provide the necessary memory management for newlib and FreeRTOS to play together, is copyright Dave Nadler.
• The AT client code in common/at_client is derived from the Apache 2.0 licensed AT parser of mbed-os.
• The stm32cube platform directory necessarily includes porting files from the STM32F4 and STM32U5 SDKs that are copyright ST Microelectronics.
• The go echo servers in common/sock/test/echo_server are based on those used in testing of AWS FreeRTOS.
• The setjmp()/longjmp() implementation in port/clib/u_port_setjmp.S, used when testing the Zephyr platform, is copyright Nick Clifton, Cygnus Solutions and part of newlib.
• The base64 implementation in common/utils/src/base64.h is copyright William Sherif.
• The ARM callstack iterator in port/platform/common/debug_utils/src/arch/arm/u_stack_frame_cortex.c is copyright Armink, part of CmBacktrace.
• The FreeRTOS additions port/platform/common/debug_utils/src/freertos/additions are copied from the Apache licensed ESP-IDF.
• If you compile-in geofencing by defining the conditional compilation flag U_CFG_GEOFENCE for your build:
  • For shapes larger than about 1 km, to employ a true-earth model you may choose to conditionally link the sub-module common/geofence from the MIT licensed GeographicLib by Charles A. Karney.
  • The default functions, which assume a spherical earth, are derived from the valuable advice (though not the code) of https://www.movable-type.co.uk/scripts/latlong.html, MIT licensed and copyright Chris Veness.

In all cases copyright, and our thanks, remain with the original authors.

Disclaimer

• The software in this repository assumes the module is in a state equal to a factory reset.
• If you modify the AT command sequences employed by ubxlib please take the time to debug/test those changes as we can't easily support you.