Difference between revisions of "STM32StepByStep:Step4 Sensors usage"

[quality revision]

Revision as of 12:48, 16 September 2021 (view source)

Escoda Michael (talk | contribs)

m

← Older edit

Latest revision as of 15:18, 17 May 2023 (view source)

Cristina Sole Sala (talk | contribs)

m

Sensors usage Using sensors with B-L475E-IOT01A and with B-U585I-IOT02A60min

Target description
The purpose of this tutorial is to explain how to perform measurements with the sensors available in the STM32L4 Discovery kit . Configuration and in the B-U585I-IOT02A Discovery kit. A step by step configuration of the temperature sensor is described step by stepavailable.
After this tutorial, you will be able to collect values using the sensors available on the B-L475E-IOT01A board and on the B-U585I-IOT02A board.
The appendix of this tutorial provides guidelines on how to port an AC6 example to STM32CubeIDE.

Prerequisites
You have gone throughalready followed:

Hardware

STM32L4 Discovery kit IoT node^[1] (B-L475E-IOT01A )
B-U585I-IOT02A Discovery kit IoT node^[2] (B-U585I-IOT02A )
USB cable Type-A to Micro-B

Literature

UM2153 Discovery kit for IoT node, multi-channel communication with STM32L4
UM1884 Description of STM32L4/L4+ HAL and low-layer drivers
UM2839 Discovery kit for IoT node with STM32U5 Series
UM2911 Description of STM32U5 HAL and low-layer drivers
UM1859 Getting started with the X-CUBE-MEMS1 motion MEMS and environmental sensor software expansion for STM32Cube
UM2579 Migration guide from System Workbench to STM32CubeIDE
Getting starting started with STM32L4 Discovery kit IoT node
Discover the new STM32U5 IoT node B-U585-IOT02A Discovery kit

1Sensors usage Using sensors with B-L475E-IOT01A
- 1.1 Hardware description
- 1.2 Example: Get Getting temperature values using the HTS221 sensor and display displaying them on a terminal
2 Using sensors with B-U585-IOT02A
- 2.1 Hardware description
- 2.2 Example: Getting temperature values using the HTS221 sensor and displaying them on a terminal
3 Appendix: Porting an AC6 example to STM32CubeIDE

2

- 3.1 Hardware description

2

- 3.2 Example:

Get

- Getting temperature values using the HTS221 sensor and

display

- displaying them on a terminal (Porting from AC6 to STM32CubeIDE)

2

- - 3.2.1 Hardware setup

2

- - 3.2.2 Example details

2

- - 3.2.3 Porting the example to STM32CubeIDE

2

- - 3.2.4 Compiling and running the example

3

4 References

1 Sensors usage Using sensors with B-L475E-IOT01A[edit]

1.1 Hardware description[edit]

The main sensors available in the STM32L4 Discovery kit IoT node (B-L475E-IOT01A) are:

Capacitive digital sensor for relative humidity and temperature (HTS221)
260-1260 hPa absolute digital output barometer (LPS22HB)
3D accelerometer and 3D gyroscope (LSM6DSL)
High-performance 3-axis magnetometer (LIS3MDL).

1.2 Example: Get Getting temperature values using the HTS221 sensor and display displaying them on a terminal[edit]

The purpose of this section is to explain provide a step by step description on how to interface with the HTS221 sensor to get temperature values and to display them on a terminal.

1.2.1 Create a working project with STM32CubeMX[edit]

The starting point is the project generated with STM32CubeMX, described in the Step3 tutorial titled tutorial : Introduction to the UART I/F on B-L475E-IOT01A.

Follow the steps

described there and call the

in the tutorial.
Name the generated project as L4_IOT_Sensors.

1.2.2 Copy BSP drivers to your project[edit]

The BSP (board support package) drivers are available in the STM32CubeL4 package. This provides APIs corresponding to the hardware components of a board.

The last lastest version of the STM32CubeL4 package is downloaded by default in the STM32CubeMX repository (:

C:\Users\user_name\STM32Cube\Repository\STM32Cube_FW_L4_Vx.xx.x).

The image below shows the BSP location and its content in the tree:

Information

In this example, the STM32CubeL4 version used version is 1.11.0, but it . Version can increase over time.

Here are the Follow these steps to follow in order to copy the BSP drivers into to your project:

In the generated project, create a folder L4_IOT_Sensors/Drivers/BSP.

Copy the STM32CubeL4/Drivers/BSP/B-L475E-IOT01 folder
In the generated project, create a folder and paste it in the L4_IOT_Sensors/Drivers/BSP. Paste the copied folder there.

Copy the STM32CubeL4/Drivers/BSP/Components folder . Paste and paste it under L4_IOT_Sensors/Drivers/BSP/Components.

Optional cleanup of working directory: as only Only the HTS221 temperature sensor is used. For this reason, some any other files and folders already copied to the working directory may can be removed
Under . This step is optional:

    * Keep only the following files under  L4_IOT_Sensors\Drivers\BSP\B-L475E-IOT01

, keep only the following files:

Under

    * Keep only the following files under L4_IOT_Sensors\Drivers\BSP\Components

, keep only the following folders

1.2.3 Support BSP in STM32CubeIDE workspace[edit]

After being copied, the added Added folders appear automatically in the STM32CubeIDE workspace:

1.2.4 Update include paths[edit]

Update the paths to support new header files:

Select the relevant project from the Project Explorer perspective:

From Project menu or File menu, go to Properties > C/C++ Build > Settings > Tool Settings > MCU GCC Compiler > Include paths.
Click on to include the new paths.
Add ../Drivers/BSP/B-L475E-IOT01 and ../Drivers/BSP/Components/hts221 paths.

The following screenshot summarizes the steps to follow:

1.2.5 Update source files[edit]

The only file to modify is Edit main.c, as follows:

Include the header files: stm32l475e_iot01.h, stm32l475e_iot01_tsensor.h and math.h

