Skip to content

Commit a767165

Browse files
authored
Merge pull request #444 from tropicsquare/ETR01SDK-525-Update-changelog-final-task
ETR01SDK-525: Update changelog with monorepo related changes
2 parents 44f0f95 + bc8a1b8 commit a767165

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

CHANGELOG.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,15 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [3.1.0]
99

1010
### Changed
11+
- Merged all Libtropic platform repositories into this main Libtropic repository.
12+
- Examples and functional tests are no longer part of the core Libtropic (related CMake options were removed from Libtropic's `CMakeLists.txt`) - they are now standalone CMake projects. Note that we provide the tests just for a reference and executing them is at user's risk, as they can cause irreversible changes to the TROPIC01 chip.
13+
- `examples/`: contains platform directories, where **Chip Identification**, **FW Update** and **Hello, World!** standalone example projects are always implemented for each platform (except the TROPIC01 Model). Each platform may contain additional example projects.
14+
- HW Wallet, Mac-And-Destroy and Separate API examples are now implemented only for the TROPIC01 Model (`examples/model/`).
15+
- `tests/functional/`: contains `src/`, where the functional tests CMake project is implemented and platform directories with entry points for each target.
16+
- Restructured [documentation](https://tropicsquare.github.io/libtropic/latest/), it is now generated only for release versions, added *Tutorials* section to help users quickly get started with Libtropic on supported platforms.
1117
- STM32 HAL: updated L432KC and started active support again.
1218
- STM32 HAL: moved clock initialization out of the HALs to remove dependency on user's `main.h` and allow for higher flexibility.
1319
- Clock initialization is up to the user now and it is demonstrated in our integration examples.
@@ -16,7 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1622
need to modify the behavior yourself (e.g., by modifiying `_write` syscall on STM32), or (in the case of the embedded platforms)
1723
you just need to configure your serial monitor correctly, so it expects only LF character (and not CR+LF pair).
1824
- TCP HAL: Fixed `lt_port_init()` cleanup, refactored local functions.
19-
- Moved TROPIC01 Model related files to `scripts/tropic01_model`.
25+
- Moved TROPIC01 Model related files to `scripts/tropic01_model/`.
2026

2127
### Added
2228
- Logging: `lt_port_log` function for platform-specific logging mechanism; is used by the logging macros declared in `libtropic_logging.h`.
@@ -26,7 +32,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2632
- Missing check of `lt_handle_t.l3.session_status` in `lt_in__ecc_key_generate()`.
2733
- CAL: support for OpenSSL.
2834
- CAL: support for WolfCrypt.
29-
- Linux HAL: added new HAL for Linux which utilizes spidev for chip select instead of GPIO.
35+
- Linux HAL: added new experimental HAL for Linux which utilizes spidev for chip select instead of GPIO.
36+
- Linux USB Devkit: added full chain verification example with tutorial.
37+
- ESP32: added examples and functional tests support for ESP32-DevKitC-V4, ESP32-S3-DevKitC-1 and ESP32-C3-DevKit-RUST-1.
3038

3139
### Fixed
3240
- `lt_print_bytes` function now returns `LT_PARAM_ERR` when incorrect parameters are passed instead of `LT_FAIL`.
@@ -39,7 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3947
- Arduino HAL: Removed `rng_seed` from `lt_dev_arduino_t`, as it should be user's responsibility to initialize the PRNG.
4048
- Arduino HAL: Removed `SPI.begin()` and `SPI.end()` calls (fixes [this](https://github.com/tropicsquare/libtropic-arduino/issues/15) issue). It is now expected that users initialize SPI in their code themselves.
4149
- Redundant checks of `lt_handle_t.l3.session_status` in `lt_l3_encrypt_request()` and `lt_l3_decrypt_response()`.
42-
- Legacy internal scripts in `scripts/test_runner`.
50+
- Legacy internal scripts in `scripts/test_runner/`.
4351

4452
## [3.0.0]
4553

0 commit comments

Comments
 (0)