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.

classutl_1_1__1wire__uart__i.html 50 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710
  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: utl::_1wire_uart_i&lt; Impl_t &gt; Class Template 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('classutl_1_1__1wire__uart__i.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="#pub-types">Public Types</a> &#124;
  89. <a href="#pri-methods">Private Member Functions</a> &#124;
  90. <a href="#pri-attribs">Private Attributes</a> &#124;
  91. <a href="classutl_1_1__1wire__uart__i-members.html">List of all members</a> </div>
  92. <div class="headertitle">
  93. <div class="title">utl::_1wire_uart_i&lt; Impl_t &gt; Class Template Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p>1-wire UART interface template class using CRTP Using the private virtual interface we provide the interface from _1wire_i&lt;&gt;
  97. <a href="classutl_1_1__1wire__uart__i.html#details">More...</a></p>
  98. <p><code>#include &lt;<a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>&gt;</code></p>
  99. <div class="dynheader">
  100. Inheritance diagram for utl::_1wire_uart_i&lt; Impl_t &gt;:</div>
  101. <div class="dyncontent">
  102. <div class="center">
  103. <img src="classutl_1_1__1wire__uart__i.png" usemap="#utl::_5F1wire_5Fuart_5Fi_3C_20Impl_5Ft_20_3E_map" alt=""/>
  104. <map id="utl::_5F1wire_5Fuart_5Fi_3C_20Impl_5Ft_20_3E_map" name="utl::_5F1wire_5Fuart_5Fi_3C_20Impl_5Ft_20_3E_map">
  105. <area href="classutl_1_1__1wire__i.html" title="Template base class for 1-wire communication interface using CRTP. " alt="utl::_1wire_i&lt; impl_t &gt;" shape="rect" coords="0,0,236,24"/>
  106. </map>
  107. </div></div>
  108. <table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  110. Public Types</h2></td></tr>
  111. <tr class="memitem:acc885c6ec2395ad20409b01aa4d5f546"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#acc885c6ec2395ad20409b01aa4d5f546">type</a> = <a class="el" href="classutl_1_1__1wire__uart__i.html">_1wire_uart_i</a>&lt; Impl_t &gt;</td></tr>
  112. <tr class="memdesc:acc885c6ec2395ad20409b01aa4d5f546"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export type as identity meta-function. <a href="#acc885c6ec2395ad20409b01aa4d5f546">More...</a><br /></td></tr>
  113. <tr class="separator:acc885c6ec2395ad20409b01aa4d5f546"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:acc4364e3aa029405a9b2b25e1fea83ac"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#acc4364e3aa029405a9b2b25e1fea83ac">Speed</a> = typename <a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a>&lt; <a class="el" href="classutl_1_1__1wire__i.html#afb63e64403924897a8277eb4159ebd44">type</a> &gt;::<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a></td></tr>
  115. <tr class="memdesc:acc4364e3aa029405a9b2b25e1fea83ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bring bus speed. <a href="#acc4364e3aa029405a9b2b25e1fea83ac">More...</a><br /></td></tr>
  116. <tr class="separator:acc4364e3aa029405a9b2b25e1fea83ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="inherit_header pub_types_classutl_1_1__1wire__i"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classutl_1_1__1wire__i')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classutl_1_1__1wire__i.html">utl::_1wire_i&lt; impl_t &gt;</a></td></tr>
  118. <tr class="memitem:a56bb736aa3620d7795b5914cac5f25cc inherit pub_types_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> { <a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a> =0,
  119. <a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cca1cbf38b04c4249d8ec27d1ec96aaff68">Speed::OVDR</a>
  120. }</td></tr>
  121. <tr class="memdesc:a56bb736aa3620d7795b5914cac5f25cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">1-wire bus speed <a href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">More...</a><br /></td></tr>
  122. <tr class="separator:a56bb736aa3620d7795b5914cac5f25cc inherit pub_types_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:afb63e64403924897a8277eb4159ebd44 inherit pub_types_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#afb63e64403924897a8277eb4159ebd44">type</a> = <a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a></td></tr>
  124. <tr class="memdesc:afb63e64403924897a8277eb4159ebd44 inherit pub_types_classutl_1_1__1wire__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export type as identity meta-function. <a href="classutl_1_1__1wire__i.html#afb63e64403924897a8277eb4159ebd44">More...</a><br /></td></tr>
  125. <tr class="separator:afb63e64403924897a8277eb4159ebd44 inherit pub_types_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  128. Protected Member Functions</h2></td></tr>
  129. <tr><td colspan="2"><div class="groupHeader">Object lifetime</div></td></tr>
  130. <tr class="memitem:ae14ed1ce068d5601c5623c410a0dbc0c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#ae14ed1ce068d5601c5623c410a0dbc0c">_1wire_uart_i</a> ()=default</td></tr>
  131. <tr class="memdesc:ae14ed1ce068d5601c5623c410a0dbc0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow constructor from derived only. <a href="#ae14ed1ce068d5601c5623c410a0dbc0c">More...</a><br /></td></tr>
  132. <tr class="separator:ae14ed1ce068d5601c5623c410a0dbc0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:afe64da15b5eaf61cd54f357f3ea8b3ea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#afe64da15b5eaf61cd54f357f3ea8b3ea">~_1wire_uart_i</a> ()=default</td></tr>
  134. <tr class="separator:afe64da15b5eaf61cd54f357f3ea8b3ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="inherit_header pro_methods_classutl_1_1__1wire__i"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classutl_1_1__1wire__i')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classutl_1_1__1wire__i.html">utl::_1wire_i&lt; impl_t &gt;</a></td></tr>
  136. <tr class="memitem:a4839577d00fdcefb51ac8d4cd91f0f1a inherit pro_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a4839577d00fdcefb51ac8d4cd91f0f1a">_1wire_i</a> ()=default</td></tr>
  137. <tr class="memdesc:a4839577d00fdcefb51ac8d4cd91f0f1a inherit pro_methods_classutl_1_1__1wire__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow constructor from derived only. <a href="classutl_1_1__1wire__i.html#a4839577d00fdcefb51ac8d4cd91f0f1a">More...</a><br /></td></tr>
  138. <tr class="separator:a4839577d00fdcefb51ac8d4cd91f0f1a inherit pro_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:afb146fda251b25c9fc812718f6c5b3e1 inherit pro_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#afb146fda251b25c9fc812718f6c5b3e1">~_1wire_i</a> ()=default</td></tr>
  140. <tr class="memdesc:afb146fda251b25c9fc812718f6c5b3e1 inherit pro_methods_classutl_1_1__1wire__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow destructor from derived only. <a href="classutl_1_1__1wire__i.html#afb146fda251b25c9fc812718f6c5b3e1">More...</a><br /></td></tr>
  141. <tr class="separator:afb146fda251b25c9fc812718f6c5b3e1 inherit pro_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:adc539ccd0e41f8f830bd96c362094c14 inherit pro_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#adc539ccd0e41f8f830bd96c362094c14">_1wire_i</a> (const <a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a> &amp;)=delete</td></tr>
  143. <tr class="memdesc:adc539ccd0e41f8f830bd96c362094c14 inherit pro_methods_classutl_1_1__1wire__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">No copies. <a href="classutl_1_1__1wire__i.html#adc539ccd0e41f8f830bd96c362094c14">More...</a><br /></td></tr>
  144. <tr class="separator:adc539ccd0e41f8f830bd96c362094c14 inherit pro_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a96222b5bd731c2b242e428aabda40642 inherit pro_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a96222b5bd731c2b242e428aabda40642">operator=</a> (const <a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a> &amp;)=delete</td></tr>
  146. <tr class="separator:a96222b5bd731c2b242e428aabda40642 inherit pro_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table><table class="memberdecls">
  148. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
  149. Private Member Functions</h2></td></tr>
  150. <tr class="memitem:a95ab6c8cc60417090b2cc4e5afc62e77"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a95ab6c8cc60417090b2cc4e5afc62e77">_CRTP_IMPL</a> (Impl_t)</td></tr>
  151. <tr class="separator:a95ab6c8cc60417090b2cc4e5afc62e77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr><td colspan="2"><div class="groupHeader">Implementation requirements</div></td></tr>
  153. <tr><td colspan="2"><div class="groupText"><dl class="section note"><dt>Note</dt><dd>In order for the implementation to have the following as private members it also need to declare this class as friend </dd></dl>
  154. </div></td></tr>
  155. <tr class="memitem:a02e0069f537ae7e8cccdf8563537952a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a02e0069f537ae7e8cccdf8563537952a">UART_RW</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> byte)</td></tr>
  156. <tr class="memdesc:a02e0069f537ae7e8cccdf8563537952a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementers's (driver) read-write function. We expect the following USART configuration: <a href="#a02e0069f537ae7e8cccdf8563537952a">More...</a><br /></td></tr>
  157. <tr class="separator:a02e0069f537ae7e8cccdf8563537952a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a4379f74ee196e6b8422a74143642004f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a4379f74ee196e6b8422a74143642004f">UART_BR</a> (uint32_t br)</td></tr>
  159. <tr class="memdesc:a4379f74ee196e6b8422a74143642004f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementers's (driver) baudrate function. <a href="#a4379f74ee196e6b8422a74143642004f">More...</a><br /></td></tr>
  160. <tr class="separator:a4379f74ee196e6b8422a74143642004f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. </table><table class="memberdecls">
  162. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  163. Private Attributes</h2></td></tr>
  164. <tr class="memitem:a6ab0ec4032cad68333590f159da83871"><td class="memItemLeft" align="right" valign="top">friend&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a6ab0ec4032cad68333590f159da83871">_1wire_i&lt; _1wire_uart_i&lt; Impl_t &gt; &gt;</a></td></tr>
  165. <tr class="memdesc:a6ab0ec4032cad68333590f159da83871"><td class="mdescLeft">&#160;</td><td class="mdescRight">Syntactic sugar to CRTP casting. <a href="#a6ab0ec4032cad68333590f159da83871">More...</a><br /></td></tr>
  166. <tr class="separator:a6ab0ec4032cad68333590f159da83871"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table><table class="memberdecls">
  168. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  169. Implementation of base requirements</h2></td></tr>
  170. <tr class="memitem:a3a2efd9546f298b920011b3c6f933051"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a3a2efd9546f298b920011b3c6f933051">BR</a> { <a class="el" href="classutl_1_1__1wire__uart__i.html#a3a2efd9546f298b920011b3c6f933051adf1980b5eb0dee83ef1f76ba38671a43">BR_STD_RST</a> =9600,
  171. <a class="el" href="classutl_1_1__1wire__uart__i.html#a3a2efd9546f298b920011b3c6f933051a6ea7cba754551a703cc94658e151f073">BR_OVR_RST</a> =57600,
  172. <a class="el" href="classutl_1_1__1wire__uart__i.html#a3a2efd9546f298b920011b3c6f933051a7ea7463824fb1b6bd5c31e1976351fb0">BR_STD</a> =115200,
  173. <a class="el" href="classutl_1_1__1wire__uart__i.html#a3a2efd9546f298b920011b3c6f933051a4919b1e0ad524b6d6a791ff6c7f96af7">BR_OVR</a> =921600
  174. }</td></tr>
  175. <tr class="memdesc:a3a2efd9546f298b920011b3c6f933051"><td class="mdescLeft">&#160;</td><td class="mdescRight">1-wire UART baudrates <a href="classutl_1_1__1wire__uart__i.html#a3a2efd9546f298b920011b3c6f933051">More...</a><br /></td></tr>
  176. <tr class="separator:a3a2efd9546f298b920011b3c6f933051"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a14e342fac3c10b66d82d154f47b9db26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a14e342fac3c10b66d82d154f47b9db26">_speed</a> {Speed::STD}</td></tr>
  178. <tr class="separator:a14e342fac3c10b66d82d154f47b9db26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a1b807cfc2a67eee08efa48ef36b99f74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a1b807cfc2a67eee08efa48ef36b99f74">speed</a> () const</td></tr>
  180. <tr class="memdesc:a1b807cfc2a67eee08efa48ef36b99f74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the 1-wire bus speed. <a href="#a1b807cfc2a67eee08efa48ef36b99f74">More...</a><br /></td></tr>
  181. <tr class="separator:a1b807cfc2a67eee08efa48ef36b99f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:aa56f7a1497c540397bebf008416118b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#aa56f7a1497c540397bebf008416118b6">speed</a> (<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s)</td></tr>
  183. <tr class="memdesc:aa56f7a1497c540397bebf008416118b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the 1-wire bus speed. <a href="#aa56f7a1497c540397bebf008416118b6">More...</a><br /></td></tr>
  184. <tr class="separator:aa56f7a1497c540397bebf008416118b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:a7bd53d23f567a31177f29fcbda4da09c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#a7bd53d23f567a31177f29fcbda4da09c">bit</a> (bool b)</td></tr>
  186. <tr class="memdesc:a7bd53d23f567a31177f29fcbda4da09c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a 1-Wire write bit and read the response. <a href="#a7bd53d23f567a31177f29fcbda4da09c">More...</a><br /></td></tr>
  187. <tr class="separator:a7bd53d23f567a31177f29fcbda4da09c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:ad40f5180bddd8cd5a55e77f2bfa66ac1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__uart__i.html#ad40f5180bddd8cd5a55e77f2bfa66ac1">_reset</a> (<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s)</td></tr>
  189. <tr class="memdesc:ad40f5180bddd8cd5a55e77f2bfa66ac1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a 1-wire reset </p><hr/>
  190. <p> Reset \ / \ X X X / </p><hr/>
  191. <p> RS: | | | | | | | | | | | bit: ST 0 1 2 3 4 5 6 7 SP &lt; -------&mdash; 1024/174 usec ----------&mdash;&gt; <a href="#ad40f5180bddd8cd5a55e77f2bfa66ac1">More...</a><br /></td></tr>
  192. <tr class="separator:ad40f5180bddd8cd5a55e77f2bfa66ac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. </table><table class="memberdecls">
  194. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  195. Additional Inherited Members</h2></td></tr>
  196. <tr class="inherit_header pub_methods_classutl_1_1__1wire__i"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classutl_1_1__1wire__i')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classutl_1_1__1wire__i.html">utl::_1wire_i&lt; impl_t &gt;</a></td></tr>
  197. <tr class="memitem:a0a7ef731162e81e0e2e07ae9cb9e6ffa inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a0a7ef731162e81e0e2e07ae9cb9e6ffa">reset</a> (<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>)</td></tr>
  198. <tr class="memdesc:a0a7ef731162e81e0e2e07ae9cb9e6ffa inherit pub_methods_classutl_1_1__1wire__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a 1-wire reset. <a href="classutl_1_1__1wire__i.html#a0a7ef731162e81e0e2e07ae9cb9e6ffa">More...</a><br /></td></tr>
  199. <tr class="separator:a0a7ef731162e81e0e2e07ae9cb9e6ffa inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:a59e7196e10e53467b62ed369ff78f07d inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a59e7196e10e53467b62ed369ff78f07d">tx_data</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> out, <a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>)</td></tr>
  201. <tr class="separator:a59e7196e10e53467b62ed369ff78f07d inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:ab3bd112ff66074bdaf7357b91ca692a8 inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#ab3bd112ff66074bdaf7357b91ca692a8">tx_data</a> (const <a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *out, <a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *in, <a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> n, <a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>)</td></tr>
  203. <tr class="separator:ab3bd112ff66074bdaf7357b91ca692a8 inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="memitem:a2585e7166d14b7f36bd47db2e43cc0b1 inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a2585e7166d14b7f36bd47db2e43cc0b1">rx_data</a> (<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>)</td></tr>
  205. <tr class="separator:a2585e7166d14b7f36bd47db2e43cc0b1 inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:ad20382d5d50ee7d457bc4079b9c38a2a inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#ad20382d5d50ee7d457bc4079b9c38a2a">rx_data</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *in, <a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> n, <a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>)</td></tr>
  207. <tr class="separator:ad20382d5d50ee7d457bc4079b9c38a2a inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:aa2d87a149c4e5dcfefc5a8cde6eaefb2 inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#aa2d87a149c4e5dcfefc5a8cde6eaefb2">match</a> (<a class="el" href="classutl_1_1__1wire__id__t.html">_1wire_id_t</a> &amp;id, <a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>)</td></tr>
  209. <tr class="separator:aa2d87a149c4e5dcfefc5a8cde6eaefb2 inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:ac88f67dd75dc23d39123ac584dce6b40 inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#ac88f67dd75dc23d39123ac584dce6b40">match_n_ovdr</a> (<a class="el" href="classutl_1_1__1wire__id__t.html">_1wire_id_t</a> &amp;id)</td></tr>
  211. <tr class="separator:ac88f67dd75dc23d39123ac584dce6b40 inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="memitem:a0a405f818fd45eb2799e6b4477021a0a inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a0a405f818fd45eb2799e6b4477021a0a">skip</a> (<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>)</td></tr>
  213. <tr class="separator:a0a405f818fd45eb2799e6b4477021a0a inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:a8b0b0ea95c02a40721f1e159119b3506 inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a8b0b0ea95c02a40721f1e159119b3506">skip_n_ovdr</a> ()</td></tr>
  215. <tr class="separator:a8b0b0ea95c02a40721f1e159119b3506 inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <tr class="memitem:a4b6d225963095d36eda832a1e0adba55 inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1__1wire__id__t.html">_1wire_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a4b6d225963095d36eda832a1e0adba55">first</a> (<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>, bool alarm=false)</td></tr>
  217. <tr class="memdesc:a4b6d225963095d36eda832a1e0adba55 inherit pub_methods_classutl_1_1__1wire__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">'first' operation, to search on the 1-Wire for the first device. This is performed by setting dec_, pos_ and cur_ to zero and then doing the search. <a href="classutl_1_1__1wire__i.html#a4b6d225963095d36eda832a1e0adba55">More...</a><br /></td></tr>
  218. <tr class="separator:a4b6d225963095d36eda832a1e0adba55 inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  219. <tr class="memitem:a3e302085f12a39fef8a378e1dac42f45 inherit pub_methods_classutl_1_1__1wire__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1__1wire__id__t.html">_1wire_id_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html#a3e302085f12a39fef8a378e1dac42f45">next</a> (<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> s=<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25ccac6ce23be5d350ce18a665427d2d950f7">Speed::STD</a>, bool alarm=false)</td></tr>
  220. <tr class="memdesc:a3e302085f12a39fef8a378e1dac42f45 inherit pub_methods_classutl_1_1__1wire__i"><td class="mdescLeft">&#160;</td><td class="mdescRight">'next' operation, to search on the 1-Wire for the next device. This search is usually performed after a 'first' operation or another 'next' operation. Based on maxim-ic application note 187. <a href="classutl_1_1__1wire__i.html#a3e302085f12a39fef8a378e1dac42f45">More...</a><br /></td></tr>
  221. <tr class="separator:a3e302085f12a39fef8a378e1dac42f45 inherit pub_methods_classutl_1_1__1wire__i"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. </table>
  223. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  224. <div class="textblock"><h3>template&lt;typename Impl_t&gt;<br />
  225. class utl::_1wire_uart_i&lt; Impl_t &gt;</h3>
  226. <p>1-wire UART interface template class using CRTP Using the private virtual interface we provide the interface from _1wire_i&lt;&gt; </p>
  227. <p>A 1-wire implementation using a microprocessor's uart for bit timing inherited from <a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a> base class. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classutl_1_1__1wire__i.html" title="Template base class for 1-wire communication interface using CRTP. ">_1wire_i</a> </dd></dl>
  228. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00052">52</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  229. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  230. <a id="acc4364e3aa029405a9b2b25e1fea83ac"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#acc4364e3aa029405a9b2b25e1fea83ac">&#9670;&nbsp;</a></span>Speed</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <div class="memtemplate">
  235. template&lt;typename Impl_t &gt; </div>
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">using <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> = typename <a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a>&lt;<a class="el" href="classutl_1_1__1wire__i.html#afb63e64403924897a8277eb4159ebd44">type</a>&gt;::<a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a></td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Bring bus speed. </p>
  243. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00057">57</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  244. </div>
  245. </div>
  246. <a id="acc885c6ec2395ad20409b01aa4d5f546"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#acc885c6ec2395ad20409b01aa4d5f546">&#9670;&nbsp;</a></span>type</h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <div class="memtemplate">
  251. template&lt;typename Impl_t &gt; </div>
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">using <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::<a class="el" href="classutl_1_1__1wire__i.html#afb63e64403924897a8277eb4159ebd44">type</a> = <a class="el" href="classutl_1_1__1wire__uart__i.html">_1wire_uart_i</a>&lt;Impl_t&gt;</td>
  255. </tr>
  256. </table>
  257. </div><div class="memdoc">
  258. <p>Export type as identity meta-function. </p>
  259. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00056">56</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  260. </div>
  261. </div>
  262. <h2 class="groupheader">Member Enumeration Documentation</h2>
  263. <a id="a3a2efd9546f298b920011b3c6f933051"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#a3a2efd9546f298b920011b3c6f933051">&#9670;&nbsp;</a></span>BR</h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <div class="memtemplate">
  268. template&lt;typename Impl_t &gt; </div>
  269. <table class="mlabels">
  270. <tr>
  271. <td class="mlabels-left">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">enum <a class="el" href="classutl_1_1__1wire__uart__i.html#a3a2efd9546f298b920011b3c6f933051">utl::_1wire_uart_i::BR</a></td>
  275. </tr>
  276. </table>
  277. </td>
  278. <td class="mlabels-right">
  279. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>1-wire UART baudrates </p>
  284. <table class="fieldtable">
  285. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3a2efd9546f298b920011b3c6f933051adf1980b5eb0dee83ef1f76ba38671a43"></a>BR_STD_RST&#160;</td><td class="fielddoc"></td></tr>
  286. <tr><td class="fieldname"><a id="a3a2efd9546f298b920011b3c6f933051a6ea7cba754551a703cc94658e151f073"></a>BR_OVR_RST&#160;</td><td class="fielddoc"></td></tr>
  287. <tr><td class="fieldname"><a id="a3a2efd9546f298b920011b3c6f933051a7ea7463824fb1b6bd5c31e1976351fb0"></a>BR_STD&#160;</td><td class="fielddoc"></td></tr>
  288. <tr><td class="fieldname"><a id="a3a2efd9546f298b920011b3c6f933051a4919b1e0ad524b6d6a791ff6c7f96af7"></a>BR_OVR&#160;</td><td class="fielddoc"></td></tr>
  289. </table>
  290. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00103">103</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  291. </div>
  292. </div>
  293. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  294. <a id="ae14ed1ce068d5601c5623c410a0dbc0c"></a>
  295. <h2 class="memtitle"><span class="permalink"><a href="#ae14ed1ce068d5601c5623c410a0dbc0c">&#9670;&nbsp;</a></span>_1wire_uart_i()</h2>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <div class="memtemplate">
  299. template&lt;typename Impl_t &gt; </div>
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname"><a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::<a class="el" href="classutl_1_1__1wire__uart__i.html">_1wire_uart_i</a> </td>
  306. <td>(</td>
  307. <td class="paramname"></td><td>)</td>
  308. <td></td>
  309. </tr>
  310. </table>
  311. </td>
  312. <td class="mlabels-right">
  313. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Allow constructor from derived only. </p>
  318. </div>
  319. </div>
  320. <a id="afe64da15b5eaf61cd54f357f3ea8b3ea"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#afe64da15b5eaf61cd54f357f3ea8b3ea">&#9670;&nbsp;</a></span>~_1wire_uart_i()</h2>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <div class="memtemplate">
  325. template&lt;typename Impl_t &gt; </div>
  326. <table class="mlabels">
  327. <tr>
  328. <td class="mlabels-left">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname"><a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::~<a class="el" href="classutl_1_1__1wire__uart__i.html">_1wire_uart_i</a> </td>
  332. <td>(</td>
  333. <td class="paramname"></td><td>)</td>
  334. <td></td>
  335. </tr>
  336. </table>
  337. </td>
  338. <td class="mlabels-right">
  339. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Allow destructor from derived only </p>
  344. </div>
  345. </div>
  346. <h2 class="groupheader">Member Function Documentation</h2>
  347. <a id="a95ab6c8cc60417090b2cc4e5afc62e77"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#a95ab6c8cc60417090b2cc4e5afc62e77">&#9670;&nbsp;</a></span>_CRTP_IMPL()</h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <div class="memtemplate">
  352. template&lt;typename Impl_t &gt; </div>
  353. <table class="mlabels">
  354. <tr>
  355. <td class="mlabels-left">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname"><a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::_CRTP_IMPL </td>
  359. <td>(</td>
  360. <td class="paramtype">Impl_t&#160;</td>
  361. <td class="paramname"></td><td>)</td>
  362. <td></td>
  363. </tr>
  364. </table>
  365. </td>
  366. <td class="mlabels-right">
  367. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. </div>
  372. </div>
  373. <a id="ad40f5180bddd8cd5a55e77f2bfa66ac1"></a>
  374. <h2 class="memtitle"><span class="permalink"><a href="#ad40f5180bddd8cd5a55e77f2bfa66ac1">&#9670;&nbsp;</a></span>_reset()</h2>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <div class="memtemplate">
  378. template&lt;typename Impl_t &gt; </div>
  379. <table class="mlabels">
  380. <tr>
  381. <td class="mlabels-left">
  382. <table class="memname">
  383. <tr>
  384. <td class="memname">bool <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::_reset </td>
  385. <td>(</td>
  386. <td class="paramtype"><a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a>&#160;</td>
  387. <td class="paramname"><em>s</em></td><td>)</td>
  388. <td></td>
  389. </tr>
  390. </table>
  391. </td>
  392. <td class="mlabels-right">
  393. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. <p>Generate a 1-wire reset </p><hr/>
  398. <p> Reset \ / \ X X X / </p><hr/>
  399. <p> RS: | | | | | | | | | | | bit: ST 0 1 2 3 4 5 6 7 SP &lt; -------&mdash; 1024/174 usec ----------&mdash;&gt; </p>
  400. <p>TX: (STD)0xF0, (OVDR)0xF8 RX: less if present</p>
  401. <dl class="params"><dt>Parameters</dt><dd>
  402. <table class="params">
  403. <tr><td class="paramname">t</td><td>Timing </td></tr>
  404. </table>
  405. </dd>
  406. </dl>
  407. <dl class="section return"><dt>Returns</dt><dd>The status of the operation <ul>
  408. <li>0 Fail </li>
  409. <li>1 Success </li>
  410. </ul>
  411. </dd></dl>
  412. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00181">181</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  413. </div>
  414. </div>
  415. <a id="a7bd53d23f567a31177f29fcbda4da09c"></a>
  416. <h2 class="memtitle"><span class="permalink"><a href="#a7bd53d23f567a31177f29fcbda4da09c">&#9670;&nbsp;</a></span>bit()</h2>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <div class="memtemplate">
  420. template&lt;typename Impl_t &gt; </div>
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">bool <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::bit </td>
  427. <td>(</td>
  428. <td class="paramtype">bool&#160;</td>
  429. <td class="paramname"><em>b</em></td><td>)</td>
  430. <td></td>
  431. </tr>
  432. </table>
  433. </td>
  434. <td class="mlabels-right">
  435. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <p>Send a 1-Wire write bit and read the response. </p>
  440. <p>Write 1 &mdash; -----------------------------------&mdash; </p><h2>Read 0/1 \ / </h2>
  441. <p>RS: | | | | | | | | | | | bit: ST 0 1 2 3 4 5 6 7 SP TX: 0xFF RX: 0xFF-&gt;1, less-&gt;0</p>
  442. <p>Write 0 &mdash; ---&mdash; </p><h2>Read 0 \ / </h2>
  443. <p>RS: | | | | | | | | | | | bit: ST 0 1 2 3 4 5 6 7 SP &lt; ----------&mdash; 87/11 usec ----------&mdash;&gt; TX: 0x00 RX: 0x00</p>
  444. <dl class="params"><dt>Parameters</dt><dd>
  445. <table class="params">
  446. <tr><td class="paramname">b</td><td>The bit to send </td></tr>
  447. </table>
  448. </dd>
  449. </dl>
  450. <dl class="section return"><dt>Returns</dt><dd>The response </dd></dl>
  451. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00136">136</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  452. </div>
  453. </div>
  454. <a id="a1b807cfc2a67eee08efa48ef36b99f74"></a>
  455. <h2 class="memtitle"><span class="permalink"><a href="#a1b807cfc2a67eee08efa48ef36b99f74">&#9670;&nbsp;</a></span>speed() <span class="overload">[1/2]</span></h2>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <div class="memtemplate">
  459. template&lt;typename Impl_t &gt; </div>
  460. <table class="mlabels">
  461. <tr>
  462. <td class="mlabels-left">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname"><a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::speed </td>
  466. <td>(</td>
  467. <td class="paramname"></td><td>)</td>
  468. <td> const</td>
  469. </tr>
  470. </table>
  471. </td>
  472. <td class="mlabels-right">
  473. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
  474. </tr>
  475. </table>
  476. </div><div class="memdoc">
  477. <p>Get the 1-wire bus speed. </p>
  478. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00111">111</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  479. </div>
  480. </div>
  481. <a id="aa56f7a1497c540397bebf008416118b6"></a>
  482. <h2 class="memtitle"><span class="permalink"><a href="#aa56f7a1497c540397bebf008416118b6">&#9670;&nbsp;</a></span>speed() <span class="overload">[2/2]</span></h2>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <div class="memtemplate">
  486. template&lt;typename Impl_t &gt; </div>
  487. <table class="mlabels">
  488. <tr>
  489. <td class="mlabels-left">
  490. <table class="memname">
  491. <tr>
  492. <td class="memname">void <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::speed </td>
  493. <td>(</td>
  494. <td class="paramtype"><a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a>&#160;</td>
  495. <td class="paramname"><em>s</em></td><td>)</td>
  496. <td></td>
  497. </tr>
  498. </table>
  499. </td>
  500. <td class="mlabels-right">
  501. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  502. </tr>
  503. </table>
  504. </div><div class="memdoc">
  505. <p>Set the 1-wire bus speed. </p>
  506. <p>Set the 1-wire bus speed for normal operation only </p><dl class="section note"><dt>Note</dt><dd>We have moved the BR set functionality here to reduce the code inside <a class="el" href="classutl_1_1__1wire__uart__i.html#a7bd53d23f567a31177f29fcbda4da09c" title="Send a 1-Wire write bit and read the response. ">bit()</a>. This is OK as long as the _1wire_i&lt;&gt; always check speed. </dd></dl>
  507. <dl class="params"><dt>Parameters</dt><dd>
  508. <table class="params">
  509. <tr><td class="paramname">s</td><td>The desired speed </td></tr>
  510. </table>
  511. </dd>
  512. </dl>
  513. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00156">156</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  514. </div>
  515. </div>
  516. <a id="a4379f74ee196e6b8422a74143642004f"></a>
  517. <h2 class="memtitle"><span class="permalink"><a href="#a4379f74ee196e6b8422a74143642004f">&#9670;&nbsp;</a></span>UART_BR()</h2>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <div class="memtemplate">
  521. template&lt;typename Impl_t &gt; </div>
  522. <table class="mlabels">
  523. <tr>
  524. <td class="mlabels-left">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname">void <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::UART_BR </td>
  528. <td>(</td>
  529. <td class="paramtype">uint32_t&#160;</td>
  530. <td class="paramname"><em>br</em></td><td>)</td>
  531. <td></td>
  532. </tr>
  533. </table>
  534. </td>
  535. <td class="mlabels-right">
  536. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
  537. </tr>
  538. </table>
  539. </div><div class="memdoc">
  540. <p>Implementers's (driver) baudrate function. </p>
  541. <dl class="params"><dt>Parameters</dt><dd>
  542. <table class="params">
  543. <tr><td class="paramname">The</td><td>desired Baudrate </td></tr>
  544. </table>
  545. </dd>
  546. </dl>
  547. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00096">96</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  548. </div>
  549. </div>
  550. <a id="a02e0069f537ae7e8cccdf8563537952a"></a>
  551. <h2 class="memtitle"><span class="permalink"><a href="#a02e0069f537ae7e8cccdf8563537952a">&#9670;&nbsp;</a></span>UART_RW()</h2>
  552. <div class="memitem">
  553. <div class="memproto">
  554. <div class="memtemplate">
  555. template&lt;typename Impl_t &gt; </div>
  556. <table class="mlabels">
  557. <tr>
  558. <td class="mlabels-left">
  559. <table class="memname">
  560. <tr>
  561. <td class="memname"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::UART_RW </td>
  562. <td>(</td>
  563. <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td>
  564. <td class="paramname"><em>byte</em></td><td>)</td>
  565. <td></td>
  566. </tr>
  567. </table>
  568. </td>
  569. <td class="mlabels-right">
  570. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td>
  571. </tr>
  572. </table>
  573. </div><div class="memdoc">
  574. <p>Implementers's (driver) read-write function. We expect the following USART configuration: </p>
  575. <ul>
  576. <li>Word Length = 8 Bits</li>
  577. <li>Stop Bit = One Stop bit</li>
  578. <li>Parity = No parity <dl class="params"><dt>Parameters</dt><dd>
  579. <table class="params">
  580. <tr><td class="paramname">The</td><td>byte to send </td></tr>
  581. </table>
  582. </dd>
  583. </dl>
  584. <dl class="section return"><dt>Returns</dt><dd>The byte received. </dd></dl>
  585. <dl class="section note"><dt>Note</dt><dd>Due to the nature of the technique, the received byte is the actual bus condition during the communication frame (time slot) </dd></dl>
  586. </li>
  587. </ul>
  588. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00089">89</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  589. </div>
  590. </div>
  591. <h2 class="groupheader">Member Data Documentation</h2>
  592. <a id="a6ab0ec4032cad68333590f159da83871"></a>
  593. <h2 class="memtitle"><span class="permalink"><a href="#a6ab0ec4032cad68333590f159da83871">&#9670;&nbsp;</a></span>_1wire_i&lt; _1wire_uart_i&lt; Impl_t &gt; &gt;</h2>
  594. <div class="memitem">
  595. <div class="memproto">
  596. <div class="memtemplate">
  597. template&lt;typename Impl_t &gt; </div>
  598. <table class="mlabels">
  599. <tr>
  600. <td class="mlabels-left">
  601. <table class="memname">
  602. <tr>
  603. <td class="memname">friend <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::<a class="el" href="classutl_1_1__1wire__i.html">_1wire_i</a>&lt; <a class="el" href="classutl_1_1__1wire__uart__i.html">_1wire_uart_i</a>&lt; Impl_t &gt; &gt;</td>
  604. </tr>
  605. </table>
  606. </td>
  607. <td class="mlabels-right">
  608. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  609. </tr>
  610. </table>
  611. </div><div class="memdoc">
  612. <p>Syntactic sugar to CRTP casting. </p>
  613. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00054">54</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  614. </div>
  615. </div>
  616. <a id="a14e342fac3c10b66d82d154f47b9db26"></a>
  617. <h2 class="memtitle"><span class="permalink"><a href="#a14e342fac3c10b66d82d154f47b9db26">&#9670;&nbsp;</a></span>_speed</h2>
  618. <div class="memitem">
  619. <div class="memproto">
  620. <div class="memtemplate">
  621. template&lt;typename Impl_t &gt; </div>
  622. <table class="mlabels">
  623. <tr>
  624. <td class="mlabels-left">
  625. <table class="memname">
  626. <tr>
  627. <td class="memname"><a class="el" href="classutl_1_1__1wire__i.html#a56bb736aa3620d7795b5914cac5f25cc">Speed</a> <a class="el" href="classutl_1_1__1wire__uart__i.html">utl::_1wire_uart_i</a>&lt; Impl_t &gt;::_speed {Speed::STD}</td>
  628. </tr>
  629. </table>
  630. </td>
  631. <td class="mlabels-right">
  632. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  633. </tr>
  634. </table>
  635. </div><div class="memdoc">
  636. <p class="definition">Definition at line <a class="el" href="__1wire__uart_8h_source.html#l00109">109</a> of file <a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a>.</p>
  637. </div>
  638. </div>
  639. <hr/>The documentation for this class was generated from the following file:<ul>
  640. <li>include/utl/com/<a class="el" href="__1wire__uart_8h_source.html">_1wire_uart.h</a></li>
  641. </ul>
  642. </div><!-- contents -->
  643. </div><!-- doc-content -->
  644. <!-- start footer part -->
  645. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  646. <ul>
  647. <li class="navelem"><a class="el" href="namespaceutl.html">utl</a></li><li class="navelem"><a class="el" href="classutl_1_1__1wire__uart__i.html">_1wire_uart_i</a></li>
  648. <li class="footer">Generated by
  649. <a href="http://www.doxygen.org/index.html">
  650. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
  651. </ul>
  652. </div>
  653. </body>
  654. </html>