Deprecation marking: Arduino (non-PlatformIO version)0 and nRF5SDK. (…

…#1074) /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, and /port/platform/nrf5sdk, i.e. the previous generation of Nordic SDK, which Nordic have put into maintenance mode, are **NOW DEPRECATED** and will be removed at release 1.5, likely before the middle of 2024. - we will continue to support Arduino through /port/platform/platformio; if you wish to continue to use ubxlib with Arduino, please consider moving 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.
u-blox · Jan 26, 2024 · cd03192 · cd03192
1 parent 03c0fc4
commit cd03192
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,8 @@
 
 [![important message](/readme_images/important_msg.svg)](/UPCOMING.md)
 
-<i>Note: if you are reading this from a package-file created by a third-party \[e.g. PlatformIO\] and the links do not work, please try reading it at the original [ubxlib Github site](https://github.com/u-blox/ubxlib) instead.</i>
+<i>Note: if you are reading this from a package-file created by a third-party \[e.g. PlatformIO\] and the links do not work, please try reading it at the original [ubxlib Github site](https://github.com/u-blox/ubxlib) instead.</i><br /><br />
+<b>IMPORTANT: [port/platform/arduino](/port/platform/arduino) and [port/platform/nrf5sdk](/port/platform/nrf5sdk) are NOW DEPRECATED and will be REMOVED at release 1.5, likely mid 2024: if you wish to continue to use `ubxlib` with Arduino, please consider moving to the [PlatformIO IDE](/port/platform/platformio); we will continue to support nRF52/nRF53 through what is now the Nordic standard [nRF Connect SDK (i.e. Zephyr 3)](/port/platform/zephyr).</b>
 
 # Introduction to `ubxlib`
 This repository contains an add-on to microcontroller and RTOS SDKs for building embedded applications with u-blox products and services. It provides portable C libraries which expose APIs with examples. `ubxlib` supports [u-blox](https://www.u-blox.com) modules with [cellular](https://www.u-blox.com/en/cellular-modules) (2G/3G/4G), [short-range](https://www.u-blox.com/en/short-range-radio-chips-and-modules) (Bluetooth and Wi-Fi) and [positioning](https://www.u-blox.com/en/positioning-chips-and-modules) (GNSS) functionality. The `ubxlib` libraries present high level C APIs for use in customer applications (e.g. connect to a network, open a TCP socket, establish location, etc.) and implements these APIs on selected popular MCUs, also available inside u-blox modules.

diff --git a/port/platform/arduino/README.md b/port/platform/arduino/README.md
@@ -1,4 +1,4 @@
-*** IMPORTANT: this platform is currently supported but WILL BE DEPRECATED soon and will be REMOVED at the end of 2023: please build for Arduino[ESP32] through [platformio](/port/platform/platformio) instead. ***
+*** IMPORTANT: this platform is now DEPRECATED, it is no longer supported and will be REMOVED in release 1.5, mid 2024: please build for Arduino[ESP32] through [platformio](/port/platform/platformio) instead. ***
 
 # Preface
 This platform allows `ubxlib` to be called from within Arduino code.  It does not provide a C++ API into `ubxlib`, does not "Arduino-ise" the `ubxlib` architecture, i.e. `ubxlib` still requires the RTOS world of tasks, mutexes, queues etc., which is provided in this case by the underlying ESP-IDF SDK.

diff --git a/port/platform/arduino/app/app.ino b/port/platform/arduino/app/app.ino
@@ -17,6 +17,10 @@
 /** @file
  * @brief An Arduino sketch used ONLY to run the ubxlib examples/tests,
  * this NOT an example of how to write Arduino code.
+ *
+ * IMPORTANT: this platform is now DEPRECATED, it is no longer supported
+ * and will be REMOVED in release 1.5, mid 2024: please build for
+ * Arduino[ESP32] through [platformio](/port/platform/platformio) instead.
  */
 
 #ifdef U_CFG_OVERRIDE

diff --git a/port/platform/arduino/u_arduino.py b/port/platform/arduino/u_arduino.py
@@ -82,6 +82,11 @@ def main(source_files, include_paths, platform_type, ubxlib_dir,
     # Make the ubxlib directory absolute, clearer that way
     ubxlib_dir = os.path.abspath(ubxlib_dir)
 
+    print("\n*** IMPORTANT: this platform is now DEPRECATED, it is no longer" \
+          " supported and will be REMOVED in release 1.5, mid 2024: please" \
+          " build for Arduino[ESP32] through /port/platform//platformio)"   \
+          " instead. ***\n")
+
     # Print out what we've been told to do
     text = "Creating an Arduino library version of ubxlib for \"" + \
            platform_type + "\" in \"" + output_dir + "\" with the"  \
@@ -126,6 +131,11 @@ def main(source_files, include_paths, platform_type, ubxlib_dir,
     else:
         print("Done, with errors.")
 
+    print("\n*** IMPORTANT: this platform is now DEPRECATED, it is no longer" \
+          " supported and will be REMOVED in release 1.5, mid 2024: please" \
+          " build for Arduino[ESP32] through /port/platform//platformio)"   \
+          " instead. ***\n")
+
     if saved_path:
         os.chdir(saved_path)
 
@@ -134,7 +144,15 @@ def main(source_files, include_paths, platform_type, ubxlib_dir,
 if __name__ == "__main__":
     PARSER = argparse.ArgumentParser(description="A script to"     \
                                      " create a ubxlib Arduino"    \
-                                     " library.\n")
+                                     " library.\nIMPORTANT: this"   \
+                                     " platform is now DEPRECATED," \
+                                     " it is no longer supported"  \
+                                     " and will be REMOVED in"     \
+                                     " release 1.5, mid 2024:"     \
+                                     " please build for"           \
+                                     " Arduino[ESP32] through"     \
+                                     " [platformio](/port/platform/" \
+                                     "platformio) instead. ***")
     PARSER.add_argument("-p", default="esp-idf", help="the ubxlib" \
                         " platform to use with Arduino, i.e. a"    \
                         " directory name under the ubxlib platform"\

diff --git a/port/platform/nrf5sdk/README.md b/port/platform/nrf5sdk/README.md
@@ -1,4 +1,4 @@
-*** IMPORTANT: this platform is currently supported but WILL BE DEPRECATED soon and will be REMOVED at the end of 2023: please use [zephyr](/port/platform/zephyr) instead. ***
+*** IMPORTANT: this platform is now DEPRECATED, it is no longer supported and will be REMOVED in release 1.5, mid 2024: please use [zephyr](/port/platform/zephyr) instead. ***
 
 # Introduction
 These directories provide the implementation of the porting layer on the Nordic nRF5 platform.  Instructions on how to install the necessary tools and perform the build can be found in the MCU directories below.

diff --git a/port/platform/nrf5sdk/mcu/nrf52/README.md b/port/platform/nrf5sdk/mcu/nrf52/README.md
@@ -1,4 +1,4 @@
-*** IMPORTANT: this platform is currently supported but WILL BE DEPRECATED soon and will be REMOVED at the end of 2023: please use [zephyr](/port/platform/zephyr) instead. ***
+*** IMPORTANT: this platform is now DEPRECATED, it is no longer supported and will be REMOVED in release 1.5, mid 2024: please use [zephyr](/port/platform/zephyr) instead. ***
 
 # Introduction
 These directories provide the configuration and build metadata for the NRF52 MCU under the nRF5 SDK.  The configuration here is sufficient to run the `ubxlib` tests and examples, no attempt is made to optimise the MCU RAM/flash etc. sizes, you need to know how to do that yourself.

diff --git a/port/platform/nrf5sdk/mcu/nrf52/gcc/README.md b/port/platform/nrf5sdk/mcu/nrf52/gcc/README.md
@@ -1,3 +1,5 @@
+*** IMPORTANT: this platform is now DEPRECATED, it is no longer supported and will be REMOVED in release 1.5, mid 2024: please use [zephyr](/port/platform/zephyr) instead. ***
+
 # Introduction
 This directory and its sub-directories contain the build infrastructure for Nordic NRF52 building under GCC with Make.
 

diff --git a/port/platform/nrf5sdk/mcu/nrf52/gcc/runner/Makefile b/port/platform/nrf5sdk/mcu/nrf52/gcc/runner/Makefile
@@ -10,6 +10,10 @@ UNITY_PATH ?= $(UBXLIB_PATH)/../Unity
 NRF5_PATH ?= $(UBXLIB_PATH)/../nrf5
 JLINK_SERIAL_NUMBER := 
 
+$(info )
+$(warning *** IMPORTANT: this platform is now DEPRECATED, it is no longer supported and will be REMOVED in release 1.5, mid 2024: please use /port/platform/zephyr instead. ***)
+$(info )
+
 # This is picked up in gcc_startup_nrf52840.S to
 # set the heap size.  If you modify this value then
 # make sure that the value of configTOTAL_HEAP_SIZE

diff --git a/port/platform/nrf5sdk/mcu/nrf52/gcc/runner/README.md b/port/platform/nrf5sdk/mcu/nrf52/gcc/runner/README.md
@@ -1,3 +1,5 @@
+*** IMPORTANT: this platform is now DEPRECATED, it is no longer supported and will be REMOVED in release 1.5, mid 2024: please use [zephyr](/port/platform/zephyr) instead. ***
+
 # Introduction
 This directory contains a build which compiles and runs any or all of the examples and tests for the NRF52 platform under GCC with Make.