v4.1.0 Release ready

DevelopmentDocs/changes.txt

@@ -1,6 +1,18 @@
+# v4.1.0 Debugging and improvements release
+Refactoring:
+- The setOutputsChange() and getOutputsChange() transparently changed. The API was not changed -it still sets and returns a boolean value- but internally now keeps a counter to avoid multithread developments generated race conditions.
+Debugging:
+- The use of getters and taskNotify mechanisms for the same attribute flags at the same time generated unexpected results due to race conditions: SOLVED.
+- Code overall simplification and cleanup.
+- DFA unconditional state changes allowed to cascade on more classes' state machines.
+Example files:
+- Several example files added.
+- Some example files modified to show different solutions approaches for the same results.
+
 # v4.0.5 Maintenance release
 - DbncdMPBttn::init() conditional execution premises corrected (the condition resulted in a Paradox)
-Pending of test on the STM32 implementation- DFA unconditional state changes allowed to cascade advancement in single step to improve speed and responsiveness for the DbncdMPBttn and DbncdDlydMPBttn classes.
+Pending of test on the STM32 implementation
+- DFA unconditional state changes allowed to cascade advancement in single step to improve speed and responsiveness for the DbncdMPBttn and DbncdDlydMPBttn classes.
 
 # v4.0.4 Maintenance release
 - Code cleanup.

README.md

@@ -1,5 +1,5 @@
 # **Buttons to Switches Library** (ButtonToSwitch_ESP32)
-## **The driving concept is pretty simple: stop checking an input pin voltage, start asking if your switch is On or Off.**  
+## **The driving concept is pretty simple: stop checking an input pin voltage, start asking if the switch is On or Off.**  
 
 This library is an evolutionary refactoring of my own -now archived- **mpbToSwitch** library.
 

docs/_button_to_switch___e_s_p32_8cpp.html

@@ -28,7 +28,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="Complex_Switch_Sq_Sm_Color_In.jpg"/></td>
   <td id="projectalign">
-   <div id="projectname">ButtonToSwitch Library for ESP32 (Arduino)<span id="projectnumber">&#160;v4.0.4</span>
+   <div id="projectname">ButtonToSwitch Library for ESP32 (Arduino)<span id="projectnumber">&#160;v4.1.0</span>
    </div>
    <div id="projectbrief">A library that provides elaborated switch mechanism behavior simulation for digital signals inputs</div>
   </td>
@@ -132,7 +132,7 @@
 <div class="textblock"><p>: Source file for the ButtonToSwitch_ESP32 library classes </p>
 <p>The library implements classes that model several switch mechanisms replacements out of simple push buttons or similar equivalent digital signal inputs. By using just a button (a.k.a. momentary switches or momentary push buttons, <em><b>MPB</b></em> for short from here on) the classes implemented in this library will manage, calculate and update several parameters to <b>generate the embedded behavior of standard electromechanical switches</b>.</p>
 <dl class="section author"><dt>Author</dt><dd>: Gabriel D. Goldman </dd></dl>
-<dl class="section version"><dt>Version</dt><dd>v4.0.4 </dd></dl>
+<dl class="section version"><dt>Version</dt><dd>v4.1.0 </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>: Created on: 06/11/2023 : Last modification: 15/09/2024 </dd></dl>
 <dl class="section copyright"><dt>Copyright</dt><dd>GPL-3.0 license</dd></dl>
 <dl class="section attention"><dt>Attention</dt><dd>This library was developed as part of the refactoring process for an industrial machines security enforcement and productivity control (hardware &amp; firmware update). As such every class included complies <b>AT LEAST</b> with the provision of the attributes and methods to make the hardware &amp; firmware replacement transparent to the controlled machines. Generic use attribute and methods were added to extend the usability to other projects and application environments, but no fitness nor completeness of those are given but for the intended refactoring project.</dd></dl>

docs/_button_to_switch___e_s_p32_8h.html

@@ -28,7 +28,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="Complex_Switch_Sq_Sm_Color_In.jpg"/></td>
   <td id="projectalign">
-   <div id="projectname">ButtonToSwitch Library for ESP32 (Arduino)<span id="projectnumber">&#160;v4.0.4</span>
+   <div id="projectname">ButtonToSwitch Library for ESP32 (Arduino)<span id="projectnumber">&#160;v4.1.0</span>
    </div>
    <div id="projectbrief">A library that provides elaborated switch mechanism behavior simulation for digital signals inputs</div>
   </td>
@@ -189,7 +189,7 @@
 <div class="textblock"><p>: Header file for the ButtonToSwitch_ESP32 library classes </p>
 <p>The library implements classes that model several switch mechanisms replacements out of simple push buttons or similar equivalent digital signal inputs. By using just a button (a.k.a. momentary switches or momentary push buttons, <em><b>MPB</b></em> for short from here on) the classes implemented in this library will manage, calculate and update several parameters to <b>generate the embedded behavior of standard electromechanical switches</b>.</p>
 <dl class="section author"><dt>Author</dt><dd>: Gabriel D. Goldman </dd></dl>
-<dl class="section version"><dt>Version</dt><dd>v4.0.4 </dd></dl>
+<dl class="section version"><dt>Version</dt><dd>v4.1.0 </dd></dl>
 <dl class="section date"><dt>Date</dt><dd>: Created on: 06/11/2023 : Last modification: 28/08/2024 </dd></dl>
 <dl class="section copyright"><dt>Copyright</dt><dd>GPL-3.0 license</dd></dl>
 <dl class="section attention"><dt>Attention</dt><dd>This library was developed as part of the refactoring process for an industrial machines security enforcement and productivity control (hardware &amp; firmware update). As such every class included complies <b>AT LEAST</b> with the provision of the attributes and methods to make the hardware &amp; firmware replacement transparent to the controlled machines. Generic use attribute and methods were added to extend the usability to other projects and application environments, but no fitness nor completeness of those are given but for the intended refactoring project.</dd></dl>