opt/1085-optimization-and-cleanup #37

ismail · 2025-09-05T09:52:58+02:00

ismail commented

2025-09-05 09:52:58 +02:00

Summary

This pull request introduces multiple improvements, refactorings, and bug fixes across the relay channel core, NVS module, notification system, and testing infrastructure.
The primary goals are to optimize performance, improve reliability, clean up the codebase, and align the implementation with ESP-IDF best practices.
Additionally, it enhances test coverage, adds SPDX headers, introduces build profile usage, and improves maintainability by addressing long-standing issues.

TICKET-1085

Changes

Fixed conditional compilation issues in CMakeLists and source files.
Restored original naming convention for config parameters (with CONFIG_ prefix).
Fixed static variable naming to follow ESP-IDF style.
Added SPDX license headers to source files.
Introduced a dedicated notification system for relay channel state changes.
Enhanced the NVS module with a background task, async writes, better commit logic, and improved error handling.
Fixed critical NVS key generation bug for multi-channel storage.
Added default tilt sensitivity get function and tests.
Refactored and improved unit tests (NVS, reset functions, tilt, etc.).
Added new *all and *all_with functions to simplify API.
Improved relay command handling with prioritized STOP and tilt sensitivity boundary checks.
Implemented relay_chn_stop_prv for more efficient stop handling.
Fixed listener unregistration behavior and notification queue handling.
Fixed various bugs (timer underflow, esp_timer_start error handling, STOP command not interrupting).
Introduced build profiles instead of multiple sdkconfig.defaults.* files.
Stopped tracking auto-generated sdkconfig files via .gitignore.
General code cleanup: constants replacement, bracket refactors, style alignment, improved comments, and removed unused declarations.
Expanded test coverage with missing cases, tags, and fixes for multi-channel tests.
Added .ESP-IDF vscode configuration files for development.

#1085 - Optimization and cleanup
#1086 - Add boundary checks for tilt sensitivity
#1087 - Rename time_sec to limit_sec for clarity
#1088 - Enhance relay command handling
#1089 - Implement *all and *all_with functions and related tests
#1090 - Add missing test cases
#1091 - Fix possible integer underflow bug
#1092 - Fix esp_timer_start error handling
#1093 - STOP command does not interrupt
#1094 - Fix single channel tests in multi mode
#1095 - Stop between transitions leads to many state changes
#1096 - Notification system and NVS enhancements
#1097 - Notification system improvements with bakcground task
#1098 - NVS improvements with background task
#1099 - Add SPDX license headers
#1100 - Fix NVS key generation bug
#1101 - Add default tilt sensitivity get function
#1102 - Fix unregister listener behavior
#1103 - Fix static variable names

Breaking Changes

Config parameter names have been restored to their original CONFIG_ prefixed form.
Old listener management code has been removed and replaced with the new notification system. Now, listener callbacks are called from a background task.
NVS write operations are now processed in a dedicated background task.
API changes and new API functions for relay channel batch operation in multi-channel mode.

Migration Guide

