Getting started with the STM32 ODE function pack for IoT node with NFC, BLE connectivity and environmental, motion and Time-of-Flight sensors

Transcription

1 User manual Getting started with the STM32 ODE function pack for IoT node with NFC, BLE connectivity and environmental, motion and Time-of-Flight sensors Introduction FP-SNS-FLIGHT1 is an STM32 ODE function pack for connecting an IoT node to a smartphone via Bluetooth low energy and view real time humidity, pressure, motion, proximity and ambient light sensor data (for X-NUCLEO-6180XA1 only). It uses the NDEF standard for simple and secure Bluetooth pairing, storing the necessary information on the NFC tag and thus simplifying the device configuration. It includes the functionality to perform firmware over-the-air updating (FOTA) with the ST BlueMS application for Android/iOS devices. This package lets you jump-start your sensor node development so that you can focus on adding desired functions. The expansion is built on STM32Cube software technology to ease portability across different STM32 microcontrollers. The software comes with sample driver implementations running on the X-NUCLEO-IKS01A2 (or X- NUCLEO-IKS01A1), X-NUCLEO-53L0A1 (or X-NUCLEO-6180XA1), X-NUCLEO-NFC01A1 and the X- NUCLEO-IDB05A1 (or X-NUCLEO-IDB04A1) boards connected to a NUCLEO-F401RE or NUCLEO- L476RG development board. March 2017 DocID Rev 4 1/50

2 Contents UM2026 Contents 1 Acronyms and abbreviations FP-SNS-FLIGHT1 software description Overview Architecture Folder structure Flash organization The boot process The installation process Firmware-over-the-air (FOTA) update APIs Sample application description Android and ios sample client application Firmware over-the-air (FOTA) update with BlueMS System setup guide Hardware description STM32 Nucleo platform X-NUCLEO-IDB04A1 expansion board X-NUCLEO-IDB05A1 expansion board X-NUCLEO-NFC01A1 expansion board X-NUCLEO-IKS01A1 expansion board X-NUCLEO-IKS01A2 expansion board X-NUCLEO-6180XA1 expansion board X-NUCLEO-53L0A1 expansion board Software description Hardware and software setup Hardware setup Software setup System setup guide Revision history /50 DocID Rev 4

3 List of tables List of tables Table 1: Acronyms and abbreviations... 5 Table 2: Document revision history DocID Rev 4 3/50

4 List of figures List of figures UM2026 Figure 1: FP-SNS-FLIGHT1 software architecture... 9 Figure 2: FP-SNS-FLIGHT1 package folder structure... 9 Figure 3: FP-SNS-FLIGHT1 Flash structure Figure 4: Bootloader folder content Figure 5: FP-SNS-FLIGHT1 Flash structure Figure 6: Binary folder content Figure 7: Content of a project folder Figure 8: BootLoader and FP-SNS-FLIGHT1 installation Figure 9: FP-SNS-FLIGHT1 dump process Figure 10: Terminal setting Figure 11: Initialization phase Figure 12: UART console output when the BLE services are started Figure 13: UART console output when a device first connects with the board Figure 14: UART console output when one device are already trusted Figure 15: BlueMS (android version) main page (after BLE connection) Figure 16: BlueMS (Android version) MotionFX sensor fusion page Figure 17: BlueMS (Android version) popup windows Figure 18: BlueMS (android version) example of plot value Figure 19: BlueMS (android version) menu selection Figure 20: BlueMS (android version) Serial console (stdout/stderr) Figure 21: BlueMS (android version) Debug console (stdin/stdout/stderr) Figure 22: BlueMS (android version) Debug console - change transmission frequency Figure 23: BlueMS (Android version) MotionAR activity recognition page Figure 24: BlueMS (Android version) MotionCP carry position recognition page Figure 25: BlueMS (Android version) MotionGR gesture recognition page Figure 26: BlueMS (Android version) gesture detection page Figure 27: BlueMS (Android version) firmware upgrade page Figure 28: BlueMS (Android version) firmware update file selection Figure 29: Terminal window information during FOTA Figure 30: BlueMS (Android version) application page during FOTA and on completion Figure 31: STM32 Nucleo board Figure 32: X-NUCLEO-IDB04A1 expansion board Figure 33: X-NUCLEO-IDB05A1 expansion board Figure 34: X-NUCLEO-NFC01A1 M24SR64-Y dynamic NFC tag expansion board Figure 35: X-NUCLEO-IKS01A1 expansion board Figure 36: X-NUCLEO-IKS01A2 MEMS and environmental sensor expansion board Figure 37: X-NUCLEO-6180XA1 expansion board Figure 38: X-NUCLEO-53L0A1 expansion board Figure 39: STM32 Nucleo development board plus X-NUCLEO-IDB05A1, X-NUCLEO-NFC01A1, X- NUCLEO-IKS01A1 and X-NUCLEO-6180XA1 expansion boards /50 DocID Rev 4

5 Acronyms and abbreviations 1 Acronyms and abbreviations Table 1: Acronyms and abbreviations Acronym Description BLE Bluetooth low energy NFC Near field communication NDEF NFC data exchange format DocID Rev 4 5/50

