Skip to content

Latest commit

 

History

History
233 lines (152 loc) · 9.6 KB

CHANGELOG.md

File metadata and controls

233 lines (152 loc) · 9.6 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

v4.0 - 22 Nov 2024

Added

  • Add AES driver from TI to optionally perform the AES128 algorithm internally.
  • Add MCU_API_get_ep_key() function to read the device private key when the new embedded AES driver is used.
  • Add SIGFOX_EP_AES_HW compilation flag to select the AES computation method (new embedded AES driver or legacy MCU_API_aes_128_cbc_encrypt() function).
  • Add SIGFOX_NUMBER_OF_RC macro.
  • Add sigfox_ep_flags_template.h file (more details in the Changed section).

Fixed

  • Fix compilation issue in TX control driver.
  • Remove unifdef dependency in all cmake with linked target.

Changed

  • Add SIGFOX_EP prefix to all compilation flags.
  • Rename RC3C zone to RC3_LBT and RC3D zone to RC3_LDC.
  • Rename sigfox_ep_flags.h to sigfox_ep_flags_template.h. The real sigfox_ep_flags.h file can be created manually from the provided template or generated by cmake. This way, the flags file can be used while keeping the sigfox-ep-lib repository clean.
  • The sigfox_ep_flags.h file is now included by default: the SIGFOX_EP_USE_FLAGS_FILE compilation flag is now replaced by SIGFOX_EP_DISABLE_FLAGS_FILE with inverted logic.
  • Add SIGFOX prefix to all macros.
  • Add _t suffix to all functions typedef.
  • Change SIGFOX EP API error codes order and name.
  • Better code formatting with spaces instead of tabs.

Removed

  • Remove MCU_API_print_dl_payload() function. It is now replaced by an applicative callback given in the RFP and TA addons API (downlink_cplt_cb field).
  • Remove sigfox_ep_flags.h file (more details in the Changed section).

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.

v3.6 - 30 May 2024

Added

  • Add weak attribute to functions templates.
  • Add SFX_UNUSED macro to remove extra warnings.

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.

v3.5 - 22 Mar 2024

Added

  • Add sigfox_rc.c and sigfox_types.c files to define constants and optimize memory footprint when including these files multiple times (extern instead of static).
  • Add SX126X RF API support in cmake.

Fixed

  • Add missing NVM writing operation in case of error during message transmission.
  • Add missing cast on temperature field computation for control frames.
  • Fix compilation issue in SIGFOX_EP_API_open() function.
  • Fix compilation issue in bitstream driver.

Changed

  • Rename RCx compilation flags to RCx_ZONE for Microchip MCUs compatibility.

Removed

  • Remove EP-ID check when using test API.

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.

v3.4 - 09 Nov 2023

Added

  • Add RF_API_start_continuous_wave() function template for type approval addon.
  • Add required macros for frequency hopping test mode of type approval addon.
  • Update cmake tool to generate type approval addon and add predefined values list for some parameters.

Fixed

  • Impose READY state to close the library (as shown in state machine).
  • Reset core context in case of low level error.
  • Fix downlink sequence in pseudo-blocking mode (asynchronous mode with process callback set to NULL).
  • Add BIDIRECTIONAL flag on MCU_API_print_dl_payload() function.

Changed

  • Use sfx_u32 type for timer durations (for type approval addon).
  • Use boolean type for bidirectional_flag field in user API.

Removed

  • Remove unused timer reasons in local _start_timer() function.
  • Remove unused inclusion of sigfox_rc.h file.
  • Remove doc folder since images are now hosted on the GitHub wiki.

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.

v3.3 - 10 Aug 2023

Added

  • Add MCU_API_get_latency() function to manage MCU drivers latencies as well as radio latencies.
  • Add LR11XX RF API support in cmake.

Fixed

  • Fix T_CONF and T_RX latency compensation formula. Reset all latency values to 0 by default.
  • Fix compilation issue in _start_timer() function.
  • Improve error callback management. Add missing volatile keyword on low level status. Stack corresponding error in process function in order to avoid putting the whole stack in volatile domain.
  • Update manufacturer functions template.

