Merge pull request #14 from dani007200964/dev

For Version 2.1.0

Author: dani007200964

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,6 @@
 ---
-name: Bug report
-about: Create a report to help us improve
+name: 🐛 Bug report
+about: Report a bug in the software
 title: ''
 labels: bug
 assignees: ''

.github/ISSUE_TEMPLATE/documentation_problem.md

@@ -0,0 +1,25 @@
+---
+name: 📜 Documentation problem
+about: Report a problem in the documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Describe the problem**
+A clear and concise description of what the problem is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. The problem is on page '...'
+2. The problem is on section '...'
+3. In the documentation there is '...' instead of '...'
+4. '...' is missing from '...'
+5. I don't understand this step or section: '...'
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
+name: 🚀 Feature request
+about: Propose a new feature
 title: ''
 labels: enhancement
 assignees: ''

.github/workflows/compile-examples.yml

@@ -24,6 +24,7 @@ jobs:
 
           sketch-paths: |
             - examples/Commander_simple
+            - examples/Commander_simple_progmem
 
   compile-examples-for-esp32:
     runs-on: ubuntu-latest

Doc/markdown_pages/arduino_installation.md

@@ -48,7 +48,7 @@ PROJECT_NAME           = Commander-API
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = V2.0.2
+PROJECT_NUMBER         = V2.1.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -61,7 +61,7 @@ PROJECT_BRIEF          = "Simple Command Parser"
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = docs/images/logo.PNG
+PROJECT_LOGO           = docs/images/logo.svg
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -505,7 +505,7 @@ EXTRACT_ALL            = YES
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
@@ -1332,7 +1332,7 @@ HTML_HEADER            = docs/Style/doxygen-custom/header.html
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            =
+HTML_FOOTER            = docs/Style/doxygen-custom/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1374,7 +1374,9 @@ HTML_EXTRA_STYLESHEET  = docs/Style/doxygen-awesome.css \
 HTML_EXTRA_FILES       = docs/Style/doxygen-custom/toggle-alternative-theme.js \
                          docs/Style/doxygen-awesome-darkmode-toggle.js \
                          docs/Style/doxygen-awesome-fragment-copy-button.js \
-                         docs/Style/doxygen-awesome-paragraph-link.js
+                         docs/Style/doxygen-awesome-paragraph-link.js \
+                         docs/images/arduino_logo.png \
+                         docs/images/platformio_logo.png
 
 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
 # should be rendered with a dark or light theme. Default setting AUTO_LIGHT
@@ -2375,7 +2377,8 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = ARDUINO \
                          ESP32 \
                          ESP8266 \
-                         ARDUINO_AVR_LEONARDO
+                         ARDUINO_AVR_LEONARDO \
+                         __AVR__
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

Doc/markdown_pages/main_page.md

@@ -1,24 +1,17 @@
 ## Commander-API library
-**Version V2.0.2**
+**Version V2.1.0**
 
 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
+__Key changes in V2.1.0:__
+* AVR PROGMEM support.
+* Piping
+* Ready to use built-in commands
 
-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...
+__Breaking changes in V2.1.0:__
+* 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.

Doxyfile

@@ -0,0 +1,59 @@
+
+<!-- HTML footer for doxygen 1.9.2-->
+<!-- start footer part -->
+<!--BEGIN GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer">
+
+      <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;"/>
+      </a> &nbsp;|&nbsp;
+
+      <a title="Arduino" href="https://www.arduino.cc/reference/en/libraries/commander-api/">
+        <img class="footer" src="arduino_logo.png" alt="Arduino" style="height:20px;width:auto;"/>
+      </a> &nbsp;|&nbsp;
+
+      <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-$year Daniel Hajnal </a> &nbsp;|&nbsp;
+      <b>$projectname $projectnumber</b> &nbsp;|&nbsp; Generated by:
+      <a href="http://www.doxygen.org/index.html">
+        <img class="footer" src="$relpath^doxygen.svg" alt="doxygen"/>
+      </a> on $date
+
+      <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;"/>
+        </a> &nbsp;|&nbsp;
+
+        <a title="Arduino" href="https://www.arduino.cc/reference/en/libraries/commander-api/">
+          <img class="footer" src="arduino_logo.png" alt="Arduino" style="height:20px;width:auto;"/>
+        </a> &nbsp;|&nbsp;
+
+        <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-$year Daniel Hajnal </a> &nbsp;|&nbsp;
+        <b>$projectname $projectnumber</b> &nbsp;|&nbsp; Generated by:
+        <a href="http://www.doxygen.org/index.html">
+          <img class="footer" src="$relpath^doxygen.svg" alt="doxygen"/>
+        </a> on $date
+
+      </small></address>
+    </li>
+  </ul>
+</div>
+<!--END GENERATE_TREEVIEW-->
+<!--BEGIN !GENERATE_TREEVIEW-->
+<hr class="footer"/><address class="footer"><small>
+<b>$projectname $projectnumber</b> &nbsp;|&nbsp; Updated on $date
+</small></address>
+<!--END !GENERATE_TREEVIEW-->
+</body>
+</html>