|
Delivery for this distribution is being prepared |
In this guide, you will learn how to get started using the Function Pack for Predictive Maintenance FP-AI-NanoEdg1 and use it as your first project to detect anomalies in your setup using accelerometer data.
This Function Pack supports two STM32 boards, STWIN and STM32L562E. Following the steps provided in this page, a user will be able to create the data logs for their setups, and generate EdgeAi libraries using Cartesiam NanoEdge AI Studio. Once these libraries are generated, the user can use these libraries by plugging them into the provided FP and can learn the nominal behavior of his setup by issuing commands through a command line interface (CLI). After training phase the monitoring can be started and any anomalies from the normal behavior are reported on the CLI as well as on the LCD (in case of L5 board).
1. What you will learn
- How to log the motion sensor data.
- How to parse and read the motion sensor data.
- How to generate the suitable libraries for your sample data set using Cartesiam NanoEdge AI Studio.
- Learn and detect the anomalies and controlling the hyper parameters of learning and detection.
2. Requirements
2.1. Hardware
- STWIN or STM32L562E
The STWIN (STEVAL-STWINKT1) and STM32L562E (L5) are two STM32 boards with environment sensors whose a three axis accelerometer.
- STLINK-V3MINI (only for the STWIN)
The STLINK-V3MINI is a stand-alone debugging and programming mini probe for STM32 microcontrollers.
- Micro SD card between 4GB and 16GB
The micro SD card will be using for the data collection.
- Laptop/PC with Windows 7 or later
- USB cables with micro USB connector
2.2. Software
- STM32 CubeIDE
Download STM32 CubeIDE from ST website. This software is an IDE for STM32, its allows the development and the compilation of firmwares.
- Optional: STM32 ST-LINK Utility (STSW-LINK004) or STM32CubeProgrammer
STM32 ST-LINK Utility and STM32CubeProgrammer allow the programming of STM32 targets and can be useful for some cases (example : download bineries on STM32 targets or erase their flash).
- Tera Term
You can easily download Tera Term form the internet.
- Cartesiam NanoEdgeAIStudio
You can get a pro licence with your company. For that contact support@cartesiam.com. Otherwise, you can download NanoEdge AI Studio for free by filling out the following form: https://share.hsforms.com/1vVgNZ5JfQAWeJs10Yw6oHQ2a3c9.
At this moment of the tutorial, if you want more information about this software see the NanoEdge AI Studio Documentation.
- Jupyter notebook
Allows to execute python code. You can get Jupyter notebook by downloading Anaconda.
- Download or clone the FP-AI-NanoEdg1 Function Pack
Download the latest version of FP-AI-NanoEdg1 function pack from ST website or clone the project into your STM32CubeIDE workspace directory.
The command to clone FP-AI-NanoEdg1 is the following:
$ cd <userName>/STM32CubeIDE/workspace_<version> $ git clone ssh://gitolite@codex.cro.st.com/ai-poc/STM32_PREDMNT1_TMP.git
3. Step 1 : Programming the STWIN with FP-AI-NanoEdg1
In order to flash the STWIN with the FP-AI-NanoEdg1 you need to use the STLINK-V3MINI. The connection steps are the following:
- Connect one side of the programming cable to STLINK-V3MINI and the other side to STWIN
- Connect STWIN to a micro USB linked to your PC
- Connect STLINK-V3MINI to a micro USB linked to your PC
Once the cabling is done you have several options in order to flash the FP-AI-NanoEdg1 firmware inside the STWIN.
3.1. Option 1: Drag and drop the binary (if the binary is already generated)
Drag and drop the binary (.bin) located in:
FP_AI_NANOEDG1\Projects\<boardName>\Applications\NanoEdgeConsole\Binary
3.2. Option 2: Flash the binary with STM32 ST-LINK Utility (if the binary is already generated)
- Open STM32 ST-LINK Utility
- Click on Connect to the target
- Click on Program verify
- Browse the binary (.bin) located in:
FP_AI_NANOEDG1\Projects\<boardName>\Applications\NanoEdgeConsole\Binary
- Load the firmware with the Start button
3.3. Option 3: Flash the binary with STM32 CubeProgrammer (if the binary is already generated)
- Open STM32 CubeProgrammer
- Click on Connect (green button)
- Go in the Erasing & Programming (see in the menu)
- In File path (Download part) browse the binary (.bin) located in:
FP_AI_NANOEDG1\Projects\<boardName>\Applications\NanoEdgeConsole\Binary
- Load the firmware with the Start Programming blue button
3.4. Option 4: Compile the FP-AI-NanoEdg1 project with STM32CubeIDE
- Open STM32 CubeIDE
- Import a STM32CubeIDE project
- Click on File --> Import
- Select General --> Existing Projects into Workspace
- Browse the STM32CubeIDE project according to the board you use :
STWIN : STM32_PREDMNT1_TMP\FP_AI_NANOEDG1\Projects\STM32L4R9ZI-STWIN
STM32L562E : STM32_PREDMNT1_TMP\FP_AI_NANOEDG1\Projects\STM32L562E-DK
- Click on Finish
If you have imported the two STM32CubeIDE projects you will get the following organization:
- Select and build (hammer icon) the STM32CubeIDE project you want to flash
- Program the project on STWIN with the run button (play green button)
4. Step 2 : How to make the data logging
Once the STWIN is programmed, you can remove the STLINK-MINI and let only the STWIN connected to the PC. The data will be logging inside a micro SD card.
4.1. Connection between the sensor and the Tera Term application
Once the micro SD card is installed in the SD card slot of your board, you can connect the STWIN through serial port to the Tera Term Application. For the configuration of the application follow these steps:
- Open Tera Term
- Open a new connection: File --> New connection
- Select Serial and chose the port number relative to the STWIN (STMicroelectronics Virtual COM Port)
- Click on OK
You will see the following terminal with a $ which indicates you can write a command:
4.2. Use CLI commands to configure sensors for data logging
In this part, we will explained the CLI commands which allows to configure sensors.
- Help
Allows to see all the possible commands with their parameters.
$ help
- Sensor info
Allows to get a list of all supported sensors (and sub-sensors) by your boad and their ID.
$ sensor_info
For example, with the STWIN, you will get the following information about supported sensors and sub sensors:
Here, the command shows us that the STWIN has two sensors: IIS3DWB (ID = 0) and ISM330DHCX (ID = 1). For the predictive maintenance application, we collect data from an accelerometer. In that case, we can only use the accelerometer (ID = 0) from the ISM330DHCX sensor (ID = 1).
- Sensor get
Allows to get the value of a parameter from a sensor with its sensor ID.
$ sensor_get <sensor_id.subsensor_Id> all
For example, with the STWIN, we can get the value of all the parameters of the accelerometer from ISM330DHCX sensor (ID = 1.0) with the following command:
$ sensor_get 1.0 all
Here we can see that the sub sensor is activated, has an ODR at 1667 Hz and a full scale at 16 mg.
- Sensor set
Allows to set the required value of a parameter for the datalogging with sensor id.
$ sensor_set <sensor_id.subsensor_Id> <param> <val>
Example: With the STWIN, we can change the full scale value of the accelerometer from ISM330DHCX sensor (ID = 1.0) with the following command:
$ sensor_set 1.0 fullScale 4.0
4.3. Use CLI commands to launch data logging
In this part, we will explained the CLI commands which allows to make data logging.
- Start datalog
Allows to start to logging of the data. You can launch this command once the configuration of your sensor is finished and your system is ready in the desired behaviour (normal or abnormal condition).
$ start datalog
- Stop
Allows to stop the data logging process once the data is logged for the required time (1min for example). You can also use the Esc button.
$ stop
5. Step 3 : How to parse and read the motion sensor data
5.1. Take the data from the SD card
Once you have finish with the data collection, remove the micro SD card from the STWIN and see its capacity on your PC. If you made four recording, you will get something like the following example:
Each data folder has the following organization:
STWIN_00X/ ├── DeviceConfig.json └── ISM330DHCX.dat
- Json file
The json file corresponds to all configurations about the STWIN (sensor and sub sensor activated, ODR or full-scale values, …).
- Dat file
The dat file corresponds to the X, Y, Z values of the accelerometer. However, we can’t read directly the data so we need to parse the data in order to understand the meaning in a human way.
5.2. Parse the data
To parse the motion sensor data you need to use the python script called Parser_for_HS_Logged_Data.ipynb that you can execute with Jupyter notebook. The python script is available inside the function pack at the following path:
STM32_PREDMNT1_TMP\FP_AI_NANOEDG1\Utilities\AI_ressources\DataLog.
The python script has two parts:
- The data parser
- Prepare CSVs for NanoEdgeAI
The second part will be used after, for now we focus on only on the first part which contains the two following blocs:
To parse your data follow these steps:
- Put your data folder inside the Sample- Datalogs folder
The organization will be the following:
Data_log/ ├── Sample-DataLogs │ ├──STWIN_001 │ ├── DeviceConfig.json │ ├── ISM330DHCX.dat │ ├──STWIN_002 │ ├── DeviceConfig.json │ ├── ISM330DHCX.dat │ ├── ...
- Chose one of the two blocs on Jupyter (part 1.1 or part 1.2)
- Change the python script about the name of your data folders
- Execute the code
The code generates an ISM330DHCX_ACC.csv file
Data_log/ ├── Sample-DataLogs │ ├──STWIN_001 │ ├── DeviceConfig.json │ ├── ISM330DHCX.dat │ ├── ISM330DHCX_ACC.csv │ ├──STWIN_002 │ ├── DeviceConfig.json │ ├── ISM330DHCX.dat │ ├── ISM330DHCX_ACC.csv │ ├── ...
6. Step 4: How to generate normal and abnormal databases
Now, we can gather all your normal data inside a same csv file and it’s the same for your abnormal data. To do so we will use the second part of the python script Parser_for_HS_Logged_Data.ipynb: Prepare CSVs for NanoEdgeAI which contains the two following blocs:
To generate your two databases, follow these steps:
- Put your csv data files inside the good folders (normal or abnormal)
The organization will be the following (for example) :
Data_log/ ├── Sample-DataLogs │ ├── Normal folder │ ├──STWIN_001 │ ├── DeviceConfig.json │ ├── ISM330DHCX.dat │ ├── ISM330DHCX_ACC.csv │ ├──STWIN_002 │ ├── Abnormal folder │ ├──STWIN_003 │ ├──STWIN_004
- Choose one of the two blocs on Jupyter (part 2.1 or part 2.2)
- Change the python script about the name of your data folders
- Execute the code
The code will generate two csv abnormalSegments.css and normalSegments.csv inside the Data log folder.
Data_log ├── abnormalSegments.csv ├── normalSegments.csv
7. Step 5: How to generate the suitable libraries for your sample data set using Cartesiam NanoEdge AI Studio
For this step you can refer to the part IV of the Cartesiam’s documentation or the Cartesiam’s tutorial YouTube.
Nevertheless, we will give you some precisions about some steps :
- Create new project
In target select the microcontroller type according to the board your using. That is to say :
- STWIN : ARM Cortex M4
- L5 : ARM Cortex M33
- Importing signal files
Select the csv files by the python script python script Parser_for_HS_Logged_Data.ipynb (see step 4):
- normalSegments.csv as regular signals
- abnormalSegments.csv as abnormal signals
- Compiling and downloading the NanoEdge AI Library
In compilation flags don’t selection -mfloat-abi
At the end the user will receive a zip folder called NanoEdgeAI_Library.zip
8. Step 7 : How to implement Cartesiam libraries in FP-AI-NanoEdg1
- Unzip the Cartesiam folder
The capacity of the folder is the following:
- Copy the NanoEdgeAI.h file from NanoEdgeAI_Library folder and replace the existing NanoEdgeAI.h file located In FP_AI_NANOEDG1\Middlewares\Third_Party\Cartesiam_NanoEdge_AI_Library\Inc (see picture below)
- Copy the libneai.a file from NanoEdgeAI_Library and replace the existing libneai.a file located In FP_AI_NANOEDG1\Middlewares\Third_Party\Cartesiam_NanoEdge_AI_Library\lib (see picture below)
- Rebuild and flash again the project inside the STWIN with STM32CubeIDE (see the step 1 and the option 3 as reminder of the procedure)
9. Step 8 : Learn and detect the anomalies and controlling the hyper parameters of learning and detection
Once the project (with the Cartesiam’s libraries) is flashed inside the STWIN, you can remove the STLINK and open a connection between the sensor and tera term (see step 2). With the CLI don’t hesitate to use the ‘help command’ in order to see all the possible commands especially those relative to the PDM that is to say:
- neai_set
This command allows to change specific parameters. For example, you can change the number of the signals using for the learning or the validation.
In the example above, the algorithm will work on 5 signals for the training or the validation.
- neai_get
This command allows to see the actual setting.
In the example above, we see the number of signals was configurated well with the neai_set command.
- Start neai_learn
This command allows to start the learning on X samples (if you are configurated the signals number with the neai_set command) or on several samples until your stop the process. The learning has to be done for the normal condition of your system.
- Start neai_detect
This command allows to test the previous learning.
The validation will be done on the number of signals configurated. For each signal the algorithm will display on the CLI only the anomaly with the following indication: <number of the signal> signal similarity = <number of the similarity> The number of the similarity indicated the percentage of similarity between the anomaly and the normal condition.