Changed

  • Initialize error stack only once in order to keep history when closing and re-opening the library.
  • Internal improvements: optimize control message type check, use EXIT_ERROR when checking library state, improve flags naming.

Removed

  • Remove unused SIGFOX_EP_API_STATE_DL_CONFIRMATION item in library state enumeration.

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.

v3.2 - 16 Jun 2023

Added

  • New LATENCY_COMPENSATION flag which enables radio latency compensation to improve MCU timers accuracy. Delay computation is now performed by the core library.
  • Add SIGFOX_ERROR_SOURCE_HW_API item to handle board drivers errors in RF API or MCU API implementation.
  • Add S2LP RF API support in cmake.

Changed

  • Remove anonymous structures to improve compilers compatibility.
  • Reduce RAM usage of AES function with a 16 bytes array whatever the UL payload length.
  • Improve error naming and TX control flags naming.
  • Reduce stack usage by using global context directly when calling core functions.
  • Add cast operations to reduce warnings.
  • Change default output power to 14dBm in flags.

Fixed

  • Fix bistream size macro issue when defining UL_PAYLOAD_SIZE and CONTROL_KEEP_ALIVE_MESSAGE or BIDIRECTIONAL.
  • Wrong status assignment in TX control driver.

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.

v3.1 - 01 Mar 2023

General

  • Add CHANGELOG file.

Added

  • Add MCU_API_timer_status() function to facilitate timeout management in RF API functions.
  • Add logical names for timers (MCU_API_TIMER_INSTANCE_xxx macros) in MCU API to define instances mapping.
  • Add reason field in timer structure.
  • Add RF_API_get_latency() function to compensate radio delays in MCU API timers duration.
  • Add new bypass flags in test API for RFP addon (ul_enable, dl_enable, dl_decoding_enable, dl_conf_enable, ldc_check_enable bits, rx_frequency_hz, cs_max_duration_first_frame_ms, and dl_t_w_ms / dl_t_rx_ms timing values).
  • Add Low Duty Cycle (LDC) check in TX control.
  • Add MCU_API_print_dl_payload() function to print RFP addon downlink results.

Changed

  • Rename fields of message status and split error flag into execution_error and network_error to differentiate internal execution errors from external errors such as TX control failure or downlink reception timeout.
  • Move SIGFOX_UL_BITSTREAM_SIZE_BYTES macro in inc/sigfox_types.h to avoid core files inclusion in manufacturer drivers.
  • Improve manufacturer functions call sequence (Tw timer and downlink ending).
  • Random frequency generator: optimize RAM footprint and increase allowed bandwidth of N=1 and N=2 modes.
  • Remove all function pointers in blocking mode for specific compilers compatibility.
  • Change default 32 bits type to long.
  • Rename sigfox_ep_version.h to sigfox_ep_lib_version.h.
  • Use RETURN macro in manufacturer functions template.

Fixed

  • Buffer overflow in downlink frame decoding functions (src/core/sigfox_ep_bitstream.c).
  • Wrong application message pointer access in blocking mode (src/sigfox_ep_api.c).
  • Wrong LBT carrier sense timeout computation for second and third frames (src/core/sigfox_tx_control.c).

Removed

  • Remove dl_phy_content_size field in RX data structure, as it is fixed to SIGFOX_DL_PHY_CONTENT_SIZE_BYTES.

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.

v3.0 - 12 Dec 2022

General

  • First version of the new Sigfox EP library.

Added

  • Asynchronous operation mode in addition to the legacy blocking mode.
  • Memory footprint optimization thanks to multiple compilation flags (inc/sigfox_ep_flags.h)
  • Precompiled source files and library generation with cmake.
  • Sigfox empty frame support.
  • Message status and error stack.
  • New options in user API: dynamic TX power, bit rate and inter-frame delay.
  • New random frequency algorithm with lower memory footprint and better distribution over device ID ranges.
  • Using structures as functions parameters to improve compatibility between compilation flags and versions.

Known limitations

  • Payload encryption not supported.
  • Secure element not supported.