6 FP-SNS-FLIGHT1 software description UM FP-SNS-FLIGHT1 software description 2.1 Overview The key features of the FP-SNS-FLIGHT1 package are: For STM32 Nucleo board with X-NUCLEO-IKS01A1 expansion boards, complete middleware to build applications using temperature and humidity sensors (HTS221), pressure sensor (LPS25HB), motion sensors (LIS3MDL and LSM6DS0), motion sensor LSM6DS3 mounted on a DIL24 expansion component, VL53L0X proximity sensor (or VL6180X proximity and ambient light sensing) module and M24SR64-Y dynamic NFC/RFID tag (using the NDEF standard). For STM32 Nucleo board with X-NUCLEO-IKS01A2 expansion boards, complete middleware to build applications using temperature and humidity sensor (HTS221), pressure sensor (LPS22HB), motion sensors (LSM303AGR and LSM6DSL), VL53L0X proximity sensor (or VL6180X proximity and ambient light sensing) module and M24SR64-Y Dynamic NFC/RFID tag (using the NDEF standard). Very low power Bluetooth low energy (BlueNRG) single-mode network processor, compliant with Bluetooth specifications core for transmitting information to one client. MotionFX (inemoengine PRO) real-time motion sensor data fusion to combine the output from multiple MEMS sensors. MotionAR (inemoengine PRO) real-time activity-recognition algorithm based only on accelerometer data. MotionCP (inemoengine PRO) carry position detection algorithm based only on accelerometer data. MotionGR (inemoengine PRO) gesture recognition algorithm based only on accelerometer data. Proximity-based hand gesture detection algorithm based on VL53L0X (or VL6180X) proximity sensors. Easy portability across different MCU families, thanks to STM32Cube. Compatible with BlueMS application for Android/iOS (ver or higher) available on the respective online Google Play /itunes stores. Over-the-air firmware update using the BlueMS application version or higher (for X-NUCLEO-IDB05A1 Bluetooth low energy expansion board only). Free, user-friendly license terms. Sample implementation on X-NUCLEO-NFC01A1, X-NUCLEO-IKS01A2 (or X- NUCLEO-IKS01A1), X-NUCLEO-53L0A1 (or X-NUCLEO-6180XA1) and X-NUCLEO- IDB05A1 (or X-NUCLEO-IDB04A1) expansion boards when connected to a NUCLEO- F401RE or NUCLEO-L476RG development board. This software creates the following Bluetooth services: the first service exposes all the hardware features and contains the following characteristics: temperature pressure humidity luminosity (for X-NUCLEO-6180XA1 only) proximity 3D gyroscope, 3D magnetometer, 3D accelerometer the second service exposes all the software features and contains the following characteristics: quaternions generated by the MotionFX library in short precision recognized activity using the MotionAR algorithm 6/50 DocID Rev 4

7 FP-SNS-FLIGHT1 software description recognized carry position using the MotionCP algorithm recognized gesture using the MotionGR algorithm the hand gesture recognized by the gesture detection middleware the third is the Console service that includes two characteristics: stdin/stdout with bi-directional communication between client and server stderr for a mono-directional channel from the STM32 Nucleo board to an Android/iOS device the last service is for transmitting/resetting the calibration status. This software gathers: the temperature, humidity, pressure, light (for X-NUCLEO-6180XA1 only), distance and motion sensor drivers for the HTS221, LPS25H, VL53L0A1 (or VL6180X), LSM6DS0 (or LSM6DS3) and LIS3MDL devices for STM32 Nucleo expansion boards with X-NUCLEO-IKS01A1. the temperature, humidity, pressure, light (with only X-NUCLEO-6180XA1), distance and motion sensor drivers for the HTS221, LPS22H, VL53L0A1 (or VL6180X), LSM6DSL and LSM303AGR devices for STM32 Nucleo expansion boards with X- NUCLEO-IKS01A2. This package is compatible with the BlueMS Android/iOS (ver or higher) application, available at the respective Google Play/iTunes stores, which can be used for displaying information sent via the Bluetooth low energy protocol. BlueMS version and above is required for Over-The-Air firmware updates (for X-NUCLEO-IDB05A1 Bluetooth low energy expansion board only). 2.2 Architecture This software is based on the STM32CubeHAL hardware abstraction layer for the STM32 microcontroller. The package extends STM32Cube by providing a board support package (BSP) for the BlueNRG-1 sensor expansion board, proximity and ambient light sensing (for X-NUCLEO-6180XA1 only) module and the dynamic NFC tag expansion boards, and some middleware components for communication with other Bluetooth low energy devices: it also enables data exchange with an NFC-ready device using the NDEF standard. BlueNRG is a very low power Bluetooth low energy (BLE) single-mode network processor. The MotionFX (inemoengine PRO) filtering and predictive suite uses advanced algorithms to intelligently integrate multiple MEMS sensor outputs, regardless of environmental conditions achieving an optimal performance. Real-time motion sensor data fusion is set to increase accuracy, resolution, stability and response time. The MotionAR (inemoengine PRO) real-time software acquires data from the accelerometer to recognize user activities. The software can also be combined with other human motion recognition algorithms and can significantly improve user experience in advanced motion-based applications in consumer, computer, industrial and medical fields. The MotionCP (inemoengine PRO) real-time software acquires data from the accelerometer to recognize board positions (on desk, on head, near head, shirt pocket, trousers pocket and in swinging arm). The MotionGR (inemoengine PRO) real-time software acquires data from the accelerometer and recognizes user gestures (pick up, glance and wake up). The gesture detect software library uses the X-NUCLEO-53L0A1 (or X-NUCLEO- 6180XA10) on-board sensor plus two additional satellites to detect tap and swipe (from left to right and from right to left) gestures. Activity recognition, carry position and gesture recognition are managed through a specific software for mobile and wearable applications, and the exclusive use of the accelerometer DocID Rev 4 7/50

