From 05f4af4287e9c80f45e5272ca2e3d4bafb4a66ad Mon Sep 17 00:00:00 2001 From: Rob Meades Date: Wed, 28 Feb 2024 11:48:38 +0000 Subject: [PATCH] Documentation change only: upcoming changes for release 1.5. (#1080) --- UPCOMING.md | 47 +++++++++++++++------------------ readme_images/important_msg.svg | 4 +-- 2 files changed, 23 insertions(+), 28 deletions(-) diff --git a/UPCOMING.md b/UPCOMING.md index 943854b4..ad400450 100644 --- a/UPCOMING.md +++ b/UPCOMING.md @@ -1,42 +1,37 @@ -# Upcoming Changes In Release 1.4, End January 2024 -In the 1.4 release of `ubxlib`, due end January 2024, we would like to inform you of the deprecation of two platforms and we will also make a number of improvements; these changes are described below. +# Upcoming Changes In Release 1.5, End July 2024 +In the 1.5 release of `ubxlib`, due end July 2024, we would like to inform you of the removal of two platforms and we will also make a number of improvements; these changes are described below. As always, we welcome your feedback on the road-map of features/improvements to `ubxlib`: simply post something in the issues list of this repo and we will respond. -Note: this repo is constantly updated, hence the features below will likely arrive before the release 1.4 tag is laid down, may already be here in fact. +Note: this repo is constantly updated, hence the features below will likely arrive before the release 1.5 tag is laid down. -# Deprecation Of Arduino (non-PlatformIO Version) And nRF5SDK Platforms -The following platforms will be deprecated from release 1.4: +# Removal Of Arduino (non-PlatformIO Version) And nRF5SDK Platforms +The following platforms will be removed from this repo in release 1.5: - [port/platform/arduino](/port/platform/arduino), i.e. the version of Arduino where we supply a Python script which copies the `ubxlib` files into a structure that Arduino understands, - [port/platform/nrf5sdk](/port/platform/nrf5sdk), i.e. the previous generation of Nordic SDK, which Nordic have put into maintenance mode. -We will continue to support Arduino through [port/platform/platformio](/port/platform/platformio); if you wish to continue to use `ubxlib` with Arduino, please consider moving to the PlatformIO IDE. +We continue to support Arduino through [port/platform/platformio](/port/platform/platformio); if you wish to continue to use `ubxlib` with Arduino, please move to the PlatformIO IDE. -We will continue to support nRF52/nRF53 through what is now the Nordic standard nRF Connect SDK (i.e. Zephyr 3). If you use `ubxlib` with nRF52/nRF53 please consider moving to nRF Connect. +We continue to support nRF52/nRF53 through what is now the Nordic standard nRF Connect SDK (i.e. Zephyr 3). If you use `ubxlib` with nRF52/nRF53 please move to nRF Connect. -Support for Arduino (non-PlatformIO Version) and nRF5SDK will be entirely removed at release 1.5, likely before the middle of 2024. +# Firmware Update For NORA-W36, u-connectExpress 2nd Generation +Support will be provided for downloading u-connextExpress FW to the NORA-W36 module. -# Geofencing -Support will be provided for flexible geofencing, permitting multiple fences, each containing multiple circles and multiple polygons, implemented within `ubxlib` (so not using the geofencing of a GNSS module) in order that the fences can be applied to cellular (CellLocate position) and Wi-Fi (Google, Skyhook and Here) as well as GNSS. +# Chunked HTTP Client API +The HTTP Client API will be extended to permit the MCU to receive an HTTP file in chunks rather than all at once. -# Cellular LENA-R8 -Support will be provided for the GSM/LTE LENA-R8 cellular module series. +# BLE Pairing And Bonding +Support will be provided for pairing and bonding BLE-capable short-range modules. -# Zephyr Peripheral Selection -In order to be able to use UART, SPI and I2C devices in the Zephyr device tree that do not follow the usual naming convention (i.e. `uartx`, `i2cx` and `spix`), support for an overlay file which aliases the required device to `ubxlib-yyyy` will be added (so for instance the alias `ubxlib-uart1 = &usart1` would mean that `ubxlib` UART 1 corresponds with the device tree entry `usart1`). +# New Platform: IRIS-W1 (NXP MCUXpresso) +Support will be provided for running `ubxlib` inside the new IRIS-W1 short-range module. -# Short-range NORA-W3 Support (Beta) -An initial release of support for the new version of uConnectExpress, as shipped with the NORA-W3 short-range module, will be provided. +# Testing Non-Nordic Zephyr Platforms +Zephyr platforms other than Nordic nRF52/nRF53 will be added inside the `ubxlib` test system, e.g. STM32. -# Cellular Helper Function To Set RF Bands -An easier-to-use interface for the setting of the RF bands employed by a cellular module will be provided. +# Wi-Fi Calibration Data +Support will be provided for downloading Wi-Fi calibration data to short-range modules. -# Cellular PPP-level Integration Of Transport Into ESP-IDF -Integration of cellular with the bottom of the IP stack of the given platform, at PPP level, will permit all of the client entities supplied with the platform (the IP stack, MQTT, HTTP, etc.) to be used with a cellular transport. This integration will work at least with the ESP-IDF platform; Zephyr, Linux and Windows will come later. - -# Module Type "Any" -Support will be provided for setting module type "ANY" within cellular, GNSS or short-range and the `ubxlib` code will do its best to figure out what module type that is attached; note that this will be "best effort": we do not test `ubxlib` with all module types so it is always possible for `ubxlib` to get this wrong, in which case the user can always specify the correct module type. - -# GNSS Auto-baud -Support will be provided for setting the desired GNSS baud rate to "auto", in which case `ubxlib` will try different baud rates until it finds one that the GNSS device responds correctly to. Note that this will result in a start-up delay: it will always be quicker for the application to chose the correct baud rate at the outset. \ No newline at end of file +# New Cellular Modules LEXI-R10, LEXI-R422, LEXI-R520, SARA-R520 +Support will be included for the new cellular LEXI-R series modules and SARA-R520 module. \ No newline at end of file diff --git a/readme_images/important_msg.svg b/readme_images/important_msg.svg index 9297f5f7..db713f3e 100644 --- a/readme_images/important_msg.svg +++ b/readme_images/important_msg.svg @@ -4,7 +4,7 @@