/* USER CODE BEGIN Includes */<br>
#include "stm32l475e_iot01.h"
#include "stm32l475e_iot01_tsensor.h"
#include <math.h>
/* USER CODE END Includes */

Add private values to use for temperature values and displayed . These values are used to display temperature and messages on the terminal:

/* USER CODE BEGIN PV */
/* Private variables -------------------------------------------------------*/
float temp_value = 0;  // Measured temperature value
char str_tmp[100] = ""; // Formatted message to display the temperature value
uint8_t msg1[] = "****** Temperature values measurement ******\n\n\r";
uint8_t msg2[] = "=====> Initialize Temperature sensor HTS221 \r\n";
uint8_t msg3[] = "=====> Temperature sensor HTS221 initialized \r\n ";
/* USER CODE END PV */

Display messages on the terminal and initialize the HTS221 temperature sensor:

/* USER CODE BEGIN 2 */
HAL_UART_Transmit(&huart1,msg1,sizeof(msg1),1000);
HAL_UART_Transmit(&huart1,msg2,sizeof(msg2),1000);
BSP_TSENSOR_Init();
HAL_UART_Transmit(&huart1,msg3,sizeof(msg3),1000);
/* USER CODE END 2 *//

In the while (1) loop, read the temperature value, format it, and then display the message with the measured value on the terminal:

/* USER CODE BEGIN 3 */
temp_value = BSP_TSENSOR_ReadTemp();
int tmpInt1 = temp_value;
float tmpFrac = temp_value - tmpInt1;
int tmpInt2 = trunc(tmpFrac * 100);
snprintf(str_tmp,100," TEMPERATURE = %d.%02d\n\r", tmpInt1, tmpInt2);
HAL_UART_Transmit(&huart1,( uint8_t * )str_tmp,sizeof(str_tmp),1000);
HAL_Delay(1000);
/* USER CODE END 3 */

Information

Pay attention to make updates in the correct Updates must only be made on the required USER CODE section in order , to avoid over-writing them overwriting all the content with a new STM32CubeMX code generation.

1.2.6 Compile and run the example[edit]

Click on the Build button to compile the project.
Click on the Debug button to run the software.
Open a console emulator such as TeraTerm ^[2^3]. To configure the console baud rate, select data bits: 8 and click OK. Port name may differ on your PCcomputer.
STM32CubeIDE opens the Debug perspective. Click on the Resume button to execute the code.
TeraTerm ^[2^3] displays the initialization message preceding the measured temperature values:

Now you are able to:

Build your own project to measure temperature values using the embedded sensor in B-L475E-IOT01A.
Add BSP components to an STM32CubeMx generated project.
Extend the use of the board to sensors other than HTS221, to make environmental measurements.

2 Using sensors with B-U585-IOT02A[edit]

2.1 Hardware description[edit]

The main sensors available in B-U585I-IOT02A discovery kit for the

sensor embedded on the B-L475E-IOT01A
Add BSP

IoT node are:

Capacitive digital sensor for relative humidity and temperature (HTS221)
260-1260 hPa absolute digital output barometer (LPS22HH)
3D accelerometer and 3D gyroscope (ISM330DHCX)
High-performance 3-axis magnetometer (IIS2MDCTR).

2.2 Example: Getting temperature values using the HTS221 sensor and displaying them on a terminal[edit]

The purpose of this section is to provide a step by step description on how to interface with the HTS221 sensor to get temperature values and to display them on a terminal.

2.2.1 Create a working project with STM32CubeMX[edit]

Create a new project using STM32CubeMX:

Select the B-U585I-IOT02A board using the Board selector.

Answer Yes to Initialize all peripherals with their default Mode ? popup.

Select without TrustZone activated?. Answer OK to the Create a new project without TrustZone activated? popup.

Verify in the Pinout tab that the USART1 mode is configured to Asynchronous.

Click on the USART1 button in the Configuration tab. Set Word Length to 8 Bits, baud rate to 115200 Bits/s, Parity to None and Stop Bits to 1, as shown below:

Enable ICache in the Pinout tab by selecting Memory address remap to reach the maximum performance.

Switch to the Project Manager tab: Select STM32CubeIDE as Toolchain/IDE and name your project.

Click on Generate Code.

Accept to open the project in STM32CubeIDE and follow the steps.

Call the generated project U5_IOT_Sensors.

2.2.2 Copy BSP drivers to your project[edit]

The BSP (board support package) drivers are available in the STM32CubeU5 package. This provides APIs corresponding to the hardware components of a board.

The lastest version of the STM32CubeU5 package is downloaded by default in the SMT32CubeMX repository:

C:\Users\user_name\STM32Cube\Repository\STM32Cube_FW_U5_Vx.xx.x.

The image below shows the BSP location and its content:

Information

In this example, the STM32CubeU5 version used is 1.1.1. Version can increase over time.

Here are the steps to follow in order to copy the BSP drivers to your project:

In the generated project, create a folder U5_IOT_Sensors/Drivers/BSP.

Copy the STM32CubeU5/Drivers/BSP/B-U585-IOT02 folder and paste it to the U5_IOT_Sensors/Drivers/BSP folder.

Copy the STM32CubeU5/Drivers/BSP/Components folder and paste it under U5_IOT_Sensors/Drivers/BSP/Components.

Only the HTS221 temperature sensor is used. For this reason, any other files and folders copied to the working directory can be removed. This step is optional:

    * Keep only the following folders under U5_IOT_Sensors\Drivers\BSP\Components:

    *Keep only the following folders under  U5_IOT_Sensors\Drivers\BSP\B-U585-IOT02:

Rename the file b_u585i_iot02a_conf_template.h to b_u585i_iot02a_conf.h.

2.2.3 Support BSP in STM32CubeIDE workspace[edit]

Added folders appear automatically in the STM32CubeIDE workspace:

2.2.4 Update include paths[edit]

Update the paths to support new header files:

Select the relevant project from the Project Explorer perspective:

