Deploy updated documentation

CLI_8cpp.html

@@ -101,13 +101,17 @@
 Functions</h2></td></tr>
 <tr class="memitem:a8757901cd08f4f81efb19b3b226f28b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a8757901cd08f4f81efb19b3b226f28b2">CLI::parse</a> (String cmd)</td></tr>
 <tr class="separator:a8757901cd08f4f81efb19b3b226f28b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a51cd44763a758e752f1e430e21be16a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a51cd44763a758e752f1e430e21be16a3">CLI::RFlinkParse</a> (String cmd)</td></tr>
+<tr class="separator:a51cd44763a758e752f1e430e21be16a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a9af91bae9053f9d192801dc2b147d62b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a9af91bae9053f9d192801dc2b147d62b">CLI::loop</a> ()</td></tr>
 <tr class="separator:a9af91bae9053f9d192801dc2b147d62b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
 Variables</h2></td></tr>
 <tr class="memitem:ac1a0c60454bd3a361cb4fc3ec4d64693"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#ac1a0c60454bd3a361cb4fc3ec4d64693">CLI::cli_start_msg_printed</a> = false</td></tr>
 <tr class="separator:ac1a0c60454bd3a361cb4fc3ec4d64693"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a75b61fe7a722ba6db6f32ed9d5bbd0bb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a75b61fe7a722ba6db6f32ed9d5bbd0bb">CLI::semicolon_parsing</a> = true</td></tr>
+<tr class="separator:a75b61fe7a722ba6db6f32ed9d5bbd0bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a268599b898b8618cbb0996922a5358d6"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCLI.html#a268599b898b8618cbb0996922a5358d6">CLI::serial_buffer</a></td></tr>
 <tr class="separator:a268599b898b8618cbb0996922a5358d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>

Device_8h.html

@@ -145,7 +145,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac01ab539db86301a2c4beaa8
 <div class="line">    \</div>
 <div class="line">        }\</div>
 <div class="line">    }</div>
-<div class="ttc" id="aclassDevice_html_a2ce5ef715273fb4fa8c1359b1300912c"><div class="ttname"><a href="classDevice.html#a2ce5ef715273fb4fa8c1359b1300912c">Device::add</a></div><div class="ttdeci">static bool add(const char *name, Device *pointer)</div><div class="ttdef"><b>Definition:</b> <a href="Device_8cpp_source.html#l00033">Device.cpp:33</a></div></div>
+<div class="ttc" id="aclassDevice_html_a2ce5ef715273fb4fa8c1359b1300912c"><div class="ttname"><a href="classDevice.html#a2ce5ef715273fb4fa8c1359b1300912c">Device::add</a></div><div class="ttdeci">static bool add(const char *name, Device *pointer)</div><div class="ttdoc">Registers an instance of Device, i.e. a devuce plugin in the static store</div><div class="ttdef"><b>Definition:</b> <a href="Device_8cpp_source.html#l00040">Device.cpp:40</a></div></div>
 </div><!-- fragment -->
 <p class="definition">Definition at line <a class="el" href="Device_8h_source.html#l00017">17</a> of file <a class="el" href="Device_8h_source.html">Device.h</a>.</p>
 

Radio_8h.html

@@ -154,7 +154,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af79cebc5e737b1dfb9d495c6
 <div class="line">            } autoRegister;\</div>
 <div class="line">        }\</div>
 <div class="line">    }</div>
-<div class="ttc" id="aclassRadio_html_a5390ea68c1d2b9aa3bb06dd02a28f1ef"><div class="ttname"><a href="classRadio.html#a5390ea68c1d2b9aa3bb06dd02a28f1ef">Radio::add</a></div><div class="ttdeci">static bool add(const char *name, Radio *pointer)</div><div class="ttdef"><b>Definition:</b> <a href="Radio_8cpp_source.html#l00016">Radio.cpp:16</a></div></div>
+<div class="ttc" id="aclassRadio_html_a5390ea68c1d2b9aa3bb06dd02a28f1ef"><div class="ttname"><a href="classRadio.html#a5390ea68c1d2b9aa3bb06dd02a28f1ef">Radio::add</a></div><div class="ttdeci">static bool add(const char *name, Radio *pointer)</div><div class="ttdoc">Registers an instance of Radio, i.e. a radio plugin in the static store</div><div class="ttdef"><b>Definition:</b> <a href="Radio_8cpp_source.html#l00018">Radio.cpp:18</a></div></div>
 <div class="ttc" id="atools_8h_html_a2117b58e19182dff91ad3558e650541d"><div class="ttname"><a href="tools_8h.html#a2117b58e19182dff91ad3558e650541d">QUOTE</a></div><div class="ttdeci">#define QUOTE(x)</div><div class="ttdef"><b>Definition:</b> <a href="tools_8h_source.html#l00007">tools.h:7</a></div></div>
 </div><!-- fragment -->
 <p class="definition">Definition at line <a class="el" href="Radio_8h_source.html#l00016">16</a> of file <a class="el" href="Radio_8h_source.html">Radio.h</a>.</p>