8 FP-SNS-FLIGHT1 software description UM2026 by MotionAR, MotionCP, and MotionGR facilitates the low power consumption required in this field of application, in compliance with Bluetooth specifications core 4.0 (X-NUCLEO- IDB04A1) or 4.2 (X-NUCLEO-IDB05A1) for STM32 Nucleo boards. The drivers abstract low-level hardware details and allow the middleware components and applications to access the Dynamic NFC tag and all the other sensors in a hardware-independent manner. The package includes a sample application that the developer can use to start experimenting with the code. The sample application was developed to enable NFC pairing and to transmit the values read from all the sensors (temperature, humidity, pressure, luminosity, proximity, accelerometer, magnetometer and gyroscope) to a Bluetooth low energy-enabled device such as an Android or ios -based smartphone. You can use the BlueMS Android/iOS application (version or higher), from the respective Google Play and itunes stores, to visualize the results of the MotionFX, MotionAR, MotionCP, MotionGR and gesture detection algorithms and display the values read from the accelerometer, magnetometer, gyroscope, temperature, humidity, pressure, luminosity and proximity sensors. Version or higher allows over-the-air firmware update (with X-NUCLEO-IDB05A1 Bluetooth low energy expansion boards only). The ST BlueMS Android/iOS application was developed to enable NFC pairing prior to sensor data transmission. The software layers used by the application software to access and use the Sensors expansion boards are: STM32Cube HAL driver layer: provides a simple, generic, multi-instance set of APIs (application programming interfaces) to interact with the upper layers (application, libraries and stacks). It is composed of generic and extension APIs and is directly built around a generic architecture and allows the layers built on top of it, such as the middleware layer, to implement their functions without dependending on the specific hardware configuration for a given microcontroller unit (MCU). This structure improves library code reusability and guarantees an easy portability across other devices. Board Support Package (BSP) layer: provides support for the peripherals (excluding the MCU) on the STM32 Nucleo board through the board support package (BSP). The BSP is a limited set of APIs which provides a programming interface for certain boardspecific peripherals like the LED, the user button, etc. 8/50 DocID Rev 4

9 FP-SNS-FLIGHT1 software description The next figure outlines the software architecture of the package: Figure 1: FP-SNS-FLIGHT1 software architecture 2.3 Folder structure Figure 2: FP-SNS-FLIGHT1 package folder structure The following folders are included in the software package: Documentation: contains a compiled HTML file generated from the source code, detailing the software components and APIs. Drivers: contains the HAL drivers, the board specific drivers for each supported board or hardware platform, including the on-board components and the CMSIS vendorindependent hardware abstraction layer for the Cortex-M processor series. Middlewares: contains libraries and protocols for BlueNRG-1 Bluetooth low energy and NDEF devices, the Meta Data Manager, MotionFX (inemoengine PRO) sensor DocID Rev 4 9/50

10 FP-SNS-FLIGHT1 software description UM2026 fusion library, MotionAR (inemoengine PRO) activity-recognition library, MotionCP (inemoengine PRO) carry-position recognition library, MotionGR (inemoengine PRO) gesture recognition library and for the gesture detection algorithm. Projects: contains a sample application used to transmit the sensor data and MotionFX sensor fusion output, MotionAR activity-recognition, MotionCP carryposition, MotionGR gesture recognition and for the gesture detection algorithm via the Bluetooth low energy protocol provided for the NUCLEO-F401RE/NUCLEO-L476RG platforms through the IAR Embedded Workbench for ARM, RealView Microcontroller Development Kit (MDK-ARM) and System Workbench for STM32 development environments. Utilities: contains the boot loader binary ready to be flashed for the STM32F401RE and STM32L476RG Nucleo boards. 2.4 Flash organization Apart from storing its code, FP-SNS-FLIGHT1 uses the Flash memory to allow the Firmware-Over-The-Air update. To enable this feature the Flash memory is divided into three different regions (see Figure 3: "FP-SNS-FLIGHT1 Flash structure"): 1. the first region contains a custom boot loader 2. the second region contains the FP-SNS-FLIGHT1 firmware 3. the third region is used to store the FOTA before the update Even if the STM32F401RE (512 KB) and the STM32L476RG (1024 KB) cache sizes and arrangements differ, the same Flash arrangement has been used for both. For further information, refer to: (RM0368) Reference manual STM32F401xB/C and STM32F401xD/E advanced ARM -based 32-bit MCUs (RM0351) Reference manual STM32L4x6 advanced ARM -based 32-bit MCUs 10/50 DocID Rev 4

11 Figure 3: FP-SNS-FLIGHT1 Flash structure FP-SNS-FLIGHT1 software description 2.5 The boot process The FP-SNS-FLIGHT1 cannot be flashed at the beginning of the Flash memory (address 0x ); therefore it is compiled to run from the beginning of the second Flash region (0x ). To enable this behavior, the vector table offset has been set in Src/system_stm32f4xx.c (for STM32F401) and Src/system_stm32l4xx.c (for STM32L476) thus: #define VECT_TAB_OFFSET 0x4000. The linker script has also been changed. For example, the linker script for SP-SNS-FLIGHT1 running on STM32F401RE and compiled using IAR Embedded Workbench for ARM is: define symbol ICFEDIT_intvec_start = 0x ; /*-Memory Regions-*/ define symbol ICFEDIT_region_ROM_start = 0x ; define symbol ICFEDIT_region_ROM_end = 0x0803FFFF; define symbol ICFEDIT_region_RAM_start = 0x ; DocID Rev 4 11/50

