Release 4.2.1

- Add CI/CD
- Issue #20
- Fix segfault in UART receive
- Fix different compilation issues
- Add CodeRabbit for automatic reviews
- Remove __pycache__ from git tracking
- Fixes from CodeRabbit review
- Simplify RAK3172_DEFAULT_CONFIG macro definition

Closes #20

Signed-off-by: Daniel Kampert <DanielKampert@kampis-elektroecke.de>

Author: Kampi

.coderabbit.yaml

@@ -0,0 +1,35 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+language: "en-US"
+reviews:
+  profile: "chill"
+  high_level_summary: true
+  poem: false
+  collapse_walkthrough: true
+  sequence_diagrams: false
+  auto_review:
+    enabled: true
+    drafts: true
+  in_progress_fortune: false
+  tools:
+    github-checks:
+      enabled: false
+    cppcheck:
+      enabled: true
+    pylint:
+      enabled: true
+    yamllint:
+      enabled: false
+    markdownlint:
+      enabled: true
+  finishing_touches:
+    docstrings:
+      enabled: false
+    unit_tests:
+      enabled: false
+  pre_merge_checks:
+    docstrings:
+      mode: "off"
+    title:
+      mode: "off"
+chat:
+  art: false

.github/workflows/release.yaml

@@ -0,0 +1,98 @@
+name: Component
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+    branches:
+      - main
+      - dev
+    paths-ignore:
+      - '*.md'
+
+env:
+  # Master branch (main or master). Can be changed for testing
+  master_branch: master
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref }}
+
+      - name: ZIP artifact
+        shell: bash
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y zip
+          zip -r ${GITHUB_REF_NAME}.zip .
+
+    #  - name: Upload to Component registry
+    #    uses: espressif/upload-components-ci-action@v2
+    #    with:
+    #      components: "ESP32-RAK3172:."
+    #      version: ${{ env.VERSION }}
+    #      namespace: "Kampi"
+    #      api_token: ${{ secrets.IDF_COMPONENT_REGISTRY_TOKEN }}
+
+      - name: Release
+        uses: docker://antonyurchenko/git-release:v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CHANGELOG_FILE: CHANGELOG.md
+        with:
+          args: |
+            ${GITHUB_REF_NAME}.zip
+  
+  generate_outputs:
+    if: github.ref_type == 'branch'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Initialize
+        run: |
+          mkdir -p log
+          echo "DATE=$(date +'%Y-%m-%d %H:%M:%S')" >> "${GITHUB_ENV}"
+
+      - name: Get release version
+        run: |
+          BRANCH_NAME="${GITHUB_REF_NAME}"
+          echo "BRANCH_NAME=${BRANCH_NAME}"
+          BASE_VERSION="${BRANCH_NAME%%_*}"
+
+          IFS='.' read -r MAJOR MINOR BUILD <<< "${BASE_VERSION}"
+
+          echo "MAJOR=${MAJOR}" >> ${GITHUB_ENV}
+          echo "MINOR=${MINOR}" >> ${GITHUB_ENV}
+          echo "BUILD=${BUILD}" >> ${GITHUB_ENV}
+          echo "VERSION=${BASE_VERSION}" >> ${GITHUB_ENV}
+
+      - name: Update version numbers
+        shell: bash
+        run: |
+          echo "Using version: ${{ env.VERSION }}"
+          sed -i -E "s/(RAK3172_LIB_MAJOR=)[0-9]+/\1${{ env.MAJOR }}/" CMakeLists.txt
+          sed -i -E "s/(RAK3172_LIB_MINOR=)[0-9]+/\1${{ env.MINOR }}/" CMakeLists.txt
+          sed -i -E "s/(RAK3172_LIB_BUILD=)[0-9]+/\1${{ env.BUILD }}/" CMakeLists.txt
+          sed -i "s/^## \[Unreleased\]/## [${{ env.VERSION }}] - $(date +'%Y-%m-%d')/" CHANGELOG.md
+          sed -i -E "s/^version: \".*\"/version: \"${{ env.VERSION }}\"/" idf_component.yml
+
+      - name: Push outputs
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          branch: ${{ github.ref_name }}
+          commit_message: Push outputs from CI/CD (${{ env.DATE }})

.gitignore

@@ -1,3 +1,6 @@
 desktop.ini
 *.log
-.vscode
+.vscode
+
+__pycache__
+dist

CHANGELOG.md

@@ -1,6 +1,6 @@
 # CHANGELOG
 
-## [4.2.0] - 
+## [4.2.1] - 2025-11-09
 
 **Fixed:**
 
@@ -10,14 +10,15 @@
 - Fix wrong length for long payload in `RAK3172_LoRaWAN_Transmit`
 - Fix missing transmission confirmation in unconfirmed mode in `RAK3172_LoRaWAN_Transmit`
 - Fix different smaller errors