From Project menu or File menu, go to Properties > C/C++ Build > Settings > Tool Settings > MCU GCC Compiler > Include paths.
Click on to include the new paths.
Add the paths ../Drivers/BSP/B-U585I-IOT02A , ../Drivers/BSP/Components/hts221 and ../Drivers/BSP/Components/lps22hh

The following screenshot summarizes the steps to follow:

2.2.5 Update source files[edit]

Edit main.c as follows:

Include the header files: b_u585i_iot02a.h, b_u585i_iot02a_env_sensors.h and math.h

/* USER CODE BEGIN Includes */
#include "b_u585i_iot02a.h"
#include "b_u585i_iot02a_env_sensors.h"
#include <math.h>
/* USER CODE END Includes */

Add private values. These values are used to display temperature and messages on the terminal:

/* USER CODE BEGIN PV */
/* Private variables -------------------------------------------------------*/
float temp_value = 0;  // Measured temperature value
char str_tmp[100] = ""; // Formatted message to display the temperature value
uint8_t msg1[] = "****** Temperature values measurement ******\n\n\r";
uint8_t msg2[] = "=====> Initialize Temperature sensor HTS221 \r\n";
uint8_t msg3[] = "=====> Temperature sensor HTS221 initialized \r\n";
/* USER CODE END PV */

Display messages on the terminal and initialize the HTS221 temperature sensor:

/* USER CODE BEGIN 2 */
HAL_UART_Transmit(&huart1,msg1,sizeof(msg1),1000);
HAL_UART_Transmit(&huart1,msg2,sizeof(msg2),1000);
BSP_ENV_SENSOR_Init(0, ENV_TEMPERATURE);
BSP_ENV_SENSOR_Enable(0, ENV_TEMPERATURE);
HAL_UART_Transmit(&huart1,msg3,sizeof(msg3),1000);
/* USER CODE END 2 *//

In the while (1) loop, read the temperature value, format it, and then display the message with the measured value on the terminal:

/* USER CODE BEGIN 3 */
BSP_ENV_SENSOR_GetValue(0, ENV_TEMPERATURE, &temp_value);
int tmpInt1 = temp_value;
float tmpFrac = temp_value - tmpInt1;
int tmpInt2 = trunc(tmpFrac * 100);
snprintf(str_tmp,100," TEMPERATURE = %d.%02d\n\r", tmpInt1, tmpInt2);
HAL_UART_Transmit(&huart1,( uint8_t *)str_tmp,sizeof(str_tmp),1000);
HAL_Delay(1000);
/* USER CODE END 3 */

Information

Updates must only be made on the required USER CODE section, to avoid overwriting all the content with a new STM32CubeMX code generation.

2.2.6 Compile and run the example[edit]

Click on the Build button to compile the project.
Click on the Debug button to run the software.
Open a console emulator such as TeraTerm ^[3]. To configure the console baud rate, select data bits: 8 and click OK. Port name may differ on your computer.
STM32CubeIDE opens the Debug perspective. Click on the Resume button to execute the code.
TeraTerm ^[3] displays the initialization message preceding the measured temperature values:

Now you are able to:

Build your own project to measure temperature values using the embedded sensor in B-U585I-IOT02A.
Add BSP components to an STM32CubeMx generated project.
Extend the use of the board to sensors other than HTS221, to make environmental measurements.

2 3 Appendix: Porting an AC6 example to STM32CubeIDE[edit]

The DataLogTerminal is the example to be used in this appendix. It is DataLogTerminal located underin: STM32CubeExpansion_MEMS1_V7.1.0\Projects\STM32L476RG-Nucleo\Examples\IKS01A2\DataLogTerminal

Information

STM32CubeExpansion_MEMS1_V7.1.0 is the extract of X-CUBE-MEMS. More recent versions of this package may be available over time from the same link.

Warning

It In order to prevent future compilation errors due to long paths, it is recommended to put place the package under C: in order to avoid compilation errors later (because of long paths)

2

.

3.1 Hardware description[edit]

The X-NUCLEO-IKS01A2^[3^4] is a motion MEMS and environmental sensor expansion board for the STM32 64-pin Nucleo. It interfaces with NUCLEO-L476RG via I²C-bus pins.

23.2 Example: Get Getting temperature values using the HTS221 sensor and display displaying them on a terminal (Porting from AC6 to STM32CubeIDE)[edit]

The purpose of this section is to explain provide a step by step description on how to interface the X-NUCLEO IKS01A2 HTS221 sensor and the NUCLEO-L476RG board in order to get obtain temperature values and to display them on a terminal.

23.2.1 Hardware setup[edit]

Extend your Nucleo board with the X-NUCLEO-IKS01A2 shield using the Arduino connectors.
Connect the board with its shield to your PCcomputer.

23.2.2 Example details[edit]

A description of the DataLogTerminal example is available under STM32CubeExpansion_MEMS1_ V7.1.0\Projects\STM32L476RG-Nucleo\Examples\IKS01A2\DataLogTerminal, in the readme.txt file:

@par Example Description
Main function is to show how to use sensor expansion board to send sensor data from a Nucleo board using UART to a connected PC or desktop, and display it on generic applications like TeraTerm.
After connection has been established:
- The user can view the data from various on-board environment sensors such as temperature, humidity, and pressure
- The user can also view data from various on-board MEMS sensors such as accelerometer, gyroscope, and magnetometer.

23.2.3 Porting the example to STM32CubeIDE[edit]

Import the DataLogTerminal example based on SW4STM32 and dedicated to the NUCLEO-L476RG into STM32CubeIDE: STM32CubeExpansion_MEMS1_V7.1.0\Projects\STM32L476RG-Nucleo\Examples\IKS01A2\DataLogTerminal.

The project must be converted and the following message is displayed:

When clicking on OK, the following message pops up:

Click OK.

Select the relevant project from the Project Explorer perspective:

23.2.4 Compiling and running the example[edit]