12 FP-SNS-FLIGHT1 software description define symbol ICFEDIT_region_RAM_end = 0x20017FFF; /*-Sizes-*/ define symbol ICFEDIT_size_cstack = 0x8000; define symbol ICFEDIT_size_heap = 0x800; Using the above linker script, the maximum usable code size is fixed at 240 KB. UM2026 You must flash the appropriate bootloader binary for STM32F401RE or STM32L476RG, found in the Utilities\BootLoader folder, to the first Flash region (address 0x ). Figure 4: Bootloader folder content At any board reset: if there is a FOTA in the third Flash region, the bootloader overwrites the second Flash region (with FP-SNS-FLIGHT1 firmware) and replaces its content with the FOTA restarting the board; if there is no FOTA, the bootloader jumps to the FP-SNS-FLIGHT1 firmware. Figure 5: FP-SNS-FLIGHT1 Flash structure 2.6 The installation process The package Binary directory contains an image (in.bin and.hex format) for each platform (NUCLEO-F401RE, NUCLEO-L476RG), including: pre-compiled FLIGHT1 firmware that may be flashed with ST-LINK to the correct memory address (0x ) of a supported STM32 Nucleo development boardnote that this pre-compiled binary is compatible with the FOTA update procedure pre-compiled FLIGHT1 plus BootLoader firmware that may be directly flashed to a supported STM32 Nucleo development board with the ST-LINK or via a Drag & Drop 12/50 DocID Rev 4

13 FP-SNS-FLIGHT1 software description operation (STM32 Nucleo boards only)note that this pre-compiled binary is not compatible with the FOTA update procedure Figure 6: Binary folder content To flash modified FLIGHT1 firmware, simply flash the compiled FP-SNS-FLIGHT1 firmware to the correct address (0x ). A batch script has been provided to simplify this operation by saving the firmware and the BootLoader on the right position; it is available for each platform (NUCLEO-F401RE, NUCLEO-L476RG) and for each IDE (IAR/RealView/System Workbench): IAR toolchain Embedded Workbench V7.70.2: For Nucleo F4: CleanFLIGHT1_IAR_53L0A1_NF401 CleanFLIGHT1_IAR_6180XA1_NF401.bat For Nucleo L4: CleanFLIGHT1_IAR_53L0A1_NL476.bat CleanFLIGHT1_IAR_6180XA1_NL476.bat µvision toolchain - MDK-ARM Professional Version: : For Nucleo F4: CleanFLIGHT1_MDK_ARM_53L0A1_NF401.bat CleanFLIGHT1_MDK_ARM_6180XA1_NF401.bat For Nucleo L4: CleanFLIGHT1_MDK_ARM_53L0A1_NL476.bat CleanFLIGHT1_MDK_ARM_6180XA1_NL476.bat System Workbench for STM32 Version : For Nucleo F4: CleanFLIGHT1_SW4STM32_53L0A1_NF401.bat CleanFLIGHT1_SW4STM32_6180XA1_NF401.bat For Nucleo L4: CleanFLIGHT1_SW4STM32_53L0A1_NL476.bat CleanFLIGHT1_SW4STM32_6180XA1_NL476.bat DocID Rev 4 13/50

14 FP-SNS-FLIGHT1 software description Figure 7: Content of a project folder UM2026 This script: performs a full Flash erase to start from a clean system flashes the BootLoader to the correct position 0x flashes the firmware to the correct position 0x /50 DocID Rev 4

15 FP-SNS-FLIGHT1 software description Figure 8: BootLoader and FP-SNS-FLIGHT1 installation The script also dumps an image containing the BootLoader and the firmware. This image file can be directly flashed to the beginning of the Flash memory like in the same way as the image provided in the Binary folder. DocID Rev 4 15/50

16 FP-SNS-FLIGHT1 software description Figure 9: FP-SNS-FLIGHT1 dump process UM2026 For the Linux or ios operating systems, there is a similar script that uses OpenOCD instead of the ST-LINK command line. The script is available for each platform, but is only included in the System Workbench IDE: CleanFLIGHT1_SW4STM32_53L0A1_NF401.sh CleanFLIGHT1_SW4STM32_6180XA1_NF401.sh CleanFLIGHT1_SW4STM32_53L0A1_NL476.sh CleanFLIGHT1_SW4STM32_6180XA1_NL476.sh To function, the script must be modified with: the installation path for OpenOCD the installation path for STM32 OpenOCD scritps the Library path for OpenOCD TheOpenOCD script section to be edited is: # 1) Set the Installation path for OpenOCD # example: #OpenOCD_DIR="C:/Ac6/SystemWorkbench/plugins/fr.ac6.mcu.externaltools.openocd.win32_ /tools/openocd/" OpenOCD_DIR="" # 2) Set the installation path for stm32 OpenOCD scritps # example: #OpenOCD_CFC="C:/Ac6/SystemWorkbench/plugins/fr.ac6.mcu.debug_ /re sources/openocd/scripts" OpenOCD_CFC="" # 3) Only for Linux/iOS add openocd library path to _LIBRARY_PATH: # For ios example: #export DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:${OpenOCD_DIR}"lib/" 16/50 DocID Rev 4

