Skip to content

Commit

Permalink
v3.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ludovic-Lesur committed May 3, 2024
1 parent f9e379f commit 9a6b6e4
Show file tree
Hide file tree
Showing 9 changed files with 266 additions and 2,144 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [v3.0](https://github.com/sigfox-tech-radio/sigfox-ep-rf-api-st-s2lp/releases/tag/v3.0) - 03 May 2024

### Added

* Add HW API functions to **enter and exit shutdown mode** with SDN pin.

### Fixed

* Reset **hardware latencies** to 0 before calling HW API function.

### Changed

* Update **S2LP library** from newer `x-cube-subg2` GitHub repository.
* Use `S2LP_CORE_SPI.h` header instead of `MCU_Interface_template.h` to define SPI access functions.

### Removed

* Remove `s2lp.patch` file since ST driver is now called as it is.

### Known limitations

* **LBT** not implemented.
* **Modulated CW** not supported for type approval addon.

## [v2.0](https://github.com/sigfox-tech-radio/sigfox-ep-rf-api-st-s2lp/releases/tag/v2.0) - 22 Mar 2024

### Added
Expand Down
8 changes: 4 additions & 4 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,19 @@ endif()

set (S2LP_RF_API_SOURCES
src/manuf/s2lp_rf_api.c
src/board/s2lp_hw_api.c
)

set (S2LP_RF_API_HEADERS
inc/manuf/s2lp_rf_api.h
inc/board/s2lp_hw_api.h
inc/board/S2LP_CORE_SPI.h
)

set( CHIP_RF_HEADERS_LIST "")

if (NOT TARGET s2lp_driver)
list(APPEND CHIP_RF_HEADERS_LIST ${CMAKE_CURRENT_BINARY_DIR}/drivers-src/s2lp/Drivers/BSP/Components/S2LP/S2LP_Library/inc/)
list(APPEND CHIP_RF_HEADERS_LIST ${CMAKE_CURRENT_SOURCE_DIR}/inc/board/)
ExternalProject_Add(s2lp
PREFIX drivers-build
CONFIGURE_COMMAND ""
Expand All @@ -37,9 +38,8 @@ if (NOT TARGET s2lp_driver)
SOURCE_DIR drivers-src/s2lp
GIT_PROGRESS TRUE
GIT_SHALLOW TRUE
GIT_REPOSITORY https://github.com/STMicroelectronics/x-cube-sfxs2lp1.git
GIT_TAG v4.0.0
PATCH_COMMAND git apply ${CMAKE_CURRENT_LIST_DIR}/cmake/s2lp.patch
GIT_REPOSITORY https://github.com/STMicroelectronics/x-cube-subg2.git
GIT_TAG v5.0.0
)
else ()
list(APPEND CHIP_RF_HEADERS_LIST "$<BUILD_INTERFACE:$<TARGET_PROPERTY:s2lp_driver,INTERFACE_INCLUDE_DIRECTORIES>>")
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The table below shows the versions compatibility between this radio example and

| **S2LP_RF_API** | **EP_LIB** |
|:---:|:---:|
| [v3.0](https://github.com/sigfox-tech-radio/sigfox-ep-rf-api-st-s2lp/releases/tag/v3.0) | >= [v3.5](https://github.com/sigfox-tech-radio/sigfox-ep-lib/releases/tag/v3.5) |
| [v2.0](https://github.com/sigfox-tech-radio/sigfox-ep-rf-api-st-s2lp/releases/tag/v2.0) | >= [v3.5](https://github.com/sigfox-tech-radio/sigfox-ep-lib/releases/tag/v3.5) |
| [v1.3](https://github.com/sigfox-tech-radio/sigfox-ep-rf-api-st-s2lp/releases/tag/v1.3) | [v3.4](https://github.com/sigfox-tech-radio/sigfox-ep-lib/releases/tag/v3.4) |
| [v1.2](https://github.com/sigfox-tech-radio/sigfox-ep-rf-api-st-s2lp/releases/tag/v1.2) | [v3.2](https://github.com/sigfox-tech-radio/sigfox-ep-lib/releases/tag/v3.2) to [v3.3](https://github.com/sigfox-tech-radio/sigfox-ep-lib/releases/tag/v3.3) |
Expand All @@ -33,9 +34,9 @@ The `LOW_LEVEL_OPEN_CLOSE` flag must be enabled to use this example.

### Dependencies

The **S2LP RF API** is based on the [official S2LP driver](https://github.com/STMicroelectronics/x-cube-sfxs2lp1/tree/main/Drivers/BSP/Components/S2LP/S2LP_Library) from ST-Microelectronics. This driver exposes a functional interface to configure the chip registers, which is used to perform the Sigfox uplink modulation and optional downlink reception. It relies on **low level functions** (called board drivers) which need to be implemented to run on your specific hardware. There are divided in 2 groups:
The **S2LP RF API** is based on the [official S2LP driver](https://github.com/STMicroelectronics/x-cube-subg2/tree/main/Drivers/BSP/Components/S2LP/S2LP_Library) from ST-Microelectronics. This driver exposes a functional interface to configure the chip registers, which is used to perform the Sigfox uplink modulation and optional downlink reception. It relies on **low level functions** (called board drivers) which need to be implemented to run on your specific hardware. There are divided in 2 groups:

* **MCU_Interface_template** : low level functions of the S2LP driver from ST (registers access through SPI and shutdown pin management).
* **S2LP_CORE_SPI** : low level SPI access functions of the S2LP driver from ST.
* **S2LP_HW_API** : additional hardware dependent functions required to get a generic RF API implementation of the S2LP.

The templates are located in the `src/board` folder.
Expand Down
Loading

0 comments on commit 9a6b6e4

Please sign in to comment.