+- Fix segfault caused by a timeout in UART driver for ESP32 when using module firmware version 1.0.4 and below
 
 **Added:**
 
 - Add `RAK3172_ERR_WRONG_PORT` error for LoRaWAN
 - Add `RAK3172_ERR_CLASS_B_DISABLED` error for class B devices
 - Add device class to driver object
-- Added `isMulticast` field to `RAK3172_Rx_t` object
-- Added `AT_NO_NETWORK_JOINED` error to `RAK3172_LoRaWAN_Transmit`
+- Add `isMulticast` field to `RAK3172_Rx_t` object
+- Add `AT_NO_NETWORK_JOINED` error to `RAK3172_LoRaWAN_Transmit`
 - Add `RAK3172_LoRaWAN_SetClass` and `RAK3172_LoRaWAN_GetClass` function
 - Add arch specific watchdog
 - Add `RAK3172_isBusy` function
@@ -31,23 +32,23 @@
 **Added (EXPERIMENTAL):**
 
 - Add FUOTA support for the host CPU via LoRaWAN
-- Add clock synchronization support for the host CPU via LoRaWAN
+- Add clock synchronization v1.0.0 support for the host CPU via LoRaWAN
 
 **Changed:**
 
-- Remove RUI3 option in `RAK3172_FactoryReset`
 - Improve error check in class B and multicast driver and add a check for the current device mode
 - Set `Retries` in `RAK3172_LoRaWAN_Transmit` as optional parameter
 - Swap `Retries` and `Confirmed` in `RAK3172_LoRaWAN_Transmit`
-- Remove overloaded `RAK3172_LoRaWAN_Transmit`
 - Clean up CMakeLists.txt
 - Update examples
 - Update documentation
-- Update README
-- Update CHANGELOG
-- Change version number to 4.2.0
 
-## [4.1.1] - 21.04.2023
+**Removed:**
+
+- Remove overloaded `RAK3172_LoRaWAN_Transmit`
+- Remove RUI3 option in `RAK3172_FactoryReset`
+
+## [4.1.1] - 2023-04-21
 
 **Fixed:**
 
@@ -61,7 +62,7 @@
 - Update CHANGELOG
 - Change version number to 4.1.1
 
-## [4.1.0] - 01.04.2023
+## [4.1.0] - 2023-04-01
 
 **Fixed:**
 
@@ -123,7 +124,7 @@
 - Rework CHANGELOG layout
 - Change version number to 4.1.0
 
-## [4.0.0] - 09.09.2022
+## [4.0.0] - 2022-09-09
 
 **Fixed:**
 
@@ -162,7 +163,7 @@
 - Update CHANGELOG
 - Change version number to 4.0.0
 
-## [3.0.0] - 22.05.2022
+## [3.0.0] - 2022-05-22
 
 **Added:**
 
@@ -179,7 +180,7 @@
 - Update CHANGELOG
 - Change version number to 3.0.0
 
-## [2.0.0] - 22.03.2022
+## [2.0.0] - 2022-03-22
 
 **Added:**
 
@@ -195,7 +196,7 @@
 - Update CHANGELOG
 - Change version number to 2.0.0
 
-## [1.0.0] - 19.03.2022
+## [1.0.0] - 2022-05-19
 
 **Added:**
 

CMakeLists.txt

@@ -28,15 +28,11 @@ if(CONFIG_RAK3172_MODE_WITH_LORAWAN)
     endif()
 endif()
 
-if(CONFIG_RAK3172_MODE_WITH_LORAWAN)
+if(CONFIG_RAK3172_MODE_WITH_P2P)
     list(APPEND COMPONENT_SRCS "src/Modes/P2P/rak3172_p2p.cpp")
     list(APPEND COMPONENT_SRCS "src/Modes/P2P/rak3172_p2p_rui3.cpp")
 endif()
 
-if(CONFIG_RAK3172_MODE_WITH_RF)
-    list(APPEND COMPONENT_SRCS "src/Modes/RF/rak3172_rf.cpp")
-endif()
-
 if((IDF_TARGET STREQUAL "esp32") OR (IDF_TARGET STREQUAL "esp32c2") OR (IDF_TARGET STREQUAL "esp32c3") OR (IDF_TARGET STREQUAL "esp32s2") OR (IDF_TARGET STREQUAL "esp32s3"))
 	list(APPEND COMPONENT_PRIV_REQUIRES esp_timer)
 	list(APPEND COMPONENT_SRCS "src/Arch/Timer/rak3172_timer.cpp")
