/XPLR-IOT-1-software

Primary LanguageC

XPLR-IOT-1-software

This project is intented to be used with the XPLR-IOT-1 device from u-blox. Sensor Aggregation use case v1.0 is compatible with XPLR-IOT-1-00 (PCB RevB and RevC version). More information about XPLR-IOT-1 hardware etc. can be found in the following link: XPLR-IOT-1 quick start guide

  • XPLR-IOT-1 (PCB RevB version) comes pre-flashed with the Sensor Aggregation Firmware (v0.3) along with a Serial Bootloader that allows firmware on the device to be updated without the need of a debugger/programmer.

  • XPLR-IOT-1 (PCB RevC and newer versions) comes pre-flashed with the Sensor Aggregation Firmware (v1.0) along with a Serial Bootloader that allows firmware on the device to be updated without the need of a debugger/programmer.

  • All PCB versions work with all firmware versions.

This project contains the Sensor Aggregation Use Case example for XPLR-IOT-1 and future updates of this application will be uploaded here.

The main function of this use case is to collect measurements from sensors and send their data to the Thingstream platform using either Wi-Fi or Cellular Network connections.

The user can enable this functionality with the single press of a button. However, if the user wants to experiment with the device and the firmware, commands are provided so that the user can configure the device, test its functionality, and customize its operation.

ubxlib

One of the major aspects of the firmware is that it uses ubxlib library as much as possible to implement its functionality. ubxlib is a u-blox library that makes it easy to use u-blox modules. ubxlib is used as a submodule in this repository, so make sure when this repo is cloned that ubxlib is also downloaded properly, e.g. by using commands such as: clone <repository_link> -recurse-submodules or after cloning something like: git submodule update --init

This project is considered to be used as an example and not as a final product code. (e.g. it is not optimized for low power consumption and may have security vulnerabilities)

Description

The main function of this use case is to collect information from sensors and send their data to the Thingstream platform using either Wi-Fi or Cellular Network connections.

The main features of the application are:

    1. UART shell. The user can use a UART terminal to get log messages and send commands to the device
    1. Two main modes of operation:
    • 2.1. Sensor Aggregation Main Functionality: Samples all sensors with same update period (including position from MAXM10S module) and sends data in Thingstream platform in 2 ways (and one partly supported):
      • 2.1.1. Using Wi-Fi networks and MQTT Now data plan in Thingstream
      • 2.1.2. Using Cellular networks and MQTT Anywhere data plan in Thingstream (using the embedded Thingstream SIM card in XPLR-IOT-1 wherever this is supported)
      • 2.1.3. (Only partly supported) Using Cellular networks and MQTT Flex data plan in Thingstream (the user should setup SARA-R5 module with his own SIM card first)
    • 2.2. Sensor Aggregation custom functionality: The user can setup the device to enable/ disable various sensors, publish or not publish their data and have different sampling rate for each sensor.The options for sending data to Thingstream are the same as in Sensor Aggregation Main Functionality.
    1. Simple button activation/deactivation of the Sensor Aggregation Main Functionality
    1. LED indication of the Sensor Aggregation Main Functionality
    1. Allow handling of u-blox modules via s-center, m-center, u-center by configuring their UARTs properly. Power up/down u-blox modules.
    1. Control Log messages

The messages sent to Thingstream are compatible with pre-built flows which allow the use of user-hosted dashboard examples using Node-RED.

Secondary features of the application:

  • XPLR-IOT-1 can be scanned by an NFC-enabled device (mobile phone/tablet). Details here.
  • XPLR-IOT-1 implements Bluetooth LE functionality for testing purposes. Details here.

More information on the functionality is provided in Readmes at the respective source code folders

Programming/Building the firmware

The XPLR-IOT-1 comes pre-programmed with the Sensor Aggregation firmware along with a Serial Bootloader to allow firmware updates without the use of a J-Link programmer/debugger.

The example is build using nRF Connect SDK version 1.7.0 and is advised to use this version to build the project in this repository.

Compiled images of the project can be found in the tools_and_compiled_images folder.

Building the firmware

The firmware is based on Nordic’s nRF Connect SDK in a Zephyr RTOS environment. To be able to build it nRF Connect SDK should be installed in your PC (this will also install some necessary tools such as west).

The nRF Connect SDK version used in Sensor Aggregation firmware is 1.7.0 so this is the recommended version. Newer or older versions could produce errors during compilation.

Sensor Aggregation firmware relies on ubxlib to handle u-blox modules ( ubxlib is a u-blox library publicly available, which makes the handling of u-blox modules easier). After installing nRF Connect SDK the path of the zephyr folder should be included in your system’s environmental variables as ZEPHYR_BASE (this is used by the project to build the firmware. If you use VS code to build the project you may not need to perform this step). Help on installing and basic use of nRF Connect can be found in Nordic's help pages like:

