Documentation fixes

Examples added and actions are updated.

Author: dani007200964

.github/workflows/compile-examples.yml

@@ -24,6 +24,8 @@ jobs:
 
           sketch-paths: |
             - examples/Commander_simple
+            - examples/Commander_simple_stream_pipe
+            - examples/Commander_simple_progmem
 
   compile-examples-for-esp32:
     runs-on: ubuntu-latest
@@ -46,7 +48,10 @@ jobs:
               source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
 
           sketch-paths: |
+            - examples/Commander_Shellminator_Advanced_Telnet_ESP32
+            - examples/Commander_Shellminator_Advanced_WebSocket_ESP32
             - examples/Commander_simple_ESP32
+            - examples/Commander_simple_stream_pipe_ESP32
 
   compile-examples-for-esp8266:
     runs-on: ubuntu-latest

README.md

@@ -3,22 +3,22 @@
 
 Commander-API is a simple-to-use parser library, and you can easily use it to process character based commands and link them to a specified function. It is designed mainly to work with low memory capacity devices, for example, __small ARM or AVR processors__.
 
-## Changes in V2
-
-Version 2.X is a more refined version of the original Commander-API. The original was working well, but it was a bit flimsy when you had to work with a huge API list.
-It also caused Hard-fault when the API tree was not created correctly. Besides that, if you wanted to add a new command, you had to change the header and the source
-file as well. The biggest problem was, that it was a C-API, so no overloading, no C++ magic.
-
-The new version is designed from ground up and the main motivation was to make it as reliable as the original, but make it much simpler to use.
-
-__Key changes:__
-* Full C++ API
-* Arduino compatible without any modifications
-* Platform-IO compatibility
-* Simpler usage
-* Better example
-* Low memory consumption to make it compatible with lower end devices like Arduino UNO, Nano...
-* Response function overload. Thanks to C++ the response function can be anything like Serial, WiFiClient...
+__Key changes in V1.2:__
+* New shortcut keys.
+* Option to set the timeout of the internal client.
+* Advanced search functions( Ctrl-R, Page-Up, Page-Down )
+* Banner text change option.
+* Path text change option. Also change it to blue color
+* Websocket channel
+* Terminal buzzer command, with mute option
+* QR-code generation
+* History command
+* Help command
+
+__Breaking changes in V1.2:__
+* The response channel is now uses the Stream class.
+  This way it is more flexible and you doesn't have to
+  create a class for every peripheral.
 
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

docs/html/_commander-_a_p_i-_commands_8cpp.html

@@ -163,6 +163,12 @@
 <tr class="memitem:a9ce486c9f6cc8f9d32719dde240cc9dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_commander-_a_p_i-_commands_8cpp.html#a9ce486c9f6cc8f9d32719dde240cc9dd">commander_wifiScan_func</a> (char *args, Stream *response)</td></tr>
 <tr class="memdesc:a9ce486c9f6cc8f9d32719dde240cc9dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Premade function for wifiScan command.  <a href="_commander-_a_p_i-_commands_8cpp.html#a9ce486c9f6cc8f9d32719dde240cc9dd">More...</a><br /></td></tr>
 <tr class="separator:a9ce486c9f6cc8f9d32719dde240cc9dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a89464d6a1bd02945dc651ed287eb0a9a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_commander-_a_p_i-_commands_8cpp.html#a89464d6a1bd02945dc651ed287eb0a9a">commander_configTime_func</a> (char *args, Stream *response)</td></tr>
+<tr class="memdesc:a89464d6a1bd02945dc651ed287eb0a9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Premade function for wifiScan command.  <a href="_commander-_a_p_i-_commands_8cpp.html#a89464d6a1bd02945dc651ed287eb0a9a">More...</a><br /></td></tr>
+<tr class="separator:a89464d6a1bd02945dc651ed287eb0a9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a841d50286418ffc91a2820f93a757ae7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_commander-_a_p_i-_commands_8cpp.html#a841d50286418ffc91a2820f93a757ae7">commander_dateTime_func</a> (char *args, Stream *response)</td></tr>
+<tr class="memdesc:a841d50286418ffc91a2820f93a757ae7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Premade function for wifiScan command.  <a href="_commander-_a_p_i-_commands_8cpp.html#a841d50286418ffc91a2820f93a757ae7">More...</a><br /></td></tr>
+<tr class="separator:a841d50286418ffc91a2820f93a757ae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa105b8da0d1654685a5ab1eee8254dc7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_commander-_a_p_i-_commands_8cpp.html#aa105b8da0d1654685a5ab1eee8254dc7">commander_neofetch_func</a> (char *args, Stream *response)</td></tr>
 <tr class="memdesc:aa105b8da0d1654685a5ab1eee8254dc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Premade function for neofetch command.  <a href="_commander-_a_p_i-_commands_8cpp.html#aa105b8da0d1654685a5ab1eee8254dc7">More...</a><br /></td></tr>
 <tr class="separator:aa105b8da0d1654685a5ab1eee8254dc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -221,7 +227,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac12b28f732724d7b0149e999
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00800">800</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00861">861</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
 </div>
 </div>
@@ -262,6 +268,45 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad50e2da8c65464fded53e4f1
 
 <p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00292">292</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
