Deploy code docs to GitHub repo. Commit fe31596c9e65f5db4f81acca9ad06…

…99c007a85b4

comms_8cpp.html

@@ -112,9 +112,9 @@
 <tr class="memitem:gacc05a4a2b965f8a7884a56c787483293" id="r_gacc05a4a2b965f8a7884a56c787483293"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#gacc05a4a2b965f8a7884a56c787483293">sendCompositeLog</a> (<a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>)</td></tr>
 <tr class="memdesc:gacc05a4a2b965f8a7884a56c787483293"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should be called when <a class="el" href="comms__legacy_8cpp.html#acfab5d46b2af852fde3daa71b84e78e0" title="Current status of serial comms.">serialStatusFlag</a> == LOG_SEND_COMPOSITE.  <br /></td></tr>
 <tr class="separator:gacc05a4a2b965f8a7884a56c787483293"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga9e064949583d0f6ff04e5ebcb7a79df9" id="r_ga9e064949583d0f6ff04e5ebcb7a79df9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">static</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga9e064949583d0f6ff04e5ebcb7a79df9">isRxTimeout</a> (<a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>)</td></tr>
-<tr class="memdesc:ga9e064949583d0f6ff04e5ebcb7a79df9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the current receive operation timed out?  <br /></td></tr>
-<tr class="separator:ga9e064949583d0f6ff04e5ebcb7a79df9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gac5cac0fcdb201602960f6610b20a1f92" id="r_gac5cac0fcdb201602960f6610b20a1f92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#gac5cac0fcdb201602960f6610b20a1f92">isRxTimeout</a> (<a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>)</td></tr>
+<tr class="memdesc:gac5cac0fcdb201602960f6610b20a1f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the current receive operation timed out?  <br /></td></tr>
+<tr class="separator:gac5cac0fcdb201602960f6610b20a1f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga4e15d4999ce2ad98c05d781f033a91e3" id="r_ga4e15d4999ce2ad98c05d781f033a91e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga4e15d4999ce2ad98c05d781f033a91e3">flushRXbuffer</a> (<a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>)</td></tr>
 <tr class="memdesc:ga4e15d4999ce2ad98c05d781f033a91e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush all remaining bytes from the rx serial buffer.  <br /></td></tr>
 <tr class="separator:ga4e15d4999ce2ad98c05d781f033a91e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -221,10 +221,10 @@
 <tr class="memitem:ga1d7ac766b75420fe858818c48cd52917" id="r_ga1d7ac766b75420fe858818c48cd52917"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">static</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga1d7ac766b75420fe858818c48cd52917">serialBytesRxTx</a> = 0</td></tr>
 <tr class="memdesc:ga1d7ac766b75420fe858818c48cd52917"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of bytes received or transmitted to date during nonblocking I/O.  <br /></td></tr>
 <tr class="separator:ga1d7ac766b75420fe858818c48cd52917"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gac894de0c65b4d8313752eea14bd8bc90" id="r_gac894de0c65b4d8313752eea14bd8bc90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">static</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">constexpr</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#gac894de0c65b4d8313752eea14bd8bc90">SERIAL_TIMEOUT</a> = 700</td></tr>
+<tr class="memitem:gac894de0c65b4d8313752eea14bd8bc90" id="r_gac894de0c65b4d8313752eea14bd8bc90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">static</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">constexpr</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#gac894de0c65b4d8313752eea14bd8bc90">SERIAL_TIMEOUT</a> = 400</td></tr>
 <tr class="memdesc:gac894de0c65b4d8313752eea14bd8bc90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timeout threshold in milliseconds.  <br /></td></tr>
 <tr class="separator:gac894de0c65b4d8313752eea14bd8bc90"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga7d83b4ba298eb9c18465f7cd2b5d4dbc" id="r_ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">static</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga7d83b4ba298eb9c18465f7cd2b5d4dbc">serialReceiveStartTime</a> = 0</td></tr>