Settings_8cpp_source.html

@@ -79,7 +79,7 @@
 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160; </div>
 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;std::map&lt;String, String&gt; <a class="code" href="classSettings.html">Settings</a>::store;</div>
 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160; </div>
-<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// Constructor sets the defaults, see &#39;dummy&#39; at end</span></div>
+<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// Constructor sets the defaults from config.cpp, see &#39;dummy&#39; at end</span></div>
 <div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classSettings.html#ab7169a6eefce79566dd07db3b1e5e967">   11</a></span>&#160;<a class="code" href="classSettings.html">Settings</a>::<a class="code" href="classSettings.html#ab7169a6eefce79566dd07db3b1e5e967">Settings</a>() {</div>
 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;    <a class="code" href="config_8h.html#a66f6b39afeed5dbfc30920a0a99ab890">factorySettings</a><a class="code" href="config_8h.html#a66f6b39afeed5dbfc30920a0a99ab890">(</a><a class="code" href="config_8h.html#a66f6b39afeed5dbfc30920a0a99ab890">)</a>;</div>
 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;}</div>

classDevice.html

@@ -77,21 +77,27 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:aad954b6bab8cdd5039efca0136c519bd"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDevice.html#aad954b6bab8cdd5039efca0136c519bd">receive</a> (const <a class="el" href="classRawTimings.html">RawTimings</a> &amp;raw, const <a class="el" href="classPulsetrain.html">Pulsetrain</a> &amp;train, const <a class="el" href="classMeaning.html">Meaning</a> &amp;meaning)</td></tr>
+<tr class="memdesc:aad954b6bab8cdd5039efca0136c519bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">virtual, to be overridden in de individual plugins  <a href="classDevice.html#aad954b6bab8cdd5039efca0136c519bd">More...</a><br /></td></tr>
 <tr class="separator:aad954b6bab8cdd5039efca0136c519bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1ddc56f9dab17a2f58664d043a481788"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDevice.html#a1ddc56f9dab17a2f58664d043a481788">transmit</a> (const String &amp;toTransmit)</td></tr>
+<tr class="memdesc:a1ddc56f9dab17a2f58664d043a481788"><td class="mdescLeft">&#160;</td><td class="mdescRight">virtual, to be overridden in de individual plugins  <a href="classDevice.html#a1ddc56f9dab17a2f58664d043a481788">More...</a><br /></td></tr>
 <tr class="separator:a1ddc56f9dab17a2f58664d043a481788"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 Static Public Member Functions</h2></td></tr>
 <tr class="memitem:a065393b4e6f18adf6d9ba1007eaf7a5c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDevice.html#a065393b4e6f18adf6d9ba1007eaf7a5c">setup</a> ()</td></tr>
 <tr class="separator:a065393b4e6f18adf6d9ba1007eaf7a5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2ce5ef715273fb4fa8c1359b1300912c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDevice.html#a2ce5ef715273fb4fa8c1359b1300912c">add</a> (const char *<a class="el" href="classDevice.html#a20a665975b9fcc0d4b7db32cbbebbaea">name</a>, <a class="el" href="classDevice.html">Device</a> *<a class="el" href="classDevice.html#a54aaf184edf47ce2ff12d5deeb43a169">pointer</a>)</td></tr>
+<tr class="memdesc:a2ce5ef715273fb4fa8c1359b1300912c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers an instance of <a class="el" href="classDevice.html">Device</a>, i.e. a devuce plugin in the static <code>store</code>  <a href="classDevice.html#a2ce5ef715273fb4fa8c1359b1300912c">More...</a><br /></td></tr>
 <tr class="separator:a2ce5ef715273fb4fa8c1359b1300912c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab9b533f779da5e859134cb201163efdb"><td class="memItemLeft" align="right" valign="top">static String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDevice.html#ab9b533f779da5e859134cb201163efdb">list</a> (String separator=&quot;, &quot;)</td></tr>