Update any code that referenced renamed config parameters to use the CONFIG_ prefixed versions.
No changes are required to the listener-related code, as no changes have been made to the public API.
Update any code that sets or gets settings saved in NVS (if enabled). Note that setting functions save values to NVS asynchronously, while getting is still synchronous. See README > NVS Operation Details.
If relying on the old batch operation relay command APIs, update to the new *all/*all_with functions. These functions are available only for multi-channel mode. See README > Usage for further information.

## Summary This pull request introduces multiple improvements, refactorings, and bug fixes across the relay channel core, NVS module, notification system, and testing infrastructure. The primary goals are to optimize performance, improve reliability, clean up the codebase, and align the implementation with ESP-IDF best practices. Additionally, it enhances test coverage, adds SPDX headers, introduces build profile usage, and improves maintainability by addressing long-standing issues. TICKET-1085 ## Changes - Fixed conditional compilation issues in CMakeLists and source files. - Restored original naming convention for config parameters (with `CONFIG_` prefix). - Fixed static variable naming to follow ESP-IDF style. - Added SPDX license headers to source files. - Introduced a dedicated notification system for relay channel state changes. - Enhanced the NVS module with a background task, async writes, better commit logic, and improved error handling. - Fixed critical NVS key generation bug for multi-channel storage. - Added default tilt sensitivity get function and tests. - Refactored and improved unit tests (NVS, reset functions, tilt, etc.). - Added new `*all` and `*all_with` functions to simplify API. - Improved relay command handling with prioritized STOP and tilt sensitivity boundary checks. - Implemented `relay_chn_stop_prv` for more efficient stop handling. - Fixed listener unregistration behavior and notification queue handling. - Fixed various bugs (timer underflow, esp_timer_start error handling, STOP command not interrupting). - Introduced build profiles instead of multiple `sdkconfig.defaults.*` files. - Stopped tracking auto-generated sdkconfig files via `.gitignore`. - General code cleanup: constants replacement, bracket refactors, style alignment, improved comments, and removed unused declarations. - Expanded test coverage with missing cases, tags, and fixes for multi-channel tests. - Added `.ESP-IDF` vscode configuration files for development. ## Related Issues - #1085 - Optimization and cleanup - #1086 - Add boundary checks for tilt sensitivity - #1087 - Rename time_sec to limit_sec for clarity - #1088 - Enhance relay command handling - #1089 - Implement *all and *all_with functions and related tests - #1090 - Add missing test cases - #1091 - Fix possible integer underflow bug - #1092 - Fix esp_timer_start error handling - #1093 - STOP command does not interrupt - #1094 - Fix single channel tests in multi mode - #1095 - Stop between transitions leads to many state changes - #1096 - Notification system and NVS enhancements - #1097 - Notification system improvements with bakcground task - #1098 - NVS improvements with background task - #1099 - Add SPDX license headers - #1100 - Fix NVS key generation bug - #1101 - Add default tilt sensitivity get function - #1102 - Fix unregister listener behavior - #1103 - Fix static variable names ## Breaking Changes - Config parameter names have been restored to their original `CONFIG_` prefixed form. - Old listener management code has been removed and replaced with the new notification system. Now, listener callbacks are called from a background task. - NVS write operations are now processed in a dedicated background task. - API changes and new API functions for relay channel batch operation in multi-channel mode. ## Migration Guide - Update any code that referenced renamed config parameters to use the `CONFIG_` prefixed versions. - No changes are required to the listener-related code, as no changes have been made to the public API. - Update any code that sets or gets settings saved in NVS (if enabled). Note that setting functions save values to NVS asynchronously, while getting is still synchronous. See [README > NVS Operation Details](https://git.kozmotronik.com.tr/KozmotronikTech/relay_chn/src/branch/opt/1085-optimization-and-cleanup/README.md#nvs-operation-details). - If relying on the old batch operation relay command APIs, update to the new `*all/*all_with` functions. These functions are available only for multi-channel mode. See [README > Usage](https://git.kozmotronik.com.tr/KozmotronikTech/relay_chn/src/branch/opt/1085-optimization-and-cleanup/README.md#usage) for further information.

🎉 1

ismail added 36 commits 2025-09-05 09:52:59 +02:00

Fix implicit-fallthrough warning. 9d3f8ddbff

Refs #1085.

Use original names for config parameters 5afefc4dc0

The config parameter names defined in the relay_chn_defs.h file
have been changed back to their original names (with the CONFIG_ prefix),
so that they are not confused with application-level defines.

Refs #1085

Fix config parameters check 6ff16b5797

Unnecessary `#if CONFIG_FOO == 1` checks were removed and the
statements were simplified to` #if CONFIG_FOO`.
`#ifdef CONFIG_FOO` statements were also changed to `#if CONFIG_FOO`
to keep the style as uniform as possible.

Refs #1085

Fix build path be4a2ebef6

Implement specific *all functions 3831384169

Specific `_*all` and `_*all_with` functions were implemented to make
the API more concise and clean, and to replace the use of
`RELAY_CHN_ID_ALL`, which caused confusion within the API.

Refs #1085

Cleanup and replace constants 396a02b5ae

- Delete unused declaration of `g_is_component_initialized`.
- Replace the following constants with approprite config options:
  + `relay_chn_count` > `CONFIG_RELAY_CHN_COUNT`
  + `opposite_inerta_ms` > `CONFIG_RELAY_CHN_OPPOSITE_INERTIA_MS`
- Replace the definition of the `test_delay_margin_ms` constant with  `#define TEST_DELAY_MARGIN_MS 50` for preprocessor calculations.

Add .ESP-IDF vscode configuration files 54c8dc26fc

Enhance relay command handling 329812aecc

- `TILT_STOP` command is prioritized in `relay_chn_tilt_issue_cmd()` because it should override any other tilt commands.
- The debug logs are cleaned up.

Fixes #1088
Refs #1085

Refactor and improve for batch operations 15d1673e77

Refactor tilt test functions to use batch operations for all channels and improve state checks.

Refs #1085

Refactor function brackets da953846c9

Refactor the brackets of the test case functions to align with ESP-IDF style.

Refs #1085

Use build profiles instead of providing sdkconfig.defaults manually 0b75df35d1

ESP-IDF provides a more efficient way of handling and combining
multi-configurations for a project than the way currently used:
Build profiles.

So I switched to this method instead of providing the sdkconfig.defaults.*
files manually. This reduced the number of sdkconfig.defaults.* files
as well as the configuration parameters defined in them.

Refs #1085

Add upper boundary checks for tilt sensitivity settings 9a6b8c9f80

The tilt sensitivity values were passed to the NVS module without
the boundaries being checked, even though the maximum
percent value is 100. This commit fixes this issue.
Also test cases are added to cover the upper boundary checks
for the tilt sensitivity settings.

Fixes #1086

Rename time_sec to limit_sec in relay channel functions for clarity 79a66c19d7

Fixes #1087

Optimize internal stop calls for output errors ae33204a87

Fix possible integer underflow bug 374647732c

Fixed a possible integer underflow bug that may cause the timer
to be set for an unexpectedly long duration.

Fixes #1091

Fix esp_timer_start error handling 71b632737e

A helper function added for each module so that each module
handles errors by itself.

Fixes #1092

Fix STOP command does not interrupt 7d597f3725

An if statement has been added to handle the STOP command properly
when the `previous_state` is one of the `*PENDING` states.

Fixes #1093

Fix function call 4eb1bb03a0

Refs #1090

Add missing test cases ec1b25d489

Some missing test cases for the public API have been added.

Closes #1090

Refactor and enhance reset_channels_to_idle_state 0cd6b4e263

- Refactor reset_channels_to_idle_state to reset_channels_to_defaults
and enhance functionality with direction reset logic. This is because
some tilt test cases were failing due to modified run limit values in some
of the previous core test cases. See #1089-3.
- A relay channel listener has been added to diagnose channel
states during tests.

Refs #1089

Add test cases for *all and *all_with functions a6d38327b7

Added test cases for the recently implemented `*all` and `*all_with`
functions. Closes #1089.

Implement relay_chn_stop_prv function a2e8e3c120

Implemented `relay_chn_stop_prv` to streamline stop command handling
and avoid unnecessary code execution. Fixes #1095.

Add missing test tags dea9f1e986

Fix single channel tests in multi mode tests db55c0b7e4

Some test cases that were testing for only one channel in multi-channel mode are fixed to test all available channels. Fixes #1094

Ignore autogenerated sdkconfig file d2b38a5b4e

Add notification system for relay channel state changes 5e8e5a4cab

- Introduced a new notification module to handle state change listeners.
- Added functions to register and unregister listeners for relay channel state changes.
- Implemented a queue-based system to manage notifications and listener callbacks.
- Updated core relay channel logic to utilize the new notification system.
- Removed old listener management code from relay channel core.
- Refactored the former listener tests to notify tests and added tests for the notification system, including handling of multiple listeners and queue overflow scenarios.
- Updated CMakeLists.txt to include new source files and headers for the notification module.
- Revised README.md to include warnings about callback execution context and performance considerations.

Refs #1096, #1085 and closes #1097

Fix NVS key bug and optimize for single mode 0122ef0803

- Fixed a critical NVS key generation bug that would cause overwriting the values for all channels.
- Optimized the code for single channel mode since no formatting required.
- Improved multi-channel test coverage to cover that each value for each channel stored correctly.

Refs #1096, #1098 and fixes #1100

Enhance NVS module with a dedicated background task 2c9ee40ff4

- Implemented a dedicated background task to decouple long-running code from the main application task.
- Improved the NVS commit code logic, especially for batch writes to minimize flash wear.
- Updated NVS functions to support asynchronous writes and synchronous reads.
- Added default value parameters to `get` functions for better usability.
- Improved error handling and logging in NVS operations.
- Refactored related code in multiple source files to accommodate these changes.

Refs #1085, #1096 and closes #1098

Refactor and improve unit tests 639533cbb6

- Refactored and improved NVS tests to accomodate latest changes in NVS module. See #1098
- Improved channel reset function that is called from `tearDown` to minimize public API calls that trigger a chain of internal calls that involve NVS and timer operations.
- Fixed test case bugs that make some test cases to fail.

Refs #1096, #1098

Stop tracking auto generated sdkconfig file a1a54e2ca0

Fix the operation of unregistering listener ad377ebfc8

- Add check for empty listener list in find_listener_entry function.
- Reset notification queue when all listeners are removed.
- Change queue operation to send remove_listener message to the front of the queue.

Refs #1085, #1096 and fixes #1102

Add default tilt sensitivity get function 7bafc4845f

Added `relay_chn_tilt_get_default_sensitivity` function and test cases.

Refs #1085 and fixes #1101

Add SPDX license headers to multiple source files 7244b57061

Refs #1085 and closes #1099

General code and comment cleanup bf5e3a4426

Fix static variable names 86cc29a33b

Fixed static variable names according to the ESP-IDF C code formatting guide.

Refs #1085 and fixes #1103

Fix conditional compilation issues. 61ca2197e1

Fixed include directory settings and conditional includes in CMakeLists and test_common.c. Refs #1085.

ismail added the Compat/Breaking Kind/Bug Kind/Documentation Kind/Enhancement Kind/Feature labels 2025-09-05 10:05:12 +02:00

ismail merged commit a3f83eaaee into dev

2025-09-05 10:05:42 +02:00

ismail referenced this issue from a commit

2025-09-05 10:05:44 +02:00

Merge pull request 'opt/1085-optimization-and-cleanup' (!37) from opt/1085-optimization-and-cleanup into dev

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: KozmotronikTech/relay_chn#37