You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 lines
18 KiB
118 lines
18 KiB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>modbus-arduino: Modbus.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="modbus.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">modbus-arduino
|
|
 <span id="projectnumber">1.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">Modbus library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('Modbus_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Modbus.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Modbus.h - Header for Modbus Base Library</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 2014 André Sarmento Barbosa</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">*/</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "Arduino.h"</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef MODBUS_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define MODBUS_H</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define MAX_REGS 32</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define MAX_FRAME 128</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//#define USE_HOLDING_REGISTERS_ONLY</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// Function Codes</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  MB_FC_READ_COILS = 0x01, </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  MB_FC_READ_INPUT_STAT = 0x02, </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  MB_FC_READ_REGS = 0x03, </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  MB_FC_READ_INPUT_REGS = 0x04, </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  MB_FC_WRITE_COIL = 0x05, </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  MB_FC_WRITE_REG = 0x06, </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  MB_FC_WRITE_COILS = 0x0F, </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  MB_FC_WRITE_REGS = 0x10, </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> };</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// Exception Codes</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  MB_EX_ILLEGAL_FUNCTION = 0x01, </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  MB_EX_ILLEGAL_ADDRESS = 0x02, </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  MB_EX_ILLEGAL_VALUE = 0x03, </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  MB_EX_SLAVE_FAILURE = 0x04, </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> };</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Reply Types</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  MB_REPLY_OFF = 0x01, </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  MB_REPLY_ECHO = 0x02, </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  MB_REPLY_NORMAL = 0x03, </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> };</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#ifndef __DOXYGEN__</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>TRegister {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  word address;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  word value;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">struct </span>TRegister* next;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> } TRegister;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classModbus.html"> 53</a></span> <span class="keyword">class </span><a class="code" href="classModbus.html">Modbus</a> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#ifndef __DOXYGEN__</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  TRegister *_regs_head;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  TRegister *_regs_last;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> readRegisters(word startreg, word numregs);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> writeSingleRegister(word reg, word value);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> writeMultipleRegisters(byte* frame,word startreg, word numoutputs, byte bytecount);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> exceptionResponse(byte fcode, byte excode);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> #ifndef USE_HOLDING_REGISTERS_ONLY</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> readCoils(word startreg, word numregs);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> readInputStatus(word startreg, word numregs);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> readInputRegisters(word startreg, word numregs);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> writeSingleCoil(word reg, word status);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> writeMultipleCoils(byte* frame,word startreg, word numoutputs, byte bytecount);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> #endif</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  TRegister* searchRegister(word addr);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> addReg(word address, word value = 0);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">bool</span> Reg(word address, word value);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  word Reg(word address);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  byte *_frame;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  byte _len;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  byte _reply;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> receivePDU(byte* frame);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classModbus.html">Modbus</a>();</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> addHreg(word offset, word value = 0);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">bool</span> Hreg(word offset, word value);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  word Hreg(word offset);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor"> #ifndef USE_HOLDING_REGISTERS_ONLY</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> addCoil(word offset, <span class="keywordtype">bool</span> value = <span class="keyword">false</span>);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> addIsts(word offset, <span class="keywordtype">bool</span> value = <span class="keyword">false</span>);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">void</span> addIreg(word offset, word value = 0);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">bool</span> Coil(word offset, <span class="keywordtype">bool</span> value);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">bool</span> Ists(word offset, <span class="keywordtype">bool</span> value);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">bool</span> Ireg(word offset, word value);</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">bool</span> Coil(word offset);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">bool</span> Ists(word offset);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  word Ireg(word offset);</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor"> #endif</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> };</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor">#endif //MODBUS_H</span></div><div class="ttc" id="classModbus_html"><div class="ttname"><a href="classModbus.html">Modbus</a></div><div class="ttdoc">Modbus base class. </div><div class="ttdef"><b>Definition:</b> <a href="Modbus_8h_source.html#l00053">Modbus.h:53</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_b68070abd0927afc37f6892e9bcc19ad.html">Modbus</a></li><li class="navelem"><b>Modbus.h</b></li>
|
|
<li class="footer">Generated on Fri Jan 19 2018 01:17:49 for modbus-arduino by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|