Click on the Build button to compile the project.
Click on the Debug button arrow and select Debug Configurations'...
In the Debug Configuration window that pops up, make sure that the selected Debug probe is probe is ST-LINK:

From the same window, click on Debug, or click on the Debug button to run the software.
Open a console emulator such as TeraTerm ^[2^3]. Configure the Console baud rate, select Data bits: 8 and click OK. The port name may differ on your PCcomputer.
Click on the Resume button to execute the code. TeraTerm ^[2^3] displays the measured values using the sensors available in the shield X-NUCLEO-IKS01A2.
The values measured by the X-NUCLEO-IKS01A2 sensors are displayed in the TeraTerm window as follows:

3 4 References[edit]

↑ STM32L4 Discovery kit IoT node
↑

2

B-U585I-IOT02A Discovery kit IoT node
↑ ^3.0

2

^3.1

2

^3.2

2

^3.3 ^3.4 ^3.5 TeraTerm
↑ X-NUCLEO-IKS01A2

Previous step

Next step

<big><big><big>'''Sensors usageUsing sensors with B-L475E-IOT01A and with B-U585I-IOT02A'''</big></big></big>[[File:Clock.png|40px|middle]]60min<br><br>
<big><big>'''Target description'''</big></big><br>

The purpose of this tutorial is to explain how to perform measurements with the sensors available in the STM32L4 Discovery kit. Configuration of and in the temperature sensor is described step by stepB-U585I-IOT02A Discovery kit. A step by step configuration of the temperature sensor is available. <br>

After this tutorial, you will be able to collect values using the sensors available on the B-L475E-IOT01A board and on the B-U585I-IOT02A board.<br>

The appendix of this tutorial provides guidelines on how to port an AC6 example to STM32CubeIDE.<br>

<big><big>'''Prerequisites'''</big></big><br>

You have gone throughalready followed:<br>

* [[STM32StepByStep:Step1 Tools installation | Step1: Tools installation and first test]]<br> 

* [[STM32StepByStep:Step3 Introduction to the UART | Step3:  UART and new board introduction]]<br>

<big><big>'''Hardware'''</big></big><br>