If nRF Connect SDK has been installed properly you should be able to build the firmware. You can do that by:

  • Recommended: Using VS code and build as a normal project (see Nordic help pages like this). In the build configuration you should use the nrf5340dk_nrf5340_cpuapp board
  • Using west commands in a command line (should install west properly and set ZEPHYR_BASE environmental variable to be able to use that): Open a command line or powershell in the project’s folder (the one which contains the ubxlib_priv folder and CMakeLists.txt file) and type the following command:
west build -p auto -b nrf5340dk_nrf5340_cpuapp --build-dir .\build .

There are three options to compile the project:

  1. Compile a simple image (default)
  2. Complile an updetable image
  3. Compile the application along with the bootloader

More information about this can be found in the compile_options folder. Depending on the configuration, a different file can be used from the resulting build folder to program the device. (see the respective Readmes in compile_options folder).

Programming the firmware using a J-Link debugger

XPLR-IOT-1 can be programmed using a J-Link debugger. There are various options to do that.

  1. Using VS code after you have successfully built the firmware you can program the device using the Flash button

vscode_flash should be here.

⚠ Note: This works if you build the firmware using the simple_hex or bootloader_inclusion options (by running the respective batch file before building). It does not work for updateable_image option -> in this case the firmware needs to be updated via the bootloader.

  1. If you have nrfjprog tools installed, you can use commands in a command line to program the device (in case only App Core is used):
nrfjprog  --eraseall
nrfjprog --program zephyr.hex --coprocessor CP_APPLICATION (where **zephyr.hex** is the appropriate hex file and also contains the filepath if necessary)
nrfjprog –reset
  1. If Net Core is also used (like in this application), the procedure is a bit more complex:
nrfjprog --recover --coprocessor CP_NETWORK
nrfjprog --eraseall --coprocessor CP_NETWORK
nrfjprog --eraseall --coprocessor CP_APPLICATION
nrfjprog --recover --coprocessor CP_NETWORK
nrfjprog --program net_core.hex --coprocessor CP_NETWORK
nrfjprog --program app_core.hex --coprocessor CP_APPLICATION
nrfjprog --reset
  1. The device can be programmed using Nordic’s nRF Connect for Desktop and more specifically the Programmer app. The device should be reset after programming.

⚠ If you want to include the bootloader, you need to run the batch file in bootloader_inclusion folder before step one and then build and Flash the firmware.

nrf connect programmer should be here.

Programming the firmware using the Serial Bootloader

XPLR-IOT-1 comes pre-flashed with a Serial Bootloader. This allows the device to be updated without the need of a programmer/debugger. If you erase the device, you need to re-program the bootloader in order to be able to use it (see here)

To easily update the device using pre-compiled images, you can run the batch file in the tools_and_compiled_images folder, following the instructions given in the same folder.

If you don't want to run the batch script:

In order to update the device using the Serial Bootloader it must be compiled using option 2 compile an updateable image from compile options (that means: run the batch script inside that folder before building the project).

  • In order to update the firmware:

    -- Reset the device while holding button 1. Release button 1 about one second after the device resets (reset can be done either by pressing the device reset button, or by turning the device off and on while pressing button 1)

    -- Send the necessary command in a command terminal to update the device. UART should be free (not used by another serial terminal while the command is sent). The necessary command is given below.

The Serial Interface to be used is interface 0 (for RevB devices). Please find the correct COM port number for your setup (in this example COM8) and use it in the command that follows.

usbhub.png should be here.

For RevC and later devices, select the lowest COM port assignment for the FTDI USB-UART device. Please find the correct COM port number for your setup (in this example COM40) and use it in the command that follows.

usbhubRevC.png should be here.

In order to send the necessary commands for update you need newtmgr.exe (find it in the tools_and_compiled_images folder):

newtmgr.exe --conntype serial --connstring "COM8,baud=115200" image upload signed_by_b0_app.bin
newtmgr.exe --conntype serial --connstring "COM8,baud=115200" image upload app_update.bin

Then reset the device using one of the following options:

  • Use the device's reset button
  • Use the nrfjprog --reset command, if you have nrftools installed and a J-Link programmer/debugger attached.
  • Use the newtmgr.exe --conntype serial --connstring "COM8,baud=115200" reset command, right after the update commands (no debugger needed).

Side Note: This application currently uses both the APPLICATION and NET core of NORA-B1 in XPLR-IOT-1. In this case, program the NET core first, then the APPLICATION core using two separate commands as described above, and then reset the device. If only the application core is used (e.g. you do not use Bluetooth LE) then the first command to update the net core is not needed. About the file names used in the commands above, see here. Off course the filenames can be anything.

Disclaimer

Copyright © u-blox

u-blox reserves all rights in this deliverable (documentation, software, etc., hereafter “Deliverable”).

u-blox grants you the right to use, copy, modify and distribute the Deliverable provided hereunder for any purpose without fee.

THIS DELIVERABLE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR U-BLOX MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS DELIVERABLE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.

In case you provide us a feedback or make a contribution in the form of a further development of the Deliverable (“Contribution”), u-blox will have the same rights as granted to you, namely to use, copy, modify and distribute the Contribution provided to us for any purpose without fee.