Micro template library A library for building device drivers
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.
 
 
 
 

142 lines
8.3 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.14"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>uTL: include/utl/com/_1wire_uart.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  18. $(document).ready(initResizable);
  19. /* @license-end */</script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/searchdata.js"></script>
  22. <script type="text/javascript" src="search/search.js"></script>
  23. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  24. </head>
  25. <body>
  26. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  27. <div id="titlearea">
  28. <table cellspacing="0" cellpadding="0">
  29. <tbody>
  30. <tr style="height: 56px;">
  31. <td id="projectalign" style="padding-left: 0.5em;">
  32. <div id="projectname">uTL
  33. </div>
  34. <div id="projectbrief">micro Template library</div>
  35. </td>
  36. </tr>
  37. </tbody>
  38. </table>
  39. </div>
  40. <!-- end header part -->
  41. <!-- Generated by Doxygen 1.8.14 -->
  42. <script type="text/javascript">
  43. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  44. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  45. /* @license-end */
  46. </script>
  47. <script type="text/javascript" src="menudata.js"></script>
  48. <script type="text/javascript" src="menu.js"></script>
  49. <script type="text/javascript">
  50. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  51. $(function() {
  52. initMenu('',true,false,'search.php','Search');
  53. $(document).ready(function() { init_search(); });
  54. });
  55. /* @license-end */</script>
  56. <div id="main-nav"></div>
  57. </div><!-- top -->
  58. <div id="side-nav" class="ui-resizable side-nav-resizable">
  59. <div id="nav-tree">
  60. <div id="nav-tree-contents">
  61. <div id="nav-sync" class="sync"></div>
  62. </div>
  63. </div>
  64. <div id="splitbar" style="-moz-user-select:none;"
  65. class="ui-resizable-handle">
  66. </div>
  67. </div>
  68. <script type="text/javascript">
  69. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  70. $(document).ready(function(){initNavTree('__1wire__uart_8h.html','');});
  71. /* @license-end */
  72. </script>
  73. <div id="doc-content">
  74. <!-- window showing the filter options -->
  75. <div id="MSearchSelectWindow"
  76. onmouseover="return searchBox.OnSearchSelectShow()"
  77. onmouseout="return searchBox.OnSearchSelectHide()"
  78. onkeydown="return searchBox.OnSearchSelectKey(event)">
  79. </div>
  80. <!-- iframe showing the search results (closed by default) -->
  81. <div id="MSearchResultsWindow">
  82. <iframe src="javascript:void(0)" frameborder="0"
  83. name="MSearchResults" id="MSearchResults">
  84. </iframe>
  85. </div>
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#nested-classes">Classes</a> &#124;
  89. <a href="#namespaces">Namespaces</a> </div>
  90. <div class="headertitle">
  91. <div class="title">_1wire_uart.h File Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <p>A 1-wire implementation using a microprocessor's uart for bit timing.
  95. <a href="#details">More...</a></p>
  96. <div class="textblock"><code>#include &lt;<a class="el" href="impl_8h_source.html">utl/core/impl.h</a>&gt;</code><br />
  97. <code>#include &lt;<a class="el" href="crtp_8h_source.html">utl/core/crtp.h</a>&gt;</code><br />
  98. <code>#include &lt;<a class="el" href="__1wire_8h_source.html">utl/com/_1wire.h</a>&gt;</code><br />
  99. </div>
  100. <p><a href="__1wire__uart_8h_source.html">Go to the source code of this file.</a></p>
  101. <table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  103. Classes</h2></td></tr>
  104. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i&lt; Impl_t &gt;</a></td></tr>
  105. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">1-wire UART interface template class using CRTP Using the private virtual interface we provide the interface from _1wire_i&lt;&gt; <a href="classutl_1_1__1wire__uart__i.html#details">More...</a><br /></td></tr>
  106. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i_3_01virtual__tag_01_4.html">utl::_1wire_uart_i&lt; virtual_tag &gt;</a></td></tr>
  108. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A virtual base class interface implementation. Using the private virtual interface we provide the interface from <a class="el" href="classutl_1_1__1wire__i_3_01virtual__tag_01_4.html" title="A virtual base class implementation. ">_1wire_i&lt;virtual_tag&gt;</a> <a href="classutl_1_1__1wire__uart__i_3_01virtual__tag_01_4.html#details">More...</a><br /></td></tr>
  109. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table><table class="memberdecls">
  111. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
  112. Namespaces</h2></td></tr>
  113. <tr class="memitem:namespaceutl"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl.html">utl</a></td></tr>
  114. <tr class="memdesc:namespaceutl"><td class="mdescLeft">&#160;</td><td class="mdescRight">STL's core language concepts. <br /></td></tr>
  115. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table>
  117. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  118. <div class="textblock"><p>A 1-wire implementation using a microprocessor's uart for bit timing. </p>
  119. <dl class="section note"><dt>Note</dt><dd>This 1-wire implementation is based on MCU UART functionality. The implementation expects: 1) An Open drain tx and a floating(or pull-up) rx UART pin configuration with both pins connected to the 1-wire bus wire 2) A Transmit/receive function even in blocking/polling mode 3) A baudrate set function</dd></dl>
  120. <p>Copyright (C) 2018 Christos Choutouridis</p>
  121. <p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
  122. <p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>
  123. <p>You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p>
  124. <p class="definition">Definition in file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  125. </div></div><!-- contents -->
  126. </div><!-- doc-content -->
  127. <!-- start footer part -->
  128. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  129. <ul>
  130. <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_82754f54d9380477ef02477185c1f103.html">utl</a></li><li class="navelem"><a class="el" href="dir_b2ad3c1a6521a4924fa9194d98c323e2.html">com</a></li><li class="navelem"><a class="el" href="__1wire__uart_8h.html">_1wire_uart.h</a></li>
  131. <li class="footer">Generated by
  132. <a href="http://www.doxygen.org/index.html">
  133. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
  134. </ul>
  135. </div>
  136. </body>
  137. </html>