lauchmelder/b15f
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc update

Browse source
This commit is contained in:
Tristan Krause 2019-05-23 15:08:54 +02:00
parent 90e62b739b
commit 5f48849c4e
117 changed files with 3780 additions and 2135 deletions
Download patch file Download diff file Expand all files Collapse all files

84
docs/html/classB15F.html
View file

@ -72,6 +72,8 @@ $(function() {
<div class="title">B15F Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="b15f_8h_source.html">b15f.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
@ -101,10 +103,10 @@ Public Member Functions</h2></td></tr>
<tr class="separator:afc76b612dd4faeee0ac02a66b65af5f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f858f21ea81d491b5031b3644a2239a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a6f858f21ea81d491b5031b3644a2239a">readDipSwitch</a> (void)</td></tr>
<tr class="separator:a6f858f21ea81d491b5031b3644a2239a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5583d591afdd3f9501856c6b0ba3e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a5c5583d591afdd3f9501856c6b0ba3e3">analogWrite0</a> (uint16_t)</td></tr>
<tr class="separator:a5c5583d591afdd3f9501856c6b0ba3e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d67795879cdc0b035c9c970e7d6fc3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a63d67795879cdc0b035c9c970e7d6fc3">analogWrite1</a> (uint16_t)</td></tr>
<tr class="separator:a63d67795879cdc0b035c9c970e7d6fc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc55fd590c7fa5c942d100cb60c4b0d3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#afc55fd590c7fa5c942d100cb60c4b0d3">analogWrite0</a> (uint16_t port)</td></tr>
<tr class="separator:afc55fd590c7fa5c942d100cb60c4b0d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f1becceac744f5cd2ad529748fd836f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a7f1becceac744f5cd2ad529748fd836f">analogWrite1</a> (uint16_t port)</td></tr>
<tr class="separator:a7f1becceac744f5cd2ad529748fd836f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0bd1f69751e2dc3c462db9213fc4627"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#ae0bd1f69751e2dc3c462db9213fc4627">analogRead</a> (uint8_t channel)</td></tr>
<tr class="separator:ae0bd1f69751e2dc3c462db9213fc4627"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab82a324426c3063318c6cafb3089ae02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#ab82a324426c3063318c6cafb3089ae02">analogSequence</a> (uint8_t channel_a, uint16_t *buffer_a, uint32_t offset_a, uint8_t channel_b, uint16_t *buffer_b, uint32_t offset_b, uint16_t start, int16_t delta, uint16_t count)</td></tr>
@ -126,33 +128,41 @@ Static Public Member Functions</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3b0fc1f85954b2d9c145af4a3af5b1ec"><td class="memItemLeft" align="right" valign="top"><a id="a3b0fc1f85954b2d9c145af4a3af5b1ec"></a>
const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>PRE</b> = &quot;[B15F] &quot;</td></tr>
const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a3b0fc1f85954b2d9c145af4a3af5b1ec">PRE</a> = &quot;[B15F] &quot;</td></tr>
<tr class="memdesc:a3b0fc1f85954b2d9c145af4a3af5b1ec"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classB15F.html">B15F</a> stdout prefix. <br /></td></tr>
<tr class="separator:a3b0fc1f85954b2d9c145af4a3af5b1ec"><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>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ab01299858f74a6cec598688562e0ad02"><td class="memItemLeft" align="right" valign="top"><a id="ab01299858f74a6cec598688562e0ad02"></a>
constexpr static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>MSG_OK</b> = 0xFF</td></tr>
constexpr static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#ab01299858f74a6cec598688562e0ad02">MSG_OK</a> = 0xFF</td></tr>
<tr class="memdesc:ab01299858f74a6cec598688562e0ad02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to acknowledge a received command. <br /></td></tr>
<tr class="separator:ab01299858f74a6cec598688562e0ad02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77d1ecf24b406c9204665d3b09c36f1e"><td class="memItemLeft" align="right" valign="top"><a id="a77d1ecf24b406c9204665d3b09c36f1e"></a>
constexpr static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>MSG_FAIL</b> = 0xFE</td></tr>
constexpr static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a77d1ecf24b406c9204665d3b09c36f1e">MSG_FAIL</a> = 0xFE</td></tr>
<tr class="memdesc:a77d1ecf24b406c9204665d3b09c36f1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to reject a received command. <br /></td></tr>
<tr class="separator:a77d1ecf24b406c9204665d3b09c36f1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a040951746fbfd632e12bd1ad14578816"><td class="memItemLeft" align="right" valign="top"><a id="a040951746fbfd632e12bd1ad14578816"></a>
constexpr static uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>RECONNECT_TIMEOUT</b> = 64</td></tr>
constexpr static uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a040951746fbfd632e12bd1ad14578816">RECONNECT_TIMEOUT</a> = 64</td></tr>
<tr class="memdesc:a040951746fbfd632e12bd1ad14578816"><td class="mdescLeft">&#160;</td><td class="mdescRight">Time in ms after which a reconnect attempt aborts. <br /></td></tr>
<tr class="separator:a040951746fbfd632e12bd1ad14578816"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a158d13bc84aed6430cdede1396384e06"><td class="memItemLeft" align="right" valign="top"><a id="a158d13bc84aed6430cdede1396384e06"></a>
constexpr static uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>WDT_TIMEOUT</b> = 15</td></tr>
constexpr static uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a158d13bc84aed6430cdede1396384e06">WDT_TIMEOUT</a> = 15</td></tr>
<tr class="memdesc:a158d13bc84aed6430cdede1396384e06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Time in ms after which the watch dog timer resets the MCU. <br /></td></tr>
<tr class="separator:a158d13bc84aed6430cdede1396384e06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c4895bdbcd71ff6743becf97985c2dc"><td class="memItemLeft" align="right" valign="top"><a id="a6c4895bdbcd71ff6743becf97985c2dc"></a>
constexpr static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>RECONNECT_TRIES</b> = 3</td></tr>
constexpr static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a6c4895bdbcd71ff6743becf97985c2dc">RECONNECT_TRIES</a> = 3</td></tr>
<tr class="memdesc:a6c4895bdbcd71ff6743becf97985c2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum count of reconnect attempts after which the driver stops. <br /></td></tr>
<tr class="separator:a6c4895bdbcd71ff6743becf97985c2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d548d6861cfc69753161bf9cda14f87"><td class="memItemLeft" align="right" valign="top"><a id="a7d548d6861cfc69753161bf9cda14f87"></a>
constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>BAUDRATE</b> = 57600</td></tr>
constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classB15F.html#a7d548d6861cfc69753161bf9cda14f87">BAUDRATE</a> = 57600</td></tr>
<tr class="memdesc:a7d548d6861cfc69753161bf9cda14f87"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classUSART.html">USART</a> baudrate for communication with the MCU. <br /></td></tr>
<tr class="separator:a7d548d6861cfc69753161bf9cda14f87"><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 class="definition">Definition at line <a class="el" href="b15f_8h_source.html#l00024">24</a> of file <a class="el" href="b15f_8h_source.html">b15f.h</a>.</p>
<div class="textblock"><p>main driver class </p>
<p class="definition">Definition at line <a class="el" href="b15f_8h_source.html#l00026">26</a> of file <a class="el" href="b15f_8h_source.html">b15f.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac962a6a49bddd0e261a8c7d3aded23f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac962a6a49bddd0e261a8c7d3aded23f8">&#9670;&nbsp;</a></span>abort() <span class="overload">[1/2]</span></h2>
@ -184,7 +194,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00327">327</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00332">332</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -218,7 +228,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00322">322</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00327">327</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -244,7 +254,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00144">144</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00145">145</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -276,7 +286,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00219">219</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00220">220</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -368,12 +378,12 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00241">241</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00243">243</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
<a id="a5c5583d591afdd3f9501856c6b0ba3e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c5583d591afdd3f9501856c6b0ba3e3">&#9670;&nbsp;</a></span>analogWrite0()</h2>
<a id="afc55fd590c7fa5c942d100cb60c4b0d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc55fd590c7fa5c942d100cb60c4b0d3">&#9670;&nbsp;</a></span>analogWrite0()</h2>
<div class="memitem">
<div class="memproto">
@ -382,7 +392,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
<td class="memname">bool B15F::analogWrite0 </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
@ -400,12 +410,12 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00199">199</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00200">200</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
<a id="a63d67795879cdc0b035c9c970e7d6fc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d67795879cdc0b035c9c970e7d6fc3">&#9670;&nbsp;</a></span>analogWrite1()</h2>
<a id="a7f1becceac744f5cd2ad529748fd836f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f1becceac744f5cd2ad529748fd836f">&#9670;&nbsp;</a></span>analogWrite1()</h2>
<div class="memitem">
<div class="memproto">
@ -414,7 +424,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
<td class="memname">bool B15F::analogWrite1 </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
@ -432,7 +442,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00209">209</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00210">210</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -458,7 +468,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00290">290</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00292">292</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -484,7 +494,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00295">295</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00297">297</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -511,7 +521,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00172">172</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00173">173</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -538,7 +548,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00181">181</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00182">182</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -570,7 +580,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00152">152</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00153">153</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -602,7 +612,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00162">162</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00163">163</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -662,7 +672,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00309">309</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00311">311</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -722,7 +732,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00300">300</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00302">302</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -749,7 +759,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00190">190</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00191">191</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -809,7 +819,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00339">339</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="b15f_8cpp_source.html#l00344">344</a> of file <a class="el" href="b15f_8cpp_source.html">b15f.cpp</a>.</p>
</div>
</div>
@ -872,7 +882,7 @@ constexpr static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu May 23 2019 15:04:21 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>