Merge branch 'dev' into release

Author: DjordjeMandic

README.md

@@ -36,7 +36,7 @@ Add UIRBcore to your `platformio.ini` file using one of the following approaches
 
 ```ini
 lib_deps =
-    djordjemandic/UIRBcorelib @ ^1.2.1  ; Depend on the latest 1.x stable version
+    djordjemandic/UIRBcorelib @ ^1.2.2  ; Depend on the latest 1.x stable version
 ```
 
 > **Tip:** Discover more about specifying packages in PlatformIO by visiting the [official documentation on package specifications](https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install.html#package-specifications).
@@ -48,7 +48,7 @@ lib_deps =
 
 ```ini
 lib_deps =
-    https://github.com/DjordjeMandic/UIRBcorelib.git#v1.2.1  ; Depend on the v1.2.1 Git tag
+    https://github.com/DjordjeMandic/UIRBcorelib.git#v1.2.2  ; Depend on the v1.2.2 Git tag
 ```
 
 ### Manually

examples/Basic/platformio.ini

@@ -38,7 +38,7 @@ default_envs = uirb-v02  ; Default environment to use for builds (specified belo
 platform = atmelavr                          ; Specifies the Atmel AVR platform (used for ATmega microcontrollers)
 framework = arduino                          ; Utilizes the Arduino framework for development
 lib_deps = 
-    djordjemandic/UIRBcorelib @ ^1.2.1       ; UIRBcore library for Universal IR Blaster (GitHub: https://github.com/DjordjeMandic/UIRBcorelib)
+    djordjemandic/UIRBcorelib @ ^1.2.2       ; UIRBcore library for Universal IR Blaster (GitHub: https://github.com/DjordjeMandic/UIRBcorelib)
 monitor_speed = 1000000                      ; Serial monitor baud rate (1M)
 monitor_filters = default, time, colorize    ; Serial monitor: default output, timestamps, and colorized text
 build_src_flags = 

examples/BypassEEPROM/platformio.ini

@@ -48,7 +48,7 @@ build_flags =
     -DUIRB_EEPROM_BYPASS_DEBUG               ; Enable EEPROM bypass mode (data stored in RAM)
     -DUIRB_EEPROM_RPROG_DEBUG=4990           ; Set Rprog resistance to 4990 ohms for debugging
 lib_deps =                                   ; Library dependencies
-    djordjemandic/UIRBcorelib @ ^1.2.1       ; UIRBcorelib library with version 1.2.1 or higher
+    djordjemandic/UIRBcorelib @ ^1.2.2       ; UIRBcorelib library with version 1.2.2 or higher
 monitor_speed = 1000000                      ; Speed for serial monitor communication in bits per second
 monitor_filters = default, time, colorize    ; Serial monitor: default output, timestamps, and colorized text
 build_src_flags = 

examples/Calibration/platformio.ini

@@ -36,7 +36,7 @@ default_envs = uirb-v02  ; Default environment to use for builds (specified belo
 platform = atmelavr                          ; Specifies the Atmel AVR platform (used for ATmega microcontrollers)
 framework = arduino                          ; Utilizes the Arduino framework for development
 lib_deps = 
-    djordjemandic/UIRBcorelib @ ^1.2.1       ; UIRBcore library for Universal IR Blaster (GitHub: https://github.com/DjordjeMandic/UIRBcorelib)
+    djordjemandic/UIRBcorelib @ ^1.2.2       ; UIRBcore library for Universal IR Blaster (GitHub: https://github.com/DjordjeMandic/UIRBcorelib)
 monitor_speed = 1000000                      ; Serial monitor baud rate (1M)
 monitor_filters = default, time, colorize    ; Serial monitor: default output, timestamps, and colorized text
 build_src_flags = 

include/UIRBcore.hpp

@@ -63,6 +63,11 @@
  * @brief Example demonstrating the calibration and usage of the 1.1V internal reference using the UIRBcore library.
  */
 
+/**
+ * @example examples/BypassEEPROM/src/BypassEEPROM.ino
+ * @brief Example showcasing EEPROM bypass and debugging features of the UIRBcore library in a simulated environment.
+ */
+
 #ifndef UIRBcore_hpp
 #define UIRBcore_hpp
 

include/UIRBcore_Version.h

@@ -85,7 +85,7 @@
      * 
      * @see https://git-scm.com/docs/git-describe for details about the `git describe` command.
      */
-    #define UIRB_CORE_LIB_VER_STR "v1.2.1"
+    #define UIRB_CORE_LIB_VER_STR "v1.2.2"
 
     #if defined(UIRB_CORE_LIB_MAJOR)
         #undef UIRB_CORE_LIB_MAJOR
@@ -126,7 +126,7 @@
      * The patch version number indicates backward-compatible bug fixes or minor updates
      * that do not introduce new features. Incrementing this number signals a patch release.
      */
-    #define UIRB_CORE_LIB_PATCH (1)
+    #define UIRB_CORE_LIB_PATCH (2)
 
 #else  // defined(UIRB_CORE_LIB)
 

library.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/platformio/platformio-core/develop/platformio/assets/schema/library.json",
   "name": "UIRBcorelib",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Universal IR Blaster core library for Arduino.",
   "keywords": [
     "uirb",

scripts/update_version.py

@@ -13,7 +13,7 @@ def get_git_version():
     Retrieves the latest Git tag or commit hash, appending 'dirty' if there are uncommitted changes.
     """
     try:
-        return subprocess.check_output(["git", "describe", "--tags", "--dirty", "--always"], stderr=subprocess.DEVNULL).strip().decode("utf-8")
+        return subprocess.check_output(["git", "--git-dir=./.git", "--work-tree=.", "describe", "--tags", "--dirty", "--always"], stderr=subprocess.DEVNULL).strip().decode("utf-8")
     except subprocess.CalledProcessError:
         raise Exception("Unable to retrieve Git version. Ensure this is a Git repository.")
 
@@ -62,12 +62,17 @@ def main():
         current_dir = os.getcwd()
         log_message(f"Current Directory: {current_dir}")
 
+        # Get the folder name of the current directory
+        folder_name = os.path.basename(current_dir)
+        if folder_name != "UIRBcorelib":
+            log_message(f"Warning: The current directory {current_dir} does not match the expected folder name 'UIRBcorelib'.")
+        
         # Path to the header file
         header_file_path = os.path.join(current_dir, "include", "UIRBcore_Version.h")
 
         # Get the latest version from Git
         git_version = get_git_version()
-        log_message(f"Git Tag Version: {git_version}")
+        log_message(f"Git Describe Output: {git_version}")
 
         # Read the header file
         content = read_header_file(header_file_path)