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.
128 lines
24 KiB
128 lines
24 KiB
1 year ago
|
<!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: ModbusSerial.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('ModbusSerial_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">ModbusSerial.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"> ModbusSerial.h - Header for ModbusSerial 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> <span class="preprocessor">#include <Modbus.h></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef MODBUSSERIAL_H</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define MODBUSSERIAL_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">//#define USE_SOFTWARE_SERIAL</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifdef USE_SOFTWARE_SERIAL</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <SoftwareSerial.h></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">enum</span> MB_PARITY {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  MB_PARITY_NONE = SERIAL_8N2, </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  MB_PARITY_EVEN = SERIAL_8E1, </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  MB_PARITY_ODD = SERIAL_8O1 </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> };</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classModbusSerial.html"> 54</a></span> <span class="keyword">class </span><a class="code" href="classModbusSerial.html">ModbusSerial</a> : <span class="keyword">public</span> <a class="code" href="classModbus.html">Modbus</a> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#ifndef __DOXYGEN__</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  Stream* _port;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">long</span> _baud;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  byte _format;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">int</span> _txPin;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> _t15; <span class="comment">// inter character time out</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordty
|
||
|
|
<div class="ttc" id="classModbusSerial_html_ad47e2b6a70d42a106a1a55a515e2f33a"><div class="ttname"><a href="classModbusSerial.html#ad47e2b6a70d42a106a1a55a515e2f33a">ModbusSerial::task</a></div><div class="ttdeci">void task()</div><div class="ttdoc">Task that performs all operations on MODBUS. </div></div>
|
||
|
|
<div class="ttc" id="classModbusSerial_html_add48c6a2b436e600865e0cf63ed0aafc"><div class="ttname"><a href="classModbusSerial.html#add48c6a2b436e600865e0cf63ed0aafc">ModbusSerial::ModbusSerial</a></div><div class="ttdeci">ModbusSerial()</div><div class="ttdoc">Default constructor. </div></div>
|
||
|
|
<div class="ttc" id="classModbusSerial_html_ae7b2f3574d102b26a1de084cb345b6cc"><div class="ttname"><a href="classModbusSerial.html#ae7b2f3574d102b26a1de084cb345b6cc">ModbusSerial::send</a></div><div class="ttdeci">bool send(byte *frame)</div></div>
|
||
|
|
<div class="ttc" id="classModbusSerial_html_a3fb991a7b8d0d9766889e2cad7fca115"><div class="ttname"><a href="classModbusSerial.html#a3fb991a7b8d0d9766889e2cad7fca115">ModbusSerial::receive</a></div><div class="ttdeci">bool receive(byte *frame)</div></div>
|
||
|
|
<div class="ttc" id="classModbusSerial_html"><div class="ttname"><a href="classModbusSerial.html">ModbusSerial</a></div><div class="ttdoc">Modbus over serial line Class. </div><div class="ttdef"><b>Definition:</b> <a href="ModbusSerial_8h_source.html#l00054">ModbusSerial.h:54</a></div></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 class="ttc" id="classModbusSerial_html_adefaff8d3e8f4cfc1d90c9b52d880262"><div class="ttname"><a href="classModbusSerial.html#adefaff8d3e8f4cfc1d90c9b52d880262">ModbusSerial::getSlaveId</a></div><div class="ttdeci">byte getSlaveId()</div><div class="ttdoc">Return slave identifier. </div></div>
|
||
|
|
<div class="ttc" id="classModbusSerial_html_a2b727d4d516177e698db6e49729624d8"><div class="ttname"><a href="classModbusSerial.html#a2b727d4d516177e698db6e49729624d8">ModbusSerial::setSlaveId</a></div><div class="ttdeci">bool setSlaveId(byte slaveId)</div><div class="ttdoc">Change the value of slave identifier. </div></div>
|
||
|
|
<div class="ttc" id="classModbusSerial_html_a69850777f84662664dd17e137250e3b0"><div class="ttname"><a href="classModbusSerial.html#a69850777f84662664dd17e137250e3b0">ModbusSerial::sendPDU</a></div><div class="ttdeci">bool sendPDU(byte *pduframe)</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_b54e0a2b0f0dd993b2c80a66bde8de0f.html">ModbusSerial</a></li><li class="navelem"><b>ModbusSerial.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>
|