Skip to content

Commit

Permalink
release 0.5.0
Browse files Browse the repository at this point in the history
Standard release updates to CHANGELOG, README, VERSION for release 0.5.0.

Signed-off-by: Nick Miller <[email protected]>
  • Loading branch information
ncmiller committed Jan 12, 2023
1 parent 0b717eb commit 1cd721a
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 5 deletions.
37 changes: 37 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,43 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.5.0] - 2023-01-12

Highlights:

- Support for ESP-IDF v5.0. This is the new recommended version. IDF 4.x is still supported.
- Support for decompressing compressed OTA artifacts
- Support for certificate authentication when connecting to Golioth
- No breaking changes from prior release

### Added
- client: new API golioth_client_wait_for_connect(), to block until connected to Golioth
- new submodule: heatshrink
- fw_update: support for decompressing compressed OTA artifacts, using heatshrink library
- fw_update: new API golioth_fw_update_state_change_callback(), notification of state changes
- fw_update: new API golioth_fw_update_init_with_config(), for more detailed configuration
- config: new configuration to enable/disable OTA decompression
- config: new configuration to set the default log level of the Golioth SDK
- linux: option to download OTA images and store as a file
- scripts: generate project root and device certificates
- support for using SDK in C++ projects, extern "C" in headers, new esp-idf example
- examples/esp_idf: new example `cpp`, demonstrating usage of SDK in C++ project
- examples/{esp_idf,linux}: new `certificate_auth` example
- docs: new document, Flash_and_RAM_Usage.md
### Changed
- esp-idf: libcoap is a separate IDF component now
- docs: improved integration guide for ESP-IDF
- esp-idf: configuration optimizations to reduce total flash size of binary
- wifi: reduce log level to WARN, to avoid spammy logs at init time
### Fixed
- Miscellaneous printf formatting warnings, e.g. converting `%d` to `PRId32`
- examples,wifi: fix potential strncpy size issue, NULL termination
- Where malloc is called, check for NULL before attempting to memset
- log: dynamically allocate JSON serialized string, to avoid 100 character limit
- linux: golioth_sys_msleep now sleeps the correct amount of time, uses nanosleep
- coap_client: only add URI path option to packet if path length is > 0
- coap_client: use the accept option on all GET requests (was incorrectly using content-type)

## [0.4.0] - 2022-11-18

### Breaking Changes
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The `verify.py` script will return 0 on success (all tests pass), and non-zero o

| Board | Platform | Module | Last Tested Commit |
| --- | --- | --- | --- |
| ESP32-S3-DevKitC-1 | ESP-IDF (v4.4.2) | ESP32-S3-WROOM-1 | Every commit, CI/CD |
| ESP32-DevKitC-32E | ESP-IDF (v4.4.2) | ESP32-WROOM-32E | v0.4.0 (Nov 17, 2022) |
| ESP32-C3-DevKitM-1 | ESP-IDF (v4.4.2) | ESP32-C3-MINI-1 | v0.4.0 (Nov 17, 2022) |
| CY8CPROTO-062-4343W | ModusToolbox (3.0.0) | PSoC® 6 CYW4343W | v0.4.0 (Nov 17, 2022) |
| ESP32-S3-DevKitC-1 | ESP-IDF (v5.0) | ESP32-S3-WROOM-1 | Every commit, CI/CD |
| ESP32-DevKitC-32E | ESP-IDF (v5.0) | ESP32-WROOM-32E | v0.5.0 (Jan 12, 2023) |
| ESP32-C3-DevKitM-1 | ESP-IDF (v5.0) | ESP32-C3-MINI-1 | v0.5.0 (Jan 12, 2023) |
| CY8CPROTO-062-4343W | ModusToolbox (3.0.0) | PSoC® 6 CYW4343W | v0.5.0 (Jan 12, 2023) |
2 changes: 1 addition & 1 deletion VERSION.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.4.0
0.5.0

0 comments on commit 1cd721a

Please sign in to comment.