Updater Improvements and Refactoring #113

Darthyson · 2025-11-18T19:34:04Z

This PR contains improvements to the firmware updater focusing on reliability, maintainability and user experience.

Key Features & Enhancements

Connection & Reliability:

New --ip-tunnel-reconnect option for IP interfaces with non-standard L2 sequence number handling (e.g., Loxone Miniserver Gen1)
Automatic KNX link reconnection on exceptions with configurable --reconnect delay (milliseconds)
Improved exception handling with graceful shutdown on [CTRL+C]
Better handling of transport layer (TL4) disconnects and timeouts

Discovery & Interface Detection:

New --discover argument to list available KNX interfaces (IP, USB and serial-port) and their properties
Simple automatic KNX gateway detection on startup

Logging & Output:

Logging system reorganization with modular logback configuration
Customizable message/exception filters to reduce noise in console output
ANSI escape code filtering in log file
Prettier, more readable console output with consistent colors
Progress indicator with spinner animation
Credits and ASCII logo now only display with --version

Code Quality & Architecture:

Major refactoring: reorganized folder structure (moved from source/src to src/)
Moved to shadowJar plugin for fat JAR creation
New DeviceManagementFactory for reflection-based L2 handling of reconnecting
Functionality separated into new packages: .logging, .progress, .devicemgnt
Fixed many IntelliJ IDEA inspection warnings
Better exception handling with custom CliInvalidException for validation errors

GUI Improvements:

Settings now saved/loaded using JSON (supports nested structures) in settings.json
Fixed progress info updates when interacting with LoggingPane: JTextPane
Better error dialogs with UncaughtExceptionHandler

Bug Fixes:

diff-header size calculation d2c37e9
buffer not repeated if error occurred in last while run 4e7152e

Breaking Changes

Reorganized code base folder hierarchy (formerly in source/src, now src/)

Testing
Added test coverage for logging components, evaluators and core functionality.

Dependency Updates:

Replaced deprecated jansi with jline-terminal-jansi
Added Dependabot configuration for Updater
Upgraded to latest versions of dependencies:
- Gradle 9.2.1
- Calimero 2.6
- Logback 1.5.21
- jline-terminal-jansi 3.30.6
- jackson-databind 2.20.1
- Guava 33.5.0-jre
- commons-cli 1.11.0
- appdirs 1.5.0
- java-intelhex-parser:9dec823

There is no reason to log/print the stack-trace on `CliInvalidException` (logic errors, e.g. IP-Secure together with USB-Interface)

Instead of creating/configuring/tinkering by our self a fatJar, we use now `com.gradleup.shadow` to create a `shadowJar`. The old `fatJar` gradle task will be now redirected to the new `shadowJar` task for some time.

