|
- <!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>uTL: include/utl/com/_1wire.h File 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="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">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(document).ready(initResizable);
- /* @license-end */</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">uTL
- </div>
- <div id="projectbrief">micro Template library</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&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&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>
- </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">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(document).ready(function(){initNavTree('__1wire_8h.html','');});
- /* @license-end */
- </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="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#namespaces">Namespaces</a> |
- <a href="#typedef-members">Typedefs</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">_1wire.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p>An 1-wire interface implementation.
- <a href="#details">More...</a></p>
- <div class="textblock"><code>#include <<a class="el" href="impl_8h_source.html">utl/core/impl.h</a>></code><br />
- <code>#include <<a class="el" href="crtp_8h_source.html">utl/core/crtp.h</a>></code><br />
- <code>#include <<a class="el" href="__1wire__id_8h_source.html">utl/com/_1wire_id.h</a>></code><br />
- <code>#include <<a class="el" href="meta_8h_source.html">utl/meta/meta.h</a>></code><br />
- </div>
- <p><a href="__1wire_8h_source.html">Go to the source code of this file.</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i.html">utl::_1wire_i< impl_t ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Template base class for 1-wire communication interface using CRTP. <a href="classutl_1_1__1wire__i.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1__1wire__i_3_01virtual__tag_01_4.html">utl::_1wire_i< virtual_tag ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A virtual base class implementation. <a href="classutl_1_1__1wire__i_3_01virtual__tag_01_4.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structutl_1_1__1wire__i__det_1_1is__1wire__.html">utl::_1wire_i_det::is_1wire_< _Tp, typename ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Primary template to catch any non 1-wire interface types. <a href="structutl_1_1__1wire__i__det_1_1is__1wire__.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structutl_1_1__1wire__i__det_1_1is__1wire___3_01___tp_00_01meta_1_1void__t_3_01void_01_4_01_4.html">utl::_1wire_i_det::is_1wire_< _Tp, meta::void_t< void > ></a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">template to catch a proper 1-wire interface type <a href="structutl_1_1__1wire__i__det_1_1is__1wire___3_01___tp_00_01meta_1_1void__t_3_01void_01_4_01_4.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
- Namespaces</h2></td></tr>
- <tr class="memitem:namespaceutl"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl.html">utl</a></td></tr>
- <tr class="memdesc:namespaceutl"><td class="mdescLeft"> </td><td class="mdescRight">STL's core language concepts. <br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:namespaceutl_1_1__1wire__i__det"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html">utl::_1wire_i_det</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:a502fff2c967d26334aa3c2fcf0b037ba"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:a502fff2c967d26334aa3c2fcf0b037ba"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a502fff2c967d26334aa3c2fcf0b037ba">utl::_1wire_i_det::try_reset_t</a> = decltype(declval< _Tp >().reset(declval< typename _Tp::Speed >()))</td></tr>
- <tr class="separator:a502fff2c967d26334aa3c2fcf0b037ba"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a303cf58468da38ceeaa2477570f82948"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:a303cf58468da38ceeaa2477570f82948"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a303cf58468da38ceeaa2477570f82948">utl::_1wire_i_det::try_rx1_t</a> = decltype(declval< _Tp >().rx_data(declval< typename _Tp::Speed >()))</td></tr>
- <tr class="separator:a303cf58468da38ceeaa2477570f82948"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac6a2b551bcf51b426c2e8506ab2473fe"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:ac6a2b551bcf51b426c2e8506ab2473fe"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#ac6a2b551bcf51b426c2e8506ab2473fe">utl::_1wire_i_det::try_tx1_t</a> = decltype(declval< _Tp >().tx_data(declval< byte_t >(), declval< typename _Tp::Speed >()))</td></tr>
- <tr class="separator:ac6a2b551bcf51b426c2e8506ab2473fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3416ddb06e089a5c191d356dd358ff00"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:a3416ddb06e089a5c191d356dd358ff00"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a3416ddb06e089a5c191d356dd358ff00">utl::_1wire_i_det::try_match_t</a> = decltype(declval< _Tp >().match(declval< _1wire_id_t & >(), declval< typename _Tp::Speed >()))</td></tr>
- <tr class="separator:a3416ddb06e089a5c191d356dd358ff00"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa85f59a97c388dc259589cb517824233"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:aa85f59a97c388dc259589cb517824233"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#aa85f59a97c388dc259589cb517824233">utl::_1wire_i_det::try_match_n_ovdr_t</a> = decltype(declval< _Tp >().match_n_ovdr(declval< _1wire_id_t & >()))</td></tr>
- <tr class="separator:aa85f59a97c388dc259589cb517824233"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9d0825a40484e7868bf41fc4825b4f7d"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:a9d0825a40484e7868bf41fc4825b4f7d"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a9d0825a40484e7868bf41fc4825b4f7d">utl::_1wire_i_det::try_skip_t</a> = decltype(declval< _Tp >().skip(declval< typename _Tp::Speed >()))</td></tr>
- <tr class="separator:a9d0825a40484e7868bf41fc4825b4f7d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af6c9df3cb6bf2479e8d30a5d36ab71cb"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:af6c9df3cb6bf2479e8d30a5d36ab71cb"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#af6c9df3cb6bf2479e8d30a5d36ab71cb">utl::_1wire_i_det::try_skip_n_ovdr_t</a> = decltype(declval< _Tp >().skip_n_ovdr())</td></tr>
- <tr class="separator:af6c9df3cb6bf2479e8d30a5d36ab71cb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3dc7b4df37cebf753556ba527306cf9f"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:a3dc7b4df37cebf753556ba527306cf9f"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a3dc7b4df37cebf753556ba527306cf9f">utl::_1wire_i_det::try_first_t</a> = decltype(declval< _Tp >().first(declval< typename _Tp::Speed >()))</td></tr>
- <tr class="separator:a3dc7b4df37cebf753556ba527306cf9f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a67a086b8e4e3ee051ccb0351e6456630"><td class="memTemplParams" colspan="2">template<class _Tp > </td></tr>
- <tr class="memitem:a67a086b8e4e3ee051ccb0351e6456630"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a67a086b8e4e3ee051ccb0351e6456630">utl::_1wire_i_det::try_next_t</a> = decltype(declval< _Tp >().next(declval< typename _Tp::Speed >()))</td></tr>
- <tr class="separator:a67a086b8e4e3ee051ccb0351e6456630"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:a85a3a19778edb037f6341f37135a5494"><td class="memTemplParams" colspan="2">template<typename _T > </td></tr>
- <tr class="memitem:a85a3a19778edb037f6341f37135a5494"><td class="memTemplItemLeft" align="right" valign="top">byte_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a85a3a19778edb037f6341f37135a5494">utl::_1wire_i_det::_touch</a> (_T &obj, byte_t out, typename _T::Speed s)</td></tr>
- <tr class="memdesc:a85a3a19778edb037f6341f37135a5494"><td class="mdescLeft"> </td><td class="mdescRight">Write a byte to 1-Wire bus and read the response. <a href="namespaceutl_1_1__1wire__i__det.html#a85a3a19778edb037f6341f37135a5494">More...</a><br /></td></tr>
- <tr class="separator:a85a3a19778edb037f6341f37135a5494"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1b07e623a39ce82f1514846169f3a954"><td class="memTemplParams" colspan="2">template<typename _T > </td></tr>
- <tr class="memitem:a1b07e623a39ce82f1514846169f3a954"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a1b07e623a39ce82f1514846169f3a954">utl::_1wire_i_det::_match</a> (_T &obj, _1wire_id_t &id, typename _T::Speed s)</td></tr>
- <tr class="separator:a1b07e623a39ce82f1514846169f3a954"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1e14f734d5e232c914be6ea97982aa40"><td class="memTemplParams" colspan="2">template<typename _T > </td></tr>
- <tr class="memitem:a1e14f734d5e232c914be6ea97982aa40"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a1e14f734d5e232c914be6ea97982aa40">utl::_1wire_i_det::_match_n_ovdr</a> (_T &obj, _1wire_id_t &id)</td></tr>
- <tr class="separator:a1e14f734d5e232c914be6ea97982aa40"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9ea80f4ef2422a7fd71788c42b228053"><td class="memTemplParams" colspan="2">template<typename _T > </td></tr>
- <tr class="memitem:a9ea80f4ef2422a7fd71788c42b228053"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a9ea80f4ef2422a7fd71788c42b228053">utl::_1wire_i_det::_skip</a> (_T &obj, typename _T::Speed s)</td></tr>
- <tr class="separator:a9ea80f4ef2422a7fd71788c42b228053"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ace224a4d329166bfd9f3448e492baf2b"><td class="memTemplParams" colspan="2">template<typename _T > </td></tr>
- <tr class="memitem:ace224a4d329166bfd9f3448e492baf2b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#ace224a4d329166bfd9f3448e492baf2b">utl::_1wire_i_det::_skip_n_ovdr</a> (_T &obj)</td></tr>
- <tr class="separator:ace224a4d329166bfd9f3448e492baf2b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a237719ffa105f988cb175d6720712a4a"><td class="memTemplParams" colspan="2">template<typename _T > </td></tr>
- <tr class="memitem:a237719ffa105f988cb175d6720712a4a"><td class="memTemplItemLeft" align="right" valign="top">_1wire_id_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a237719ffa105f988cb175d6720712a4a">utl::_1wire_i_det::_first</a> (_T &obj, typename _T::Speed s, bool alarm)</td></tr>
- <tr class="memdesc:a237719ffa105f988cb175d6720712a4a"><td class="mdescLeft"> </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="namespaceutl_1_1__1wire__i__det.html#a237719ffa105f988cb175d6720712a4a">More...</a><br /></td></tr>
- <tr class="separator:a237719ffa105f988cb175d6720712a4a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1f7b692a40769ebe59343613b147e01d"><td class="memTemplParams" colspan="2">template<typename _T > </td></tr>
- <tr class="memitem:a1f7b692a40769ebe59343613b147e01d"><td class="memTemplItemLeft" align="right" valign="top">_1wire_id_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1__1wire__i__det.html#a1f7b692a40769ebe59343613b147e01d">utl::_1wire_i_det::_next</a> (_T &obj, typename _T::Speed s, bool alarm)</td></tr>
- <tr class="memdesc:a1f7b692a40769ebe59343613b147e01d"><td class="mdescLeft"> </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="namespaceutl_1_1__1wire__i__det.html#a1f7b692a40769ebe59343613b147e01d">More...</a><br /></td></tr>
- <tr class="separator:a1f7b692a40769ebe59343613b147e01d"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>An 1-wire interface implementation. </p>
- <p>Copyright (C) 2018 Christos Choutouridis</p>
- <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>
- <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>
- <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>
-
- <p class="definition">Definition in file <a class="el" href="__1wire_8h_source.html">_1wire.h</a>.</p>
- </div></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_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_8h.html">_1wire.h</a></li>
- <li class="footer">Generated by
- <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
- </ul>
- </div>
- </body>
- </html>
|