17 FP-SNS-FLIGHT1 software description # For Linux example: #export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${OpenOCD_DIR}"lib/" 2.7 Firmware-over-the-air (FOTA) update 2.8 APIs For the X-NUCLEO-IDB05A1 Bluetooth low energy expansion board only, the FP-SNS- FLIGHT1 firmware may be updated over-the-air (FOTA) through the connected Android/iOS device via Bluetooth using the BlueMS application (ver and above) available at their respective application web stores. The application sends the update and associated CRC (cyclic-redundancy-check) value that the FP-SNS_FLIGHT1 checks against the hardware cyclic redundancy check calculation unit on the STM32F401/STM32L476 processor to ensure update integrity. If the CRC calculation matches the BlueMS CRC value, the new firmware is written from the beginning of the third Flash region. A magic number prompts the boot loader that a firmware update has been received, checked and is ready to replace the current FP-SNS-FLIGHT1 firmware (see Section 2.11: "Firmware over-the-air (FOTA) update with BlueMS"). Detailed technical information regarding the APIs available to the user can be found in a compiled HTML file located inside the Documentation folder of the software package, where all the functions and parameters are fully described. 2.9 Sample application description A sample application using the X-NUCLEO-NFC01A1, X-NUCLEO-IKS01A2 (or X- NUCLEO-IKS01A1), X-NUCLEO-53L0A1 (or X-NUCLEO-6180XA1) and X-NUCLEO- IDB05A1 (or X-NUCLEO-IDB04A1) expansion boards with the NUCLEO-F401RE or NUCLEO-L476RG board is provided in the Projects directory. Ready-to-build projects are available for multiple IDEs. You can set up a terminal window for the appropriate UART communication port (using the baud, data, parity and stop settings below) to control the initialization phase. DocID Rev 4 17/50

18 FP-SNS-FLIGHT1 software description Figure 10: Terminal setting UM2026 When you first press the reset button, the application: 1. starts initializing the UART, I²C 2. declares which MEMS sensor expansion board is plugged and if all the sensors are working 3. with X-NUCLEO-IKS01A1, checks whether the LSM6DS3 DIL24 extension is present 4. with the NDEF protocol, writes the URI to the M24SR dynamic NFC tag on the X-NUCLEO-NFC01A1 expansion board 5. declares whether the firmware is compiled for X-NUCLEO-53L0A1 or X-NUCLEO- 6180XA1 18/50 DocID Rev 4

19 Figure 11: Initialization phase FP-SNS-FLIGHT1 software description When reading the NFC tag content with an Android device, the browser automatically starts and tries to connect to that URI. When the user presses the blue user button (see Figure 12: "UART console output when the BLE services are started"), the program: 1. initializes the proximity sensor and discovery of the satellites 2. initializes the SPI interface used for communicating with the BlueNRG-1 expansion board 3. determines which BlueNRG-1 expansion board (X-NUCLEO-IDB04A1 or X- NUCLEOIDB05A1) is connected to the STM32 Nucleo board and the hardware and firmware versions 4. creates the random BLE MAC address and PIN necessary for the connection 5. initializes the BLE hardware service (adding the temperature, humidity, pressure, ambient light for VL6180X only, distance, 3D gyroscope, 3D magnetometer and 3D accelerometer characteristics) 6. initializes the BLE console service adding the stdin/stdout and stderr characteristics 7. initializes the BLE configuration service 8. changes the content of the M24SR64-Y dynamic NFC tag (using NDEF) in order to write all the information necessary to automatically launch the BlueMS Android application (name of application, BLE advertise data, BLE MAC address and BLE connection PIN). DocID Rev 4 19/50

20 FP-SNS-FLIGHT1 software description Figure 12: UART console output when the BLE services are started UM2026 When reading the above NFC content on an Android device with the BlueMS application installed, it is possible to automatically launch the BlueMS application to connect the device 20/50 DocID Rev 4

21 FP-SNS-FLIGHT1 software description with the STM32 Nucleo board, without having to scan for the board or manually insert the PIN. ios does not allow the use of NFC for this purpose, so you must manually run the application, scan for the STM32 Nucleo board and enter the connection PIN. The FLIGHT1_SECURE_CONNECTION define in the Projects\Multi\Applications\FLIGHT1\Inc\flight1_config.h file controls whether the STM32 Nucleo board only accepts secure connections (default) or any connection (define is commented), so you do not have to enter the BLE connection PIN for a device to connect to the STM32 Nucleo board. As the console output shows, the application sends: the values of temperature/humidity/pressure and abient light (for X-NUCLEO-6180XA1 only) every 500 ms the values of the 3D accelerometer, 3D gyroscope and 3D magnetometer every 100 ms the proximity values every 50 ms Connection of an Android/iOS device to the STM32 Nucleo board starts with the secure pairing procedure, where ping information is sent to the stdout console BLE characteristic. DocID Rev 4 21/50

22 FP-SNS-FLIGHT1 software description Figure 13: UART console output when a device first connects with the board UM /50 DocID Rev 4

23 FP-SNS-FLIGHT1 software description The application has a white list of one element, so subsequent connections with the last trusted device are automatically authenticated (see figure below). Figure 14: UART console output when one device are already trusted 2.10 Android and ios sample client application The FP-SNS-FLIGHT1 software for STM32Cube is compatible with the BlueMS Android/iOS applications (Version and above), available at the respective Google Play/iOS stores. Version or above is required for over-the-air firmware updates (for X-NUCLEO- IDB05A1 Bluetooth low energy expansion boards only). The Android application is used here to show how the application works. After connection, BlueMS starts with the main page shown below,where the values of temperature, ambient light (only for VL6180X), pressure and humidity are displayed. DocID Rev 4 23/50

24 FP-SNS-FLIGHT1 software description Figure 15: BlueMS (android version) main page (after BLE connection) UM2026 If the MotionFX sensor fusion library is enabled, the following page shows a cube that rotates according to the board movement. 24/50 DocID Rev 4