…IDEA) downloaded on 10.08.2024 from [Github gitignore - JetBrains.gitignore](https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore) based on [JetBrains IDEs Support IntelliJ Platform - How to manage projects under Version Control Systems](https://intellij-support.jetbrains.com/hc/en-us/articles/206544839-How-to-manage-projects-under-Version-Control-Systems)

This commit breaks intentionally the build to fix the code base folder hierarchy and not to loose git history. Next commits will (hopefully) fix it. Reasons for code base reorganization: - The Updater project itself was in subfolder `source`, which is redundant since we already use `src` for source files - `main` code was in `source/src/main/java/org/selfbus/*`. - `test` code was in `source/src/test/java/org/selfbus/*`.

New files in `.idea` are from a fresh gradle import in IntelliJ IDEA Community Edition 2024.2

`objno` was logged instead of `objConf`

The 7th bit of the Config Octet shall always be 1 for Group Object Table - Realisation Type 1 (KNX Spec. 3.0 3/5/1 4.18.3.1.2.1). The 7th bit of the Config Octet of The Group Object Table - Realisation Type 2 is used as Update Enable flag (KNX Spec. 3.0 3/5/1 4.18.4.1).

Also fixed gradle warning: The archives configuration has been deprecated for artifact declaration.

Copilot

Pull request overview

This PR introduces substantial improvements to the firmware updater, focusing on reliability, maintainability, and user experience. The changes include:

Enhanced connection handling with new reconnect options
Improved KNX interface discovery
Reorganized logging system with custom filters
Major code refactoring with relocated source structure
Migration from JUnit 4 to JUnit 5
Updated dependencies and build configuration

Key Changes

Refactored communication object handling logic with improved APCI command processing
Added comprehensive test coverage for logging, GUI components, and utility functions
Migrated test framework from JUnit 4 to JUnit 5 with Hamcrest replaced by native assertions
Enhanced debug output with new helper functions for communication object inspection

Reviewed changes

Copilot reviewed 130 out of 158 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
test/lib-test-cases/src/knx/test_*.{h,cpp}	New test files for memory and EEPROM functionality
sblib/src/eib/com_objectsBCU1.cpp	Refactored processGroupTelegram logic with switch-case pattern
sblib/src/eib/com_object*.cpp	Added debug output functions and formatting improvements
sblib/inc/sblib/eib/types.h	Added COMCONF_UPDATE enum value
firmware_updater/updater/test/*/.java	Migrated to JUnit 5 and added new test coverage
firmware_updater/updater/test/resources/hex/*.hex	Updated test resources with corrected paths

Files not reviewed (10)

firmware_updater/updater/.idea/.name: Language not supported
firmware_updater/updater/.idea/Selfbus_Updater.iml: Language not supported
firmware_updater/updater/.idea/artifacts/SB_updater_main_jar.xml: Language not supported
firmware_updater/updater/.idea/compiler.xml: Language not supported
firmware_updater/updater/.idea/misc.xml: Language not supported
firmware_updater/updater/.idea/modules.xml: Language not supported
firmware_updater/updater/.idea/modules/SB_updater.main.iml: Language not supported
firmware_updater/updater/.idea/modules/SB_updater.test.iml: Language not supported
firmware_updater/updater/.idea/runConfigurations/_template__of_Application.xml: Language not supported
firmware_updater/updater/source/.idea/artifacts/SB_updater_main_jar.xml: Language not supported

Comments suppressed due to low confidence (1)

firmware_updater/updater/src/org/selfbus/updater/bootloader/BootloaderStatistic.java:36

This method overrides Object.toString; it is advisable to add an Override annotation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-30T01:53:24Z

firmware_updater/updater/src/org/selfbus/updater/SBManagementClientImpl.java

+        }
+    }
+
+    private class SBTransportListener implements TransportListener


SBTransportListener could be made static, since the enclosing instance is used only in its constructor.

Copilot · 2025-11-30T01:53:25Z

firmware_updater/updater/src/org/selfbus/updater/CliOptions.java

+
+        if (cmdLine.hasOption(OPT_LONG_DUMPFLASH)) {
+            String[] optArgs = cmdLine.getOptionValues(OPT_LONG_DUMPFLASH);
+            setDumpFlashStartAddress(Long.decode(optArgs[0]));


Potential uncaught 'java.lang.NumberFormatException'.

Copilot · 2025-11-30T01:53:25Z

firmware_updater/updater/src/org/selfbus/updater/CliOptions.java

+        if (cmdLine.hasOption(OPT_LONG_DUMPFLASH)) {
+            String[] optArgs = cmdLine.getOptionValues(OPT_LONG_DUMPFLASH);
+            setDumpFlashStartAddress(Long.decode(optArgs[0]));
+            setDumpFlashEndAddress(Long.decode(optArgs[1]));


Potential uncaught 'java.lang.NumberFormatException'.

Copilot · 2025-11-30T01:53:25Z

firmware_updater/updater/src/org/selfbus/updater/gui/ConColorsToStyledDoc.java

+            int cursorMovementCode = cursorMovement.charAt(cursorMovement.length() - 1);
+            int number;
+            if (cursorMovement.length() > 1) {
+                number = Integer.parseInt(cursorMovement.substring(0, cursorMovement.length() - 1));


Potential uncaught 'java.lang.NumberFormatException'.

Copilot · 2025-11-30T01:53:25Z

firmware_updater/updater/src/org/selfbus/updater/gui/ConColorsToStyledDoc.java

+                code = code.substring(0, code.length() - 1); // strip of 'm'
+            }
+
+            switch (Integer.parseInt(code)) {


Potential uncaught 'java.lang.NumberFormatException'.

Copilot · 2025-11-30T01:53:26Z

firmware_updater/updater/src/org/selfbus/updater/Updater.java

+            }
+        }
+
+        public void run() {


This method overrides Thread.run; it is advisable to add an Override annotation.

Copilot · 2025-11-30T01:53:26Z

firmware_updater/updater/src/org/selfbus/updater/Updater.java

+     *
+     * @see java.lang.Runnable#run()
+     */
+    public void run() {


This method overrides Runnable.run; it is advisable to add an Override annotation.

Copilot · 2025-11-30T01:53:27Z

firmware_updater/updater/src/org/selfbus/updater/SBManagementClientImpl.java

+            this.linkLogger = (Logger) LoggerFactory.getLogger(SBLinkListener.class.getName() + " " + link.getName());
+        }
+
+        public void indication(final FrameEvent e)


This method overrides LinkListener.indication; it is advisable to add an Override annotation.

Copilot · 2025-11-30T01:53:27Z

firmware_updater/updater/src/org/selfbus/updater/bootloader/BootloaderIdentity.java

+        return new BootloaderIdentity(vMajor, vMinor, versionSBLibMajor, versionSBLibMinor, features, applicationFirstAddress);
+    }
+
+    public String toString() {


This method overrides Record.toString; it is advisable to add an Override annotation.

Copilot · 2025-11-30T01:53:27Z

firmware_updater/updater/src/org/selfbus/updater/progress/ProgressInfo.java

+        return "   Done Speed   Avg   Min   Max  Time";
+    }
+
+    public String toString() {


This method overrides Object.toString; it is advisable to add an Override annotation.

Darthyson added 30 commits August 9, 2024 14:08

[Updater] Use constant for settings.xml handling

c993ffe

[Updater] Bump commons-cli:commons-cli from 1.5.0 to 1.8.0

cd898ec

[Updater] Bump org.fusesource.jansi:jansi from 2.4.0 to 2.4.1

688e97f

[Updater] With c081ba3 --fileName is no more required

309245c

[Updater] Suppress inspection on javax.javax.usb.properties

9d90fd3

[Updater] Use CliInvalidException for logic errors

0a49ff2

There is no reason to log/print the stack-trace on `CliInvalidException` (logic errors, e.g. IP-Secure together with USB-Interface)

[Updater] log styling

0bfe374

[Updater] More cli-logic checks on IP-Secure, USB

2334d43

[Updater] Fix gradle warnings

3cb63b4

[Updater] Ensure UTF-8 encoding, add description

5fedec8

[Updater] Serialisation warning disabled in 3cb63b4

ea89fc7

[Updater] MANIFEST.MF is created dynamically during build

b7f2c55

[Updater] Add sourceSets, move .hex files to tests

4c88a76

[Updater] Add version, git-sha and build time to MANIFEST.MF

410b0a8

[Updater] Fix missing java in sourceSets path

44d8d43

[Updater] Use plugin com.gradleup.shadow for shadowJar

f719f7e

Instead of creating/configuring/tinkering by our self a fatJar, we use now `com.gradleup.shadow` to create a `shadowJar`. The old `fatJar` gradle task will be now redirected to the new `shadowJar` task for some time.

[Updater] Fix gradle sourceSets, MANIFEST.MF & some links

1af5563

[Updater] Recreate deleted .idea files

59dbf3d

New files in `.idea` are from a fresh gradle import in IntelliJ IDEA Community Edition 2024.2

[Update] Add application template

c37ba36

[Updater] Fix typos and docu

a13d56b

[Updater] English is default language, no need translate

03fea64

[GUI] Fix camelCase

ef834ac

[GUI] Rename language resources and in subfolder language

5275353

[GUI] Fix warning hardcoded value

042ee62

[GUI] Only one element. No need for list.

4671ef3

[Updater] Don´t use custom tag @warning

6af9a5b

[Updater] Use Javadoc not DoxyGen

8a0fa9e

[Updater] Use System.lineSeparator() instead of \n

39dc7c3

Darthyson added 22 commits November 17, 2025 13:02

Format ComObject debug logging

cb1fc12

Fix objConf debug logging

10e411d

`objno` was logged instead of `objConf`

Add some setObjectFlags debug logging

17c6ad7

Move some ComObject debug logging to new header

6e9dc87

Add BCU ComObjectConfig table debug logging

9aaa630

Add BCU1 ComObjectConfig table debug logging

9afbf47

[Test] Add Memory and UserEeprom unit tests

087a99b

[Updater] Invert link state logic for better readability

cf92241

[Updater] Show tunnel address, if available

e55b6f3

[Updater] Upgrade gradle to 9.2.1

7d5286a

Also fixed gradle warning: The archives configuration has been deprecated for artifact declaration.

[Updater] Upgrade to net.harawata:appdirs:1.5.0

cb1f3ef

[Updater] Upgrade to slf4j-jdk-platform-logging:2.0.17

2263650

[Updater] Upgrade to com.google.guava:guava:33.5.0-jre

5d3da80

[Updater] Upgrade to jackson-databind:2.20.1

4199521

[Updater] Upgrade to logback-classic:1.5.21

47ee871

[Updater] Upgrade to jline-terminal-jansi:3.30.6

82efb5e

[Updater] Upgrade commons-cli:1.11.0

46d456a

[Updater] Fix commons-cli .build() deprecation warning

dd702d2

[Updater] Add todo for HelpFormatter deprecation warning

e614123

Add dependabot for Updater

0700e49

[Updater] Bump version to 1.27

cb110d8

Darthyson requested review from dallmair and gnampf1 November 18, 2025 19:34

Darthyson added bug enhancement labels Nov 18, 2025

Darthyson requested a review from Copilot November 30, 2025 01:49

Copilot started reviewing on behalf of Darthyson November 30, 2025 01:50 View session

Copilot finished reviewing on behalf of Darthyson November 30, 2025 01:51

Copilot AI reviewed Nov 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Updater Improvements and Refactoring #113

Updater Improvements and Refactoring #113

Darthyson commented Nov 18, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Copilot AI Nov 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Updater Improvements and Refactoring #113

Are you sure you want to change the base?

Updater Improvements and Refactoring #113

Conversation

Darthyson commented Nov 18, 2025

Key Features & Enhancements

Breaking Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants