spacecruft
/
satnogs-rotator-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Activity
satnogs-rotator-firmware/doxygen_files/html/classrs485.html

431 lines
19 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>satnogs-rotator-firmware: rs485 Class Reference</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="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>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">satnogs-rotator-firmware
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classrs485-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rs485 Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class that functions for interacting with a RS485 transceiver.
<a href="classrs485.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="rs485_8h_source.html">rs485.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>
<tr class="memitem:acd42457ff65a8979a5cdd62b64d1b905"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#acd42457ff65a8979a5cdd62b64d1b905">rs485</a> (uint8_t pin_dir, uint16_t tx_time)</td></tr>
<tr class="separator:acd42457ff65a8979a5cdd62b64d1b905"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7cf3f6e3b6e6d79dc490145aa3c1b12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#ab7cf3f6e3b6e6d79dc490145aa3c1b12">begin</a> (uint16_t baudrate)</td></tr>
<tr class="memdesc:ab7cf3f6e3b6e6d79dc490145aa3c1b12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the RS485 transceiver. <a href="#ab7cf3f6e3b6e6d79dc490145aa3c1b12">More...</a><br /></td></tr>
<tr class="separator:ab7cf3f6e3b6e6d79dc490145aa3c1b12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acffe305907c9de94dda20135bc6ad93a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#acffe305907c9de94dda20135bc6ad93a">print</a> (String str)</td></tr>
<tr class="memdesc:acffe305907c9de94dda20135bc6ad93a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a string to RS485 bus. <a href="#acffe305907c9de94dda20135bc6ad93a">More...</a><br /></td></tr>
<tr class="separator:acffe305907c9de94dda20135bc6ad93a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac549517006a6b2cff970e3390ccd2c45"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#ac549517006a6b2cff970e3390ccd2c45">read</a> ()</td></tr>
<tr class="memdesc:ac549517006a6b2cff970e3390ccd2c45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a char/uint8_t from RS485 bus. <a href="#ac549517006a6b2cff970e3390ccd2c45">More...</a><br /></td></tr>
<tr class="separator:ac549517006a6b2cff970e3390ccd2c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a204229ca0c3ee5d24d4c5eac9a543ef7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#a204229ca0c3ee5d24d4c5eac9a543ef7">available</a> (void)</td></tr>
<tr class="memdesc:a204229ca0c3ee5d24d4c5eac9a543ef7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of chars/uint8_t that are available in RS485 buffer. <a href="#a204229ca0c3ee5d24d4c5eac9a543ef7">More...</a><br /></td></tr>
<tr class="separator:a204229ca0c3ee5d24d4c5eac9a543ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af02e2635ac5bb688bc9f05895a983704"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#af02e2635ac5bb688bc9f05895a983704">flush</a> ()</td></tr>
<tr class="memdesc:af02e2635ac5bb688bc9f05895a983704"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the transmission of outgoing serial data to complete. <a href="#af02e2635ac5bb688bc9f05895a983704">More...</a><br /></td></tr>
<tr class="separator:af02e2635ac5bb688bc9f05895a983704"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a7d6743372a514e371f761d357b3bd8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#a1a7d6743372a514e371f761d357b3bd8">end</a> ()</td></tr>
<tr class="memdesc:a1a7d6743372a514e371f761d357b3bd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables RS485 communication. <a href="#a1a7d6743372a514e371f761d357b3bd8">More...</a><br /></td></tr>
<tr class="separator:a1a7d6743372a514e371f761d357b3bd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a8a09bf5dcd2b3274220eb95c6323e2bf"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#a8a09bf5dcd2b3274220eb95c6323e2bf">_pin_dir</a></td></tr>
<tr class="separator:a8a09bf5dcd2b3274220eb95c6323e2bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b38109fc4d9cf9f98cebda6d6f2b033"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrs485.html#a1b38109fc4d9cf9f98cebda6d6f2b033">_tx_time</a></td></tr>
<tr class="separator:a1b38109fc4d9cf9f98cebda6d6f2b033"><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 that functions for interacting with a RS485 transceiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin_dir</td><td>Digital pin, to set read or write to RS485 bus </td></tr>
<tr><td class="paramname">tx_time</td><td>Time delay in ms in order to transmit and change the status of direction pin </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00023">23</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acd42457ff65a8979a5cdd62b64d1b905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd42457ff65a8979a5cdd62b64d1b905">&#9670;&nbsp;</a></span>rs485()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rs485::rs485 </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pin_dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>tx_time</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00026">26</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">References <a class="el" href="rs485_8h_source.html#l00096">_pin_dir</a>, and <a class="el" href="rs485_8h_source.html#l00097">_tx_time</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a204229ca0c3ee5d24d4c5eac9a543ef7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a204229ca0c3ee5d24d4c5eac9a543ef7">&#9670;&nbsp;</a></span>available()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t rs485::available </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of chars/uint8_t that are available in RS485 buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>A char/uint8_t </dd></dl>
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00073">73</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00048">easycomm::easycomm_proc()</a>, and <a class="el" href="watchdog_8h_source.html#l00056">ISR()</a>.</p>
</div>
</div>
<a id="ab7cf3f6e3b6e6d79dc490145aa3c1b12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7cf3f6e3b6e6d79dc490145aa3c1b12">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rs485::begin </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>baudrate</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the RS485 transceiver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">baudrate</td><td>Set the baudrate of RS485 bus </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00038">38</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">References <a class="el" href="rs485_8h_source.html#l00096">_pin_dir</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00039">easycomm::easycomm_init()</a>.</p>
</div>
</div>
<a id="a1a7d6743372a514e371f761d357b3bd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a7d6743372a514e371f761d357b3bd8">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rs485::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Disables RS485 communication. </p>
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00091">91</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
</div>
</div>
<a id="af02e2635ac5bb688bc9f05895a983704"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af02e2635ac5bb688bc9f05895a983704">&#9670;&nbsp;</a></span>flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rs485::flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Waits for the transmission of outgoing serial data to complete. </p>
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00082">82</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00048">easycomm::easycomm_proc()</a>, and <a class="el" href="watchdog_8h_source.html#l00056">ISR()</a>.</p>
</div>
</div>
<a id="acffe305907c9de94dda20135bc6ad93a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acffe305907c9de94dda20135bc6ad93a">&#9670;&nbsp;</a></span>print()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void rs485::print </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Print a string to RS485 bus. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>A String to transmit </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00050">50</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">References <a class="el" href="rs485_8h_source.html#l00096">_pin_dir</a>, and <a class="el" href="rs485_8h_source.html#l00097">_tx_time</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00048">easycomm::easycomm_proc()</a>, and <a class="el" href="watchdog_8h_source.html#l00056">ISR()</a>.</p>
</div>
</div>
<a id="ac549517006a6b2cff970e3390ccd2c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac549517006a6b2cff970e3390ccd2c45">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t rs485::read </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a char/uint8_t from RS485 bus. </p>
<dl class="section return"><dt>Returns</dt><dd>A char/uint8_t </dd></dl>
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00063">63</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="easycomm_8h_source.html#l00048">easycomm::easycomm_proc()</a>, and <a class="el" href="watchdog_8h_source.html#l00056">ISR()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8a09bf5dcd2b3274220eb95c6323e2bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a09bf5dcd2b3274220eb95c6323e2bf">&#9670;&nbsp;</a></span>_pin_dir</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t rs485::_pin_dir</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00096">96</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="rs485_8h_source.html#l00038">begin()</a>, <a class="el" href="rs485_8h_source.html#l00050">print()</a>, and <a class="el" href="rs485_8h_source.html#l00026">rs485()</a>.</p>
</div>
</div>
<a id="a1b38109fc4d9cf9f98cebda6d6f2b033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b38109fc4d9cf9f98cebda6d6f2b033">&#9670;&nbsp;</a></span>_tx_time</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t rs485::_tx_time</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="rs485_8h_source.html#l00097">97</a> of file <a class="el" href="rs485_8h_source.html">rs485.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="rs485_8h_source.html#l00050">print()</a>, and <a class="el" href="rs485_8h_source.html#l00026">rs485()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libraries/<a class="el" href="rs485_8h_source.html">rs485.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink