Skip to content

Commit

Permalink
Help is updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@lexus2k
lexus2k committed Sep 13, 2016
1 parent 538e701 commit 9239f74
Show file tree
Hide file tree
Showing 104 changed files with 3,546 additions and 1,749 deletions.
4 changes: 2 additions & 2 deletions doc/html/TinyProtocol_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,14 @@

<p>Tiny protocol Arduino API.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="src_2arduino_2src_2proto_2tiny__layer2_8h_source.html">proto/tiny_layer2.h</a>&quot;</code><br />
<div class="textblock"><code>#include &quot;proto/tiny_layer2.h&quot;</code><br />
<code>#include &lt;HardwareSerial.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for TinyProtocol.h:</div>
<div class="dyncontent">
<div class="center"><img src="TinyProtocol_8h__incl.png" border="0" usemap="#src_2arduino_2src_2TinyProtocol_8h" alt=""/></div>
<map name="src_2arduino_2src_2TinyProtocol_8h" id="src_2arduino_2src_2TinyProtocol_8h">
<area shape="rect" id="node2" href="src_2arduino_2src_2proto_2tiny__layer2_8h.html" title="Tiny protocol API. " alt="" coords="27,80,156,107"/><area shape="rect" id="node4" href="tiny__defines_8h_source.html" title="tiny_defines.h" alt="" coords="95,155,197,181"/><area shape="rect" id="node5" href="tiny__config_8h_source.html" title="tiny_config.h" alt="" coords="98,229,194,256"/></map>
</map>
</div>
</div>
<p><a href="TinyProtocol_8h_source.html">Go to the source code of this file.</a></p>
Expand Down
3 changes: 0 additions & 3 deletions doc/html/TinyProtocol_8h__incl.map
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
<map id="src/arduino/src/TinyProtocol.h" name="src/arduino/src/TinyProtocol.h">
<area shape="rect" id="node2" href="$src_2arduino_2src_2proto_2tiny__layer2_8h.html" title="Tiny protocol API. " alt="" coords="27,80,156,107"/>
<area shape="rect" id="node4" href="$tiny__defines_8h_source.html" title="tiny_defines.h" alt="" coords="95,155,197,181"/>
<area shape="rect" id="node5" href="$tiny__config_8h_source.html" title="tiny_config.h" alt="" coords="98,229,194,256"/>
</map>
2 changes: 1 addition & 1 deletion doc/html/TinyProtocol_8h__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
bf038ede224aa9c9c3ddab45aacf7426
20682e9414dfe8a8bb0e7741d3ad6fc7
Binary file modified doc/html/TinyProtocol_8h__incl.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 5 additions & 6 deletions doc/html/TinyProtocol_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#ifndef _TINY_PROTOCOL_H_</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define _TINY_PROTOCOL_H_</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="src_2arduino_2src_2proto_2tiny__layer2_8h.html">proto/tiny_layer2.h</a>&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;proto/tiny_layer2.h&quot;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#ifdef ARDUINO</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor"># include &lt;HardwareSerial.h&gt;</span></div>
Expand All @@ -130,8 +130,8 @@
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">inline</span> <a class="code" href="classTiny_1_1Proto.html">Proto</a>() { m_uidEnabled = <span class="keyword">false</span>; }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTiny_1_1Proto.html#a6f5f4ebec42dc6e679c25e79284d7705">begin</a> (<a class="code" href="src_2arduino_2src_2proto_2tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a> writecb,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="src_2arduino_2src_2proto_2tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a> readcb);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classTiny_1_1Proto.html#a6f5f4ebec42dc6e679c25e79284d7705">begin</a> (<a class="code" href="tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a> writecb,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a> readcb);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#ifdef ARDUINO</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
Expand Down Expand Up @@ -264,11 +264,9 @@
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;</div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;</div>
<div class="ttc" id="src_2arduino_2src_2proto_2tiny__layer2_8h_html_ae3d867e030f59de94508902f2b84a7ec"><div class="ttname"><a href="src_2arduino_2src_2proto_2tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a></div><div class="ttdeci">int(* read_block_cb_t)(void *pdata, uint8_t *buffer, int size)</div><div class="ttdef"><b>Definition:</b> tiny_layer2.h:131</div></div>
<div class="ttc" id="classTiny_1_1Packet_html_a52c746f604ee6c0e4e78902b4cf710a9"><div class="ttname"><a href="classTiny_1_1Packet.html#a52c746f604ee6c0e4e78902b4cf710a9">Tiny::Packet::put</a></div><div class="ttdeci">void put(uint8_t byte)</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:248</div></div>
<div class="ttc" id="classTiny_1_1Proto_html_a2ef1c80490d9343b896180ab8b8a6f77"><div class="ttname"><a href="classTiny_1_1Proto.html#a2ef1c80490d9343b896180ab8b8a6f77">Tiny::Proto::enableCrc32</a></div><div class="ttdeci">bool enableCrc32()</div></div>
<div class="ttc" id="classTiny_1_1Proto_html_acc00ac10509eaa11a83b0b88a2278b3e"><div class="ttname"><a href="classTiny_1_1Proto.html#acc00ac10509eaa11a83b0b88a2278b3e">Tiny::Proto::read</a></div><div class="ttdeci">int read(char *buf, int size, uint8_t flags=TINY_FLAG_WAIT_FOREVER)</div></div>
<div class="ttc" id="src_2arduino_2src_2proto_2tiny__layer2_8h_html"><div class="ttname"><a href="src_2arduino_2src_2proto_2tiny__layer2_8h.html">tiny_layer2.h</a></div><div class="ttdoc">Tiny protocol API. </div></div>
<div class="ttc" id="classTiny_1_1Packet_html_a71765e73adfbc67138f75c2b8ea7d74c"><div class="ttname"><a href="classTiny_1_1Packet.html#a71765e73adfbc67138f75c2b8ea7d74c">Tiny::Packet::getUint16</a></div><div class="ttdeci">uint16_t getUint16()</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:316</div></div>
<div class="ttc" id="group__FLAGS__GROUP_html_ga3a34267804581c5709d03f52d232b307"><div class="ttname"><a href="group__FLAGS__GROUP.html#ga3a34267804581c5709d03f52d232b307">TINY_FLAG_WAIT_FOREVER</a></div><div class="ttdeci">#define TINY_FLAG_WAIT_FOREVER</div><div class="ttdoc">This flag makes tiny API functions perform in blocking mode. </div><div class="ttdef"><b>Definition:</b> tiny_layer2.h:77</div></div>
<div class="ttc" id="namespaceTiny_html"><div class="ttname"><a href="namespaceTiny.html">Tiny</a></div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:39</div></div>
Expand All @@ -281,7 +279,7 @@
<div class="ttc" id="classTiny_1_1Proto_html_a1dcad822337b6155148b1da9222fdd82"><div class="ttname"><a href="classTiny_1_1Proto.html#a1dcad822337b6155148b1da9222fdd82">Tiny::Proto::beginToSerial</a></div><div class="ttdeci">void beginToSerial()</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:70</div></div>
<div class="ttc" id="classTiny_1_1Packet_html_a5741e3aec04c9100ce00a6b702417231"><div class="ttname"><a href="classTiny_1_1Packet.html#a5741e3aec04c9100ce00a6b702417231">Tiny::Packet::put</a></div><div class="ttdeci">void put(const Packet &amp;pkt)</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:289</div></div>
<div class="ttc" id="classTiny_1_1Packet_html_a0055b5d1c437104e38bf66ece8ab84ba"><div class="ttname"><a href="classTiny_1_1Packet.html#a0055b5d1c437104e38bf66ece8ab84ba">Tiny::Packet::put</a></div><div class="ttdeci">void put(uint16_t data)</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:261</div></div>
<div class="ttc" id="src_2arduino_2src_2proto_2tiny__layer2_8h_html_a7f69e669de5baa69a43ee5cb439a7496"><div class="ttname"><a href="src_2arduino_2src_2proto_2tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a></div><div class="ttdeci">int(* write_block_cb_t)(void *pdata, const uint8_t *buffer, int size)</div><div class="ttdef"><b>Definition:</b> tiny_layer2.h:120</div></div>
<div class="ttc" id="tiny__layer2_8h_html_a7f69e669de5baa69a43ee5cb439a7496"><div class="ttname"><a href="tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a></div><div class="ttdeci">int(* write_block_cb_t)(void *pdata, const uint8_t *buffer, int size)</div><div class="ttdef"><b>Definition:</b> tiny_layer2.h:120</div></div>
<div class="ttc" id="classTiny_1_1Proto_html_aedbc025e1534105134e4a2499d32207c"><div class="ttname"><a href="classTiny_1_1Proto.html#aedbc025e1534105134e4a2499d32207c">Tiny::Proto::beginToSerial3</a></div><div class="ttdeci">void beginToSerial3()</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:108</div></div>
<div class="ttc" id="classTiny_1_1Packet_html"><div class="ttname"><a href="classTiny_1_1Packet.html">Tiny::Packet</a></div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:227</div></div>
<div class="ttc" id="classTiny_1_1Packet_html_a2de2c7f2c3ea6baaab462dd7e4469ecb"><div class="ttname"><a href="classTiny_1_1Packet.html#a2de2c7f2c3ea6baaab462dd7e4469ecb">Tiny::Packet::operator=</a></div><div class="ttdeci">Packet &amp; operator=(char chr)</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:372</div></div>
Expand All @@ -306,6 +304,7 @@
<div class="ttc" id="classTiny_1_1Packet_html_a464ddc51642812e604ac39f775762165"><div class="ttname"><a href="classTiny_1_1Packet.html#a464ddc51642812e604ac39f775762165">Tiny::Packet::put</a></div><div class="ttdeci">void put(int16_t data)</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:275</div></div>
<div class="ttc" id="classTiny_1_1Packet_html_a5dd4b89cb7224b62d4f0328c8e40f38f"><div class="ttname"><a href="classTiny_1_1Packet.html#a5dd4b89cb7224b62d4f0328c8e40f38f">Tiny::Packet::getUint32</a></div><div class="ttdeci">uint32_t getUint32()</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:328</div></div>
<div class="ttc" id="classTiny_1_1Proto_html_a6d06cd3b1530e4986ce42a9987c522c4"><div class="ttname"><a href="classTiny_1_1Proto.html#a6d06cd3b1530e4986ce42a9987c522c4">Tiny::Proto::beginToSerial2</a></div><div class="ttdeci">void beginToSerial2()</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:95</div></div>
<div class="ttc" id="tiny__layer2_8h_html_ae3d867e030f59de94508902f2b84a7ec"><div class="ttname"><a href="tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a></div><div class="ttdeci">int(* read_block_cb_t)(void *pdata, uint8_t *buffer, int size)</div><div class="ttdef"><b>Definition:</b> tiny_layer2.h:131</div></div>
<div class="ttc" id="classTiny_1_1Packet_html_a260645f9d055da878f149a13ecd58844"><div class="ttname"><a href="classTiny_1_1Packet.html#a260645f9d055da878f149a13ecd58844">Tiny::Packet::getChar</a></div><div class="ttdeci">char getChar()</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:310</div></div>
<div class="ttc" id="classTiny_1_1Packet_html_abfaef504eb88a4db88bca3b907770fa2"><div class="ttname"><a href="classTiny_1_1Packet.html#abfaef504eb88a4db88bca3b907770fa2">Tiny::Packet::operator[]</a></div><div class="ttdeci">uint8_t &amp; operator[](size_t idx)</div><div class="ttdef"><b>Definition:</b> TinyProtocol.h:366</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
6 changes: 3 additions & 3 deletions doc/html/classTiny_1_1Proto.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6f5f4ebec42dc6e679c25e79284d7705"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiny_1_1Proto.html#a6f5f4ebec42dc6e679c25e79284d7705">begin</a> (<a class="el" href="inc_2tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a> writecb, <a class="el" href="inc_2tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a> readcb)</td></tr>
<tr class="memitem:a6f5f4ebec42dc6e679c25e79284d7705"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiny_1_1Proto.html#a6f5f4ebec42dc6e679c25e79284d7705">begin</a> (<a class="el" href="tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a> writecb, <a class="el" href="tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a> readcb)</td></tr>
<tr class="separator:a6f5f4ebec42dc6e679c25e79284d7705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dcad822337b6155148b1da9222fdd82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiny_1_1Proto.html#a1dcad822337b6155148b1da9222fdd82">beginToSerial</a> ()</td></tr>
<tr class="separator:a1dcad822337b6155148b1da9222fdd82"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -143,13 +143,13 @@
<tr>
<td class="memname">void Tiny::Proto::begin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="inc_2tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a>&#160;</td>
<td class="paramtype"><a class="el" href="tiny__layer2_8h.html#a7f69e669de5baa69a43ee5cb439a7496">write_block_cb_t</a>&#160;</td>
<td class="paramname"><em>writecb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="inc_2tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a>&#160;</td>
<td class="paramtype"><a class="el" href="tiny__layer2_8h.html#ae3d867e030f59de94508902f2b84a7ec">read_block_cb_t</a>&#160;</td>
<td class="paramname"><em>readcb</em>&#160;</td>
</tr>
<tr>
Expand Down
Loading

0 comments on commit 9239f74

Please sign in to comment.