25 FP-SNS-FLIGHT1 software description Figure 16: BlueMS (Android version) MotionFX sensor fusion page In the page above: the central button enables or disables the proximity sensor, which triggers the cube zooming out or in as a function of the proximity measured by the X-NUCLEO-53L0A1 (or X-NUCLEO-6180XA1) expansion board; the left button resets the cube position; the right button shows the MotionFX library calibration status (black for not calibrated, green for calibrated). Clicking it forces a magneto calibration. DocID Rev 4 25/50

26 FP-SNS-FLIGHT1 software description UM2026 When a button is pressed, the application pops up a window describing how to position the board for a correct cube rotation and how to move the board to facilitate calibration (see figure below). Figure 17: BlueMS (Android version) popup windows On the next page to the left, you can plot any value from the sensor expansion boards. 26/50 DocID Rev 4

27 FP-SNS-FLIGHT1 software description Figure 18: BlueMS (android version) example of plot value In the option menu below, you can access: Serial or Debug (with stdin) console firmware upgrade DocID Rev 4 27/50

28 FP-SNS-FLIGHT1 software description Figure 19: BlueMS (android version) menu selection UM2026 If the Serial console is enabled, stdout/stderr is displayed, as shown below. 28/50 DocID Rev 4

29 FP-SNS-FLIGHT1 software description Figure 20: BlueMS (android version) Serial console (stdout/stderr) If the Debug console is enabled, stdin is displayed and any message written in the Debug console triggers a reply with the same message, as shown below. DocID Rev 4 29/50

30 FP-SNS-FLIGHT1 software description Figure 21: BlueMS (android version) Debug console (stdin/stdout/stderr) UM2026 Through the Debug console, you can change the sensor value transmission frequency. For temperature/humidity/pressure with the the application sends environmental data every 5 the application sends environmental data every 1 the application sends environmental data every 100 the application sends environmental data as default (500 ms). For 3D accelerometer, 3D gyroscope and 3D magnetometer with the the application sends the data every 500 the application sends the data every 100 ms 30/50 DocID Rev 4