@@ -58,4 +54,4 @@ idf_component_register(SRCS ${COMPONENT_SRCS}
 
 target_compile_definitions(${COMPONENT_LIB} PUBLIC RAK3172_LIB_MAJOR=4)
 target_compile_definitions(${COMPONENT_LIB} PUBLIC RAK3172_LIB_MINOR=2)
-target_compile_definitions(${COMPONENT_LIB} PUBLIC RAK3172_LIB_BUILD=0)
+target_compile_definitions(${COMPONENT_LIB} PUBLIC RAK3172_LIB_BUILD=1)

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Daniel Kampert (www.kampis-elektroecke.de)
+Copyright (c) 2025 Daniel Kampert (www.kampis-elektroecke.de)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -9,7 +9,7 @@
   - [Clock Synchronization](#clock-synchronization)
   - [Use with PlatformIO](#use-with-platformio)
   - [Use with esp-idf](#use-with-esp-idf)
-  - [Additional ressources](#additional-ressources)
+  - [Additional resources](#additional-resources)
   - [Support me](#support-me)
   - [Maintainer](#maintainer)
 
@@ -48,7 +48,7 @@ lib_deps =
 - Run `menuconfig` from the root of your project to configure the driver and the examples
 - Build the project
 
-## Additional ressources
+## Additional resources
 
 - [ST AN5554](https://www.st.com/resource/en/application_note/an5554-lorawan-firmware-update-over-the-air-with-stm32cubewl-stmicroelectronics.pdf)
 - [LoRaWAN Fragmented Data Block Transport Specification](https://lora-alliance.org/resource_hub/lorawan-fragmented-data-block-transport-specification-v1-0-0/)
@@ -63,4 +63,4 @@ If you are interested in the RAK3172 modules or in other RAKwireless products, y
 
 ## Maintainer
 
-- [Daniel Kampert](mailto:daniel.kameprt@kampis-elektroecke.de)
+- [Daniel Kampert](mailto:DanielKampert@kampis-elektroecke.de)

examples/ClockSynchronization/Device/main.cpp

@@ -10,6 +10,8 @@
 #include "settings/LoRaWAN_Default.h"
 
 static RAK3172_t _Device                        = RAK3172_DEFAULT_CONFIG(CONFIG_RAK3172_UART_PORT, CONFIG_RAK3172_UART_RX, CONFIG_RAK3172_UART_TX, CONFIG_RAK3172_UART_BAUD);
+
+// WARNING: These are example keys only. Replace with your actual multicast group credentials.
 static RAK3172_MC_Group_t _Group = {
     .Class          = RAK_CLASS_C,
     .DevAddr        = "B8DD8FDB",
@@ -39,6 +41,8 @@ static void applicationTask(void* p_Parameter)
     if(Error != RAK3172_ERR_OK)
     {
         ESP_LOGE(TAG, "Cannot initialize RAK3172! Error: 0x%04X", static_cast<unsigned int>(Error));
+        vTaskDelay(5000 / portTICK_PERIOD_MS);
+        esp_restart();
     }
 
     ESP_LOGI(TAG, "Firmware: %s", Info.Firmware.c_str());
@@ -49,6 +53,8 @@ static void applicationTask(void* p_Parameter)
     if(Error != RAK3172_ERR_OK)
     {
         ESP_LOGE(TAG, "Cannot initialize RAK3172 LoRaWAN! Error: 0x%04X", static_cast<unsigned int>(Error));
+        vTaskDelay(5000 / portTICK_PERIOD_MS);
+        esp_restart();
     }
 
     if(RAK3172_LoRaWAN_isJoined(_Device) == false)
@@ -59,6 +65,8 @@ static void applicationTask(void* p_Parameter)
         if(Error != RAK3172_ERR_OK)
         {
             ESP_LOGE(TAG, "Cannot join network! Error: 0x%04X", static_cast<unsigned int>(Error));
+            vTaskDelay(5000 / portTICK_PERIOD_MS);
+            esp_restart();
         }
     }
     else
@@ -90,15 +98,15 @@ static void applicationTask(void* p_Parameter)
             ESP_LOGE(TAG, "Clock sync failed! Error: 0x%X", static_cast<unsigned int>(Error));
         }
 
-        vTaskDelay(10000 / portTICK_PERIOD_MS);
+        vTaskDelay(3600000 / portTICK_PERIOD_MS);
     }
 }
 
 extern "C" void app_main(void)
 {
     ESP_LOGI(TAG, "Starting application...");
 
-    _applicationHandle = xTaskCreateStatic(applicationTask, "applicationTask", sizeof(_applicationStack), NULL, 1, _applicationStack, &_applicationBuffer);
+    _applicationHandle = xTaskCreateStatic(applicationTask, "applicationTask", 8192, NULL, 1, _applicationStack, &_applicationBuffer);
     if(_applicationHandle == NULL)
     {
         ESP_LOGE(TAG, "    Unable to create application task!");