Skip to content

Commit cce7400

Browse files
Grolleau-BenjaminGrom-
authored andcommitted
[doc] Add specification related to #30 issue
1 parent b33add0 commit cce7400

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
# STSELib
22

33
![STSELib](doc/resources/Pictures/STSELib.png)
44

@@ -11,10 +11,35 @@ The STSELib middleware is composed of three software modules as illustrated in t
1111
![STSELib](doc/resources/Pictures/STSELib_arch.png)
1212

1313
<b>- Application Programming Interface (API) layer</b>
14-
This software layer is the entry point for the system application. It provides a set of high level functions allowing interaction with STMicroelectronics Secure Elements.
14+
This software layer is the entry point for the system application. It provides a set of high level functions allowing interaction with STMicroelectronics Secure Elements.
1515

1616
<b>- Service layer</b>
1717
Provides a set of product services that format all commands supported by the targeted secure element and reports response to higher layers API/Application . This layer can be used directly from Application (for advanced user).
1818

1919
<b>- Core layer</b>
2020
Contains generic definition for ST Secure Element and functions for communicating with target secure element.
21+
22+
## Integration
23+
24+
### 1. Add STSELib as a Git submodule
25+
26+
From your project root:
27+
28+
```bash
29+
git submodule add https://github.com/STMicroelectronics/STSELib.git lib/stselib
30+
git submodule update --init --recursive
31+
```
32+
33+
> [!NOTE]
34+
>
35+
> Don’t forget to add lib/stselib to your CMakeLists.txt include paths.
36+
37+
### 2. Base configuration
38+
39+
Two headers files are mantatories, [`stse_conf.h`](doc/resources/Markdown/03_LIBRARY_CONFIGURATION/03_LIBRARY_CONFIGURATION.md) and [`stse_platform_generic.h`](doc/resources/Markdown/04_PORTING_GUIDE/PAL_files/stse_platform_generic.h.md).
40+
41+
### 3. Optional files
42+
43+
For platform-specific integrations and STSafe use-cases, you may implement additional headers. Detailed specifications are available in the HTML documentation included in the release ZIP.
44+
45+
Sample is available on Grom-'s github : [STSAFE-A_Accessory_authentication](https://github.com/Grom-/STSAFE-A_Accessory_authentication). The platform files are located in the `Platforms/NUCLEO-L452RE/STSELib` directory.

0 commit comments

Comments
 (0)