IntroductionFP-CLD-AWS1 is an STM32Cube function pack that lets you safely connect your IoT node to an Amazon AWS IoT service soyou can transmit sensor data and receive commands from AWS-based cloud applications.

It fully supports security and protocol requirements to interface with AWS cloud thanks to the integrated Amazon AWS IoT SDK.

A companion AWS-based web dashboard (DSH-PREDMNT) is available to quickly evaluate the firmware package functions forcomprehensive sensor data visualization and device control.

This software together with our suggested combinations of STM32 and ST devices can be used to develop complete sensor-to-cloud applications for a broad range of smart home and smart industry applications.

The software runs on the STM32 microcontroller and includes drivers for the Wi-Fi, cellular modem and motion andenvironmental sensors.

RELATED LINKS Visit the STM32Cube ecosystem web page on www.st.com for further information

Getting started with the FP-CLD-AWS1 software package for IoT node with Wi-Fi, cellular modem module and sensors, connected to Amazon AWS IoT cloud

UM2186

User manual

UM2186 - Rev 3 - August 2019For further information contact your local STMicroelectronics sales office.

www.st.com

1 Acronyms and abbreviations

Table 1. List of acronyms

Acronym Description

AP Access point

BSP Base support package

FOTA Firmware update over-the-air

GPIO General purpose input/output

HAL Hardware abstraction layer

HTML Hypertext markup language

HTTP Hypertext transfer protocol

IDE Integrated development environment

IoT Internet of things

I2C Inter-integrated circuit

MCU Microcontroller unit

MEMS Micro electro-mechanical systems

ODE Open development environment

REST API Representational state transfer API

SDK Software development kit

SMD Surface mount device

SSID Service set identifier

UART Universal asynchronous receiver/transmitter

URL Uniform resource locator

Wi-Fi Wireless LAN based on IEEE 802.11

WLAN Wireless local area network

UM2186Acronyms and abbreviations

UM2186 - Rev 3 page 2/40

2 FP-CLD-AWS1 software expansion for STM32Cube

2.1 Overview

The package features:• Complete firmware to safely connect an IoT node with sensors to Amazon AWS IoT using Wi-Fi or cellular

communication technology• Middleware libraries featuring the Amazon AWS IoT software development kit, Wi-Fi, cellular and transport-

level security (mbedTLS)• Ready-to-use binaries to connect the IoT node to a web dashboard running on Amazon AWS services for

sensor data visualization and device control• Sample implementation available for STM32L4 Discovery Kit for IoT node (B-L475E-IOT01A) or for X-

NUCLEO-IKS01A3 sensors expansion board connected to P-L496G-CELL02 LTE Cellular to Cloud Pack• Easy portability across different MCU families, thanks to STM32Cube• Free, user-friendly license terms

The package integrates the AWS IoT device SDK middleware with APIs to simplify interaction between theDiscovery Kit for IoT node and the Amazon AWS IoT services.You can use it to prototype end-to-end sensors-to-cloud IoT applications, by registering your board to AmazonAWS IoT and begin exchanging real-time sensor data and commands.A web dashboard based on Amazon AWS is also provided free of charge to facilitate the evaluation of thefunction pack. For AWS license terms, visit https://aws.amazon.com.

2.2 Architecture