+<tr class="memdesc:ab9b533f779da5e859134cb201163efdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a String with alist of registered device plugins, appending " [disabled]" if needed.  <a href="classDevice.html#ab9b533f779da5e859134cb201163efdb">More...</a><br /></td></tr>
 <tr class="separator:ab9b533f779da5e859134cb201163efdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a60f5a81ddc0a56f35981f9d7fb025857"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDevice.html#a60f5a81ddc0a56f35981f9d7fb025857">new_packet</a> (<a class="el" href="classRawTimings.html">RawTimings</a> &amp;raw, <a class="el" href="classPulsetrain.html">Pulsetrain</a> &amp;train, <a class="el" href="classMeaning.html">Meaning</a> &amp;meaning)</td></tr>
+<tr class="memdesc:a60f5a81ddc0a56f35981f9d7fb025857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static, passes all 3 forms of an incoming packet to each non-disabled device plugin.  <a href="classDevice.html#a60f5a81ddc0a56f35981f9d7fb025857">More...</a><br /></td></tr>
 <tr class="separator:a60f5a81ddc0a56f35981f9d7fb025857"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a62d24001e2d51d7509555abefb5abef1"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDevice.html#a62d24001e2d51d7509555abefb5abef1">transmit</a> (const String &amp;plugin_name, const String &amp;toTransmit)</td></tr>
+<tr class="memdesc:a62d24001e2d51d7509555abefb5abef1"><td class="mdescLeft">&#160;</td><td class="mdescRight">static, passes a String to a named device's <code>tx()</code> function  <a href="classDevice.html#a62d24001e2d51d7509555abefb5abef1">More...</a><br /></td></tr>
 <tr class="separator:a62d24001e2d51d7509555abefb5abef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
@@ -171,7 +177,17 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2ce5ef715273fb4fa8c1359b
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00033">33</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
+<p>Registers an instance of <a class="el" href="classDevice.html">Device</a>, i.e. a devuce plugin in the static <code>store</code> </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">name</td><td>(char*) Name of plugin, maximum MAX_DEVICE_NAME_LEN characters </td></tr>
+    <tr><td class="paramname">pointer</td><td>Pointer to the plugin instance </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><code>false</code> if store already holds info on MAX_DEVICES plugins </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00040">40</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
 
 </div>
 </div>
@@ -199,7 +215,16 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab9b533f779da5e859134cb20
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00044">44</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
+<p>Returns a String with alist of registered device plugins, appending " [disabled]" if needed. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">separator</td><td>Between the names, e.g. ", " </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The list </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00056">56</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
 
 </div>
 </div>
@@ -243,7 +268,18 @@ <h2 class="memtitle"><span class="permalink"><a href="#a60f5a81ddc0a56f35981f9d7
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00017">17</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
+<p>Static, passes all 3 forms of an incoming packet to each non-disabled device plugin. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">raw</td><td>incoming packet </td></tr>
+    <tr><td class="paramname">train</td><td>incoming packet </td></tr>
+    <tr><td class="paramname">meaning</td><td>incoming packet </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> as soon as one of the plugin rx functions returns <code>true</code>, <code>false</code> otherwise </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00022">22</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
 
 </div>
 </div>
@@ -281,7 +317,18 @@ <h2 class="memtitle"><span class="permalink"><a href="#a62d24001e2d51d7509555abe
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00060">60</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
+<p>static, passes a String to a named device's <code>tx()</code> function </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">plugin_name</td><td>name of plugin </td></tr>
+    <tr><td class="paramname">toTransmit</td><td>String to be passed to <code>tx()</code> </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><br  />
+ </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00076">76</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
 
 </div>
 </div>
@@ -325,7 +372,18 @@ <h2 class="memtitle"><span class="permalink"><a href="#aad954b6bab8cdd5039efca01
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00069">69</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
+<p>virtual, to be overridden in de individual plugins </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">raw</td><td>incoming packet </td></tr>
+    <tr><td class="paramname">train</td><td>incoming packet </td></tr>
+    <tr><td class="paramname">meaning</td><td>incoming packet </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><code>false</code> if not overridden </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00092">92</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
 
 </div>
 </div>
@@ -353,7 +411,16 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1ddc56f9dab17a2f58664d04
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00073">73</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
+<p>virtual, to be overridden in de individual plugins </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">toTransmit</td><td>String for plugin to make sense of and be transmitted </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><code>false</code> if not overridden </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="Device_8cpp_source.html#l00099">99</a> of file <a class="el" href="Device_8cpp_source.html">Device.cpp</a>.</p>
 
 </div>
 </div>