2.2.0

API changes:

- Updates `ScheduleMessage` API to return a message ID on success
- Adds `MessageSlotsMax` API to return the maximum number of messages that the message queue can contain
- Adds `MessageQueueStatus` API to retrieve the status of all messages currently in the queue
- Adds `MessageQueueDelete` API to remove a specific message from the queue by its message ID

Improvements:

- Improves network performance
- Reduces energy consumption
- Adds support for u-blox M10 GNSS modules
- Adds [AT client](examples/at_modem/at_client.py) in `at_modem` example to simulate the host controller behaviour
- Adds [message_queue example application](examples/message_queue) demonstrating usage of the message queue APIs
- Improves `log-util.py` with structured decoding and enhanced error handling
- Updates supported platforms to include Ubuntu 24.04
- Updates supported platforms to include macOS 26 (Tahoe)

Other changes:

- Drops installation support for Ubuntu 20.04
- Drops installation support for macOS 15 (Sequoia) and earlier versions

2.1.0

API changes:

- Adds `MessageSlotsFree` API to return the number of messages that can be scheduled in the message queue
- Deprecates `MAX_MESSAGE_SIZE` constant

Improvements:

- Adds support to transmit messages larger than 20 bytes
- Updates [at modem application](examples/at_modem/README.md) to transmit messages larger than 20 bytes
- Updates [tracker example application](examples/tracker) to transmit messages larger than 20 bytes
- Extends [tools/updater.py](tools/updater.py) to support Myriota FlexSense
- Removes unused imports from various python scripts
- Updates the flash memory start address of the user application

2.0.1

Improvements:

- Improves network performance
- Reduces energy consumption during device startup
- Adds `DISABLE_GNSS_FIX` build flag in `at_modem` example

2.0.0

API changes:

  - Adds `OnReceiveMessage` and `ReceiveMessage` APIs to retrieve device control messages
  - Updates API `RxStatsGet` to retrieve [downlink receive statistics](examples/rf_test/rx_packet/README.md)
  - Updates return type of API `ScheduleMessage` to `int`
  - Removes API `MaxThroughput` and associated example
  - Drops support for `SATELLITES=LabRx` in `rx_packet` example
  - Drops support for `SATELLITES=Lab` and `SATELLITES=LabRxWithLocation`
  - Drops support for satellite simulator

Improvements:

  - Improves network performance
  - Reduces energy consumption
  - Adds support to receive messages
  - Adds [receive example application](examples/receive/README.md) to demonstrate `OnReceiveMessage` and `ReceiveMessage`
  - Adds battery voltage in the message of Sense&Locate example
  - Adds time and location setting commands in `at_modem` example to support external time and location sources
  - Updates cross compiler to version 13.2.1

Other changes:

  - Drops support for Ubuntu 18.04

1.5.6-1

Improvements:

- Updates supported platforms to include Ubuntu 22.04
- Adds option to use Github Codespace
- Cleans up tools

1.5.6

Improvements:
  - Adds support to retrieve network information and diagnostics data from the module. The data can be uploaded to Myriota cloud for post-processing

1.5.5

Fixes:

- Fixes an issue where the wakeup capability of both GPIOs is disabled when `GPIODisableWakeup` is called
- Fixes an issue in `RFTestTxStop` hardware API where LED won't be turned off when the test stops
- Fixes an issue in the RSSI test of the `rf_test` example where the BSP antenna selection logic is not been used properly
- Fixes an issue in the makefile of `i2c_spi` example where SPI mode binary cannot be built
- Fixes an issue where unnecessary diagnostic messages are generated when specific network information is received via downlink

Improvements:

- Adds APIs to update the network information in the user application
- Significantly reduces the startup time after programming the user application or network information
- Reduces the wakeup time when neither LEUART nor pulse counter is enabled
- Avoids potential current leak from GNSS UART1_RX pin in deep sleep
- Increases user job watchdog timeout time from 6 minutes to 15 minutes

1.5.4

Improvements:

- Optimises TX scheduling to improve TX performance
- Adds support of applying TX calibration table in the module to tune the TX power and current draw
- Clarifies temperature sensor readings in the comment/document

Fixes:

- Corrects module TX frequency selection error which reduces the message success rate
- Fixes an issue where SDK 1.5.3 is not compatible with applications built against older SDKs

1.5.3

Improvements:

- Adds SDK APIs to save user data in [persistent storage](examples/nvram/README.md)
- Adds SDK API `RxStatsGet` to get [downlink stats](examples/rf_test/rx_packet/README.md)
- Improves the support of network performance tuning via network information
- Improves the Sense&Locate [example](examples/snl) to simplify sensor testing
- Adds permission for logging to unpacker example for the [tracker example application](examples/tracker/aws)
- Adds support for macOS installation
- Improves the accuracy of the GNSS fix when the device is moving
- Adds an option to `mergy_binary.py` tool to extract individual raw files from a merged file
- Stops printing satellite IDs to the debug output
- Removes obsolete functions from the math folder

Fixes:

- Corrects rare event causing module to reset during satellite prediction

1.5.2

API changes:

- Changes the `GNSSFIX` environment variable for satellite simulator mode (lab mode)
- Network information and user application binaries for programming via XMODEM tool or SWD hardware interface are generated under the `raw_binary` folder

Improvements:

- Adds support to separate the network information from the user application
  - the user application can fully utilise the 34k-byte flash memory allocated to it
  - network information and user application can be updated individually during development and manufacturing
- Adds `merge_binary.py` tool to merge multiple firmware files into one
    - multiple different types of files can be merged into one and updated by `updater.py` with `-m` option
    - file contents are CRC checked to detect corruption
    - the network information and the user application are merged together by default and can be updated by either `-u` for backward compatibility or `-m`
- Adds support to print memory usages when building the user application
- Improves `message_inject.py` error handling when the module ID specified does not exist
- Adds CloudFormation template of an AWS lambda for the tracker example application
- System GNSS update job won't run when system GNSS fix is skipped to reduce module wakeups
- Adds redirection support for network information download to be future-proof
- Improves `log-util.py` error handling when log purging fails

Fixes:

- Fixes an issue in `BeforeSatelliteTransmit` where time based on an invalid transmit opportunity may be returned
- Fixes an issue in `updater.py` where failed communication during updating may be recognised as partition error
- Fixes an issue in `log-util.py` when decoding user log entries with zero length
- Fixes an issue where suspend mode can't be disabled in `BoardStart`
- Fixes an issue when the system GNSS is skipped causing delayed diagnostic messages
- Fixes an issue when the system GNSS is skipped the location set is reset to default after disabling suspend mode