+<tr class="memitem:ga7d83b4ba298eb9c18465f7cd2b5d4dbc" id="r_ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga7d83b4ba298eb9c18465f7cd2b5d4dbc">serialReceiveStartTime</a> = 0</td></tr>
 <tr class="memdesc:ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time in milliseconds at which the serial receive started. Used for calculating whether a timeout has occurred.  <br /></td></tr>
 <tr class="separator:ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gac772dbbd5148947d8cf56df07cb6ada7" id="r_gac772dbbd5148947d8cf56df07cb6ada7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">static</a> <a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">FastCRC32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#gac772dbbd5148947d8cf56df07cb6ada7">CRC32_serial</a></td></tr>

comms_8h.html

@@ -124,11 +124,17 @@
 <tr class="memitem:ga9f7ff4d3336019845d217d0f94739193" id="r_ga9f7ff4d3336019845d217d0f94739193"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga9f7ff4d3336019845d217d0f94739193">serialTransmit</a> (<a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>)</td></tr>
 <tr class="memdesc:ga9f7ff4d3336019845d217d0f94739193"><td class="mdescLeft">&#160;</td><td class="mdescRight">The serial transmit pump. Should be called when <a class="el" href="comms__legacy_8cpp.html#acfab5d46b2af852fde3daa71b84e78e0" title="Current status of serial comms.">serialStatusFlag</a> indicates a transmit operation is in progress.  <br /></td></tr>
 <tr class="separator:ga9f7ff4d3336019845d217d0f94739193"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gac5cac0fcdb201602960f6610b20a1f92" id="r_gac5cac0fcdb201602960f6610b20a1f92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#gac5cac0fcdb201602960f6610b20a1f92">isRxTimeout</a> (<a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">void</a>)</td></tr>
+<tr class="memdesc:gac5cac0fcdb201602960f6610b20a1f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the current serial command should be timed out.  <br /></td></tr>
+<tr class="separator:gac5cac0fcdb201602960f6610b20a1f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
 Variables</h2></td></tr>
 <tr class="memitem:ga9f49e2ed648d3b97f09ac5d0670d11bd" id="r_ga9f49e2ed648d3b97f09ac5d0670d11bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">Stream</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga9f49e2ed648d3b97f09ac5d0670d11bd">pPrimarySerial</a></td></tr>
 <tr class="separator:ga9f49e2ed648d3b97f09ac5d0670d11bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7d83b4ba298eb9c18465f7cd2b5d4dbc" id="r_ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group-serial-comms-impl.html#ga7d83b4ba298eb9c18465f7cd2b5d4dbc">serialReceiveStartTime</a></td></tr>
+<tr class="memdesc:ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The time in milliseconds at which the serial receive started. Used for calculating whether a timeout has occurred.  <br /></td></tr>
+<tr class="separator:ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>File for handling all serial requests. </p>

comms_8h_source.html

@@ -83,8 +83,8 @@
 </div><!--header-->
 <div class="contents">
 <a href="comms_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span> </div>
-<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#ifndef NEW_COMMS_H</span></div>
-<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#define NEW_COMMS_H</span></div>
+<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#ifndef COMMS_H</span></div>
+<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#define COMMS_H</span></div>
 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#if defined(CORE_TEENSY)</span></div>
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">  #define BLOCKING_FACTOR       251</span></div>
@@ -100,15 +100,21 @@
 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">extern</span> <a class="code hl_function" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">Stream</a> *<a class="code hl_variable" href="group__group-serial-comms-impl.html#ga9f49e2ed648d3b97f09ac5d0670d11bd">pPrimarySerial</a>;</div>
 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="comms_8h.html#a8f22d4abe44d2b7d78b2056f3fdb0778">   25</a></span><span class="preprocessor">#define primarySerial (*pPrimarySerial)</span></div>
 <div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
