Bump release to 1.2.0, fixes compile errors, updates examples, adds new options

Author: DjordjeMandic

.github/workflows/publish.yml

@@ -1,17 +1,27 @@
 name: Publish Library to PlatformIO
 
 on:
-  push:
-    tags:
-      - 'v[0-9]*.[0-9]*.[0-9]*'   # Match tags in the vMAJOR.MINOR.PATCH format (e.g., v1.0.0)
+  release:
+    types:
+      - published   # Trigger only when a release is published
 
 jobs:
   publish:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Validate Tag Format
+        run: |
+          echo "Validating tag format: ${{ github.event.release.tag_name }}"
+          if [[ ! "${{ github.event.release.tag_name }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "Error: Tag format is invalid. Must be in vMAJOR.MINOR.PATCH format (e.g., v1.0.0)."
+            exit 1
+          fi
+
       - name: Checkout Code
         uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}  # Check out the tag associated with the release
 
       - name: Publish to PlatformIO
         uses: bojit/platformio-publish@v1.0.0

README.md

@@ -22,7 +22,7 @@ This library is designed with PlatformIO in mind and requires the **uirb-v02-atm
 To use UIRBcore, ensure you have the following:
 
 1. [PlatformIO](https://platformio.org/) installed.
-2. The custom board definition for **uirb-v02-atmega328p** installed. You will need to provide a path to the definition during project setup. (A repository link with more information will be added here in the future.)
+2. The custom board definition for **uirb-v02-atmega328p** installed. You will need to provide a path to the definition during project setup. Visit the [UIRB PlatformIO Example Project Repository](https://github.com/DjordjeMandic/UIRBpio) for more information.
 
 ---
 
@@ -32,12 +32,14 @@ To use UIRBcore, ensure you have the following:
 
 Add UIRBcore to your `platformio.ini` file using one of the following approaches:
 
+> **Tip:** Learn more about semantic versioning at [devhints.io/semver](https://devhints.io/semver) and [semver.org](https://semver.org/).
+
 ```ini
 lib_deps =
-    djordjemandic/UIRBcorelib @ ^1.1.1  ; Depend on the latest 1.x stable version
+    djordjemandic/UIRBcorelib @ ^1.2.0  ; Depend on the latest 1.x stable version
 ```
 
-> **Tip:** Learn more about semantic versioning at [devhints.io/semver](https://devhints.io/semver) and [semver.org](https://semver.org/).
+> **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).
 
 ```ini
 lib_deps =
@@ -46,11 +48,9 @@ lib_deps =
 
 ```ini
 lib_deps =
-    https://github.com/DjordjeMandic/UIRBcorelib.git#v1.1.1  ; Depend on the v1.1.1 Git tag
+    https://github.com/DjordjeMandic/UIRBcorelib.git#v1.2.0  ; Depend on the v1.2.0 Git tag
 ```
 
-> **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).
-
 ### Manually
 
 1. Download the latest release from the [UIRBcore GitHub repository](https://github.com/DjordjeMandic/UIRBcorelib).
@@ -62,6 +62,10 @@ lib_deps =
 
 Here’s a quick example of how to initialize the UIRBcore library:
 
+> **Important:** The ATMEGA328P EEPROM must store a valid hardware version for the UIRB constructor to initialize correctly. If the EEPROM does not contain valid data, the constructor will cause the system to hang and reboot.
+
+> **Note:** For IR signal transmission and reception, use compatible external libraries.
+
 ```cpp
 #include <Arduino.h>
 #include <UIRBcore.hpp>
@@ -92,10 +96,6 @@ void loop()
 }
 ```
 
-> **Important:** The ATMEGA328P EEPROM must store a valid hardware version for the UIRB constructor to initialize correctly. If the EEPROM does not contain valid data, the constructor will cause the system to hang and reboot.
-
-> **Note:** For IR signal transmission and reception, use compatible external libraries.
-
 ---
 
 ## Examples
@@ -112,12 +112,16 @@ These examples are located within the [`examples`](./examples) folder of the lib
 
 ## Configuration
 
+> **Limitation:** Simulation using simavr in PlatformIO is not supported because there is currently no method to pre-load EEPROM data before the simulation. However, this limitation can be mitigated using `#define UIRB_EEPROM_BYPASS_DEBUG` and `#define UIRB_EEPROM_RPROG_DEBUG`.
+
 The library uses fixed pin assignments predefined for the UIRB V0.2 board. Refer to the source code for exact pin mappings.
 
 ---
 
 ## Doxygen Documentation and Scripts
 
+> **Note:** All scripts should be executed from the root of the repository.
+
 ### Version Management
 
 Update version information in [`UIRBcore_Version.h`](./include/UIRBcore_Version.h) using the script [`update_version.py`](./scripts/update_version.py):
@@ -130,23 +134,19 @@ python ./scripts/update_version.py
 
 This project uses Doxygen for documentation. Use the script [`doxygen_generate.ps1`](./scripts/doxygen_generate.ps1) to generate the documentation:
 
-```powershell
-pwsh ./scripts/doxygen_generate.ps1 Doxyfile -OpenHTML
-```
-
-```powershell
-pwsh ./scripts/doxygen_generate.ps1 Doxyfile -UpdateVersion -OpenHTML
-```
-
 > **Details:**
 > - **UpdateVersion**: Updates the `UIRBcore_Version.h` file using `update_version.py`.
 > - **OpenHTML**: Opens the `index.html` file in the `docs/html` directory after successful generation.
 > - Ensure the script and its dependencies (`git_info.ps1`, `update_version.py`) are properly configured and placed in the `scripts` directory.
 > - Requires Git, Python, and Doxygen installed and accessible via the command line.
 
-> **Note:** All scripts should be executed from the root of the repository.
+```powershell
+pwsh ./scripts/doxygen_generate.ps1 Doxyfile -OpenHTML
+```
 
-> **Limitation:** Simulation using simavr in PlatformIO is not supported because there is currently no method to pre-load EEPROM data before the simulation. However, this limitation can be mitigated using `#define UIRB_EEPROM_BYPASS_DEBUG` and `#define UIRB_EEPROM_RPROG_DEBUG`.
+```powershell
+pwsh ./scripts/doxygen_generate.ps1 Doxyfile -UpdateVersion -OpenHTML
+```
 
 ---
 
@@ -169,4 +169,5 @@ This project is licensed under the MIT License. See the [LICENSE](./LICENSE) fil
 
 ---
 
-_For more information about the custom board definition and the hardware design, a dedicated repository link will be added here soon._
+_For more information about the custom board definition, visit the [UIRBpio GitHub repository](https://github.com/DjordjeMandic/UIRBpio)._
+

examples/Basic/boards/uirb-v02-atmega328p.json

@@ -0,0 +1,49 @@
+{
+    "build": {
+        "core": "MiniCore",
+        "extra_flags": [
+            "-DARDUINO_AVR_ATmega328P",
+            "-DAVR8_USER_BAUDRATE=1000000",
+            "-DAVR8_SWINT_SOURCE=1",
+            "-DUIRB_BOARD_V02"
+        ],
+        "hwids": [
+            ["0x10C4", "0xEA60"],
+            ["0x10C4", "0xEA63"]
+        ],
+        "f_cpu": "8000000L",
+        "mcu": "atmega328p",
+        "variant": "standard"
+    },
+    "hardware": {
+        "oscillator": "external",
+        "uart": "uart0",
+        "bod": "2.7v",
+        "eesave": "yes",
+        "ckout": "no"
+    },
+    "bootloader": {
+        "type": "urboot",
+        "led_pin": "B5",
+        "uart0_pins": "uart0_rxd0_txd1",
+        "speed": 1000000
+    },
+    "debug": {
+        "simavr_target": "atmega328p",
+        "avr-stub": {
+            "speed": 1000000
+        }
+    },
+    "frameworks": [ "arduino" ],
+    "platforms": [ "atmelavr" ],
+    "name": "Universal IR Blaster V0.2",
+    "upload": {
+        "maximum_ram_size": 2048,
+        "maximum_size": 32768,
+        "protocol": "urclock",
+        "require_upload_port": true,
+        "speed": 1000000
+    },
+    "url": "https://www.github.com/DjordjeMandic/Universal-IR-Blaster/Hardware/v02",
+    "vendor": "Djordje Mandic"
+}

examples/Basic/platformio.ini

@@ -1,24 +1,106 @@
-; PlatformIO Project Configuration File for UIRB V0.2 Basic Example
+; PlatformIO Project Configuration File for UIRB Basic Example
 ;
-; **Requirements:**
-; - Ensure the custom UIRB V0.2 board definition is installed in PlatformIO.
+; **Overview:**
+; This configuration file sets up build and environment settings for the Universal Infrared Blaster (UIRB)
+; project using the UIRBcore library. It supports a custom UIRB V0.2 board along with other Arduino-compatible 
+; boards. Key features include customizable pin configurations, high-speed serial communication, and support 
+; for debugging.
 ;
-; **Features:**
-; - Target Platform: Atmel AVR
-; - Framework: Arduino
-; - Dependencies: UIRBcore library
-; - Upload and Serial Monitor speed set to 1000000 baud for fast communication.
-; - Includes a time filter for the serial monitor to display timestamps alongside output.
+; **Project Details:**
+; - Targets Atmel AVR microcontrollers using the Arduino framework.
+; - Focuses on the UIRB V0.2 board with expansion capabilities and a custom pin layout.
+; - Provides examples for Uno, Nano, and Pro series boards with reusable configurations.
+; - Ensures consistency across environments using shared `custom_pin_config`.
 ;
-; **Documentation:**
-; - PlatformIO Options: https://docs.platformio.org/page/projectconf.html
-; - UIRB Library and Examples: https://github.com/DjordjeMandic/UIRBcorelib
-[env:uirb-v02-atmega328p]
-platform = atmelavr
-board = uirb-v02-atmega328p    ; Custom UIRB-v02 board definition must be installed
-framework = arduino
+; **Usage Notes:**
+; - Ensure the UIRBcore library is installed (https://github.com/DjordjeMandic/UIRBcorelib).
+; - For UIRB V0.2, confirm the board definition (`uirb-v02-atmega328p`) is installed.
+; - Review and modify the `custom_pin_config` section for specific hardware setups.
+;
+; **References:**
+; - UIRBcore Library Documentation: https://github.com/DjordjeMandic/UIRBcorelib
+; - PlatformIO Documentation: https://docs.platformio.org/
+; - UIRB PlatformIO Project Example Details: https://github.com/DjordjeMandic/UIRBpio
+;
+; **Supported Environments:**
+; - [env:uirb-v02]: Default environment for UIRB V0.2 hardware.
+; - [env:uirb-v02-usbasp]: Uses USBasp for firmware uploads on the UIRB V0.2.
+; - [env:uno], [env:nano], [env:pro-16mhz-328], [env:pro-8mhz-328p]: Arduino-compatible boards.
+
+; General PlatformIO settings
+[platformio]
+name = UIRB Basic Example
+description = Basic example demonstrating the use of the UIRBcore library.
+default_envs = uirb-v02  ; Default environment to use for builds (specified below)
+
+; Common settings for all environments
+[env]
+platform = atmelavr                          ; Specifies the Atmel AVR platform (used for ATmega microcontrollers)
+framework = arduino                          ; Utilizes the Arduino framework for development
 lib_deps = 
-    djordjemandic/UIRBcorelib @ ^1.1.1  ; Depend on the latest 1.x stable version
-upload_speed = 1000000       ; High upload speed for faster programming
-monitor_speed = 1000000      ; Serial monitor baud rate
-monitor_filters = time       ; Adds timestamps to serial monitor output
+    djordjemandic/UIRBcorelib @ ^1.2.0       ; 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 = 
+    -DMONITOR_SPEED=${env.monitor_speed}     ; Define monitor speed as a preprocessor macro
+
+; Default environment for the UIRB V0.2 board with urboot bootloader
+[env:uirb-v02]
+board = uirb-v02-atmega328p                  ; Board configuration for UIRB V0.2 hardware (ATmega328P).
+                                             ; For details, see https://github.com/DjordjeMandic/UIRBpio
+build_type = release                         ; Specifies release build type
+; upload_speed = 57600                       ; Uncomment if bootloader has issues with the default upload speed
+; upload_port = COM6                         ; Uncomment and set this to specify a fixed upload port.
+                                             ; Ports are automatically detected using hardware IDs (hwids).
+
+; Environment for the UIRB V0.2 board using USBasp as the programmer
+[env:uirb-v02-usbasp]
+extends = env:uirb-v02                       ; Inherit settings from the default UIRB V0.2 environment
+upload_protocol = usbasp                     ; Use USBasp for uploading firmware
+upload_flags =                               ; Additional configuration for USBasp:
+  -PUSB                                      ; Specify USB as the upload port
+  -B8                                        ; Set SPI clock speed (divide by 8) for stable uploads
+
+; Custom pin configuration section
+[custom_pin_config]
+build_flags = 
+    -DPIN_USB_IO3=4               ; Define USB I/O pin
+    -DPIN_BUTTON_WAKEUP=2         ; Define button wakeup pin
+    -DPIN_BUTTON_OPTION_1=A1      ; Define first option button pin
+    -DPIN_BUTTON_OPTION_2=A2      ; Define second option button pin
+    -DPIN_BUTTON_OPTION_3=A3      ; Define third option button pin
+    -DPIN_PULLDOWN_RESISTOR=5     ; Define pulldown resistor pin
+    -DPIN_TX=1                    ; Define UART TX pin
+    -DPIN_RX=0                    ; Define UART RX pin
+    -DBUTTON_PIN_ACTIVE_STATE=0   ; Define active state for buttons (0 = LOW)
+    -DPIN_STAT_LED=LED_BUILTIN    ; Define status LED pin (shared with SPI SCK)
+    -DPIN_IR_LED=3                ; Define IR LED pin for IR transmission
+    -DPIN_IR_CAPTURE=8            ; Define input capture pin for IR raw signal
+    -DIR_CAPTURE_PIN_PULLUP=0     ; Disable pull-up resistor for IR capture pin
+    -DPIN_IR_RECEIVE=12           ; Define demodulating IR receiver pin
+    -DIR_RECEIVE_PIN_PULLUP=1     ; Enable pull-up resistor for IR receive pin
+    -DPIN_PROG=A0                 ; Define pin for the PROG line (TP4057 charger monitoring and control)
+
+; Arduino Uno environment
+[env:uno]
+board = uno                          ; Board definition for Arduino Uno
+build_flags = 
+    ${custom_pin_config.build_flags} ; Reuse custom pin configuration
+
+; Arduino Nano environment
+[env:nano]
+board = nano                         ; Board definition for Arduino Nano
+build_flags = 
+    ${custom_pin_config.build_flags} ; Reuse custom pin configuration
+
+; Arduino Pro 16MHz environment with ATmega328
+[env:pro-16mhz-328]
+board = pro16MHzatmega328            ; Board definition for Arduino Pro 16MHz
+build_flags = 
+    ${custom_pin_config.build_flags} ; Reuse custom pin configuration
+
+; Arduino Pro 8MHz environment with ATmega328P
+[env:pro-8mhz-328p]
+board = pro8MHzatmega328             ; Board definition for Arduino Pro 8MHz
+build_flags = 
+    ${custom_pin_config.build_flags} ; Reuse custom pin configuration

examples/Basic/Basic.ino examples/Basic/src/Basic.inoexamples/Basic/Basic.ino renamed to examples/Basic/src/Basic.ino

@@ -53,6 +53,17 @@
 #include <Arduino.h>
 #include <UIRBcore.hpp>
 
+#if defined(PLATFORMIO)
+#warning "This is a PlatformIO project. Please visit https://github.com/DjordjeMandic/UIRBpio for more details and latest boards definitions."
+#endif
+
+/* Define the baud rate for serial communication */
+#if defined(MONITOR_SPEED)
+static constexpr unsigned long BAUD_RATE = MONITOR_SPEED;  // Use user-defined monitor speed if available
+#else
+static constexpr unsigned long BAUD_RATE = 1000000;  // Default baud rate: 1M BAUD
+#endif  // !defined(MONITOR_SPEED)
+
 /* Use namespace to prevent typing uirbcore:: before each member. */
 using namespace uirbcore;
 
@@ -102,7 +113,7 @@ void io3WakeupCallback()
  */
 void setup()
 {
-    Serial.begin(1000000);
+    Serial.begin(BAUD_RATE);
     Serial.println(F("UIRBcore basic example"));
 
 

examples/BypassEEPROM/boards/uirb-v02-atmega328p.json

@@ -0,0 +1,49 @@
+{
+    "build": {
+        "core": "MiniCore",
+        "extra_flags": [
+            "-DARDUINO_AVR_ATmega328P",
+            "-DAVR8_USER_BAUDRATE=1000000",
+            "-DAVR8_SWINT_SOURCE=1",
+            "-DUIRB_BOARD_V02"
+        ],
+        "hwids": [
+            ["0x10C4", "0xEA60"],
+            ["0x10C4", "0xEA63"]
+        ],
+        "f_cpu": "8000000L",
+        "mcu": "atmega328p",
+        "variant": "standard"
+    },
+    "hardware": {
+        "oscillator": "external",
+        "uart": "uart0",
+        "bod": "2.7v",
+        "eesave": "yes",
+        "ckout": "no"
+    },
+    "bootloader": {
+        "type": "urboot",
+        "led_pin": "B5",
+        "uart0_pins": "uart0_rxd0_txd1",
+        "speed": 1000000
+    },
+    "debug": {
+        "simavr_target": "atmega328p",
+        "avr-stub": {
+            "speed": 1000000
+        }
+    },
+    "frameworks": [ "arduino" ],
+    "platforms": [ "atmelavr" ],
+    "name": "Universal IR Blaster V0.2",
+    "upload": {
+        "maximum_ram_size": 2048,
+        "maximum_size": 32768,
+        "protocol": "urclock",
+        "require_upload_port": true,
+        "speed": 1000000
+    },
+    "url": "https://www.github.com/DjordjeMandic/Universal-IR-Blaster/Hardware/v02",
+    "vendor": "Djordje Mandic"
+}