feat(refactor): Restructure project for improved modularity and clarity

This commit introduces a major refactoring of the project structure to align
with Zephyr's recommended multi-application and library organization.

Key changes include:
- Relocation of custom modules from 'software/modules/' to 'software/lib/'.
- Introduction of a central 'software/CMakeLists.txt' to manage application
  and library subdirectories.
- Creation of new Kconfig files for 'software/' and 'software/apps/slave_node/'
  to define project-wide and application-specific configurations.
- Removal of the 'gateway' and 'stm32g431_tests' applications.
- Removal of 'shell_modbus.c' and 'shell_system.c' from 'slave_node' application's
  direct source files, indicating a shift towards library-based shell commands.
- Updates to 'software/apps/slave_node/CMakeLists.txt', 'prj.conf', and
  'boards/bluepill_f103rb.conf' to reflect the new structure and dependencies.

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "files.associations": {
+        "fwu.h": "c"
+    }
+}

README.de.md

@@ -1,3 +1,5 @@
+<img src="./docs/img/logo.png" alt="Logo" width="100"/>
+
 🇩🇪 Deutsch | [🇬🇧 English](README.md) | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md)
 
 # Modulares Bewässerungssystem
@@ -11,6 +13,8 @@ Die detaillierte Dokumentation befindet sich im Verzeichnis [`docs/`](./docs/):
 *   **[Konzept](./docs/concept.de.md)**: Beschreibt die Systemarchitektur, die verwendeten Komponenten und die grundlegenden Design-Entscheidungen.
 *   **[MODBUS Register](./docs/modbus-registers.de.md)**: Definiert die Register-Map für die Kommunikation mit den Slave-Nodes.
 *   **[Projektplan](./docs/planning.de.md)**: Enthält den Entwicklungs- und Implementierungsplan.
+*   **[Firmware-Handbuch](./docs/firmware-manual.de.md)**: Beschreibt den Funktionsumfang und die Bedienung der Slave-Node-Firmware.
+*   **[Modbus Test-Tool](./software/tools/modbus_tool/README.de.md)**: Anleitung für das Python-basierte Kommandozeilen-Tool zum Testen der Slaves.
 
 ## Schnellstart
 

README.es.md

@@ -1,3 +1,5 @@
+<img src="./docs/img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](README.de.md) | [🇬🇧 English](README.md) | [🇫🇷 Français](README.fr.md) | 🇪🇸 Español
 
 # Sistema de riego modular

README.fr.md

@@ -1,3 +1,5 @@
+<img src="./docs/img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](README.de.md) | [🇬🇧 English](README.md) | 🇫🇷 Français | [🇪🇸 Español](README.es.md)
 
 # Système d'irrigation modulaire

README.md

@@ -1,3 +1,5 @@
+<img src="./docs/img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](README.de.md) | 🇬🇧 English | [🇫🇷 Français](README.fr.md) | [🇪🇸 Español](README.es.md)
 
 # Modular Irrigation System

docs/concept.de.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 🇩🇪 Deutsch | [🇬🇧 English](concept.en.md) | [🇫🇷 Français](concept.fr.md) | [🇪🇸 Español](concept.es.md)
 
 # Konzept: Modulares Bewässerungssystem

docs/concept.en.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](concept.de.md) | 🇬🇧 English | [🇫🇷 Français](concept.fr.md) | [🇪🇸 Español](concept.es.md)
 
 # Concept: Modular Irrigation System

docs/concept.es.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](concept.de.md) | [🇬🇧 English](concept.en.md) | [🇫🇷 Français](concept.fr.md) | 🇪🇸 Español
 
 # Concepto: Sistema de riego modular

docs/concept.fr.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](concept.de.md) | [🇬🇧 English](concept.en.md) | 🇫🇷 Français | [🇪🇸 Español](concept.es.md)
 
 # Concept : Système d'irrigation modulaire

docs/img/logo.svg

@@ -0,0 +1,16 @@
+<svg width="100" height="120" viewBox="0 0 100 120" xmlns="http://www.w3.org/2000/svg" aria-labelledby="logoTitle">
+  <title id="logoTitle">Logo: Wassertropfen mit integriertem Chip</title>
+  
+  <path 
+    d="M50 115 C 85 85, 95 65, 95 45 A 45 45 0 1 0 5 45 C 5 65, 15 85, 50 115 Z" 
+    fill="#2563EB" 
+  />
+  
+  <g fill="#FFFFFF">
+    <rect x="25" y="35" width="50" height="8" rx="2"/>
+    <rect x="25" y="50" width="35" height="8" rx="2"/>
+    <rect x="70" y="50" width="5" height="8" rx="2"/>
+    <rect x="25" y="65" width="50" height="8" rx="2"/>
+  </g>
+  
+</svg>

docs/modbus-registers.de.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 🇩🇪 Deutsch | [🇬🇧 English](modbus-registers.en.md) | [🇫🇷 Français](modbus-registers.fr.md) | [🇪🇸 Español](modbus-registers.es.md)
 
 # MODBUS Register Map Definition v1.0