The software layers used by the application software to access and use the STM32 microcontroller, the Wi-Fi,cellular (LTE-IoT) modem and the sensor expansion boards are:STM32Cube HAL layer: a simple, generic and multi-instance set of APIs (application programming interfaces) tointeract with the upper layer applications, libraries and stack layers. The APIs are based on a common frameworkso that overlying software can implement functions and routines without specific microcontroller unit (MCU)hardware configurations. This structure improves library code reusability and guarantees easy portability acrossother devices.Board support package (BSP) layer: drives the STM32 Nucleo board peripherals such as LEDs, user button,etc. (except the MCU), with a specific set of APIs. This interface also helps in identifying the specific boardversion.Middleware layers: contains mbedTLS and the Amazon AWS IoT device SDK (https://github.com/aws/aws-iot-device-sdk-embedded-C) to facilitate the connection of the Discovery Kit to AWS IoT services.

UM2186FP-CLD-AWS1 software expansion for STM32Cube

UM2186 - Rev 3 page 3/40

Figure 1. FP-CLD-AWS1 software architecture

2.3 Folder structure

The folders in the software package are:• Documentation: with a compiled HTML file generated from the source code detailing the software

components and APIs (one for each project).• Drivers: the HAL drivers and the board-specific drivers for each supported board or hardware platform,

including those for the on-board components, and the CMSIS vendor-independent hardware abstractionlayer for the ARM Cortex-M processor series.

• Middlewares: the middleware interface for Wi-Fi, cellular and mbedTLS, together with the porting ofAmazon AWS IoT device SDK.

• Utilities: contains Tera Term script parameters• Projects: contains sample applications for B-L475E-IOT01A and 32L496GDISCOVERY which can be used

to register a device and transmit sensors data to Amazon AWS IoT; together with the companion webdashboard, these sample applications enable easy sensor data visualization and device control throughAWS IoT. Sample applications can be compiled under the IAR Embedded Workbench for ARM, RealViewMicrocontroller Development Kit or System Workbench for STM32 development environments. For eachsample application, the folder also contains the correspondent pre-compiled binary.

UM2186Folder structure

UM2186 - Rev 3 page 4/40

3 How to run the firmware application

Before you begin, you should set up the hardware configuration that is compatible with the FP-CLD-AWS1function pack.

Below you will find the general steps that you should follow to set up your remote IoT application with cloudmonitoring and control capability.

Step 1. Configure and launch a serial terminal application.

Step 2. Download firmware package from FP-CLD-AWS1 page on the ST website.

Step 3. Recompile the code or flash pre-compiled binaries to your board.

Step 4. Complete the Wi-Fi setup and read the MAC address from serial terminal.

Step 5. Open the web dashboard.

Step 6. Register your board in the web dashboard using the MAC address as device ID.

Step 7. Download the certificate and key file from the dashboard.

Step 8. Provision credentials and certificates to your board.

Step 9. Login to the dashboard using the MAC address as device ID.

Step 10. Visualize sensor data and control device.

Now you can proceed to follow the detailed instructions for each step.

RELATED LINKS 4 System setup guide on page 31

3.1 Serial terminal setup

To update the provisioning data (Wi-Fi and certificates) to the board, you have to set up a serial terminal on a PC.A serial terminal is required to:• configure the board (Wi-Fi parameters, device credentials)• read MAC address (used as device ID to register the device in the web dashboard)• display the published and received AWS IoT messages locally

Tera Term is used in the example below, but you can use any other similar tool.

Step 1. When using the board for the first time, connect it to your PC USB port.

Step 2. Determine the STM32 ST-LINK Virtual COM port used for the STM32 Nucleo board.

Step 3. Open the [Device Manager].

Step 4. Open a serial terminal on the PC and connect it to the above virtual COM port.

UM2186How to run the firmware application

UM2186 - Rev 3 page 5/40

Figure 2. Opening the COM port for the STM32 Nucleo board

Step 5. Configure the COM port number and the other parameters as shown below.

Figure 3. Serial COM port setup

Step 6. Configure the terminal with the recommended parameters shown below.

Figure 4. Terminal setup

UM2186Serial terminal setup

UM2186 - Rev 3 page 6/40

Note: The virtual terminal new-line transmit configuration must be set to LineFeed (\n or LF) to allow copying andpasting from the UNIX type text files. The “Local echo” option makes copy and paste visible on the console.

Step 7. Flash the board with the pre-compiled binaries provided in the FP-CLD-AWS1 package.

Step 8. Reset the board and follow the indications on the serial terminal to configure Wi-Fi parameters anddevice credentials (see the following sections).Data entered via serial terminal is copied and stored in the Flash memory and can be reused withoutediting after each board reset.

3.2 Configuration of Wi-Fi credentials

Wi-Fi credentials can be entered or updated in two ways:• If the credentials are not available in Flash (blank board), the console prompts to enter Wi-Fi credentials on

startup.• If the credentials are available in Flash (pre-provisioned board), the console prompts to press the user

button (blue) within 5 seconds after board startup to update the pre-provisioned Wi-Fi credentials.

3.2.1 Blank boardStep 1. Enter Wi-Fi SSID after board reset

Figure 5. Enter Wi-Fi SSID credentials in the terminal

Step 2. Enter security mode of Wi-Fi connection.

UM2186Configuration of Wi-Fi credentials

UM2186 - Rev 3 page 7/40

Figure 6. Enter Wi-Fi security mode in the terminal

Step 3. Enter Wi-Fi password.

Figure 7. Enter Wi-Fi password in the terminal

The board is now connected to the Wi-Fi access point.

UM2186Configuration of Wi-Fi credentials

UM2186 - Rev 3 page 8/40

Figure 8. Wi-Fi connected to AP

The board MAC address is shown in the serial terminal.

Figure 9. Board MAC address shown in the terminal

3.2.2 Provisioned boardPre-provisioned boards read Wi-Fi parameters from the Flash memory.You can update the pre-provisioned credentials by pressing the blue user button: if you press it within 5 seconds(after the message in the figure below appears), you can update the Wi-Fi credentials otherwise credentialsstored in Flash memory are used.The system prints the Wi-Fi SSID to which it is trying to connect.After connection, the “Wi-Fi connected to AP” message appears.

Figure 10. Enter Wi-Fi SSID credentials in the terminal

UM2186Configuration of Wi-Fi credentials

UM2186 - Rev 3 page 9/40

3.2.3 How to register the board to the ST IoT web dashboardTo run the test application included in FP-CLD-AWS1 package and connect it to the ST AWS Dashboard, it isnecessary to register the board and download the device certificate and key.The communication between ST development boards and AWS IoT is protected by X.509 device certificate, adigital certificate that uses public key infrastructure (PKI) standard.The dashboard automates the generation of such certificates in the ST owned AWS Account used to deploy andrun the web application.

Step 1. To register a board and generate certificates, open the ST AWS Dashboard Login page

Figure 11. ST IoT web dashboard

Step 2. Under [Login], enter a login name in the [Device group name] field and a password in the field[Password] and then click on the [Submit] button.

Step 3. After successful login, the Devices page is available. Under [Devices], click on the [+] button to registeryour new device.The [Enroll new Device] popup appears.

UM2186Configuration of Wi-Fi credentials

UM2186 - Rev 3 page 10/40

Figure 12. Enroll a new device

Step 4. Enter a descriptive name for the device in the [Custom Name] field and the board MAC address(shown in the serial terminal) in the [MAC address] field, and click on the [Submit] button.The MAC address must be entered in the format “XX:XX:XX:XX:XX:XX”.

Figure 13. New board registration in the ST AWS dashboard

UM2186Configuration of Wi-Fi credentials

UM2186 - Rev 3 page 11/40

Figure 14. New board registration MAC address

The web application automatically creates the AWS Thing in the AWS IoT core and generates thecorresponding device certificates for the MAC address entered.

Note: The AWS Thing is created in a proprietary ST AWS account.

Step 5. Click on the [DOWNLOAD] button in the popup window that prompts you to download the devicecertificate and private key in a text file.

Figure 15. Certificate and key download

Step 6. You can check the file in a text editor.The text file named XX_XX_XX_XX_XX_XX.cert is divided into two sections:a. The first section is the certificate of the AWS Thing created in AWS IoT core, it is delimited thus:

◦ -----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----

UM2186Configuration of Wi-Fi credentials

UM2186 - Rev 3 page 12/40

b. The second section is the private key of the AWS Thing created in AWS IoT, it is delimited thus:◦ -----BEGIN RSA PRIVATE KEY-----

...-----END RSA PRIVATE KEY-----

Figure 16. XX_XX_XX_XX_XX_XX.cert file content

Step 7. Wait for the browser to refresh to view the newly created Thing in the Devices page.

Figure 17. AWS Thing in Devices page

UM2186Configuration of Wi-Fi credentials

UM2186 - Rev 3 page 13/40

3.3 Configuration of cellular credentials

The P-L496G-CELL02 Discovery Kit features ready-to-run firmware examples using the 2G, 3G, LTE Cat M1, orNB-IoT protocols to support quick evaluation and development of AWS IoT cloud applications.The FP-CLD-AWS1 package offers out-of-the-box connectivity for communication to the AWS IoT through theMQTT protocol. It implements a complete middleware and application-level stack in C language, which allows theconnection of the P-L496G-CELL02 Discovery kit to a AWS IoT.The cellular-to-AWS kit includes an STM32-based main board, a cellular add-on modem board, and a prepaidSIM, which enables the registration to a cellular PLMN.

Note: The global roaming provided by the SIM provider allows device attachment from any country. The SIM onlyoffers IP connectivity. The volume of data available in the prepaid offer depends on where it is used.The add-on modem boards (P-L496G-CELL02) embed an eSIM, provisioned with the EMnify MVNO profile.For the BG96 modem, with the EMnify eSIM, 2G fallback is possible and sometimes, depending on the country,LTE Cat M1 is also available.To be sure to be able to use the BG96 modem in Cat M1 or NB1 mode, the user must insert a plastic SIM cardcompliant with this network technology from an MNO that has already deployed it.After board reset, you can initialize the cellular module.

Figure 18. Cellular module initialization and modem connection to the network

Then, you have to connect to the dashboard and registrate the new device (Thing).

Figure 19. Dashboard link and Thing registration

The first sixteen bytes of the SIM ID of the platform are used as default Thing Name/Device ID in AWS IoT Thingregistration. When connection to MNO equipment is established, the SIM ID (that is, the sixteen bytes) of theboard is shown on the serial terminal.

UM2186Configuration of cellular credentials

UM2186 - Rev 3 page 14/40

Figure 20. SIM ID

3.3.1 How to register the board to the ST IoT web dashboard

Step 1. Follow the procedure described in Section 3.2.3 in steps 1-2-3.

Step 2. On the [Enroll new Device] popup, deselect the [Device ID is a MAC address] checkbox.This is so you can enter generic Device ID text (required for cellular boards) instead of a MAC address.

Figure 21. Device ID checkbox

Step 3. Enter a descriptive name for the device in the [Custom Name] field.

Step 4. Enter the first sixteen bytes of SIM ID in the [Device ID] field and click on [Submit].The ID string is displayed in the serial terminal when you configure the cellular credentials.

UM2186Configuration of cellular credentials

UM2186 - Rev 3 page 15/40

Figure 22. Cellular board registration by entering the first sixteen bytes of the SIM ID

The web application automatically creates the AWS Thing in the AWS IoT Core and generates thecorresponding device certificates for the device ID entered.

Note: The AWS Thing is created in a proprietary ST AWS account.

Step 5. Click on the [DOWNLOAD] button in the popup window that prompts you to download the devicecertificate and private key in a text file.

Figure 23. Device Certificate and Private Key download

Step 6. You can check the file in a text editor.The text file named device_id.cert is divided into two sections:a. The first section is the certificate of the AWS Thing created in AWS IoT core, it is delimited thus:

◦ -----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----

UM2186Configuration of cellular credentials

UM2186 - Rev 3 page 16/40

b. The second section is the private key of the AWS Thing created in AWS IoT, it is delimited thus:◦ -----BEGIN RSA PRIVATE KEY-----

...-----END RSA PRIVATE KEY-----

Figure 24. Content of downloaded device_id.cert file

Step 7. Wait for the browser to refresh to view the newly created Thing in the Devices page.

Figure 25. Devices page: new Thing

UM2186Configuration of cellular credentials

UM2186 - Rev 3 page 17/40

RELATED LINKS 3.3 Configuration of cellular credentials on page 13

3.4 Board security credential provisioning

To set up your board with security credentials downloaded from ST IoT web dashboard after board registration,you can enter or update credentials in two ways:• if the credentials are not available in the Flash memory (blank board), the console prompts to enter device

certificates and key at startup;• if the credentials are available in the Flash (pre-provisioned board), the console prompts to press the user

blue button within 5 seconds after the board startup to update them.

3.4.1 Blank boardWhen the board is flashed with pre-compiled files and started, enter or update the following parameters.• AWS IoT endpoint• Thing Name• AWS Root Certificate• Thing Device Certificate• Thing Private Key

Note: The firmware contains default values for the Root Certificate and AWS IoT endpoint which are related to the STaccount used to deploy web dashboard and must not be modified. By default, the device ID used to register thething to the AWS IoT core is the MAC address of the device for the Wi-Fi based board and SIM ID (first sixteenbytes) for the cellular board.The user is required to enter Private Key and Device Certificate which can be copied and pasted from the<device_id>.cert file downloaded from the web page as described in previous section.

Step 1. When prompted to change Default ST IoT Dashboard hosting AWS account, press ‘n’ and [ENTER] toproceed.The default endpoint must not be changed when using the firmware with the web dashboard.

Figure 26. Default ST IoT Dashboard hosting AWS account

The firmware reads the MAC address as default device ID, the same used to register the device andcreate certificates through the web dashboard.

UM2186Board security credential provisioning

UM2186 - Rev 3 page 18/40

Figure 27. Default Thing name

Step 2. Press ‘n’ and [ENTER] when asked to update default Thing name.

Figure 28. Default Thing name change

Step 3. When prompted to change Default Root Certificate, press ‘n’ and [ENTER] to proceed.

Figure 29. Default Root CA certificate

Step 4. Enter device certificate.

Step 5. Open your XX_XX_XX_XX_XX_XX.cert file downloaded from the web dashboard in a text editor.

Step 6. Copy the section highlighted below.

UM2186Board security credential provisioning

UM2186 - Rev 3 page 19/40

Figure 30. Data.cert file: device certificate and private key

Step 7. Go to the terminal application.

Step 8. Right-click on the terminal.A clipboard window pops up with the copied certificate data.

UM2186Board security credential provisioning

UM2186 - Rev 3 page 20/40

Figure 31. Clipboard confirmation

Step 9. Click OK to copy the data to the terminal.

Figure 32. Device certificate copied to the terminal

Step 10. Press enter twice to send data to the device.

UM2186Board security credential provisioning

UM2186 - Rev 3 page 21/40

Figure 33. Device certificate accepted

Step 11. Open XX_XX_XX_XX_XX_XX.cert file and copy the device Private Key.

Step 12. Follow the same procedure used for the device certificate to paste the Private Key in the serial terminaland send it to the device.

3.4.2 Provisioned boardThe entered device certificate and private key and the confirmed defaults values for Root Certificate, AWSendpoint and thing name are copied in the Flash memory.When the board restarts, configuration data are read from the Flash memory.You can update the pre-provisioned data by pressing the user button within 5 seconds, otherwise the Flashconfiguration data are used.

Figure 34. Device security parameter update

3.5 Data visualization in the web dashboard

Once the device configuration is complete, the board sends sensor data to the AWS IoT Cloud.To visualize sensor data, follow the procedure below.

Step 1. Log in to the Web Dashboard.

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 22/40

Figure 35. Dashboard login

The Devices page dispalays the list of devices registered in the Dashboard account you logged into.

Figure 36. List of devices registered in the Dashboard account

The dashboard also indicates the devices connected to the Dashboard AWS IoT account.

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 23/40

Figure 37. List of devices connected to the Dashboard AWS IoT account

Step 2. Click on [Telemetry] to visualize data.

Figure 38. Telemetry data

Step 3. Click on [Select devices to monitor] to select the device from which you want to visualize data

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 24/40

Figure 39. Select device to monitor

Figure 40. List of devices

Step 4. Select the device(s) you want to visualize or monitor the data from.You can select more than one device.

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 25/40

Figure 41. Selected device

Step 5. Click on the [Play] button to visualize data.

Figure 42. Data visualization

Step 6. Click [Select window time] to control the period of data displayed in the Telemetry page.ACC is the default measure displayed. You can change it by clicking [Select measure].

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 26/40

Figure 43. ACC sensor data displayed

At the dashboard page top, you can find the name of the Thing/Device for which the data is displayed.

Step 7. Click [Select measure] to visualize temperature, humidity, pressure, accelerometer, gyroscope andmagnetometer values in charts for a period of 1, 3, 6 or 12 hours and custom period.You can also visualize the High Value@Time and Low Value@Time plotted on a time frame of 1, 6, 24and 48 hours.

Figure 44. Temperature

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 27/40

Figure 45. Humidity

Figure 46. Pressure

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 28/40

Figure 47. Accelerometer

Figure 48. Gyroscope

UM2186Data visualization in the web dashboard

UM2186 - Rev 3 page 29/40

Figure 49. Magnetometer

3.6 Delete a registered board

You can remove a registered board and the corresponding thing created in the AWS IoT Core directly from theweb dashboard by simply clicking on the icon of the device in the dashboard and then clicking on the delete iconin the pop up to delete the device.

Figure 50. Dashboard: delete a registered board section

UM2186Delete a registered board

UM2186 - Rev 3 page 30/40

4 System setup guide

The following systems are compatible with the FP-CLD-AWS1 function pack software for IoT nodes:1. P-L496G-CELL02 Discovery Kit plus X-NUCLEO-IKS01A3 sensor expansion board.2. B-L475E-IOT01ASTM32L4 Discovery Kit for IoT nodes.

4.1 Hardware description

4.1.1 P-L496G-CELL02 discovery packThe P-L496G-CELL02 STM32 discovery pack for LTE IoT cellular to cloud (STM32-C2C/LTE IoT) is a turnkeydevelopment platform for cellular and cloud technology-based solutions.The discovery pack consists of the following boards:1. An STM32L496AGI6-based low-power discovery motherboard with preloaded firmware

(32L496GDISCOVERY). The microcontroller has 1 Mbyte of Flash memory and 320 Kbytes of RAM in aUFBGA169 package.

2. An STMod+ cellular expansion board with antenna. The expansion board features a Quectel BG96worldwide cellular modem LTE Cat M1/Cat NB1/EGPRS module 300 kbps downlink, 375 kbps uplink.

Figure 51. P-L496G-CELL02 LTE cellular to cloud pack

4.1.2 X-NUCLEO-IKS01A3 expansion boardThe X-NUCLEO-IKS01A3 is a motion MEMS and environmental sensor evaluation board system.It is compatible with the Arduino UNO R3 connector layout and features the LSM6DSO 3-axis accelerometer + 3-axis gyroscope, the LIS2MDL 3-axis magnetometer, the LIS2DW12 3-axis accelerometer, the HTS221 humidityand temperature sensor, the LPS22HH pressure sensor, and the STTS751 temperature sensor.The X-NUCLEO-IKS01A3 interfaces with the STM32 microcontroller via the I²C pin, and it is possible to changethe default I²C port.

UM2186System setup guide

UM2186 - Rev 3 page 31/40

Figure 52. X-NUCLEO-IKS01A3 MEMS and environmental sensor expansion board

4.1.3 STM32L4 Discovery kit IoT nodeThe B-L475E-IOT01A Discovery kit for IoT node allows you to develop applications to directly connect to cloudservers.The Discovery kit enables a wide variety of applications by exploiting low-power communication, multi-waysensing and ARM® Cortex® -M4 core-based STM32L4 series features.It supports Arduino Uno R3 and PMOD connectivity providing unlimited expansion capabilities with a large choiceof dedicated add-on boards.

Figure 53. B-L475E-IOT01A Discovery kit

UM2186Hardware description

UM2186 - Rev 3 page 32/40

4.2 Hardware setup

The following hardware components are needed:1. A P-L496G-CELL02 Discovery Kit2. A sensor expansion board (order code: X-NUCLEO-IKS01A3)3. As alternative to the boards above, an STM32L4 Discovery Kit for IoT node (order code: B-L475E-IOT01A)4. A USB type A to Mini-B USB cable to connect the board to the PC

4.2.1 P-L496G-CELL02 Discovery Kit and X-NUCLEO-IKS01A3 expansion board setupStep 1. Connect the P-L496G-CELL02 host board to the modem board via the STMod+ connector.

Step 2. When the UICC chip soldered on the add-on board is not used, insert a UICC compliant with the realnetwork used into the UICC socket.If the soldered UICC chip is used, it must be activated and selected in the boot menu.

Step 3. Power the board on by plugging its USB connector to a PC, USB power supply, or USB power bank.The USB connector must be connected to a PC with an open console application. For instance, powerbands are needed when 2G is selected with particular radio conditions.

Step 4. Connect the X-NUCLEO-IKS01A3 to the P-L496G-CELL02 Discovery Kit through the Arduino UNO R3connector as shown below.

UM2186Hardware setup

UM2186 - Rev 3 page 33/40

Figure 54. X-NUCLEO-IKS01A3 expansion board connected to P-L496G-CELL02 Discovery Kitvia Arduino connector

4.3 Software setup

The following software components are needed in order to set up a suitable development environment forcompiling and running the FP-CLD-AWS1 package:• FP-CLD-AWS1 software, available on www.st.com/stm32cube• One of the following development tool-chain and compilers:

– IAR Embedded Workbench for ARM® toolchain + ST-LINK– RealView Microcontroller Development Kit toolchain + ST-LINK– System Workbench for STM32 (SW4STM32) + ST-LINK

Note: Project files for all three supported IDEs can be found in FP-CLD-AWS-Release/FW/Projects/B-L475E-IOT01/Applications/Cloud/AWS for the B-L475E-IOT01A board or in FP-CLD-AWS-Release//Projects/32L496GDISCOVERY/Applications/Cloud/AWS for the P-L496G-CELL02 Discovery board.• a serial line monitor (e.g. Tera Term, https://ttssh2.osdn.jp/index.html.en)

UM2186Software setup

UM2186 - Rev 3 page 34/40

Revision history

Table 2. Document revision history

Date Version Changes

22-Mar-2017 1 Initial release

10-Oct-2018 2 Update all content to reflect FP-CLD-AWS1 package 2.0.0 release.

01-Aug-2019 3

Updated Introduction, Section 2.1 Overview, Section 2.2 Architecture, Section 2.3 Folderstructure, Section 3.2.3 How to register the board to the ST IoT web dashboard, Section 3.4.1 Blank board, Figure 34. Device security parameter update, Section 3.5 Data visualization inthe web dashboard, Section 3.6 Delete a registered board, Section 4.2 Hardware setup andSection 4.3 Software setup.

Added Section 3.3 Configuration of cellular credentials, Section 3.3.1 How to register the board tothe ST IoT web dashboard, Section 4.1.1 P-L496G-CELL02 discovery pack, Section 4.1.2 X-NUCLEO-IKS01A3 expansion board and Section 4.2.1 P-L496G-CELL02 Discovery Kit and X-NUCLEO-IKS01A3 expansion board setup

UM2186

UM2186 - Rev 3 page 35/40

Contents

1 Acronyms and abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

2 FP-CLD-AWS1 software expansion for STM32Cube. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.2 Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.3 Folder structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3 How to run the firmware application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

3.1 Serial terminal setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3.2 Configuration of Wi-Fi credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.2.1 Blank board. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.2.2 Provisioned board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.2.3 How to register the board to the ST IoT web dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3.3 Configuration of cellular credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

3.3.1 How to register the board to the ST IoT web dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . 15

3.4 Board security credential provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

3.4.1 Blank board. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

3.4.2 Provisioned board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

3.5 Data visualization in the web dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

3.6 Delete a registered board. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4 System setup guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

4.1 Hardware description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

4.1.1 P-L496G-CELL02 discovery pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

4.1.2 X-NUCLEO-IKS01A3 expansion board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

4.1.3 STM32L4 Discovery kit IoT node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

4.2 Hardware setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4.2.1 P-L496G-CELL02 Discovery Kit and X-NUCLEO-IKS01A3 expansion board setup . . . . . 33

4.3 Software setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

UM2186Contents

UM2186 - Rev 3 page 36/40

List of figuresFigure 1. FP-CLD-AWS1 software architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Figure 2. Opening the COM port for the STM32 Nucleo board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Figure 3. Serial COM port setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Figure 4. Terminal setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Figure 5. Enter Wi-Fi SSID credentials in the terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Figure 6. Enter Wi-Fi security mode in the terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Figure 7. Enter Wi-Fi password in the terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Figure 8. Wi-Fi connected to AP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Figure 9. Board MAC address shown in the terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Figure 10. Enter Wi-Fi SSID credentials in the terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Figure 11. ST IoT web dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Figure 12. Enroll a new device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Figure 13. New board registration in the ST AWS dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Figure 14. New board registration MAC address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Figure 15. Certificate and key download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Figure 16. XX_XX_XX_XX_XX_XX.cert file content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Figure 17. AWS Thing in Devices page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Figure 18. Cellular module initialization and modem connection to the network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Figure 19. Dashboard link and Thing registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Figure 20. SIM ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Figure 21. Device ID checkbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Figure 22. Cellular board registration by entering the first sixteen bytes of the SIM ID . . . . . . . . . . . . . . . . . . . . . . . . . . 16Figure 23. Device Certificate and Private Key download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Figure 24. Content of downloaded device_id.cert file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Figure 25. Devices page: new Thing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Figure 26. Default ST IoT Dashboard hosting AWS account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Figure 27. Default Thing name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Figure 28. Default Thing name change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Figure 29. Default Root CA certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Figure 30. Data.cert file: device certificate and private key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Figure 31. Clipboard confirmation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Figure 32. Device certificate copied to the terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Figure 33. Device certificate accepted. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Figure 34. Device security parameter update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Figure 35. Dashboard login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Figure 36. List of devices registered in the Dashboard account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Figure 37. List of devices connected to the Dashboard AWS IoT account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Figure 38. Telemetry data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Figure 39. Select device to monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Figure 40. List of devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Figure 41. Selected device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Figure 42. Data visualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Figure 43. ACC sensor data displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Figure 44. Temperature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Figure 45. Humidity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Figure 46. Pressure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Figure 47. Accelerometer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Figure 48. Gyroscope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Figure 49. Magnetometer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Figure 50. Dashboard: delete a registered board section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Figure 51. P-L496G-CELL02 LTE cellular to cloud pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Figure 52. X-NUCLEO-IKS01A3 MEMS and environmental sensor expansion board . . . . . . . . . . . . . . . . . . . . . . . . . . 32

UM2186List of figures

UM2186 - Rev 3 page 37/40

Figure 53. B-L475E-IOT01A Discovery kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Figure 54. X-NUCLEO-IKS01A3 expansion board connected to P-L496G-CELL02 Discovery Kit via Arduino connector . . 34

UM2186List of figures

UM2186 - Rev 3 page 38/40

List of tablesTable 1. List of acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Table 2. Document revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

UM2186List of tables

UM2186 - Rev 3 page 39/40

IMPORTANT NOTICE – PLEASE READ CAREFULLY

STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and improvements to STproducts and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. STproducts 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 ofPurchasers’ 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. For additional information about ST trademarks, please refer to www.st.com/trademarks. All other product or servicenames are the property of their respective owners.

Information in this document supersedes and replaces information previously supplied in any prior versions of this document.

© 2019 STMicroelectronics – All rights reserved

UM2186

UM2186 - Rev 3 page 40/40