-<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__group-serial-comms-impl.html#ga7e59b4f0d357a308ac2f7257cca678e1">serialReceive</a>(<span class="keywordtype">void</span>);</div>
-<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
-<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__group-serial-comms-impl.html#ga9f7ff4d3336019845d217d0f94739193">serialTransmit</a>(<span class="keywordtype">void</span>);</div>
-<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
-<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#endif </span><span class="comment">// COMMS_H</span></div>
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">extern</span> <a class="code hl_function" href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">uint32_t</a> <a class="code hl_variable" href="group__group-serial-comms-impl.html#ga7d83b4ba298eb9c18465f7cd2b5d4dbc">serialReceiveStartTime</a>; </div>
+<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
+<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__group-serial-comms-impl.html#ga7e59b4f0d357a308ac2f7257cca678e1">serialReceive</a>(<span class="keywordtype">void</span>);</div>
+<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
+<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__group-serial-comms-impl.html#ga9f7ff4d3336019845d217d0f94739193">serialTransmit</a>(<span class="keywordtype">void</span>);</div>
+<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
+<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__group-serial-comms-impl.html#gac5cac0fcdb201602960f6610b20a1f92">isRxTimeout</a>(<span class="keywordtype">void</span>);</div>
+<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span> </div>
+<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#endif </span><span class="comment">// COMMS_H</span></div>
 <div class="ttc" id="agroup__group-opt-shift_html_gada522535b5b26abf6eb2c7da12c71454"><div class="ttname"><a href="group__group-opt-shift.html#gada522535b5b26abf6eb2c7da12c71454">rshift</a></div><div class="ttdeci">static uint32_t rshift(uint32_t a)</div><div class="ttdoc">Bitwise right shift - generic, unoptimized, case.</div><div class="ttdef"><b>Definition</b> bit_shifts.h:349</div></div>
+<div class="ttc" id="agroup__group-serial-comms-impl_html_ga7d83b4ba298eb9c18465f7cd2b5d4dbc"><div class="ttname"><a href="group__group-serial-comms-impl.html#ga7d83b4ba298eb9c18465f7cd2b5d4dbc">serialReceiveStartTime</a></div><div class="ttdeci">uint32_t serialReceiveStartTime</div><div class="ttdoc">The time in milliseconds at which the serial receive started. Used for calculating whether a timeout ...</div><div class="ttdef"><b>Definition</b> comms.cpp:84</div></div>
 <div class="ttc" id="agroup__group-serial-comms-impl_html_ga7e59b4f0d357a308ac2f7257cca678e1"><div class="ttname"><a href="group__group-serial-comms-impl.html#ga7e59b4f0d357a308ac2f7257cca678e1">serialReceive</a></div><div class="ttdeci">void serialReceive(void)</div><div class="ttdoc">The serial receive pump. Should be called whenever the serial port has data available to read.</div><div class="ttdef"><b>Definition</b> comms.cpp:465</div></div>
 <div class="ttc" id="agroup__group-serial-comms-impl_html_ga9f49e2ed648d3b97f09ac5d0670d11bd"><div class="ttname"><a href="group__group-serial-comms-impl.html#ga9f49e2ed648d3b97f09ac5d0670d11bd">pPrimarySerial</a></div><div class="ttdeci">Stream * pPrimarySerial</div><div class="ttdef"><b>Definition</b> comms.cpp:104</div></div>
-<div class="ttc" id="agroup__group-serial-comms-impl_html_ga9f7ff4d3336019845d217d0f94739193"><div class="ttname"><a href="group__group-serial-comms-impl.html#ga9f7ff4d3336019845d217d0f94739193">serialTransmit</a></div><div class="ttdeci">void serialTransmit(void)</div><div class="ttdoc">The serial transmit pump. Should be called when serialStatusFlag indicates a transmit operation is in...</div><div class="ttdef"><b>Definition</b> comms.cpp:548</div></div>
+<div class="ttc" id="agroup__group-serial-comms-impl_html_ga9f7ff4d3336019845d217d0f94739193"><div class="ttname"><a href="group__group-serial-comms-impl.html#ga9f7ff4d3336019845d217d0f94739193">serialTransmit</a></div><div class="ttdeci">void serialTransmit(void)</div><div class="ttdoc">The serial transmit pump. Should be called when serialStatusFlag indicates a transmit operation is in...</div><div class="ttdef"><b>Definition</b> comms.cpp:549</div></div>
+<div class="ttc" id="agroup__group-serial-comms-impl_html_gac5cac0fcdb201602960f6610b20a1f92"><div class="ttname"><a href="group__group-serial-comms-impl.html#gac5cac0fcdb201602960f6610b20a1f92">isRxTimeout</a></div><div class="ttdeci">bool isRxTimeout(void)</div><div class="ttdoc">Checks whether the current serial command should be timed out.</div><div class="ttdef"><b>Definition</b> comms.cpp:113</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>