@@ -47,6 +49,7 @@ Alle Register sind in einer einzigen, durchgehenden Liste pro Register-Typ (`Inp
 | **0x0002** | `MAX_SCHLIESSZEIT_S`          | Ventil            | Sicherheits-Timeout in Sekunden für den Schliessen-Vorgang.                                                                                |
 | **0x0010** | `DIGITAL_AUSGAENGE_ZUSTAND`   | Ausgänge          | Bitmaske zum Lesen und Schreiben der Ausgänge. Bit 0: Ausgang 1, Bit 1: Ausgang 2. `1`=AN, `0`=AUS.                                         |
 | **0x00F0** | `WATCHDOG_TIMEOUT_S`          | System            | Timeout des Fail-Safe-Watchdogs in Sekunden. `0`=Deaktiviert.                                                                             |
+| **0x00F1** | `DEVICE_RESET`                | System            | Schreibt `1` um das Gerät neu zu starten.                                                                                                 |
 | **0x0100** | `FWU_COMMAND`                 | Firmware-Update   | `1`: **Verify Chunk**: Der zuletzt übertragene Chunk wurde vom Client als gültig befunden. Der Slave soll ihn nun ins Flash schreiben. `2`: **Finalize Update**: Alle Chunks sind übertragen. Installation abschliessen und neu starten. |
 | **0x0101** | `FWU_CHUNK_OFFSET_LOW`        | Firmware-Update   | Untere 16 Bit des 32-Bit-Offsets, an den der nächste Chunk geschrieben werden soll.                                                         |
 | **0x0102** | `FWU_CHUNK_OFFSET_HIGH`       | Firmware-Update   | Obere 16 Bit des 32-Bit-Offsets.                                                                                                          |

docs/modbus-registers.en.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](modbus-registers.de.md) | 🇬🇧 English | [🇫🇷 Français](modbus-registers.fr.md) | [🇪🇸 Español](modbus-registers.es.md)
 
 # MODBUS Register Map Definition v1.0

docs/modbus-registers.es.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](modbus-registers.de.md) | [🇬🇧 English](modbus-registers.en.md) | [🇫🇷 Français](modbus-registers.fr.md) | 🇪🇸 Español
 
 # Definición del mapa de registros MODBUS v1.0

docs/modbus-registers.fr.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](modbus-registers.de.md) | [🇬🇧 English](modbus-registers.en.md) | 🇫🇷 Français | [🇪🇸 Español](modbus-registers.es.md)
 
 # Définition de la carte des registres MODBUS v1.0

docs/planning.de.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 🇩🇪 Deutsch | [🇬🇧 English](planning.en.md) | [🇫🇷 Français](planning.fr.md) | [🇪🇸 Español](planning.es.md)
 
 # Projektplan: Modulares Bewässerungssystem

docs/planning.en.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](planning.de.md) | 🇬🇧 English | [🇫🇷 Français](planning.fr.md) | [🇪🇸 Español](planning.es.md)
 
 # Project Plan: Modular Irrigation System

docs/planning.es.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](planning.de.md) | [🇬🇧 English](planning.en.md) | [🇫🇷 Français](planning.fr.md) | 🇪🇸 Español
 
 # Plan del proyecto: Sistema de riego modular

docs/planning.fr.md

@@ -1,3 +1,5 @@
+<img src="./img/logo.png" alt="Logo" width="100"/>
+
 [🇩🇪 Deutsch](planning.de.md) | [🇬🇧 English](planning.en.md) | 🇫🇷 Français | [🇪🇸 Español](planning.es.md)
 
 # Plan de projet : Système d'irrigation modulaire

lib/fwu/CMakeLists.txt

@@ -0,0 +1,6 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(fwu)
+
+target_sources(fwu PRIVATE src/fwu.c)
+target_include_directories(fwu PUBLIC include)

lib/modbus_server/CMakeLists.txt

@@ -0,0 +1,6 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(modbus_server)
+
+target_sources(modbus_server PRIVATE src/modbus_server.c)
+target_include_directories(modbus_server PUBLIC include)

lib/valve/CMakeLists.txt

@@ -0,0 +1,6 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(valve)
+
+target_sources(valve PRIVATE src/valve.c)
+target_include_directories(valve PUBLIC include)

software/Kconfig

@@ -0,0 +1 @@
+rsource "lib/Kconfig"

software/apps/slave_node/CMakeLists.txt

@@ -1,10 +1,8 @@
 cmake_minimum_required(VERSION 3.20)
 
-# Point BOARD_ROOT and DTS_ROOT to the 'software' directory, which contains 'boards'.
-list(APPEND BOARD_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../..)
-list(APPEND DTS_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../..)
-
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
-project(slave_node)
 
+project(slave_node LANGUAGES C)
+zephyr_include_directories(../../include)
+add_subdirectory(../../lib lib)
 target_sources(app PRIVATE src/main.c)

software/apps/slave_node/Kconfig

@@ -0,0 +1,2 @@
+rsource "../../lib/Kconfig"
+source "Kconfig.zephyr"

software/apps/slave_node/boards/bluepill_f103rb.conf

@@ -0,0 +1,7 @@
+# Disable UART console
+CONFIG_UART_CONSOLE=n
+
+# Enable RTT console
+CONFIG_RTT_CONSOLE=y
+CONFIG_USE_SEGGER_RTT=y
+CONFIG_SHELL_BACKEND_RTT=y

software/apps/slave_node/boards/bluepill_f103rb.overlay

@@ -0,0 +1,43 @@
+/ {
+    chosen {
+        zephyr,console = &rtt;
+        zephyr,shell = &rtt;
+        zephyr,settings-partition = &storage_partition;
+    };
+
+    rtt: rtt {
+        compatible = "segger,rtt-uart";
+        #address-cells = <1>;
+        #size-cells = <0>;
+        label = "RTT";
+        status = "okay";
+    };
+};
+
+&flash0 {
+    partitions {
+        compatible = "fixed-partitions";
+        #address-cells = <1>;
+        #size-cells = <1>;
+
+        /* Application partition starts at the beginning of flash */
+        slot0_partition: partition@0 {
+            label = "image-0";
+            reg = <0x00000000 DT_SIZE_K(120)>;
+        };
+
+        /* Use the last 8K for settings */
+        storage_partition: partition@1E000 {
+            label = "storage";
+            reg = <0x0001E000 DT_SIZE_K(8)>;
+        };
+    };
+};
+
+&usart1 {
+	modbus0 {
+		compatible = "zephyr,modbus-serial";
+		status = "okay";
+	};
+	status = "okay";
+};

software/apps/slave_node/boards/weact_stm32g431_core.overlay

@@ -0,0 +1,9 @@
+&usart1 {
+	modbus0 {
+		compatible = "zephyr,modbus-serial";
+		status = "okay";
+	};
+	status = "okay";
+    pinctrl-0 = <&usart1_tx_pa9 &usart1_rx_pa10>;
+    pinctrl-names = "default";
+};

software/apps/slave_node/cdc-acm.overlay

@@ -0,0 +1,10 @@
+&zephyr_udc0 {
+	cdc_acm_uart0: cdc_acm_uart0 {
+		compatible = "zephyr,cdc-acm-uart";
+
+		modbus0 {
+			compatible = "zephyr,modbus-serial";
+			status = "okay";
+		};
+	};
+};

software/apps/slave_node/overlay-cdc-acm.conf

@@ -0,0 +1,4 @@
+CONFIG_USB_DEVICE_STACK=y
+CONFIG_USB_DEVICE_PRODUCT="Modbus slave node"
+CONFIG_UART_LINE_CTRL=y
+CONFIG_USB_DEVICE_INITIALIZE_AT_BOOT=n

software/apps/slave_node/prj.conf

@@ -1,7 +1,23 @@
-# --- Base Slave Node Config ---
-CONFIG_GPIO=y
+# Enable Console and printk for logging
+CONFIG_CONSOLE=y
+CONFIG_LOG=y
+
+# Enable Shell
+CONFIG_SHELL=y
+CONFIG_REBOOT=y
+
+# Enable Settings Subsystem
+CONFIG_SETTINGS=y
+CONFIG_SETTINGS_NVS=y
+CONFIG_NVS=y
+CONFIG_FLASH=y
+CONFIG_FLASH_MAP=y
+CONFIG_FLASH_PAGE_LAYOUT=y
+CONFIG_SETTINGS_LOG_LEVEL_DBG=y
+
+# Config modbus
+CONFIG_UART_INTERRUPT_DRIVEN=y
+CONFIG_MODBUS=y
+CONFIG_MODBUS_ROLE_SERVER=y
+CONFIG_MODBUS_BUFFER_SIZE=256
 
-# Use RTT for console output instead of UART
-CONFIG_USE_SEGGER_RTT=y
-CONFIG_RTT_CONSOLE=y
-CONFIG_UART_CONSOLE=n

software/apps/slave_node/src/main.c

@@ -1,16 +1,28 @@
-/*
- * Copyright (c) 2025 Eduard Iten
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
 #include <zephyr/kernel.h>
+#include <zephyr/settings/settings.h>
+#include <zephyr/logging/log.h>
+#include <lib/modbus_server.h>
+#include <lib/valve.h>
+#include <lib/fwu.h>
+
+LOG_MODULE_REGISTER(main, LOG_LEVEL_INF);
 
 int main(void)
 {
-	while (1) {
-		printk("Hello from Slave Node!\n");
-		k_msleep(1000);
+	LOG_INF("Starting Irrigation System Slave Node");
+
+	if (settings_subsys_init() || settings_load()) {
+		LOG_ERR("Settings initialization or loading failed");
 	}
+
+	valve_init();
+	fwu_init();
+
+	if (modbus_server_init()) {
+		LOG_ERR("Modbus RTU server initialization failed");
+		return 0;
+	}
+	
+	LOG_INF("Irrigation System Slave Node started successfully");
 	return 0;
 }

software/include/lib/fwu.h

@@ -0,0 +1,10 @@
+#ifndef FWU_H
+#define FWU_H
+
+#include <stdint.h>
+
+void fwu_init(void);
+void fwu_handler(uint16_t addr, uint16_t reg);
+uint16_t fwu_get_last_chunk_crc(void);
+
+#endif // FWU_H

software/include/lib/modbus_server.h

@@ -0,0 +1,52 @@
+#ifndef MODBUS_SERVER_H
+#define MODBUS_SERVER_H
+
+#include <stdint.h>
+
+/**
+ * @brief Modbus Input Register Addresses.
+ */
+enum {
+	/* Valve Control & Status */
+	REG_INPUT_VALVE_STATE_MOVEMENT        = 0x0000,
+	REG_INPUT_MOTOR_CURRENT_MA            = 0x0001,
+	/* Digital Inputs */
+	REG_INPUT_DIGITAL_INPUTS_STATE        = 0x0020,
+	REG_INPUT_BUTTON_EVENTS               = 0x0021,
+	/* System Config & Status */
+	REG_INPUT_FIRMWARE_VERSION_MAJOR_MINOR = 0x00F0,
+	REG_INPUT_FIRMWARE_VERSION_PATCH      = 0x00F1,
+	REG_INPUT_DEVICE_STATUS               = 0x00F2,
+	REG_INPUT_UPTIME_SECONDS_LOW          = 0x00F3,
+	REG_INPUT_UPTIME_SECONDS_HIGH         = 0x00F4,
+	/* Firmware Update */
+	REG_INPUT_FWU_LAST_CHUNK_CRC          = 0x0100,
+};
+
+/**
+ * @brief Modbus Holding Register Addresses.
+ */
+enum {
+	/* Valve Control */
+	REG_HOLDING_VALVE_COMMAND             = 0x0000,
+	REG_HOLDING_MAX_OPENING_TIME_S        = 0x0001,
+	REG_HOLDING_MAX_CLOSING_TIME_S        = 0x0002,
+	/* Digital Outputs */
+	REG_HOLDING_DIGITAL_OUTPUTS_STATE     = 0x0010,
+	/* System Config */
+	REG_HOLDING_WATCHDOG_TIMEOUT_S        = 0x00F0,
+	REG_HOLDING_DEVICE_RESET              = 0x00F1,
+	/* Firmware Update */
+	REG_HOLDING_FWU_COMMAND               = 0x0100,
+	REG_HOLDING_FWU_CHUNK_OFFSET_LOW      = 0x0101,
+	REG_HOLDING_FWU_CHUNK_OFFSET_HIGH     = 0x0102,
+	REG_HOLDING_FWU_CHUNK_SIZE            = 0x0103,
+	REG_HOLDING_FWU_DATA_BUFFER           = 0x0180,
+};
+
+int modbus_server_init(void);
+int modbus_reconfigure(uint32_t baudrate, uint8_t unit_id);
+uint32_t modbus_get_baudrate(void);
+uint8_t modbus_get_unit_id(void);
+
+#endif // MODBUS_SERVER_H

software/include/lib/valve.h

@@ -0,0 +1,23 @@
+#ifndef VALVE_H
+#define VALVE_H
+
+#include <stdint.h>
+
+enum valve_state { VALVE_STATE_CLOSED, VALVE_STATE_OPEN };
+enum valve_movement { VALVE_MOVEMENT_IDLE, VALVE_MOVEMENT_OPENING, VALVE_MOVEMENT_CLOSING, VALVE_MOVEMENT_ERROR };
+
+void valve_init(void);
+void valve_open(void);
+void valve_close(void);
+void valve_stop(void);
+
+enum valve_state valve_get_state(void);
+enum valve_movement valve_get_movement(void);
+uint16_t valve_get_motor_current(void);
+
+void valve_set_max_open_time(uint16_t seconds);
+void valve_set_max_close_time(uint16_t seconds);
+uint16_t valve_get_max_open_time(void);
+uint16_t valve_get_max_close_time(void);
+
+#endif // VALVE_H

software/lib/CMakeLists.txt

@@ -1,4 +1,5 @@
-# Add your shared libraries here
-# Example:
-# add_library(modbus modbus/modbus.c)
-# target_include_directories(modbus PUBLIC .)
+add_subdirectory_ifdef(CONFIG_LIB_FWU fwu)
+add_subdirectory_ifdef(CONFIG_LIB_MODBUS_SERVER modbus_server)
+add_subdirectory_ifdef(CONFIG_LIB_VALVE valve)
+add_subdirectory_ifdef(CONFIG_SHELL_SYSTEM shell_system)
+add_subdirectory_ifdef(CONFIG_SHELL_MODBUS shell_modbus)

software/lib/Kconfig

@@ -0,0 +1,8 @@
+menu "Irrigation system software libraries"
+
+rsource "fwu/Kconfig"
+rsource "modbus_server/Kconfig"
+rsource "valve/Kconfig"
+rsource "shell_system/Kconfig"
+rsource "shell_modbus/Kconfig"
+endmenu

software/lib/fwu/CMakeLists.txt

@@ -0,0 +1 @@
+zephyr_library_sources(fwu.c)

software/lib/fwu/Kconfig

@@ -0,0 +1,5 @@
+config LIB_FWU
+    bool "Enable Firmware Update Library"
+    default y
+    help
+      Enable the Firmware Update Library.

software/lib/fwu/fwu.c

@@ -0,0 +1,45 @@
+#include <zephyr/kernel.h>
+#include <zephyr/sys/crc.h>
+#include <zephyr/sys/byteorder.h>
+#include <zephyr/logging/log.h>
+#include <lib/fwu.h>
+
+LOG_MODULE_REGISTER(fwu, LOG_LEVEL_INF);
+
+#define FWU_BUFFER_SIZE 256
+static uint8_t fwu_buffer[FWU_BUFFER_SIZE];
+static uint32_t fwu_chunk_offset = 0;
+static uint16_t fwu_chunk_size = 0;
+static uint16_t fwu_last_chunk_crc = 0;
+
+void fwu_init(void) {}
+
+void fwu_handler(uint16_t addr, uint16_t reg)
+{
+    // This is a simplified handler. In a real scenario, you would have a proper mapping
+    // between register addresses and actions.
+    if (addr == 0x0100) { // FWU_COMMAND
+        if (reg == 1) { LOG_INF("FWU: Chunk at offset %u (size %u) verified.", fwu_chunk_offset, fwu_chunk_size); }
+        else if (reg == 2) { LOG_INF("FWU: Finalize command received. Rebooting (simulated)."); }
+    } else if (addr == 0x0101) { // FWU_CHUNK_OFFSET_LOW
+        fwu_chunk_offset = (fwu_chunk_offset & 0xFFFF0000) | reg;
+    } else if (addr == 0x0102) { // FWU_CHUNK_OFFSET_HIGH
+        fwu_chunk_offset = (fwu_chunk_offset & 0x0000FFFF) | ((uint32_t)reg << 16);
+    } else if (addr == 0x0103) { // FWU_CHUNK_SIZE
+        fwu_chunk_size = (reg > FWU_BUFFER_SIZE) ? FWU_BUFFER_SIZE : reg;
+    } else if (addr >= 0x0180 && addr < (0x0180 + (FWU_BUFFER_SIZE / 2))) {
+        uint16_t index = (addr - 0x0180) * 2;
+        if (index < sizeof(fwu_buffer)) {
+            sys_put_be16(reg, &fwu_buffer[index]);
+            if (index + 2 >= fwu_chunk_size) {
+                fwu_last_chunk_crc = crc16_ccitt(0xffff, fwu_buffer, fwu_chunk_size);
+                LOG_INF("FWU: Chunk received, CRC is 0x%04X", fwu_last_chunk_crc);
+            }
+        }
+    }
+}
+
+uint16_t fwu_get_last_chunk_crc(void)
+{
+    return fwu_last_chunk_crc;
+}

software/lib/modbus_server/CMakeLists.txt

@@ -0,0 +1 @@
+zephyr_library_sources(modbus_server.c)

software/lib/modbus_server/Kconfig

@@ -0,0 +1,5 @@
+config LIB_MODBUS_SERVER
+    bool "Enable Modbus Server Library"
+    default y
+    help
+      Enable the Modbus Server Library.

software/lib/modbus_server/modbus_server.c

@@ -0,0 +1,202 @@
+#include <zephyr/kernel.h>
+#include <zephyr/drivers/uart.h>
+#include <zephyr/device.h>
+#include <zephyr/modbus/modbus.h>
+#include <zephyr/logging/log.h>
+#include <zephyr/settings/settings.h>
+#include <zephyr/sys/reboot.h>
+#include <lib/modbus_server.h>
+#include <lib/valve.h>
+#include <lib/fwu.h>
+
+#include <zephyr/usb/usb_device.h>
+
+LOG_MODULE_REGISTER(modbus_server, LOG_LEVEL_INF);
+
+static int modbus_iface;
+static struct modbus_iface_param server_param = {
+	.mode = MODBUS_MODE_RTU,
+	.server = {.user_cb = NULL, .unit_id = 1},
+	.serial = {.baud = 19200, .parity = UART_CFG_PARITY_NONE},
+};
+
+static uint16_t watchdog_timeout_s = 0;
+static struct k_timer watchdog_timer;
+
+static void watchdog_timer_handler(struct k_timer *timer_id)
+{
+	LOG_WRN("Modbus watchdog expired! Closing valve as a fail-safe.");
+	valve_close();
+}
+
+static inline void reset_watchdog(void)
+{
+	if (watchdog_timeout_s > 0)
+	{
+		k_timer_start(&watchdog_timer, K_SECONDS(watchdog_timeout_s), K_NO_WAIT);
+	}
+}
+
+static int holding_reg_rd(uint16_t addr, uint16_t *reg)
+{
+	reset_watchdog();
+	switch (addr)
+	{
+	case REG_HOLDING_MAX_OPENING_TIME_S:
+		*reg = valve_get_max_open_time();
+		break;
+	case REG_HOLDING_MAX_CLOSING_TIME_S:
+		*reg = valve_get_max_close_time();
+		break;
+	case REG_HOLDING_WATCHDOG_TIMEOUT_S:
+		*reg = watchdog_timeout_s;
+		break;
+	default:
+		*reg = 0;
+		break;
+	}
+	return 0;
+}
+
+static int holding_reg_wr(uint16_t addr, uint16_t reg)
+{
+	reset_watchdog();
+	switch (addr)
+	{
+	case REG_HOLDING_VALVE_COMMAND:
+		if (reg == 1)
+		{
+			valve_open();
+		}
+		else if (reg == 2)
+		{
+			valve_close();
+		}
+		else if (reg == 0)
+		{
+			valve_stop();
+		}
+		break;
+	case REG_HOLDING_MAX_OPENING_TIME_S:
+		valve_set_max_open_time(reg);
+		break;
+	case REG_HOLDING_MAX_CLOSING_TIME_S:
+		valve_set_max_close_time(reg);
+		break;
+	case REG_HOLDING_WATCHDOG_TIMEOUT_S:
+		watchdog_timeout_s = reg;
+		if (watchdog_timeout_s > 0)
+		{
+			LOG_INF("Watchdog enabled with %u s timeout.", watchdog_timeout_s);
+			reset_watchdog();
+		}
+		else
+		{
+			LOG_INF("Watchdog disabled.");
+			k_timer_stop(&watchdog_timer);
+		}
+		break;
+	case REG_HOLDING_DEVICE_RESET:
+		if (reg == 1)
+		{
+			LOG_WRN("Modbus reset command received. Rebooting...");
+			sys_reboot(SYS_REBOOT_WARM);
+		}
+		break;
+	default:
+		fwu_handler(addr, reg);
+		break;
+	}
+	return 0;
+}
+
+static int input_reg_rd(uint16_t addr, uint16_t *reg)
+{
+	reset_watchdog();
+	uint32_t uptime_s = k_uptime_get_32() / 1000;
+	switch (addr)
+	{
+	case REG_INPUT_VALVE_STATE_MOVEMENT:
+		*reg = (valve_get_movement() << 8) | (valve_get_state() & 0xFF);
+		break;
+	case REG_INPUT_MOTOR_CURRENT_MA:
+		*reg = valve_get_motor_current();
+		break;
+	case REG_INPUT_UPTIME_SECONDS_LOW:
+		*reg = (uint16_t)(uptime_s & 0xFFFF);
+		break;
+	case REG_INPUT_UPTIME_SECONDS_HIGH:
+		*reg = (uint16_t)(uptime_s >> 16);
+		break;
+	case REG_INPUT_FWU_LAST_CHUNK_CRC:
+		*reg = fwu_get_last_chunk_crc();
+		break;
+	case REG_INPUT_FIRMWARE_VERSION_MAJOR_MINOR:
+		*reg = (0 << 8) | 0;
+		break;
+	case REG_INPUT_FIRMWARE_VERSION_PATCH:
+		*reg = 2;
+		break;
+	default:
+		*reg = 0;
+		break;
+	}
+	return 0;
+}
+
+static struct modbus_user_callbacks mbs_cbs = {
+	.holding_reg_rd = holding_reg_rd,
+	.holding_reg_wr = holding_reg_wr,
+	.input_reg_rd = input_reg_rd,
+};
+
+#define MODBUS_NODE DT_COMPAT_GET_ANY_STATUS_OKAY(zephyr_modbus_serial)
+
+int modbus_server_init(void)
+{
+	k_timer_init(&watchdog_timer, watchdog_timer_handler, NULL);
+	const char iface_name[] = {DEVICE_DT_NAME(MODBUS_NODE)};
+#if DT_NODE_HAS_COMPAT(DT_PARENT(MODBUS_NODE), zephyr_cdc_acm_uart)
+	const struct device *const dev = DEVICE_DT_GET(DT_PARENT(MODBUS_NODE));
+	uint32_t dtr = 0;
+
+	if (!device_is_ready(dev) || usb_enable(NULL))
+	{
+		return 0;
+	}
+
+	while (!dtr)
+	{
+		uart_line_ctrl_get(dev, UART_LINE_CTRL_DTR, &dtr);
+		k_sleep(K_MSEC(100));
+	}
+
+	LOG_INF("Client connected to server on %s", dev->name);
+#endif
+	modbus_iface = modbus_iface_get_by_name(iface_name);
+	if (modbus_iface < 0)
+	{
+		return modbus_iface;
+	}
+	server_param.server.user_cb = &mbs_cbs;
+	return modbus_init_server(modbus_iface, server_param);
+}
+
+int modbus_reconfigure(uint32_t baudrate, uint8_t unit_id)
+{
+	server_param.serial.baud = baudrate;
+	server_param.server.unit_id = unit_id;
+
+	int ret = modbus_init_server(modbus_iface, server_param);
+
+	if (ret == 0)
+	{
+		settings_save_one("modbus/baudrate", &baudrate, sizeof(baudrate));
+		settings_save_one("modbus/unit_id", &unit_id, sizeof(unit_id));
+	}
+
+	return ret;
+}
+
+uint32_t modbus_get_baudrate(void) { return server_param.serial.baud; }
+uint8_t modbus_get_unit_id(void) { return server_param.server.unit_id; }

software/lib/shell_modbus/CMakeLists.txt

@@ -0,0 +1 @@
+zephyr_library_sources(shell_modbus.c)

software/lib/shell_modbus/Kconfig

@@ -0,0 +1,5 @@
+config SHELL_MODBUS
+    bool "Enable Shell Modbus"
+    default y
+    help
+      Enable the modnbus shell commands.

software/lib/shell_modbus/shell_modbus.c

@@ -0,0 +1,119 @@
+#include <zephyr/shell/shell.h>
+#include <stdlib.h>
+#include <lib/modbus_server.h>
+#include <lib/valve.h>
+
+static int cmd_modbus_set_baud(const struct shell *sh, size_t argc, char **argv)
+{
+	if (argc != 2) {
+		shell_error(sh, "Usage: set_baud <baudrate>");
+		return -EINVAL;
+	}
+
+	uint32_t new_baud = (uint32_t)strtoul(argv[1], NULL, 10);
+	const uint32_t valid_baud_rates[] = {1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200};
+	bool is_valid = false;
+
+	for (int i = 0; i < ARRAY_SIZE(valid_baud_rates); i++) {
+		if (new_baud == valid_baud_rates[i]) {
+			is_valid = true;
+			break;
+		}
+	}
+
+	if (!is_valid) {
+		char error_msg[128];
+		int offset = snprintf(error_msg, sizeof(error_msg), "Invalid baudrate. Valid rates are: ");
+		for (int i = 0; i < ARRAY_SIZE(valid_baud_rates); i++) {
+			offset += snprintf(error_msg + offset, sizeof(error_msg) - offset, "%u ", valid_baud_rates[i]);
+		}
+		shell_error(sh, "%s", error_msg);
+		return -EINVAL;
+	}
+
+	if (modbus_reconfigure(new_baud, modbus_get_unit_id()) != 0) {
+		shell_error(sh, "Failed to apply new baudrate");
+	} else {
+		shell_print(sh, "Modbus baudrate set to: %u (and saved)", new_baud);
+	}
+
+	return 0;
+}
+
+static int cmd_modbus_set_id(const struct shell *sh, size_t argc, char **argv)
+{
+	if (argc != 2) {
+		shell_error(sh, "Usage: set_id <slave_id>");
+		return -EINVAL;
+	}
+
+	uint32_t new_id_u32 = (uint32_t)strtoul(argv[1], NULL, 10);
+	if (new_id_u32 == 0 || new_id_u32 > 247) {
+		shell_error(sh, "Invalid slave ID: %s. Must be between 1 and 247.", argv[1]);
+		return -EINVAL;
+	}
+	uint8_t new_id = (uint8_t)new_id_u32;
+
+	if (modbus_reconfigure(modbus_get_baudrate(), new_id) != 0) {
+		shell_error(sh, "Failed to apply new slave ID");
+	} else {
+		shell_print(sh, "Modbus slave ID set to: %u (and saved)", new_id);
+	}
+
+	return 0;
+}
+
+static int cmd_valve_set_open_time(const struct shell *sh, size_t argc, char **argv)
+{
+    if (argc != 2) {
+        shell_error(sh, "Usage: set_open_time <seconds>");
+        return -EINVAL;
+    }
+
+    uint16_t seconds = (uint16_t)strtoul(argv[1], NULL, 10);
+    valve_set_max_open_time(seconds);
+    shell_print(sh, "Max opening time set to: %u seconds (and saved)", seconds);
+
+    return 0;
+}
+
+static int cmd_valve_set_close_time(const struct shell *sh, size_t argc, char **argv)
+{
+    if (argc != 2) {
+        shell_error(sh, "Usage: set_close_time <seconds>");
+        return -EINVAL;
+    }
+
+    uint16_t seconds = (uint16_t)strtoul(argv[1], NULL, 10);
+    valve_set_max_close_time(seconds);
+    shell_print(sh, "Max closing time set to: %u seconds (and saved)", seconds);
+
+    return 0;
+}
+
+static int cmd_config_show(const struct shell *sh, size_t argc, char **argv)
+{
+	shell_print(sh, "Current Modbus Configuration:");
+	shell_print(sh, "  Baudrate: %u", modbus_get_baudrate());
+	shell_print(sh, "  Slave ID: %u", modbus_get_unit_id());
+    shell_print(sh, "Current Valve Configuration:");
+    shell_print(sh, "  Max Opening Time: %u s", valve_get_max_open_time());
+    shell_print(sh, "  Max Closing Time: %u s", valve_get_max_close_time());
+	return 0;
+}
+
+SHELL_STATIC_SUBCMD_SET_CREATE(sub_modbus_cmds,
+	SHELL_CMD(set_baud, NULL, "Set Modbus baudrate", cmd_modbus_set_baud),
+	SHELL_CMD(set_id,   NULL, "Set Modbus slave ID", cmd_modbus_set_id),
+	SHELL_SUBCMD_SET_END
+);
+
+SHELL_STATIC_SUBCMD_SET_CREATE(sub_valve_cmds,
+    SHELL_CMD(set_open_time, NULL, "Set max valve opening time", cmd_valve_set_open_time),
+    SHELL_CMD(set_close_time, NULL, "Set max valve closing time", cmd_valve_set_close_time),
+    SHELL_SUBCMD_SET_END
+);
+
+SHELL_CMD_REGISTER(modbus, &sub_modbus_cmds, "Modbus configuration", NULL);
+SHELL_CMD_REGISTER(valve, &sub_valve_cmds, "Valve configuration", NULL);
+SHELL_CMD_REGISTER(show_config, NULL, "Show all configurations", cmd_config_show);

software/lib/shell_system/CMakeLists.txt

@@ -0,0 +1 @@
+zephyr_library_sources(shell_system.c)

software/lib/shell_system/Kconfig

@@ -0,0 +1,5 @@
+config SHELL_SYSTEM
+    bool "Enable Shell System"
+    default y
+    help
+      Enable the system commands.

software/lib/shell_system/shell_system.c

@@ -0,0 +1,12 @@
+#include <zephyr/shell/shell.h>
+#include <zephyr/sys/reboot.h>
+
+static int cmd_reset(const struct shell *sh, size_t argc, char **argv)
+{
+	shell_print(sh, "Rebooting system...");
+	k_sleep(K_MSEC(100)); // Allow the shell to print the message
+	sys_reboot(SYS_REBOOT_WARM);
+	return 0;
+}
+
+SHELL_CMD_REGISTER(reset, NULL, "Reboot the system", cmd_reset);

software/lib/valve/CMakeLists.txt

@@ -0,0 +1 @@
+zephyr_library_sources(valve.c)

software/lib/valve/Kconfig

@@ -0,0 +1,5 @@
+config LIB_VALVE
+    bool "Enable Valve Library"
+    default y
+    help
+      Enable the Valve Library.

software/lib/valve/valve.c

@@ -0,0 +1,62 @@
+#include <zephyr/kernel.h>
+#include <zephyr/settings/settings.h>
+#include <zephyr/logging/log.h>
+#include <lib/valve.h>
+
+LOG_MODULE_REGISTER(valve, LOG_LEVEL_INF);
+
+static enum valve_state current_state = VALVE_STATE_CLOSED;
+static enum valve_movement current_movement = VALVE_MOVEMENT_IDLE;
+static uint16_t max_opening_time_s = 60;
+static uint16_t max_closing_time_s = 60;
+static struct k_work_delayable valve_work;
+
+static void valve_work_handler(struct k_work *work)
+{
+    if (current_movement == VALVE_MOVEMENT_OPENING) {
+        LOG_INF("Virtual valve finished opening");
+    } else if (current_movement == VALVE_MOVEMENT_CLOSING) {
+        current_state = VALVE_STATE_CLOSED;
+        LOG_INF("Virtual valve finished closing");
+    }
+    current_movement = VALVE_MOVEMENT_IDLE;
+}
+
+void valve_init(void)
+{
+    k_work_init_delayable(&valve_work, valve_work_handler);
+    settings_load_one("valve/max_open_time", &max_opening_time_s, sizeof(max_opening_time_s));
+    settings_load_one("valve/max_close_time", &max_closing_time_s, sizeof(max_closing_time_s));
+}
+
+void valve_open(void)
+{
+    if (current_state == VALVE_STATE_CLOSED) {
+        current_state = VALVE_STATE_OPEN;
+        current_movement = VALVE_MOVEMENT_OPENING;
+        k_work_schedule(&valve_work, K_SECONDS(max_opening_time_s));
+    }
+}
+
+void valve_close(void)
+{
+    if (current_state == VALVE_STATE_OPEN) {
+        current_movement = VALVE_MOVEMENT_CLOSING;
+        k_work_schedule(&valve_work, K_SECONDS(max_closing_time_s));
+    }
+}
+
+void valve_stop(void)
+{
+    k_work_cancel_delayable(&valve_work);
+    current_movement = VALVE_MOVEMENT_IDLE;
+}
+
+enum valve_state valve_get_state(void) { return current_state; }
+enum valve_movement valve_get_movement(void) { return current_movement; }
+uint16_t valve_get_motor_current(void) { return (current_movement != VALVE_MOVEMENT_IDLE) ? 150 : 10; }
+
+void valve_set_max_open_time(uint16_t seconds) { max_opening_time_s = seconds; settings_save_one("valve/max_open_time", &max_opening_time_s, sizeof(max_opening_time_s)); }
+void valve_set_max_close_time(uint16_t seconds) { max_closing_time_s = seconds; settings_save_one("valve/max_close_time", &max_closing_time_s, sizeof(max_closing_time_s)); }
+uint16_t valve_get_max_open_time(void) { return max_opening_time_s; }
+uint16_t valve_get_max_close_time(void) { return max_closing_time_s; }

software/tools/modbus_tool/README.de.md

@@ -0,0 +1,103 @@
+<img src="../../../docs/img/logo.png" alt="Logo" width="100"/>
+
+# Modbus Tool für Bewässerungssystem-Knoten
+
+Dieses Python-Skript bietet eine interaktive Kommandozeilen-Benutzeroberfläche (TUI) zur Steuerung und Überwachung eines Ventil-Knotens des Bewässerungssystems über Modbus RTU.
+
+## Features
+
+- **Interaktive Benutzeroberfläche:** Eine benutzerfreundliche, auf `curses` basierende Oberfläche, die eine einfache Bedienung ermöglicht.
+- **Live-Statusanzeige:** Zeigt tabellarisch und in Echtzeit alle wichtigen Register des Slaves an:
+    - Ventilstatus (Zustand, Bewegung, Motorstrom)
+    - Zustand der digitalen Ein- und Ausgänge
+    - "Clear-on-Read" Taster-Events
+    - Systemkonfiguration (Öffnungs-/Schließzeiten, Watchdog-Timeout)
+    - Gerätestatus (Firmware-Version, Uptime)
+- **Volle Kontrolle:** Ermöglicht das Senden von Befehlen zum Öffnen, Schließen und Stoppen des Ventils sowie zum Umschalten der digitalen Ausgänge.
+- **Konfiguration zur Laufzeit:** Die maximalen Öffnungs-/Schließzeiten und der Watchdog-Timeout können direkt in der Oberfläche geändert werden.
+- **Simulierter Firmware-Upload:** Implementiert den vollständigen, in der Dokumentation beschriebenen Firmware-Update-Prozess. Das Tool sendet eine `firmware.bin`-Datei in Chunks an den Slave und folgt dem CRC-Verifizierungs-Protokoll.
+
+## Installation
+
+### Voraussetzungen
+
+- Python 3.x
+- `pip` (Python Paket-Installer)
+
+### Installation der Abhängigkeiten
+
+Die benötigten Python-Pakete sind in der Datei `requirements.txt` aufgeführt. Sie können auf zwei Arten installiert werden: global oder in einer virtuellen Umgebung (empfohlen).
+
+#### Option 1: Installation mit virtueller Umgebung (empfohlen)
+
+Eine virtuelle Umgebung isoliert die Projekt-Abhängigkeiten von Ihrem globalen Python-System, was Konflikte vermeidet.
+
+1.  **Virtuelle Umgebung erstellen:**
+    Führen Sie im Verzeichnis `software/tools/modbus_tool` den folgenden Befehl aus, um eine Umgebung im Ordner `.venv` zu erstellen:
+    ```bash
+    python3 -m venv .venv
+    ```
+
+2.  **Umgebung aktivieren:**
+    -   **Linux / macOS:**
+        ```bash
+        source .venv/bin/activate
+        ```
+        Ihre Shell-Anzeige sollte sich ändern und `(.venv)` am Anfang zeigen.
+    -   **Windows (cmd.exe):**
+        ```bash
+        .venv\Scripts\activate.bat
+        ```
+    -   **Windows (PowerShell):**
+        ```powershell
+        .venv\Scripts\Activate.ps1
+        ```
+
+3.  **Abhängigkeiten installieren:**
+    Wenn die Umgebung aktiv ist, installieren Sie die Pakete:
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+4.  **Umgebung deaktivieren:**
+    Wenn Sie fertig sind, können Sie die Umgebung mit folgendem Befehl wieder verlassen:
+    ```bash
+    deactivate
+    ```
+
+#### Option 2: Globale Installation (nicht empfohlen)
+
+Wenn Sie keine virtuelle Umgebung verwenden möchten, können Sie die Pakete direkt in Ihrem globalen Python-System installieren.
+
+```bash
+pip install -r requirements.txt
+```
+
+## Verwendung
+
+Stellen Sie sicher, dass das Skript ausführbar ist:
+```bash
+chmod +x modbus_tool.py
+```
+
+Starten Sie das Tool, indem Sie den seriellen Port als Argument übergeben:
+
+```bash
+./modbus_tool.py /dev/ttyACM0
+```
+Ersetzen Sie `/dev/ttyACM0` durch den korrekten Port Ihres Geräts.
+
+### Kommandozeilen-Argumente
+
+- `port`: (Erforderlich) Der serielle Port (z.B. `/dev/ttyACM0` oder `COM3`).
+- `--baud`: Die Baudrate (Standard: `19200`).
+- `--slave-id`: Die Modbus Slave ID des Geräts (Standard: `1`).
+- `--interval`: Das Abfrageintervall für den Status in Sekunden (Standard: `1.0`).
+
+### Bedienung der Oberfläche
+
+- **Navigation:** Verwenden Sie die **Pfeiltasten (↑/↓)**, um zwischen den Menüpunkten zu navigieren.
+- **Auswählen:** Drücken Sie **Enter**, um den ausgewählten Befehl auszuführen.
+- **Werte eingeben:** Bei Aktionen wie "Set Watchdog" werden Sie zur Eingabe eines Wertes aufgefordert. Geben Sie den Wert ein und bestätigen Sie mit **Enter**.
+- **Firmware Update:** Diese Funktion startet den Upload der Datei `firmware.bin` aus dem aktuellen Verzeichnis. Während des Updates wird eine Fortschrittsanzeige dargestellt.
+- **Beenden:** Wählen Sie den Menüpunkt **"Exit"** und drücken Sie **Enter**.

software/tools/modbus_tool/modbus_tool.py

@@ -0,0 +1,330 @@
+#!/usr/bin/env python3
+import argparse
+import threading
+import time
+import sys
+import curses
+import os
+from pymodbus.client import ModbusSerialClient
+from pymodbus.exceptions import ModbusException
+
+# --- Register Definitions ---
+# (omitted for brevity, no changes here)
+REG_INPUT_VALVE_STATE_MOVEMENT = 0x0000
+REG_INPUT_MOTOR_CURRENT_MA = 0x0001
+REG_INPUT_DIGITAL_INPUTS_STATE = 0x0020
+REG_INPUT_BUTTON_EVENTS = 0x0021
+REG_INPUT_FIRMWARE_VERSION_MAJOR_MINOR = 0x00F0
+REG_INPUT_FIRMWARE_VERSION_PATCH = 0x00F1
+REG_INPUT_DEVICE_STATUS = 0x00F2
+REG_INPUT_UPTIME_SECONDS_LOW = 0x00F3
+REG_INPUT_UPTIME_SECONDS_HIGH = 0x00F4
+REG_INPUT_FWU_LAST_CHUNK_CRC = 0x0100
+REG_HOLDING_VALVE_COMMAND = 0x0000
+REG_HOLDING_MAX_OPENING_TIME_S = 0x0001
+REG_HOLDING_MAX_CLOSING_TIME_S = 0x0002
+REG_HOLDING_DIGITAL_OUTPUTS_STATE = 0x0010
+REG_HOLDING_WATCHDOG_TIMEOUT_S = 0x00F0
+REG_HOLDING_DEVICE_RESET = 0x00F1
+REG_HOLDING_FWU_COMMAND = 0x0100
+REG_HOLDING_FWU_CHUNK_OFFSET_LOW = 0x0101
+REG_HOLDING_FWU_CHUNK_OFFSET_HIGH = 0x0102
+REG_HOLDING_FWU_CHUNK_SIZE = 0x0103
+REG_HOLDING_FWU_DATA_BUFFER = 0x0180
+
+
+# --- Global State ---
+stop_event = threading.Event()
+client = None
+status_data = {}
+status_lock = threading.Lock()
+update_status = {"running": False, "message": "", "progress": 0.0}
+update_lock = threading.Lock()
+
+def format_uptime(seconds):
+    if not isinstance(seconds, (int, float)) or seconds < 0: return "N/A"
+    if seconds == 0: return "0s"
+    days, rem = divmod(seconds, 86400); hours, rem = divmod(rem, 3600); minutes, secs = divmod(rem, 60)
+    parts = []
+    if days > 0: parts.append(f"{int(days)}d")
+    if hours > 0: parts.append(f"{int(hours)}h")
+    if minutes > 0: parts.append(f"{int(minutes)}m")
+    if secs > 0 or not parts: parts.append(f"{int(secs)}s")
+    return " ".join(parts)
+
+def poll_status(slave_id, interval):
+    global status_data
+    reconnect_attempts = 0
+    max_reconnect_attempts = 5
+    reconnect_delay = 1 # seconds
+
+    while not stop_event.is_set():
+        if update_status["running"]:
+            time.sleep(interval)
+            continue
+
+        new_data = {}
+        try:
+            if not client.is_socket_open():
+                reconnect_attempts += 1
+                if reconnect_attempts >= max_reconnect_attempts:
+                    new_data["error"] = f"Failed to reconnect after {max_reconnect_attempts} attempts. Exiting."
+                    stop_event.set()
+                    break
+                
+                # Attempt to connect
+                if client.connect():
+                    reconnect_attempts = 0
+                    new_data["error"] = None # Clear error on successful reconnect
+                else:
+                    new_data["error"] = f"Connection lost. Attempting to reconnect ({reconnect_attempts}/{max_reconnect_attempts})..."
+                    time.sleep(reconnect_delay)
+                    continue
+
+            # If connected, try to read data
+            ir_valve = client.read_input_registers(REG_INPUT_VALVE_STATE_MOVEMENT, count=2, slave=slave_id)
+            ir_dig = client.read_input_registers(REG_INPUT_DIGITAL_INPUTS_STATE, count=2, slave=slave_id)
+            ir_sys = client.read_input_registers(REG_INPUT_FIRMWARE_VERSION_MAJOR_MINOR, count=5, slave=slave_id)
+            hr_valve = client.read_holding_registers(REG_HOLDING_MAX_OPENING_TIME_S, count=2, slave=slave_id)
+            hr_dig = client.read_holding_registers(REG_HOLDING_DIGITAL_OUTPUTS_STATE, count=1, slave=slave_id)
+            hr_sys = client.read_holding_registers(REG_HOLDING_WATCHDOG_TIMEOUT_S, count=1, slave=slave_id)
+
+            for res in [ir_valve, ir_dig, ir_sys, hr_valve, hr_dig, hr_sys]:
+                if res.isError():
+                    raise ModbusException(str(res))
+            
+            valve_state_raw = ir_valve.registers[0]
+            movement_map = {0: "Idle", 1: "Opening", 2: "Closing", 3: "Error"}
+            state_map = {0: "Closed", 1: "Open"}
+            new_data["movement"] = movement_map.get(valve_state_raw >> 8, 'Unknown')
+            new_data["state"] = state_map.get(valve_state_raw & 0xFF, 'Unknown')
+            new_data["motor_current"] = f"{ir_valve.registers[1]} mA"
+            new_data["open_time"] = f"{hr_valve.registers[0]}s"
+            new_data["close_time"] = f"{hr_valve.registers[1]}s"
+            new_data["digital_inputs"] = f"0x{ir_dig.registers[0]:04X}"
+            new_data["button_events"] = f"0x{ir_dig.registers[1]:04X}"
+            new_data["digital_outputs"] = f"0x{hr_dig.registers[0]:04X}"
+            
+            fw_major = ir_sys.registers[0] >> 8
+            fw_minor = ir_sys.registers[0] & 0xFF
+            fw_patch = ir_sys.registers[1]
+            uptime_seconds = (ir_sys.registers[4] << 16) | ir_sys.registers[3]
+            new_data["firmware"] = f"v{fw_major}.{fw_minor}.{fw_patch}"
+            new_data["device_status"] = "OK" if ir_sys.registers[2] == 0 else "ERROR"
+            new_data["uptime"] = format_uptime(uptime_seconds)
+            new_data["watchdog"] = f"{hr_sys.registers[0]}s"
+            new_data["error"] = None # Clear any previous error on successful read
+            reconnect_attempts = 0 # Reset attempts on successful communication
+        except Exception as e:
+            new_data["error"] = f"Communication Error: {e}. Closing connection."
+            client.close() # Close connection to force reconnect attempt in next loop
+        finally:
+            with status_lock:
+                status_data = new_data
+            time.sleep(interval)
+
+def firmware_update_thread(slave_id, filepath):
+    global update_status
+    with update_lock:
+        update_status = {"running": True, "message": "Starting update...", "progress": 0.0}
+    try:
+        with open(filepath, 'rb') as f: firmware = f.read()
+        file_size = len(firmware)
+        chunk_size = 248
+        offset = 0
+        while offset < file_size:
+            chunk = firmware[offset:offset + chunk_size]
+            with update_lock:
+                update_status["message"] = f"Sending chunk {offset//chunk_size + 1}/{(file_size + chunk_size - 1)//chunk_size}..."
+                update_status["progress"] = offset / file_size
+            client.write_register(REG_HOLDING_FWU_CHUNK_OFFSET_LOW, offset & 0xFFFF, slave=slave_id)
+            client.write_register(REG_HOLDING_FWU_CHUNK_OFFSET_HIGH, (offset >> 16) & 0xFFFF, slave=slave_id)
+            client.write_register(REG_HOLDING_FWU_CHUNK_SIZE, len(chunk), slave=slave_id)
+            padded_chunk = chunk + (b'\x00' if len(chunk) % 2 != 0 else b'')
+            registers = [int.from_bytes(padded_chunk[i:i+2], 'big') for i in range(0, len(padded_chunk), 2)]
+            burst_size_regs = 16
+            for i in range(0, len(registers), burst_size_regs):
+                reg_burst = registers[i:i + burst_size_regs]
+                start_addr = REG_HOLDING_FWU_DATA_BUFFER + i
+                client.write_registers(start_addr, reg_burst, slave=slave_id)
+                time.sleep(0.02)
+            time.sleep(0.1)
+            client.read_input_registers(REG_INPUT_FWU_LAST_CHUNK_CRC, count=1, slave=slave_id)
+            client.write_register(REG_HOLDING_FWU_COMMAND, 1, slave=slave_id)
+            offset += len(chunk)
+        with update_lock:
+            update_status["progress"] = 1.0
+            update_status["message"] = "Finalizing update..."
+        client.write_register(REG_HOLDING_FWU_COMMAND, 2, slave=slave_id)
+        time.sleep(1)
+        with update_lock: update_status["message"] = "Update complete! Slave is rebooting."
+        time.sleep(2)
+    except Exception as e:
+        with update_lock: update_status["message"] = f"Error: {e}"
+        time.sleep(3)
+    finally:
+        with update_lock: update_status["running"] = False
+
+def draw_button(stdscr, y, x, text, selected=False):
+    """Draws a button, handling selection highlight."""
+    color = curses.color_pair(2) if selected else curses.color_pair(1)
+    button_width = len(text) + 2
+    stdscr.addstr(y, x, " " * button_width, color)
+    stdscr.addstr(y, x + 1, text, color)
+
+def file_browser(stdscr):
+    """A simple curses file browser."""
+    curses.curs_set(1)
+    path = os.getcwd()
+    selected_index = 0
+    
+    while True:
+        stdscr.clear()
+        h, w = stdscr.getmaxyx()
+        stdscr.addstr(0, 0, f"Select Firmware File: {path}".ljust(w-1), curses.color_pair(2))
+        
+        try:
+            items = sorted(os.listdir(path))
+        except OSError as e:
+            items = [f".. (Error: {e})"]
+
+        items.insert(0, "..")
+        
+        for i, item_name in enumerate(items):
+            if i >= h - 2: break
+            display_name = item_name
+            if os.path.isdir(os.path.join(path, item_name)):
+                display_name += "/"
+            
+            if i == selected_index:
+                stdscr.addstr(i + 1, 0, display_name, curses.color_pair(2))
+            else:
+                stdscr.addstr(i + 1, 0, display_name)
+
+        key = stdscr.getch()
+
+        if key == curses.KEY_UP:
+            selected_index = max(0, selected_index - 1)
+        elif key == curses.KEY_DOWN:
+            selected_index = min(len(items) - 1, selected_index + 1)
+        elif key == curses.KEY_ENTER or key in [10, 13]:
+            selected_item_path = os.path.join(path, items[selected_index])
+            if os.path.isdir(selected_item_path):
+                path = os.path.abspath(selected_item_path)
+                selected_index = 0
+            else:
+                return selected_item_path
+        elif key == 27: # ESC key
+            return None
+
+def main_menu(stdscr, slave_id):
+    global status_data, update_status
+    curses.curs_set(0); stdscr.nodelay(1); stdscr.timeout(100)
+    curses.start_color(); curses.init_pair(1, curses.COLOR_WHITE, curses.COLOR_BLUE); curses.init_pair(2, curses.COLOR_BLUE, curses.COLOR_WHITE); curses.init_pair(3, curses.COLOR_RED, curses.COLOR_BLUE)
+    stdscr.bkgd(' ', curses.color_pair(1))
+
+    menu = ["Open Valve", "Close Valve", "Stop Valve", "Toggle Output 1", "Toggle Output 2", "Set Watchdog", "Reset Node", "Firmware Update", "Exit"]
+    current_row_idx = 0
+    message, message_time = "", 0
+    input_mode, input_prompt, input_str, input_target_reg = False, "", "", 0
+
+    while not stop_event.is_set():
+        h, w = stdscr.getmaxyx()
+        key = stdscr.getch()
+
+        with update_lock: is_updating = update_status["running"]
+
+        if is_updating:
+            pass
+        elif input_mode:
+            if key in [10, 13]:
+                try:
+                    value = int(input_str)
+                    client.write_register(input_target_reg, value, slave=slave_id)
+                    message = f"-> Set register 0x{input_target_reg:04X} to {value}"
+                except Exception as e: message = f"-> Error: {e}"
+                message_time, input_mode, input_str = time.time(), False, ""
+            elif key == curses.KEY_BACKSPACE or key == 127: input_str = input_str[:-1]
+            elif key != -1 and chr(key).isprintable(): input_str += chr(key)
+        else:
+            if key == curses.KEY_UP: current_row_idx = (current_row_idx - 1) % len(menu)
+            elif key == curses.KEY_DOWN: current_row_idx = (current_row_idx + 1) % len(menu)
+            elif key == curses.KEY_ENTER or key in [10, 13]:
+                selected_option = menu[current_row_idx]
+                message_time = time.time()
+                if selected_option == "Exit": stop_event.set(); continue
+                elif selected_option == "Open Valve": client.write_register(REG_HOLDING_VALVE_COMMAND, 1, slave=slave_id); message = "-> Sent OPEN command"
+                elif selected_option == "Close Valve": client.write_register(REG_HOLDING_VALVE_COMMAND, 2, slave=slave_id); message = "-> Sent CLOSE command"
+                elif selected_option == "Stop Valve": client.write_register(REG_HOLDING_VALVE_COMMAND, 0, slave=slave_id); message = "-> Sent STOP command"
+                elif "Toggle Output" in selected_option:
+                    bit = 0 if "1" in selected_option else 1
+                    try:
+                        current_val = client.read_holding_registers(REG_HOLDING_DIGITAL_OUTPUTS_STATE, count=1, slave=slave_id).registers[0]
+                        client.write_register(REG_HOLDING_DIGITAL_OUTPUTS_STATE, current_val ^ (1 << bit), slave=slave_id)
+                        message = f"-> Toggled Output {bit+1}"
+                    except Exception as e: message = f"-> Error: {e}"
+                elif selected_option == "Set Watchdog":
+                    input_mode, input_prompt, input_target_reg = True, "Enter Watchdog Timeout (s): ", REG_HOLDING_WATCHDOG_TIMEOUT_S
+                elif selected_option == "Reset Node":
+                    try:
+                        client.write_register(REG_HOLDING_DEVICE_RESET, 1, slave=slave_id)
+                        message = "-> Sent RESET command. Node should reboot."
+                    except Exception as e:
+                        message = f"-> Error sending reset: {e}"
+                elif selected_option == "Firmware Update":
+                    filepath = file_browser(stdscr)
+                    if filepath:
+                        threading.Thread(target=firmware_update_thread, args=(slave_id, filepath), daemon=True).start()
+                    else:
+                        message = "-> Firmware update cancelled."
+
+        stdscr.clear()
+        if is_updating:
+            with update_lock: prog, msg = update_status["progress"], update_status["message"]
+            stdscr.addstr(h // 2 - 1, w // 2 - 25, "FIRMWARE UPDATE IN PROGRESS", curses.A_BOLD | curses.color_pair(2))
+            stdscr.addstr(h // 2, w // 2 - 25, f"[{'#' * int(prog * 50):<50}] {prog:.0%}")
+            stdscr.addstr(h // 2 + 1, w // 2 - 25, msg.ljust(50))
+        else:
+            with status_lock: current_data = status_data.copy()
+            bold, normal = curses.color_pair(1) | curses.A_BOLD, curses.color_pair(1)
+            if current_data.get("error"): stdscr.addstr(0, 0, current_data["error"], curses.color_pair(3) | curses.A_BOLD)
+            else:
+                col1, col2, col3, col4 = 2, 30, 58, 88
+                stdscr.addstr(1, col1, "State:", bold); stdscr.addstr(1, col1 + 18, str(current_data.get('state', 'N/A')), normal)
+                stdscr.addstr(2, col1, "Movement:", bold); stdscr.addstr(2, col1 + 18, str(current_data.get('movement', 'N/A')), normal)
+                stdscr.addstr(3, col1, "Motor Current:", bold); stdscr.addstr(3, col1 + 18, str(current_data.get('motor_current', 'N/A')), normal)
+                stdscr.addstr(1, col2, "Digital Inputs:", bold); stdscr.addstr(1, col2 + 18, str(current_data.get('digital_inputs', 'N/A')), normal)
+                stdscr.addstr(2, col2, "Digital Outputs:", bold); stdscr.addstr(2, col2 + 18, str(current_data.get('digital_outputs', 'N/A')), normal)
+                stdscr.addstr(3, col2, "Button Events:", bold); stdscr.addstr(3, col2 + 18, str(current_data.get('button_events', 'N/A')), normal)
+                stdscr.addstr(1, col3, "Max Open Time:", bold); stdscr.addstr(1, col3 + 16, str(current_data.get('open_time', 'N/A')), normal)
+                stdscr.addstr(2, col3, "Max Close Time:", bold); stdscr.addstr(2, col3 + 16, str(current_data.get('close_time', 'N/A')), normal)
+                stdscr.addstr(3, col3, "Watchdog:", bold); stdscr.addstr(3, col3 + 16, str(current_data.get('watchdog', 'N/A')), normal)
+                stdscr.addstr(1, col4, "Firmware:", bold); stdscr.addstr(1, col4 + 14, str(current_data.get('firmware', 'N/A')), normal)
+                stdscr.addstr(2, col4, "Uptime:", bold); stdscr.addstr(2, col4 + 14, str(current_data.get('uptime', 'N/A')), normal)
+                stdscr.addstr(3, col4, "Dev. Status:", bold); stdscr.addstr(3, col4 + 14, str(current_data.get('device_status', 'N/A')), normal)
+            stdscr.addstr(5, 0, "─" * (w - 1), normal)
+            for idx, row in enumerate(menu):
+                draw_button(stdscr, h // 2 - len(menu) + (idx * 2), w // 2 - len(row) // 2, row, idx == current_row_idx)
+            if time.time() - message_time < 2.0: stdscr.addstr(h - 2, 0, message.ljust(w - 1), curses.color_pair(1) | curses.A_BOLD)
+            if input_mode:
+                curses.curs_set(1); stdscr.addstr(h - 2, 0, (input_prompt + input_str).ljust(w-1), curses.color_pair(2)); stdscr.move(h - 2, len(input_prompt) + len(input_str))
+            else: curses.curs_set(0)
+        stdscr.refresh()
+
+def main():
+    global client
+    parser = argparse.ArgumentParser(description="Modbus tool for irrigation system nodes.")
+    parser.add_argument("port", help="Serial port"); parser.add_argument("--baud", type=int, default=19200); parser.add_argument("--slave-id", type=int, default=1); parser.add_argument("--interval", type=float, default=1.0)
+    args = parser.parse_args()
+    client = ModbusSerialClient(port=args.port, baudrate=args.baud, stopbits=1, bytesize=8, parity="N", timeout=1)
+    if not client.connect(): print(f"Error: Failed to connect to serial port {args.port}"); sys.exit(1)
+    print("Successfully connected. Starting UI..."); time.sleep(0.5)
+    threading.Thread(target=poll_status, args=(args.slave_id, args.interval), daemon=True).start()
+    try: curses.wrapper(main_menu, args.slave_id)
+    finally:
+        stop_event.set()
+        print("\nExiting...")
+        if client.is_socket_open(): client.close()
+
+if __name__ == "__main__":
+    main()

software/tools/modbus_tool/requirements.txt

@@ -0,0 +1,2 @@
+pymodbus>=3.6.0
+pyserial>=3.5