+</div>
+</div>
+<a id="a89464d6a1bd02945dc651ed287eb0a9a" name="a89464d6a1bd02945dc651ed287eb0a9a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a89464d6a1bd02945dc651ed287eb0a9a">&#9670;&#160;</a></span>commander_configTime_func()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void commander_configTime_func </td>
+          <td>(</td>
+          <td class="paramtype">char *&#160;</td>
+          <td class="paramname"><em>args</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">Stream *&#160;</td>
+          <td class="paramname"><em>response</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Premade function for wifiScan command. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">args</td><td>Pointer to the argument string. </td></tr>
+    <tr><td class="paramname">response</td><td>Response channel for messages. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00494">494</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+
 </div>
 </div>
 <a id="ab6780710f945ac78f9b54630663f4e75" name="ab6780710f945ac78f9b54630663f4e75"></a>
@@ -299,7 +344,46 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab6780710f945ac78f9b54630
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00733">733</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00794">794</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+
+</div>
+</div>
+<a id="a841d50286418ffc91a2820f93a757ae7" name="a841d50286418ffc91a2820f93a757ae7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a841d50286418ffc91a2820f93a757ae7">&#9670;&#160;</a></span>commander_dateTime_func()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void commander_dateTime_func </td>
+          <td>(</td>
+          <td class="paramtype">char *&#160;</td>
+          <td class="paramname"><em>args</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">Stream *&#160;</td>
+          <td class="paramname"><em>response</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Premade function for wifiScan command. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">args</td><td>Pointer to the argument string. </td></tr>
+    <tr><td class="paramname">response</td><td>Response channel for messages. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00530">530</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
 </div>
 </div>
@@ -533,7 +617,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa105b8da0d1654685a5ab1ee
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00494">494</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00549">549</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
 </div>
 </div>
@@ -572,7 +656,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a768c422672b927ef72696dd6
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00741">741</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00802">802</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
 </div>
 </div>
@@ -650,7 +734,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aec5a719106b789f165808039
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00764">764</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00825">825</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
 </div>
 </div>
@@ -689,7 +773,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa254cffc6e91bf6c2c779802
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00703">703</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00758">758</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
 </div>
 </div>
@@ -728,7 +812,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1a754007529f61db96b2ac3b
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00725">725</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
+<p class="definition">Definition at line <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html#l00786">786</a> of file <a class="el" href="_commander-_a_p_i-_commands_8cpp_source.html">Commander-API-Commands.cpp</a>.</p>
 
 </div>
 </div>
@@ -867,11 +951,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#a066128d063cd819e9bafb1fe
       <a title="Shellminator" href="https://github.com/dani007200964/Commander-API">
         <img class="footer" src="logo.svg" alt="Shellminator" style="height:20px;width:auto;"/>
       </a> &nbsp;|&nbsp;
-      <a title="Daniel Hajnal" href="mailto: [email protected]"> &copy; 2020-2022 Daniel Hajnal </a> &nbsp;|&nbsp;
+      <a title="Daniel Hajnal" href="mailto: [email protected]"> &copy; 2020-2023 Daniel Hajnal </a> &nbsp;|&nbsp;
       <b>Commander-API V2.1.0</b> &nbsp;|&nbsp; Generated by:
       <a href="http://www.doxygen.org/index.html">
         <img class="footer" src="doxygen.svg" alt="doxygen"/>
-      </a> on Mon Oct 10 2022
+      </a> on Fri Feb 10 2023
       <hr class="footer"/><address class="footer"><small>
         <a title="PlatformIO" href="https://registry.platformio.org/libraries/dani007200964/Commander-API">
           <img class="footer" src="platformio_logo.png" alt="PlatformIO" style="height:20px;width:auto;"/>
@@ -882,11 +966,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#a066128d063cd819e9bafb1fe
         <a title="Shellminator" href="https://github.com/dani007200964/Commander-API">
           <img class="footer" src="logo.svg" alt="Shellminator" style="height:20px;width:auto;"/>
         </a> &nbsp;|&nbsp;
-        <a title="Daniel Hajnal" href="mailto: [email protected]"> &copy; 2020-2022 Daniel Hajnal </a> &nbsp;|&nbsp;
+        <a title="Daniel Hajnal" href="mailto: [email protected]"> &copy; 2020-2023 Daniel Hajnal </a> &nbsp;|&nbsp;
         <b>Commander-API V2.1.0</b> &nbsp;|&nbsp; Generated by:
         <a href="http://www.doxygen.org/index.html">
           <img class="footer" src="doxygen.svg" alt="doxygen"/>
-        </a> on Mon Oct 10 2022
+        </a> on Fri Feb 10 2023
       </small></address>
     </li>
   </ul>

docs/html/_commander-_a_p_i-_commands_8cpp.js

@@ -2,7 +2,9 @@ var _commander__a_p_i__commands_8cpp =
 [
     [ "commander_abs_func", "_commander-_a_p_i-_commands_8cpp.html#ac12b28f732724d7b0149e99927664af0", null ],
     [ "commander_analogRead_func", "_commander-_a_p_i-_commands_8cpp.html#ad50e2da8c65464fded53e4f101c12df4", null ],
+    [ "commander_configTime_func", "_commander-_a_p_i-_commands_8cpp.html#a89464d6a1bd02945dc651ed287eb0a9a", null ],
     [ "commander_cos_func", "_commander-_a_p_i-_commands_8cpp.html#ab6780710f945ac78f9b54630663f4e75", null ],
+    [ "commander_dateTime_func", "_commander-_a_p_i-_commands_8cpp.html#a841d50286418ffc91a2820f93a757ae7", null ],
     [ "commander_digitalRead_func", "_commander-_a_p_i-_commands_8cpp.html#a2ddb2545106085b4c45b9d7d6e0271c2", null ],
     [ "commander_digitalWrite_func", "_commander-_a_p_i-_commands_8cpp.html#a25104d380b58889aabc445a89372e298", null ],
     [ "commander_ipconfig_func", "_commander-_a_p_i-_commands_8cpp.html#af2d007a0ffedbcbb4e50e5e455f2b580", null ],