Merge pull request #48 from bxparks/develop

merge 1.4.2 into master

Author: bxparks

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
 * Unreleased
+* 1.4.2 (2022-02-04)
+    * Remove dependency to AceCommon library in `libraries.properties`.
+        * AceRoutine core no longer depends on AceCommon.
+        * A few programs in `tests/` and `examples/` still depend it though,
+          but those are used mainly by the developers, not end-users.
+    * Clean up and update `examples/ChannelBenchmark` and its `README.md`.
+        * Use `generate_readme.py` and `generate_table.awk` scripts, just like
+          `examples/AutoBenchmark`.
 * 1.4.1 (2022-02-02)
     * Update `examples/SoundManager` to demonstrate coroutines defined in
       separate files (see

README.md

@@ -104,7 +104,7 @@ AceRoutine is a self-contained library that works on any platform supporting the
 Arduino API (AVR, Teensy, ESP8266, ESP32, etc), and it provides a handful of
 additional macros that can reduce boilerplate code.
 
-**Version**: 1.4.1 (2022-02-02)
+**Version**: 1.4.2 (2022-02-04)
 
 **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
@@ -292,21 +292,22 @@ void loop() {
 <a name="Installation"></a>
 ## Installation
 
-The latest stable release is available in the Arduino IDE Library Manager. Two
-libraries need to be installed since v1.1:
+The latest stable release is available in the Arduino IDE Library Manager. Only
+a single library needs to be installed since v1.1:
 
 * Search for "AceRoutine". Click Install.
-* Search for "AceCommon". Click Install.
 
-The development version can be installed by cloning the 2 git repos:
+The direct dependency to the [AceRoutine](https://github.com/bxparks/AceRoutine)
+library was removed in v1.4.2, but some of the programs under `tests/` and
+`examples/` may still require the `AceCommon` library to be installed.
+
+The development version can be installed by cloning the following git repo:
 
 * AceRoutine (https://github.com/bxparks/AceRoutine)
-* AceCommon  (https://github.com/bxparks/AceCommon)
 
 You can copy these directories to the `./libraries` directory used by the
-Arduino IDE. (The result is a directory named `./libraries/AceRoutine` and
-`./libraries/AceCommon`). Or you can create symlinks from `/.libraries` to these
-directories.
+Arduino IDE. (The result is a directory named `./libraries/AceRoutine`). Or you
+can create symlinks from `/.libraries` to this directory.
 
 The `develop` branch contains the latest working version.
 The `master` branch contains the stable release.

USER_GUIDE.md

@@ -4,7 +4,7 @@ See the [README.md](README.md) for installation instructions and other
 background information. This document describes how to use the library once it
 is installed.
 
-**Version**: 1.4.1 (2022-02-02)
+**Version**: 1.4.2 (2022-02-04)
 
 ## Table of Contents
 

docs/doxygen.cfg

@@ -38,7 +38,7 @@ PROJECT_NAME           = "AceRoutine"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.4.1
+PROJECT_NUMBER         = 1.4.2
 
 # 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

docs/html/AceRoutine_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceRoutine
-   &#160;<span id="projectnumber">1.4.1</span>
+   &#160;<span id="projectnumber">1.4.2</span>
    </div>
    <div id="projectbrief">A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.</div>
   </td>
@@ -105,8 +105,8 @@
 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#endif</span></div>
 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160; </div>
 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">// Version format: xxyyzz == &quot;xx.yy.zz&quot;</span></div>
-<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION 10401</span></div>
-<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION_STRING &quot;1.4.1&quot;</span></div>
+<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION 10402</span></div>
+<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">#define ACE_ROUTINE_VERSION_STRING &quot;1.4.2&quot;</span></div>
 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160; </div>
 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Coroutine_8h.html">ace_routine/Coroutine.h</a>&quot;</span></div>
 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="preprocessor">#include &quot;ace_routine/CoroutineScheduler.h&quot;</span></div>

docs/html/Channel_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceRoutine
-   &#160;<span id="projectnumber">1.4.1</span>
+   &#160;<span id="projectnumber">1.4.2</span>
    </div>
    <div id="projectbrief">A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.</div>
   </td>

docs/html/ClockInterface_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceRoutine
-   &#160;<span id="projectnumber">1.4.1</span>
+   &#160;<span id="projectnumber">1.4.2</span>
    </div>
    <div id="projectbrief">A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.</div>
   </td>

docs/html/CoroutineScheduler_8h_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceRoutine
-   &#160;<span id="projectnumber">1.4.1</span>
+   &#160;<span id="projectnumber">1.4.2</span>
    </div>
    <div id="projectbrief">A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.</div>
   </td>
@@ -219,7 +219,7 @@
 <div class="ttc" id="aclassace__routine_1_1CoroutineSchedulerTemplate_html_a86ebd507e675b913301f92af0a34abde"><div class="ttname"><a href="classace__routine_1_1CoroutineSchedulerTemplate.html#a86ebd507e675b913301f92af0a34abde">ace_routine::CoroutineSchedulerTemplate::setupCoroutines</a></div><div class="ttdeci">static void setupCoroutines()</div><div class="ttdoc">Set up the coroutines by calling their setupCoroutine() methods.</div><div class="ttdef"><b>Definition:</b> <a href="CoroutineScheduler_8h_source.html#l00087">CoroutineScheduler.h:87</a></div></div>
 <div class="ttc" id="aclassace__routine_1_1CoroutineSchedulerTemplate_html_ac792080cdec6db9f6539a446d7af587c"><div class="ttname"><a href="classace__routine_1_1CoroutineSchedulerTemplate.html#ac792080cdec6db9f6539a446d7af587c">ace_routine::CoroutineSchedulerTemplate::setup</a></div><div class="ttdeci">static void setup()</div><div class="ttdoc">Set up the scheduler.</div><div class="ttdef"><b>Definition:</b> <a href="CoroutineScheduler_8h_source.html#l00084">CoroutineScheduler.h:84</a></div></div>
 <div class="ttc" id="aclassace__routine_1_1CoroutineSchedulerTemplate_html_adfe184942d2691e1b4c8774623722d8e"><div class="ttname"><a href="classace__routine_1_1CoroutineSchedulerTemplate.html#adfe184942d2691e1b4c8774623722d8e">ace_routine::CoroutineSchedulerTemplate::list</a></div><div class="ttdeci">static void list(Print &amp;printer)</div><div class="ttdoc">Print out the known coroutines to the printer (usually Serial).</div><div class="ttdef"><b>Definition:</b> <a href="CoroutineScheduler_8h_source.html#l00105">CoroutineScheduler.h:105</a></div></div>
-<div class="ttc" id="aclassace__routine_1_1CoroutineSchedulerTemplate_html"><div class="ttname"><a href="classace__routine_1_1CoroutineSchedulerTemplate.html">ace_routine::CoroutineSchedulerTemplate</a></div><div class="ttdoc">Class that manages instances of the Coroutine class, and executes them in a round-robin fashion.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00271">Coroutine.h:271</a></div></div>
+<div class="ttc" id="aclassace__routine_1_1CoroutineSchedulerTemplate_html"><div class="ttname"><a href="classace__routine_1_1CoroutineSchedulerTemplate.html">ace_routine::CoroutineSchedulerTemplate</a></div><div class="ttdoc">Class that manages instances of the Coroutine class, and executes them in a round-robin fashion.</div><div class="ttdef"><b>Definition:</b> <a href="Coroutine_8h_source.html#l00270">Coroutine.h:270</a></div></div>
 <div class="ttc" id="aCoroutine_8h_html"><div class="ttname"><a href="Coroutine_8h.html">Coroutine.h</a></div></div>
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/html/Coroutine_8cpp_source.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AceRoutine
-   &#160;<span id="projectnumber">1.4.1</span>
+   &#160;<span id="projectnumber">1.4.2</span>
    </div>
    <div id="projectbrief">A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.</div>
   </td>