31 FP-SNS-FLIGHT1 software the application sends the data every 50 the application sends the data as default (100 ms). For ambient light (lux) with the command (for VL6180X the application sends environmental data every 5 the application sends environmental data every 1 the application sends environmental data every 100 the application sends environmental data as default (500 ms). For distance (proximity) with the the application sends the data every 500 the application sends the data every 100 the application sends the data every 50 the application sends the data as default (50 ms). Figure 22: BlueMS (android version) Debug console - change transmission frequency If the MotionAR algorithm is enabled, the page shown below is available, signaling one of the following recognized activities: stationary walking fast walking DocID Rev 4 31/50

32 FP-SNS-FLIGHT1 software description jogging biking driving Figure 23: BlueMS (Android version) MotionAR activity recognition page UM2026 If the MotionCP algorithm is enabled, the page shown below is available, with information about how the user is carrying the board, which equates to phone carry positions: on desk in hand near head shirt pocket trousers pocket arm swing 32/50 DocID Rev 4

33 FP-SNS-FLIGHT1 software description Figure 24: BlueMS (Android version) MotionCP carry position recognition page If the MotionGR algorithm is enabled, the page shown below is available with gesture recognition information: pick up glance wake up in hand DocID Rev 4 33/50

34 FP-SNS-FLIGHT1 software description Figure 25: BlueMS (Android version) MotionGR gesture recognition page UM2026 If gesture detection is enabled, the page shown below displays the results of the detected gestures, which can be a single tap (indicated by the circular symbol) or directional swipes (indicated by the double arrows). 34/50 DocID Rev 4

35 FP-SNS-FLIGHT1 software description Figure 26: BlueMS (Android version) gesture detection page 2.11 Firmware over-the-air (FOTA) update with BlueMS If the 'Firmware upgrade' menu option is selected in the BlueMS main application page, the following page appears: DocID Rev 4 35/50

36 FP-SNS-FLIGHT1 software description Figure 27: BlueMS (Android version) firmware upgrade page UM2026 The BlueMS application shows which version of the FP-SNS-FLIGHT1 software is running and the board type. To apply an update, press the red button and select the appropriate update file. 36/50 DocID Rev 4

37 FP-SNS-FLIGHT1 software description Figure 28: BlueMS (Android version) firmware update file selection BlueMS sends to FP-SNS-FLIGHT1 an update of a certain byte size and corresponding CRC value. The figure below shows the terminal window with the debug information returned during FOTA for an STM32 Nucleo platform (STM32F401RE/L476RG) when we use a UART to control FP-SNS-FLIGHT1 behavior. DocID Rev 4 37/50

38 FP-SNS-FLIGHT1 software description Figure 29: Terminal window information during FOTA UM2026 During the FOTA procedure, the BlueMS application shows the remaining packets to be sent, and the total update time when the procedure has finished. Figure 30: BlueMS (Android version) application page during FOTA and on completion 38/50 DocID Rev 4

39 System setup guide 3 System setup guide 3.1 Hardware description This section describes the hardware components needed for sensor-based application development STM32 Nucleo platform STM32 Nucleo development boards provide an affordable and flexible way for users to test solutions and build prototypes with any STM32 microcontroller line. The Arduino connectivity support and ST morpho connectors make it easy to expand the functionality of the STM32 Nucleo open development platform with a wide range of specialized expansion boards to choose from. The STM32 Nucleo board does not require separate probes as it integrates the ST- LINK/V2-1 debugger/programmer. The STM32 Nucleo board comes with the comprehensive STM32 software HAL library together with various packaged software examples. Figure 31: STM32 Nucleo board Information regarding the STM32 Nucleo board is available at DocID Rev 4 39/50

40 System setup guide X-NUCLEO-IDB04A1 expansion board The X-NUCLEO-IDB04A1 is a Bluetooth BlueNRG expansion board usable with the STM32 Nucleo system. The BlueNRG is a very low power Bluetooth low energy (BLE) single-mode network processor, compliant with Bluetooth specifications core 4.0. Figure 32: X-NUCLEO-IDB04A1 expansion board UM2026 Information regarding the X-NUCLEO-IDB04A1 expansion board is available on at X-NUCLEO-IDB05A1 expansion board The X-NUCLEO-IDB05A1 is a Bluetooth low energy expansion board based on the SPBTLE-RF BlueNRG-MS RF module to allow expansion of the STM32 Nucleo boards. The SPBTLE-RF module is FCC (FCC ID: S9NSPBTLERF) and IC certified (IC: 8976C- SPBTLERF). The BlueNRG-MS is a very low power Bluetooth low energy (BLE) singlemode network processor, compliant with Bluetooth specification v4.2. X-NUCLEO-IDB05A1 is compatible with the ST morpho and Arduino UNO R3 connector layout. This expansion board can be plugged into the Arduino UNO R3 connectors of any STM32 Nucleo board. 40/50 DocID Rev 4

41 Figure 33: X-NUCLEO-IDB05A1 expansion board System setup guide Information about the X-NUCLEO-IDB05A1 expansion board is available on at X-NUCLEO-NFC01A1 expansion board The X-NUCLEO-NFC01A1 is an expansion board based on the M24SR64-Y device. This expansion board can be plugged on the Arduino UNO R3 connectors of any STM32 Nucleo board. The M24SR64-Y device is a dynamic NFC/RFID tag IC with a dual interface. It embeds 64 Kbit EEPROM memory, and can be operated from: an I²C interface a MHz RFID reader or a NFC phone. The I²C interface uses a two-wire serial interface, consisting of a bidirectional data line and a clock line. It behaves as a slave with respect to the I²C protocol. The RF protocol is compatible with: ISO/IEC Type A NFC Forum Type 4 Tag. The board is powered through the Arduino UNO R3 connectors and includes three general purpose LEDs. DocID Rev 4 41/50

42 System setup guide Figure 34: X-NUCLEO-NFC01A1 M24SR64-Y dynamic NFC tag expansion board UM2026 Information regarding the X-NUCLEO-NFC01A1 expansion board is available on at X-NUCLEO-IKS01A1 expansion board The X-NUCLEO-IKS01A1 is a sensor expansion board for the STM32 Nucleo board. It is also compatible with Arduino UNO R3 connector layout and is designed around humidity (HTS221), pressure (LPS25HB) and motion (LIS3MDL and LSM6DS0) sensing devices. The X-NUCLEO-IKS01A1 interfaces with the STM32 MCU via the I²C pin, and the user can change the default I²C port and the device IRQ by changing a resistor on the evaluation board. You can attach the LSM6DS3 DIL24 expansion component and use it instead of the one of the LSM6DS0 sensors. 42/50 DocID Rev 4

43 Figure 35: X-NUCLEO-IKS01A1 expansion board System setup guide X-NUCLEO-IKS01A2 expansion board The X-NUCLEO-IKS01A2 is a motion MEMS and environmental sensor expansion board for the STM32 Nucleo. It is equipped with Arduino UNO R3 connector layout, and is designed around the LSM6DSL 3D accelerometer and 3D gyroscope, the LSM303AGR 3D accelerometer and 3D magnetometer, the HTS221 humidity and temperature sensor and the LPS22HB pressure sensor. The X-NUCLEO-IKS01A2 interfaces with the STM32 microcontroller via the I²C pin, and it is possible to change the default I²C port. DocID Rev 4 43/50

44 System setup guide Figure 36: X-NUCLEO-IKS01A2 MEMS and environmental sensor expansion board UM X-NUCLEO-6180XA1 expansion board The X-NUCLEO-6180XA1 is an expansion board for the STM32 Nucleo system, also compatible with Arduino UNO R3 connector layout and designed around STMicroelectronics VL6180X proximity, gesture and ALS sensor, based on the ST FlightSense Time-of-Flight technology. The board allows the user to test VL6180X functionality and develop relevant applications. It includes: a 4-Digit display to render either the range value in mm or the ambient light value in lux a switch to select the value type to be displayed a 2.8 V regulator to supply the VL6180X two level shifters to adapt the I/O level to the microcontroller main board the necessary connectivity for the application For applications which implement gesture recognition, you need to plug two additional satellite sensors to the connectors marked LEFT and RIGHT. The third connector (BOTTOM) is not used. 44/50 DocID Rev 4

45 Figure 37: X-NUCLEO-6180XA1 expansion board System setup guide X-NUCLEO-53L0A1 expansion board The X-NUCLEO-53L0A1 is an expansion board for the STM32 Nucleo system, also compatible with Arduino UNO R3 connector layout and designed around ST VL53L0X ranging and gesture detection sensor, based on ST FlightSense, Time-of-Flight technology. Several ST expansion boards can be superposed through the Arduino connectors, which allows, for example, to develop VL53L0X applications with Bluetooth or Wi-Fi interface. To allow the user to quickly access the gesture recognition demonstration, the X-NUCLEO- 53L0A1 expansion board is delivered with two VL53L0X satellites. The key features are: VL53L0X ranging and gesture detection sensor module; accurate absolute ranging distance, independent of the reflectance of the target; a 4-digit display, displaying the distance of a target from the ranging sensor; two 10-pin connectors; a cover glass holder; 3 different spacers of 0.25, 0.5 and 1 mm height to be fitted below the cover glass in order to simulate various air gaps. DocID Rev 4 45/50

46 System setup guide Figure 38: X-NUCLEO-53L0A1 expansion board UM Software description The following software components are required to establish a suitable development environment for creating applications for the STM32 Nucleo equipped with the NFC, sensors, FlightSense and BlueNRG expansion boards: FP-SNS-FLIGHT1: a Bluetooth low energy, sensors and NFC tag software for STM32Cube. The FP-SNS-FLIGHT1 firmware and related documentation is available on Development tool-chain and Compiler: The STM32Cube expansion software supports the three following environments: IAR Embedded Workbench for ARM (EWARM) toolchain + ST-LINK RealView Microcontroller Development Kit (MDK-ARM) toolchain + ST-LINK System Workbench for STM32 (SW4STM32) + ST-LINK 46/50 DocID Rev 4

47 3.3 Hardware and software setup System setup guide This section describes the hardware and software setup procedures. It also describes the system setup needed for the above Hardware setup The following hardware components are needed: Software setup One STM32 Nucleo Development platform (order code: NUCLEO-F401RE or NUCLEO-L476RG) One NFC expansion board (order code: X-NUCLEO-NFC01A1) One sensors expansion board (order code: X-NUCLEO-IKS01A2 or X-NUCLEO- IKS01A1) One FlightSense expansion board (order code: X-NUCLEO-53L0A1 or X-NUCLEO- 6180XA1) One BlueNRG Bluetooth low energy expansion board (order code: X-NUCLEO- IDB04A1 or X-NUCLEO-IDB05A1) One USB type A to Mini-B USB cable to connect the STM32 Nucleo to the PC This section lists the minimum requirements for the developer to setup the SDK, run the sample testing scenario based on the GUI utility and customize applications Development tool-chains and compilers Select one of the Integrated Development Environments supported by the STM32Cube expansion software and follow the system and setup information provided by the selected IDE provider System setup guide This section describes how to set up different hardware parts before writing and executing an application on the STM32 Nucleo board with the sensors expansion board STM32 Nucleo and sensor expansion boards setup The STM32 Nucleo board integrates the ST-LINK/V2-1 debugger/programmer. You can download the relevant version of the ST-LINK/V2-1 USB driver by searching STSW- LINK008 or STSW-LINK009 on (based on your version of Microsoft Windows). Connect the following boards through the Arduino UNO R3 extension connector: 1. The X-NUCLEO-IDB05A1 (or X-NUCLEO-IDB04A1) expansion board on the STM32 Nucleo development board. 2. The X-NUCLEO-NFC01A1 expansion board on the X-NUCLEO-IDB05A1 (or X- NUCLEO-IDB04A1). 3. The X-NUCLEO-IKS01A2 (or X-NUCLEO-IKS01A1 ) expansion board on the X- NUCLEO-NFC01A1. 4. The X-NUCLEO-53L0A1 (or X-NUCLEO-6180XA1) expansion board on the X- NUCLEO-IKS01A2 (or X-NUCLEO-IKS01A1 ) expansion. DocID Rev 4 47/50

48 System setup guide UM2026 Figure 39: STM32 Nucleo development board plus X-NUCLEO-IDB05A1, X-NUCLEO-NFC01A1, X-NUCLEO-IKS01A1 and X-NUCLEO-6180XA1 expansion boards You must connect the boards in the sequence described above to optimize the performance of the SPBTLE-RF module on the X-NUCLEO-IDB05A1 expansion board and to reduce interference from its antenna. 48/50 DocID Rev 4

49 Revision history 4 Revision history Table 2: Document revision history Date Version Changes 25-Feb Initial release. 05-Dec Feb Mar Updated Section "Introduction", Section 2.1: "Overview ", Figure 4: "Initialization phase", Figure 5: "UART console output when the BLE services are started", Figure 6: "UART console output when a device first connects with the board", Figure 15: "BlueMS (android version) initial page after BLE connection", Figure 1: "FP-SNS-FLIGHT1 software architecture" and Figure 18: "BlueMS (android version) Serial console (stdout/stderr)"; Added Section 2.6: "Flash organization", Section 2.7: "The boot process", Section 2.8: "Firmware-Over-The-Air (FOTA) update" and Section 2.9: "Firmware Over The Air (FOTA) update with BlueMS" Throughout document: - minor text and formatting changes. - added IKS01A2 expansion board compatibility information Added Section 2.6: " The installation process" Updated Section 2.9: "Sample application description", Section 2.10: " Android and ios sample client application" and Section 2.11: "Firmware-over-the-air (FOTA) update with BlueMS" Updated title, Introduction, Section 2.1: "Overview ", Section 2.2: "Architecture", Section 2.3: "Folder structure", Section 2.6: "The installation process", Section 2.9: "Sample application description", Section 2.10: "Android and ios sample client application", Section 2.11: "Firmware over-the-air (FOTA) update with BlueMS". Added X-NUCLEO-53L0A1 expansion board compatibility information. Added Section 3.1.8: "X-NUCLEO-53L0A1 expansion board". DocID Rev 4 49/50

50 IMPORTANT NOTICE PLEASE READ CAREFULLY STMicroelectronics NV and its subsidiaries ( ST ) reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST s terms and conditions of sale in place at the time of order acknowledgement. Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of Purchasers products. No license, express or implied, to any intellectual property right is granted by ST herein. Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product. ST and the ST logo are trademarks of ST. All other product or service names are the property of their respective owners. Information in this document supersedes and replaces information previously supplied in any prior versions of this document STMicroelectronics All rights reserved 50/50 DocID Rev 4