* STM32L4 Discovery kit IoT node<ref>[https://www.st.com/en/evaluation-tools/b-l475e-iot01a.html  STM32L4 Discovery kit IoT node]</ref> (B-L475E-IOT01A )<br>

* B-U585I-IOT02A Discovery kit IoT node<ref>[https://www.st.com/en/evaluation-tools/b-u585i-iot02a.html  B-U585I-IOT02A Discovery kit IoT node]</ref> (B-U585I-IOT02A )<br>

* USB cable Type-A to Micro-B
<big><big>'''Literature'''</big></big><br>

* [https://www.st.com/resource/en/user_manual/dm00347848.pdf UM2153]  Discovery kit for IoT node, multi-channel communication with STM32L4<br>

* [http://www.st.com/content/ccc/resource/technical/document/user_manual/63/a8/8f/e3/ca/a1/4c/84/DM00173145.pdf/files/DM00173145.pdf/jcr:content/translations/en.DM00173145.pdf UM1884]  Description of STM32L4/L4+ HAL and low-layer drivers<br>

* [https://www.st.com/resource/en/user_manual/um2839-discovery-kit-for-iot-node-with-stm32u5-series-stmicroelectronics.pdf UM2839]  Discovery kit for IoT node with STM32U5 Series<br>

* [https://www.st.com/content/ccc/resource/technical/document/user_manual/group2/17/c1/76/07/05/1c/4e/fb/DM00813340/files/DM00813340.pdf/jcr:content/translations/en.DM00813340.pdf UM2911] Description of STM32U5 HAL and low-layer drivers<br>

* [https://www.st.com/resource/en/user_manual/dm00157069.pdf UM1859] Getting started with the X-CUBE-MEMS1 motion MEMS and environmental sensor software expansion for STM32Cube<br>

* [https://www.st.com/resource/en/user_manual/dm00613836-migration-guide-from-system-workbench-to-stm32cubeide-stmicroelectronics.pdf UM2579] Migration guide from System Workbench to STM32CubeIDE<br>

* [[File:pc_videol.png|middle|20px|link=https://www.youtube.com/watch?v=6eUqxjBL_wI]] [https://www.youtube.com/watch?v=6eUqxjBL_wI Getting startingstarted with STM32L4 Discovery kit IoT node]<br>
<br>

==Sensors usage* [[File:pc_videol.png|middle|20px|link=https://www.youtube.com/watch?v=Zo10SQaU7jA]] [https://www.youtube.com/watch?v=Zo10SQaU7jA Discover the new STM32U5 IoT node B-U585-IOT02A Discovery kit]<br>
<br>

==Using sensors with B-L475E-IOT01A==
===Hardware description===
The main sensors available in the STM32L4 Discovery kit IoT node (B-L475E-IOT01A) are:<br>

* Capacitive digital sensor for relative humidity and temperature (HTS221)<br>

* 260-1260 hPa absolute digital output barometer (LPS22HB)<br>

* 3D accelerometer and 3D gyroscope (LSM6DSL)<br>

* High-performance 3-axis magnetometer (LIS3MDL).<br>

[[File:IoTNode_Board_Sensor.png|middle|400px600px]]<br>
<br>


===Example: GetGetting temperature values using the HTS221 sensor and displaydisplaying them on a terminal===
{{Highlight|The purpose of this section is to explain provide a step by step description on how to interface with the HTS221 sensor to get temperature values and to display them on a terminal.}}<br>

====Create a working project with STM32CubeMX====
The starting point is the project generated with STM32CubeMX, described in the Step3 tutorial titled: [[STM32StepByStep:Step3 Introduction to the UART#Introduction to the UART I/F on B-L475E-IOT01A (IoT Node)| Introduction to the UART I/F on B-L475E-IOT01A]].<br>
* Follow the steps described there and call the generated project in the tutorial. <br>

* Name the generated project as L4_IOT_Sensors.<br>


====Copy BSP drivers to your project====
The '''''BSP''''' (board support package) drivers are available in the '''''STM32CubeL4 package'''''. This provides APIs corresponding to the hardware components of a board. <br> 

The lastlastest version of the STM32CubeL4 package is downloaded by default in the STM32CubeMX repository ('': 

'''''C:\Users\user_name\STM32Cube\Repository\STM32Cube_FW_L4_Vx.xx.x'')'''.<br>
'''''BSP''''' location and content in the tree

The image below shows the '''''BSP''''' location and its content:<br>

[[File:Folder_tree.png|middle|150px]]<br>

{{info|STM32CubeL4 used version In this example, the STM32CubeL4 version used is 1.11.0, but it . Version can increase over time.}}
Here are the steps to follow in order to Follow these steps to copy the BSP drivers intoto your project:<br>
* 

* In the generated project, create a folder '''''L4_IOT_Sensors/Drivers/BSP'''''. 

* Copy the '''''STM32CubeL4/Drivers/BSP/B-L475E-IOT01''''' folder<br>

* In the generated project, create a folder  and paste it in the '''''L4_IOT_Sensors/Drivers/BSP'''''. Paste the copied folder there.<br>
 folder. 
* Copy the '''''STM32CubeL4/Drivers/BSP/Components''''' folder. Paste  and paste it under '''''L4_IOT_Sensors/Drivers/BSP/Components'''''.<br>

* Optional cleanup of working directory: as only 


* Only the HTS221 temperature sensor is used, some. For this reason, any other files and folders already copied to the working directory maycan be removed<br>

** Under  . This step is optional:
     * Keep only the following files under  '''''L4_IOT_Sensors\Drivers\BSP\B-L475E-IOT01''''', keep only the following files:<br>:<br>
[[File:Folder_tree_2.png|middle|150px]]

** Under <br>

     * Keep only the following files under '''''L4_IOT_Sensors\Drivers\BSP\Components''''', keep only the following folders:<br>:<br>
[[File:Folder_tree_3.png|middle|100px]]<br>


====Support BSP in STM32CubeIDE workspace====After being copied, the added Added folders appear automatically in the STM32CubeIDE workspace:<br>

[[File:Folder_tree_4.png|middle|150px]]<br>
<br>

====Update include paths====
Update the paths to support new header files:<br>

* Select the relevant project from the '''''Project Explorer''''' perspective: 
[[File:Project_select.png|middle|300px]]<br>

* From '''''Project menu''''' or '''''File menu''''', go to '''''Properties > C/C++ Build > Settings > Tool Settings > MCU GCC Compiler > Include paths'''''.<br>

* Click on [[File:Add_icon.png|middle|30px]] to include the new paths. <br>

* Add '''''../Drivers/BSP/B-L475E-IOT01''''' and '''''../Drivers/BSP/Components/hts221''''' paths.<br>

The following screenshot summarizes the steps to follow:<br>

[[File:Project_setting.png|middle|450px]]<br>

====Update source files====The only file to modify is '''''main.c''''',Edit '''''main.c''''' as follows:<br>

* Include the header files: '''''stm32l475e_iot01.h''''', '''''stm32l475e_iot01_tsensor.h''''' and '''''math.h'''''<br>
<syntaxhighlight lang="c">/* USER CODE BEGIN Includes */<br>

#include "stm32l475e_iot01.h"
#include "stm32l475e_iot01_tsensor.h"
#include <math.h>

/* USER CODE END Includes */</syntaxhighlight>

* Add private values to use for temperature values and displayed . These values are used to display temperature and messages on the terminal:<syntaxhighlight lang="c">/* USER CODE BEGIN PV */
/* Private variables -------------------------------------------------------*/
float temp_value = 0;  // Measured temperature value
char str_tmp[100] = ""; // Formatted message to display the temperature value
uint8_t msg1[] = "****** Temperature values measurement ******\n\n\r";
uint8_t msg2[] = "=====> Initialize Temperature sensor HTS221 \r\n";
uint8_t msg3[] = "=====> Temperature sensor HTS221 initialized \r\n ";
/* USER CODE END PV */</syntaxhighlight>

* Display messages on the terminal and initialize the HTS221 temperature sensor:<syntaxhighlight lang="c">/* USER CODE BEGIN 2 */
HAL_UART_Transmit(&huart1,msg1,sizeof(msg1),1000);
HAL_UART_Transmit(&huart1,msg2,sizeof(msg2),1000);
BSP_TSENSOR_Init();
HAL_UART_Transmit(&huart1,msg3,sizeof(msg3),1000);
/* USER CODE END 2 *//</syntaxhighlight>

* In the '''''while (1)''''' loop, read the  temperature value, format it, and then display the message with the measured value on the terminal:<syntaxhighlight lang="c">/* USER CODE BEGIN 3 */
temp_value = BSP_TSENSOR_ReadTemp();
int tmpInt1 = temp_value;
float tmpFrac = temp_value - tmpInt1;
int tmpInt2 = trunc(tmpFrac * 100);
snprintf(str_tmp,100," TEMPERATURE = %d.%02d\n\r", tmpInt1, tmpInt2);
HAL_UART_Transmit(&huart1,( uint8_t * )str_tmp,sizeof(str_tmp),1000);
HAL_Delay(1000);
/* USER CODE END 3 */</syntaxhighlight>

{{info|Pay attention to make updates in the correct '''''USER CODE''''' section in order to avoid over-writing them Updates must only be made on the required '''''USER CODE''''' section, to avoid overwriting all the content with a new STM32CubeMX code generation.}}

====Compile and run the example====
* Click on the '''''Build''''' button [[File:Built_Button.png|20px|middle]] to compile the project.<br>

* Click on the '''''Debug''''' button [[File:Debug_Button.png|20px|middle]] to run the software.<br>

* Open a console emulator such as TeraTerm <ref name="TeraTerm" >[https://ttssh2.osdn.jp/index.html.en TeraTerm]</ref>. To configure the console baud rate, select '''data bits: 8''' and click '''OK'''. Port name may differ on your PCcomputer.<br>

* STM32CubeIDE opens the '''''Debug perspective'''''. Click on the '''''Resume''''' button [[File:Resume_Button.png|20px|middle]] to execute the code.<br>

*  TeraTerm <ref name="TeraTerm" /> displays the initialization message preceding the measured temperature values:<br>

[[File:TeraTerm_Temp.png|middle|300px]]<br>

{{Highlight|Now you are able to}}:
* Build your own project to measure temperature values withusing the sensor embedded on thesensor in B-L475E-IOT01A.<br>

* Add BSP components to an STM32CubeMx generated project.<br>

* Extend the use of the board to sensors other than HTS221, to make environmental measurements.

==Appendix: Porting an AC6 example to STM32CubeIDE==
The example to be used in this appendix is '''''DataLogTerminal''''' located under==Using sensors with B-U585-IOT02A==
===Hardware description===

The main sensors available in B-U585I-IOT02A discovery kit for the IoT node are:<br>

* Capacitive digital sensor for relative humidity and temperature (HTS221)<br>

* 260-1260 hPa absolute digital output barometer (LPS22HH)<br>

* 3D accelerometer and 3D gyroscope (ISM330DHCX)<br>

* High-performance 3-axis magnetometer (IIS2MDCTR).<br>

[[File:IoTNode_Board_SensorU5.png|middle|600px]]<br>
<br>

===Example: Getting temperature values using the HTS221 sensor and displaying them on a terminal===
{{Highlight|The purpose of this section is to provide a step by step description on how to interface with the HTS221 sensor to get temperature values and to display them on a terminal.}}<br>

====Create a working project with STM32CubeMX====
Create a new project using STM32CubeMX:

* Select the '''''B-U585I-IOT02A''''' board using the '''''Board selector'''''.<br>


* Answer '''''Yes''''' to '''''Initialize all peripherals with their default Mode ?''''' popup.<br>


* Select '''''without TrustZone activated?'''''. Answer '''''OK''''' to the '''''Create a new project without TrustZone activated?''''' popup.<br>


* Verify in the '''''Pinout''''' tab that the '''''USART1''''' mode is configured to '''Asynchronous'''.<br>


* Click on the '''''USART1''''' button in the '''''Configuration''''' tab. Set '''''Word Length''''' to '''''8 Bits''''', baud rate to '''''115200 Bits/s''''', '''''Parity''''' to '''''None '''''and '''''Stop Bits''''' to '''''1''''', as shown below:<br>


[[File:UART_setup2.png|middle|300px]]<br>


* Enable '''''ICache'''''  in the '''''Pinout''''' tab by selecting '''''Memory address remap''''' to reach the maximum performance'''''.<br>


* Switch to the '''''Project Manager''''' tab: Select '''''STM32CubeIDE''''' as Toolchain/IDE and name your project. <br>


* Click on '''''Generate Code'''''. 

* Accept to open the project in STM32CubeIDE and follow the steps. 

* Call the generated project U5_IOT_Sensors.<br>


====Copy BSP drivers to your project====
The '''''BSP''''' (board support package) drivers are available in the '''''STM32CubeU5 package'''''. This provides APIs corresponding to the hardware components of a board. 

The lastest version of the STM32CubeU5 package is downloaded by default in the SMT32CubeMX repository:

'''''C:\Users\user_name\STM32Cube\Repository\STM32Cube_FW_U5_Vx.xx.x'''''.<br>


The image below shows the '''''BSP''''' location and its content:<br>

[[File:BSP.png|middle|150px]]<br>


{{info|In this example, the STM32CubeU5 version used is 1.1.1. Version can increase over time.}}

Here are the steps to follow in order to copy the BSP drivers to your project:<br>


* In the generated project, create a folder '''''U5_IOT_Sensors/Drivers/BSP'''''. 

* Copy the '''''STM32CubeU5/Drivers/BSP/B-U585-IOT02''''' folder and paste it to the '''''U5_IOT_Sensors/Drivers/BSP''''' folder.<br>


* Copy the '''''STM32CubeU5/Drivers/BSP/Components''''' folder and paste it under '''''U5_IOT_Sensors/Drivers/BSP/Components'''''.<br>


* Only the HTS221 temperature sensor is used. For this reason, any other files and folders copied to the working directory can be removed. This step is optional: <br>

     * Keep only the following folders under '''''U5_IOT_Sensors\Drivers\BSP\Components''''':<br>

[[File:Components_drivers.png|middle|100px]]<br>

     *Keep only the following folders under  '''''U5_IOT_Sensors\Drivers\BSP\B-U585-IOT02''''':<br>

[[File:b_u585i_iot2 drivers.png|middle|150px]]<br>


* Rename the file '''''b_u585i_iot02a_conf_template.h''''' to '''''b_u585i_iot02a_conf.h'''''.<br>


====Support BSP in STM32CubeIDE workspace====
Added folders appear automatically in the STM32CubeIDE workspace:<br>

[[File:Project_with_BSP_Drivers.png|middle|200px]]<br>
<br>


====Update include paths====
Update the paths to support new header files:<br>

* Select the relevant project from the '''''Project Explorer''''' perspective: 
[[File:Project_name.png|middle|300px]]<br>

* From '''''Project menu''''' or '''''File menu''''', go to '''''Properties > C/C++ Build > Settings > Tool Settings > MCU GCC Compiler > Include paths'''''.<br>

* Click on [[File:Add_icon.png|middle|30px]] to include the new paths. <br>

* Add the paths '''''../Drivers/BSP/B-U585I-IOT02A''''' , '''''../Drivers/BSP/Components/hts221''''' and '''''../Drivers/BSP/Components/lps22hh'''''<br>

The following screenshot summarizes the steps to follow:<br>

[[File:Path1.png|middle|450px]]<br>


====Update source files====
Edit '''''main.c''''' as follows:<br>

* Include the header files: '''''b_u585i_iot02a.h''''', '''''b_u585i_iot02a_env_sensors.h''''' and '''''math.h'''''<br>
<syntaxhighlight lang="c">/* USER CODE BEGIN Includes */
#include "b_u585i_iot02a.h"
#include "b_u585i_iot02a_env_sensors.h"
#include <math.h>

/* USER CODE END Includes */</syntaxhighlight>

* Add private values. These values are used to display temperature and messages on the terminal:<syntaxhighlight lang="c">/* USER CODE BEGIN PV */
/* Private variables -------------------------------------------------------*/
float temp_value = 0;  // Measured temperature value
char str_tmp[100] = ""; // Formatted message to display the temperature value
uint8_t msg1[] = "****** Temperature values measurement ******\n\n\r";
uint8_t msg2[] = "=====> Initialize Temperature sensor HTS221 \r\n";
uint8_t msg3[] = "=====> Temperature sensor HTS221 initialized \r\n";
/* USER CODE END PV */</syntaxhighlight>

* Display messages on the terminal and initialize the HTS221 temperature sensor:<syntaxhighlight lang="c">/* USER CODE BEGIN 2 */
HAL_UART_Transmit(&huart1,msg1,sizeof(msg1),1000);
HAL_UART_Transmit(&huart1,msg2,sizeof(msg2),1000);
BSP_ENV_SENSOR_Init(0, ENV_TEMPERATURE);
BSP_ENV_SENSOR_Enable(0, ENV_TEMPERATURE);
HAL_UART_Transmit(&huart1,msg3,sizeof(msg3),1000);
/* USER CODE END 2 *//</syntaxhighlight>

* In the '''''while (1)''''' loop, read the temperature value, format it, and then display the message with the measured value on the terminal:<syntaxhighlight lang="c">/* USER CODE BEGIN 3 */
BSP_ENV_SENSOR_GetValue(0, ENV_TEMPERATURE, &temp_value);
int tmpInt1 = temp_value;
float tmpFrac = temp_value - tmpInt1;
int tmpInt2 = trunc(tmpFrac * 100);
snprintf(str_tmp,100," TEMPERATURE = %d.%02d\n\r", tmpInt1, tmpInt2);
HAL_UART_Transmit(&huart1,( uint8_t *)str_tmp,sizeof(str_tmp),1000);
HAL_Delay(1000);
/* USER CODE END 3 */</syntaxhighlight>

{{info|Updates must only be made on the required USER CODE section, to avoid overwriting all the content with a new STM32CubeMX code generation.}}

====Compile and run the example====
* Click on the '''''Build''''' button [[File:Built_Button.png|20px|middle]] to compile the project.<br>

* Click on the '''''Debug''''' button [[File:Debug_Button.png|20px|middle]] to run the software.<br>

* Open a console emulator such as TeraTerm <ref name="TeraTerm" >[https://ttssh2.osdn.jp/index.html.en TeraTerm]</ref>. To configure the console baud rate, select '''data bits: 8''' and click '''OK'''. Port name may differ on your computer.<br>

* STM32CubeIDE opens the '''''Debug perspective'''''. Click on the '''''Resume''''' button [[File:Resume_Button.png|20px|middle]] to execute the code.<br>

*  TeraTerm <ref name="TeraTerm" /> displays the initialization message preceding the measured temperature values:<br>

[[File:tera_term_temp.png|middle|400px]]<br>

{{Highlight|Now you are able to}}:
* Build your own project to measure temperature values using the embedded sensor in B-U585I-IOT02A.<br>

* Add BSP components to an STM32CubeMx generated project.<br>

* Extend the use of the board to sensors other than HTS221, to make environmental measurements.

==Appendix: Porting an AC6 example to STM32CubeIDE==
'''''DataLogTerminal''''' is the example used in this appendix. 
It is located in: '''''STM32CubeExpansion_MEMS1_V7.1.0\Projects\STM32L476RG-Nucleo\Examples\IKS01A2\DataLogTerminal'''''<br>

{{info|STM32CubeExpansion_MEMS1_V7.1.0 is the extract of [http://www.st.com/en/embedded-software/x-cube-mems1.html X-CUBE-MEMS]. More recent versions of this package may be available over time from the same link.}}
{{Warning | It is recommended to put the package under C: in order to avoid compilation errors later (because of long paths)In order to prevent future compilation errors due to long paths, it is recommended to place the package under C:. }}
===Hardware description===

The X-NUCLEO-IKS01A2<ref>[https://www.st.com/content/st_com/en/products/ecosystems/stm32-open-development-environment/stm32-nucleo-expansion-boards/stm32-ode-sense-hw/x-nucleo-iks01a2.html X-NUCLEO-IKS01A2]</ref> is a motion MEMS and  environmental sensor expansion board for the STM32 64-pin Nucleo. It interfaces with  [https://www.st.com/en/evaluation-tools/nucleo-l476rg.html NUCLEO-L476RG] via I²C-bus pins.<br>

[[File:IKS_Sensor_Board.png|middle|450px]]<br>

===Example: GetGetting temperature values using the HTS221 sensor and displaydisplaying them on a terminal (Porting from AC6 to STM32CubeIDE)===
The purpose of this section is to explain provide a step by step description on how to interface the X-NUCLEO IKS01A2 '''''HTS221''''' sensor and the NUCLEO-L476RG to getboard in order to obtain temperature values and to display them on a terminal.<br>

====Hardware setup====
* Extend your Nucleo board with the X-NUCLEO-IKS01A2 shield using the Arduino connectors.<br>

* Connect the board with its shield to your PCcomputer.<br>

====Example details====
A description of the '''''DataLogTerminal''''' example is available under '''''STM32CubeExpansion_MEMS1_ V7.1.0\Projects\STM32L476RG-Nucleo\Examples\IKS01A2\DataLogTerminal''''', in the '''''readme.txt''''' file:<syntaxhighlight lang="c">

@par Example Description
Main function is to show how to use sensor expansion board to send sensor data from a Nucleo board using UART to a connected PC or desktop, and display it on generic applications like TeraTerm.
After connection has been established:
- The user can view the data from various on-board environment sensors such as temperature, humidity, and pressure
- The user can also view data from various on-board MEMS sensors such as accelerometer, gyroscope, and magnetometer.</syntaxhighlight>


====Porting the example to STM32CubeIDE====
Import the '''''DataLogTerminal''''' example based on '''''SW4STM32''''' and dedicated to the '''''NUCLEO-L476RG''''' into STM32CubeIDE:
'''''STM32CubeExpansion_MEMS1_V7.1.0\Projects\STM32L476RG-Nucleo\Examples\IKS01A2\DataLogTerminal'''''.<br>

The project must be converted and the following message is displayed:<br>

[[File:Project_Converter_2.png|middle|300px]]<br>

* When clicking on '''''OK''''', the following message pops up:
[[File:Project_Converter_OK.png|middle|300px]]<br>

* Click '''''OK'''''
.
* Select the relevant project from the '''''Project Explorer''''' perspective:
[[File:Project_Explorer.png|middle|300px]]<br>

====Compiling and running the example====
* Click on the '''''Build''''' button [[File:Built_Button.png|20px|middle]] to compile the project.<br>

* Click on the '''''Debug''''' button ''''' arrow''''' [[File:Debug_Arrow_Button.png|40px|middle]] and select '''''Debug Configurations...'''''''''.<br>

* In the '''Debug Configuration''' window that pops up, make sure that the selected '''Debug probe isprobe''' is '''''ST-LINK''''':
[[File:Debug_Panel.png|middle|450px]]<br>

* From the same window, click on '''''Debug''''', or click on the '''''Debug''''' button [[File:Debug_Button.png|20px|middle]] to run the software.<br> 

* Open a console emulator such as TeraTerm <ref name="TeraTerm" />. Configure the Console baud rate, select '''Data bits: 8''' and click '''''OK'''''. The port name may differ on your PCcomputer.<br>

* Click on the '''''Resume''''' button [[File:Resume_Button.png|20px|middle]] to execute the code.  TeraTerm <ref name="TeraTerm" /> displays the measured values using the sensors available in the shield X-NUCLEO-IKS01A2.<br>

* The values measured by the X-NUCLEO-IKS01A2 sensors  are displayed in the TeraTerm window as follows:
[[File:TeraTerm_AllSensor.png|middle|350px]]<br>


==References==<references />
<br><br>

{|class="st-table" style="margin: auto; text-align:center"
|style="border-style: hidden; background-color: white;width:200px; text-align:right"|'''[[STM32StepByStep:Step3 Introduction to the UART | Previous step]]'''
|style="border-style: hidden; background-color: white;width:100px; text-align:left"|[[File:Arrow left.png|20px|link=STM32StepByStep:Step3 Introduction to the UART]]

|style="border-style: hidden; background-color: white;width:100px; text-align:right"|[[File:Arrow right.png|20px|link=STM32StepByStep:Step5 Build an IOT system]]''
|style="border-style: hidden; background-color: white;width:200px; text-align:left"|'''[[STM32StepByStep:Step5 Build an IOT system | Next step]]'''
|}
{{PublicationRequestId | <noinclude>

[[Category:Getting started with STM32 : STM32 step by step|50]]
{{PublicationRequestId | 27173| 2023-05-12 | }}
{{PublicationRequestId | 16010| 2020-05-05 | Philip SAGE}}
{{ArticleBasedOnModel | Example STM32 Step by step article}}
<noinclude>

[[Category:STM32 step by step]]</noinclude>

[1] STM32L4 Discovery kit IoT node

[2] ↑

[2] B-U585I-IOT02A Discovery kit IoT node

[TeraTerm-3] 3.0

[TeraTerm-3] 3.1

[TeraTerm-3] 3.2

[TeraTerm-3] 3.3 ^3.4 ^3.5 TeraTerm

[4] X-NUCLEO-IKS01A2

[1]

[2]

[

3]

[3]

4]

User

Wiki

Categories

General Books

Difference between revisions of "STM32StepByStep:Step4 Sensors usage"

Contents

1 Sensors usage Using sensors with B-L475E-IOT01A[edit]

1.1 Hardware description[edit]

1.2 Example: Get Getting temperature values using the HTS221 sensor and display displaying them on a terminal[edit]

1.2.1 Create a working project with STM32CubeMX[edit]

1.2.2 Copy BSP drivers to your project[edit]

1.2.3 Support BSP in STM32CubeIDE workspace[edit]

1.2.4 Update include paths[edit]

1.2.5 Update source files[edit]

1.2.6 Compile and run the example[edit]

2 Using sensors with B-U585-IOT02A[edit]

2.1 Hardware description[edit]

2.2 Example: Getting temperature values using the HTS221 sensor and displaying them on a terminal[edit]

2.2.1 Create a working project with STM32CubeMX[edit]

2.2.2 Copy BSP drivers to your project[edit]

2.2.3 Support BSP in STM32CubeIDE workspace[edit]

2.2.4 Update include paths[edit]

2.2.5 Update source files[edit]

2.2.6 Compile and run the example[edit]

2 3 Appendix: Porting an AC6 example to STM32CubeIDE[edit]

3.1 Hardware description[edit]

23.2 Example: Get Getting temperature values using the HTS221 sensor and display displaying them on a terminal (Porting from AC6 to STM32CubeIDE)[edit]

23.2.1 Hardware setup[edit]

23.2.2 Example details[edit]

23.2.3 Porting the example to STM32CubeIDE[edit]

23.2.4 Compiling and running the example[edit]

3 4 References[edit]

Manage page

Toolbox

QR code

Mode