Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
F-L-X-S committed Oct 1, 2024
1 parent 72ccb5a commit 0734543
Show file tree
Hide file tree
Showing 10 changed files with 95 additions and 52 deletions.
68 changes: 35 additions & 33 deletions docs/html/_char_array_8h_source.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/_frame__modbus_r_t_u_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,8 @@
<div class="ttc" id="a_frame_8h_html"><div class="ttname"><a href="_frame_8h.html">Frame.h</a></div></div>
<div class="ttc" id="aclass_char_array_html"><div class="ttname"><a href="class_char_array.html">CharArray</a></div><div class="ttdoc">Class for storing char-array (byte-array) together with size. The Array is stored on Heap-memory and ...</div><div class="ttdef"><b>Definition</b> CharArray.h:38</div></div>
<div class="ttc" id="aclass_frame__modbus_r_t_u_html"><div class="ttname"><a href="class_frame__modbus_r_t_u.html">Frame_modbusRTU</a></div><div class="ttdoc">Class for defining the structure of the Modbus-RTU-Frame. Can be constructed by a given modbus-frame ...</div><div class="ttdef"><b>Definition</b> Frame_modbusRTU.h:58</div></div>
<div class="ttc" id="aclass_frame__modbus_r_t_u_html_a02b47ac99a90a57c64b17f291190b13d"><div class="ttname"><a href="class_frame__modbus_r_t_u.html#a02b47ac99a90a57c64b17f291190b13d">Frame_modbusRTU::getFunctionCode</a></div><div class="ttdeci">char getFunctionCode()</div><div class="ttdoc">Get the Modbus-RTU-function-code of the frame-instance.</div><div class="ttdef"><b>Definition</b> Frame_modbusRTU.cpp:90</div></div>
<div class="ttc" id="aclass_frame__modbus_r_t_u_html_a4c47818dc37cda1cd7ba792989bcb0ea"><div class="ttname"><a href="class_frame__modbus_r_t_u.html#a4c47818dc37cda1cd7ba792989bcb0ea">Frame_modbusRTU::checkCRC16</a></div><div class="ttdeci">bool checkCRC16()</div><div class="ttdoc">Verifies the CRC16 checksum of the current Modbus RTU frame.</div><div class="ttdef"><b>Definition</b> Frame_modbusRTU.cpp:111</div></div>
<div class="ttc" id="aclass_frame__modbus_r_t_u_html_a02b47ac99a90a57c64b17f291190b13d"><div class="ttname"><a href="class_frame__modbus_r_t_u.html#a02b47ac99a90a57c64b17f291190b13d">Frame_modbusRTU::getFunctionCode</a></div><div class="ttdeci">char getFunctionCode()</div><div class="ttdoc">Get the Modbus-RTU-function-code of the frame-instance.</div><div class="ttdef"><b>Definition</b> Frame_modbusRTU.cpp:87</div></div>
<div class="ttc" id="aclass_frame__modbus_r_t_u_html_a4c47818dc37cda1cd7ba792989bcb0ea"><div class="ttname"><a href="class_frame__modbus_r_t_u.html#a4c47818dc37cda1cd7ba792989bcb0ea">Frame_modbusRTU::checkCRC16</a></div><div class="ttdeci">bool checkCRC16()</div><div class="ttdoc">Verifies the CRC16 checksum of the current Modbus RTU frame.</div><div class="ttdef"><b>Definition</b> Frame_modbusRTU.cpp:108</div></div>
<div class="ttc" id="aclass_frame__modbus_r_t_u_html_a981fc8dff661e9ac46ea378f17a28e9a"><div class="ttname"><a href="class_frame__modbus_r_t_u.html#a981fc8dff661e9ac46ea378f17a28e9a">Frame_modbusRTU::~Frame_modbusRTU</a></div><div class="ttdeci">~Frame_modbusRTU()</div><div class="ttdoc">Destroy the Frame_modbusRTU object.</div><div class="ttdef"><b>Definition</b> Frame_modbusRTU.cpp:45</div></div>
<div class="ttc" id="aclass_frame__modbus_r_t_u_html_ac8bde306d324d44d9d6adc6bc718e3a5"><div class="ttname"><a href="class_frame__modbus_r_t_u.html#ac8bde306d324d44d9d6adc6bc718e3a5">Frame_modbusRTU::Frame_modbusRTU</a></div><div class="ttdeci">Frame_modbusRTU()</div><div class="ttdoc">Construct empty Modbus-RTU-Frame.</div><div class="ttdef"><b>Definition</b> Frame_modbusRTU.cpp:39</div></div>
<div class="ttc" id="aclass_frame_html"><div class="ttname"><a href="class_frame.html">Frame</a></div><div class="ttdoc">Frame-Class as derived class from Content The derived classes define: -the conversion from a given pa...</div><div class="ttdef"><b>Definition</b> Frame.h:50</div></div>
Expand Down
25 changes: 13 additions & 12 deletions docs/html/class_char_array-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,18 +92,19 @@
<p>This is the complete list of members for <a class="el" href="class_char_array.html">CharArray</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#a146ef9bb0b947f92e5f0ccb80b768c81">CharArray</a>()</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#ac79f104c9a63490a71f4a05f7fc2539b">CharArray</a>(const CharArray &amp;other)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#aca5000ba20e3e1a4b6efd128c8dd62dd">getData</a>() const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#ab6ae6efb0622d58bd8ae2aa77cce6b00">getHexString</a>()</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#a384344479de289fff7c98966f0b079be">getSize</a>() const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#ab801f84f8b8b84f089b8d574d9f0f7dd">operator!=</a>(const CharArray &amp;other) const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#af571946b68108c9cb95c6b046073227f">operator+=</a>(char c)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#a5a3f1e26bd80a96b7cc36a5e0b984860">operator=</a>(const CharArray &amp;other)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#a065e4ef970ec3952d129d14c947400e1">operator=</a>(const String &amp;other)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#ad530feb6d6970e84df2056ef7b338da5">operator==</a>(const CharArray &amp;other) const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#a388f6ed3f703102118c210c1a7c79ef6">operator[]</a>(size_t index)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#ae79eeb2b6c5b4fc80ffcd599e82239e6">operator[]</a>(size_t index) const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#ae13f8ca8c3f0de90cb43edff3753199a">~CharArray</a>()</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#a989d2a2e387fe94255a15341b6bc7550">CharArray</a>(const String &amp;str)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#ac79f104c9a63490a71f4a05f7fc2539b">CharArray</a>(const CharArray &amp;other)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#aca5000ba20e3e1a4b6efd128c8dd62dd">getData</a>() const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#ab6ae6efb0622d58bd8ae2aa77cce6b00">getHexString</a>()</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#a384344479de289fff7c98966f0b079be">getSize</a>() const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#ab801f84f8b8b84f089b8d574d9f0f7dd">operator!=</a>(const CharArray &amp;other) const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#af571946b68108c9cb95c6b046073227f">operator+=</a>(char c)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#a5a3f1e26bd80a96b7cc36a5e0b984860">operator=</a>(const CharArray &amp;other)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#a065e4ef970ec3952d129d14c947400e1">operator=</a>(const String &amp;other)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#ad530feb6d6970e84df2056ef7b338da5">operator==</a>(const CharArray &amp;other) const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#a388f6ed3f703102118c210c1a7c79ef6">operator[]</a>(size_t index)</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_char_array.html#ae79eeb2b6c5b4fc80ffcd599e82239e6">operator[]</a>(size_t index) const</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_char_array.html#ae13f8ca8c3f0de90cb43edff3753199a">~CharArray</a>()</td><td class="entry"><a class="el" href="class_char_array.html">CharArray</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
31 changes: 30 additions & 1 deletion docs/html/class_char_array.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@
&#160;</td><td class="memItemRight" valign="bottom"><b>~CharArray</b> ()</td></tr>
<tr class="memdesc:ae13f8ca8c3f0de90cb43edff3753199a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the Char Array object. <br /></td></tr>
<tr class="separator:ae13f8ca8c3f0de90cb43edff3753199a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a989d2a2e387fe94255a15341b6bc7550" id="r_a989d2a2e387fe94255a15341b6bc7550"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a989d2a2e387fe94255a15341b6bc7550">CharArray</a> (const <a class="el" href="namespacearduino_mocking.html#a074bce778184555fd29d1370a36298bf">String</a> &amp;str)</td></tr>
<tr class="memdesc:a989d2a2e387fe94255a15341b6bc7550"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor for Arduino-String <br /></td></tr>
<tr class="separator:a989d2a2e387fe94255a15341b6bc7550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac79f104c9a63490a71f4a05f7fc2539b" id="r_ac79f104c9a63490a71f4a05f7fc2539b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac79f104c9a63490a71f4a05f7fc2539b">CharArray</a> (const <a class="el" href="class_char_array.html">CharArray</a> &amp;other)</td></tr>
<tr class="memdesc:ac79f104c9a63490a71f4a05f7fc2539b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:ac79f104c9a63490a71f4a05f7fc2539b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -144,8 +147,34 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for storing char-array (byte-array) together with size. The Array is stored on Heap-memory and is extended by adding bytes with "+=" or by write-access to an index larger than the current size. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a989d2a2e387fe94255a15341b6bc7550" name="a989d2a2e387fe94255a15341b6bc7550"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989d2a2e387fe94255a15341b6bc7550">&#9670;&#160;</a></span>CharArray() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CharArray::CharArray </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacearduino_mocking.html#a074bce778184555fd29d1370a36298bf">String</a> &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>constructor for Arduino-String </p>
<p>Initializes a new <a class="el" href="class_char_array.html" title="Class for storing char-array (byte-array) together with size. The Array is stored on Heap-memory and ...">CharArray</a> object with the content of the String-object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The String-Object </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ac79f104c9a63490a71f4a05f7fc2539b" name="ac79f104c9a63490a71f4a05f7fc2539b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac79f104c9a63490a71f4a05f7fc2539b">&#9670;&#160;</a></span>CharArray()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ac79f104c9a63490a71f4a05f7fc2539b">&#9670;&#160;</a></span>CharArray() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down
1 change: 1 addition & 0 deletions docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="files" name="files"></a>
Files</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"><span class="icondoc"></span>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="main_8cpp.html">main.cpp</a></td></tr>
<tr class="memdesc:main_8cpp"><td class="mdescLeft">&#160;</td><td class="mdescRight">This main is an example-implementation of a simple modbus-messenger to demonstrate the usage of a layer-7-service in the program. The String typed in by the user via serial-interface is sent to the device with PARTNER_DEVICE_ID. All received Messages and raised errors are displayed on serial-monitor. Switch PARTNER_DEVICE_ID and DEVICE_ID before uploading to the Partner-device. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/html/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@
<tr id="row_0_7_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="_service_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_service_8h.html" target="_self">Service.h</a></td><td class="desc"></td></tr>
<tr id="row_0_7_3_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="_service_cluster_8h_source.html"><span class="icondoc"></span></a><a class="el" href="_service_cluster_8h.html" target="_self">ServiceCluster.h</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="dynsection.toggleFolder('1_')">&#9660;</span><span id="img_1_" class="iconfopen" onclick="dynsection.toggleFolder('1_')">&#160;</span><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html" target="_self">src</a></td><td class="desc"></td></tr>
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="main_8cpp.html" target="_self">main.cpp</a></td><td class="desc"></td></tr>
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="main_8cpp.html" target="_self">main.cpp</a></td><td class="desc">This main is an example-implementation of a simple modbus-messenger to demonstrate the usage of a layer-7-service in the program. The String typed in by the user via serial-interface is sent to the device with PARTNER_DEVICE_ID. All received Messages and raised errors are displayed on serial-monitor. Switch PARTNER_DEVICE_ID and DEVICE_ID before uploading to the Partner-device </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
3 changes: 3 additions & 0 deletions docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ <h5><a class="anchor" id="autotoc_md5"></a>
<li class="checked">Implementation of <a href="lib/Interface/ServiceInterface.h">Modbus-RTU Service-Interface</a> to process payload from/for the registered services and frames of from/for <a href="lib/ModbusRTU/CommInterface_modbusRTU.h">Modbus-RTU communication-interface</a></li>
<li class="unchecked">Setup of the <a href="lib/ModbusRTU/ServiceInterface_modbusRTU.h">Modbus-RTU Service-interface</a> for Master-mode (polling and message-forwarding)</li>
</ul>
<ul class="check">
<li class="unchecked">Response-Timeout for Message-Service</li>
</ul>
<h5><a class="anchor" id="autotoc_md6"></a>
I2C implementation</h5>
<ul class="check">
Expand Down
Loading

0 comments on commit 0734543

Please sign in to comment.