hoo2
/
utl
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
48 Commits
3 Branches
5.6 MiB
 
 
 
 
Tree: bebb193278
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'bebb193278'
${ noResults }
utl/doc/latex/namespaceutl_1_1__1wire__i_...

306 lines
22 KiB
Raw Blame History 

  1. \hypertarget{namespaceutl_1_1__1wire__i__det}{}\section{utl\+:\+:\+\_\+1wire\+\_\+i\+\_\+det Namespace Reference}

  2. \label{namespaceutl_1_1__1wire__i__det}\index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  3. \subsection*{Classes}

  4. \begin{DoxyCompactItemize}

  5. \item 

  6. struct \mbox{\hyperlink{structutl_1_1__1wire__i__det_1_1is__1wire__}{is\+\_\+1wire\+\_\+}}

  7. \begin{DoxyCompactList}\small\item\em Primary template to catch any non 1-\/wire interface types. \end{DoxyCompactList}\item 

  8. struct \mbox{\hyperlink{structutl_1_1__1wire__i__det_1_1is__1wire___3_01___tp_00_01meta_1_1void__t_3_01void_01_4_01_4}{is\+\_\+1wire\+\_\+$<$ \+\_\+\+Tp, meta\+::void\+\_\+t$<$ void $>$ $>$}}

  9. \begin{DoxyCompactList}\small\item\em template to catch a proper 1-\/wire interface type \end{DoxyCompactList}\end{DoxyCompactItemize}

  10. \subsection*{Typedefs}

  11. \begin{DoxyCompactItemize}

  12. \item 

  13. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a502fff2c967d26334aa3c2fcf0b037ba}{try\+\_\+reset\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().reset(declval$<$ typename \+\_\+\+Tp\+::\+Speed $>$()))

  14. \item 

  15. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a303cf58468da38ceeaa2477570f82948}{try\+\_\+rx1\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().rx\+\_\+data(declval$<$ typename \+\_\+\+Tp\+::\+Speed $>$()))

  16. \item 

  17. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_ac6a2b551bcf51b426c2e8506ab2473fe}{try\+\_\+tx1\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().tx\+\_\+data(declval$<$ \mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} $>$(), declval$<$ typename \+\_\+\+Tp\+::\+Speed $>$()))

  18. \item 

  19. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a3416ddb06e089a5c191d356dd358ff00}{try\+\_\+match\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().match(declval$<$ \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \& $>$(), declval$<$ typename \+\_\+\+Tp\+::\+Speed $>$()))

  20. \item 

  21. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_aa85f59a97c388dc259589cb517824233}{try\+\_\+match\+\_\+n\+\_\+ovdr\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().match\+\_\+n\+\_\+ovdr(declval$<$ \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \& $>$()))

  22. \item 

  23. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a9d0825a40484e7868bf41fc4825b4f7d}{try\+\_\+skip\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().skip(declval$<$ typename \+\_\+\+Tp\+::\+Speed $>$()))

  24. \item 

  25. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_af6c9df3cb6bf2479e8d30a5d36ab71cb}{try\+\_\+skip\+\_\+n\+\_\+ovdr\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().skip\+\_\+n\+\_\+ovdr())

  26. \item 

  27. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a3dc7b4df37cebf753556ba527306cf9f}{try\+\_\+first\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().first(declval$<$ typename \+\_\+\+Tp\+::\+Speed $>$()))

  28. \item 

  29. {\footnotesize template$<$class \+\_\+\+Tp $>$ }\\using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a67a086b8e4e3ee051ccb0351e6456630}{try\+\_\+next\+\_\+t}} = decltype(declval$<$ \+\_\+\+Tp $>$().next(declval$<$ typename \+\_\+\+Tp\+::\+Speed $>$()))

  30. \end{DoxyCompactItemize}

  31. \subsection*{Functions}

  32. \begin{DoxyCompactItemize}

  33. \item 

  34. {\footnotesize template$<$typename \+\_\+T $>$ }\\\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a85a3a19778edb037f6341f37135a5494}{\+\_\+touch}} (\+\_\+T \&obj, \mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} out, typename \+\_\+\+T\+::\+Speed s)

  35. \begin{DoxyCompactList}\small\item\em Write a byte to 1-\/\+Wire bus and read the response. \end{DoxyCompactList}\item 

  36. {\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a1b07e623a39ce82f1514846169f3a954}{\+\_\+match}} (\+\_\+T \&obj, \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&id, typename \+\_\+\+T\+::\+Speed s)

  37. \item 

  38. {\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a1e14f734d5e232c914be6ea97982aa40}{\+\_\+match\+\_\+n\+\_\+ovdr}} (\+\_\+T \&obj, \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&id)

  39. \item 

  40. {\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a9ea80f4ef2422a7fd71788c42b228053}{\+\_\+skip}} (\+\_\+T \&obj, typename \+\_\+\+T\+::\+Speed s)

  41. \item 

  42. {\footnotesize template$<$typename \+\_\+T $>$ }\\void \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_ace224a4d329166bfd9f3448e492baf2b}{\+\_\+skip\+\_\+n\+\_\+ovdr}} (\+\_\+T \&obj)

  43. \item 

  44. {\footnotesize template$<$typename \+\_\+T $>$ }\\\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a237719ffa105f988cb175d6720712a4a}{\+\_\+first}} (\+\_\+T \&obj, typename \+\_\+\+T\+::\+Speed s, bool alarm)

  45. \begin{DoxyCompactList}\small\item\em \textquotesingle{}first\textquotesingle{} 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. \end{DoxyCompactList}\item 

  46. {\footnotesize template$<$typename \+\_\+T $>$ }\\\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a1f7b692a40769ebe59343613b147e01d}{\+\_\+next}} (\+\_\+T \&obj, typename \+\_\+\+T\+::\+Speed s, bool alarm)

  47. \begin{DoxyCompactList}\small\item\em \textquotesingle{}next\textquotesingle{} operation, to search on the 1-\/\+Wire for the next device. This search is usually performed after a \textquotesingle{}first\textquotesingle{} operation or another \textquotesingle{}next\textquotesingle{} operation. Based on maxim-\/ic application note 187. \end{DoxyCompactList}\end{DoxyCompactItemize}

  48. 

  49. 

  50. \subsection{Typedef Documentation}

  51. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a3dc7b4df37cebf753556ba527306cf9f}\label{namespaceutl_1_1__1wire__i__det_a3dc7b4df37cebf753556ba527306cf9f}} 

  52. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+first\+\_\+t@{try\+\_\+first\+\_\+t}}

  53. \index{try\+\_\+first\+\_\+t@{try\+\_\+first\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  54. \subsubsection{\texorpdfstring{try\+\_\+first\+\_\+t}{try\_first\_t}}

  55. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  56. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a3dc7b4df37cebf753556ba527306cf9f}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+first\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().first (declval$<$typename \+\_\+\+Tp\+::\+Speed$>$()))}

  57. 

  58. 

  59. 

  60. Definition at line 679 of file \+\_\+1wire.\+h.

  61. 

  62. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_aa85f59a97c388dc259589cb517824233}\label{namespaceutl_1_1__1wire__i__det_aa85f59a97c388dc259589cb517824233}} 

  63. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+match\+\_\+n\+\_\+ovdr\+\_\+t@{try\+\_\+match\+\_\+n\+\_\+ovdr\+\_\+t}}

  64. \index{try\+\_\+match\+\_\+n\+\_\+ovdr\+\_\+t@{try\+\_\+match\+\_\+n\+\_\+ovdr\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  65. \subsubsection{\texorpdfstring{try\+\_\+match\+\_\+n\+\_\+ovdr\+\_\+t}{try\_match\_n\_ovdr\_t}}

  66. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  67. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_aa85f59a97c388dc259589cb517824233}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+match\+\_\+n\+\_\+ovdr\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().match\+\_\+n\+\_\+ovdr (declval$<$\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}}\&$>$()))}

  68. 

  69. 

  70. 

  71. Definition at line 676 of file \+\_\+1wire.\+h.

  72. 

  73. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a3416ddb06e089a5c191d356dd358ff00}\label{namespaceutl_1_1__1wire__i__det_a3416ddb06e089a5c191d356dd358ff00}} 

  74. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+match\+\_\+t@{try\+\_\+match\+\_\+t}}

  75. \index{try\+\_\+match\+\_\+t@{try\+\_\+match\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  76. \subsubsection{\texorpdfstring{try\+\_\+match\+\_\+t}{try\_match\_t}}

  77. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  78. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a3416ddb06e089a5c191d356dd358ff00}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+match\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().match (declval$<$\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}}\&$>$(), declval$<$typename \+\_\+\+Tp\+::\+Speed$>$()))}

  79. 

  80. 

  81. 

  82. Definition at line 675 of file \+\_\+1wire.\+h.

  83. 

  84. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a67a086b8e4e3ee051ccb0351e6456630}\label{namespaceutl_1_1__1wire__i__det_a67a086b8e4e3ee051ccb0351e6456630}} 

  85. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+next\+\_\+t@{try\+\_\+next\+\_\+t}}

  86. \index{try\+\_\+next\+\_\+t@{try\+\_\+next\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  87. \subsubsection{\texorpdfstring{try\+\_\+next\+\_\+t}{try\_next\_t}}

  88. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  89. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a67a086b8e4e3ee051ccb0351e6456630}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+next\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().next (declval$<$typename \+\_\+\+Tp\+::\+Speed$>$()))}

  90. 

  91. 

  92. 

  93. Definition at line 680 of file \+\_\+1wire.\+h.

  94. 

  95. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a502fff2c967d26334aa3c2fcf0b037ba}\label{namespaceutl_1_1__1wire__i__det_a502fff2c967d26334aa3c2fcf0b037ba}} 

  96. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+reset\+\_\+t@{try\+\_\+reset\+\_\+t}}

  97. \index{try\+\_\+reset\+\_\+t@{try\+\_\+reset\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  98. \subsubsection{\texorpdfstring{try\+\_\+reset\+\_\+t}{try\_reset\_t}}

  99. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  100. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a502fff2c967d26334aa3c2fcf0b037ba}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+reset\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().reset (declval$<$typename \+\_\+\+Tp\+::\+Speed$>$()))}

  101. 

  102. 

  103. 

  104. Definition at line 671 of file \+\_\+1wire.\+h.

  105. 

  106. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a303cf58468da38ceeaa2477570f82948}\label{namespaceutl_1_1__1wire__i__det_a303cf58468da38ceeaa2477570f82948}} 

  107. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+rx1\+\_\+t@{try\+\_\+rx1\+\_\+t}}

  108. \index{try\+\_\+rx1\+\_\+t@{try\+\_\+rx1\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  109. \subsubsection{\texorpdfstring{try\+\_\+rx1\+\_\+t}{try\_rx1\_t}}

  110. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  111. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a303cf58468da38ceeaa2477570f82948}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+rx1\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().rx\+\_\+data (declval$<$typename \+\_\+\+Tp\+::\+Speed$>$()))}

  112. 

  113. 

  114. 

  115. Definition at line 672 of file \+\_\+1wire.\+h.

  116. 

  117. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_af6c9df3cb6bf2479e8d30a5d36ab71cb}\label{namespaceutl_1_1__1wire__i__det_af6c9df3cb6bf2479e8d30a5d36ab71cb}} 

  118. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+skip\+\_\+n\+\_\+ovdr\+\_\+t@{try\+\_\+skip\+\_\+n\+\_\+ovdr\+\_\+t}}

  119. \index{try\+\_\+skip\+\_\+n\+\_\+ovdr\+\_\+t@{try\+\_\+skip\+\_\+n\+\_\+ovdr\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  120. \subsubsection{\texorpdfstring{try\+\_\+skip\+\_\+n\+\_\+ovdr\+\_\+t}{try\_skip\_n\_ovdr\_t}}

  121. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  122. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_af6c9df3cb6bf2479e8d30a5d36ab71cb}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+skip\+\_\+n\+\_\+ovdr\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().skip\+\_\+n\+\_\+ovdr ())}

  123. 

  124. 

  125. 

  126. Definition at line 678 of file \+\_\+1wire.\+h.

  127. 

  128. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a9d0825a40484e7868bf41fc4825b4f7d}\label{namespaceutl_1_1__1wire__i__det_a9d0825a40484e7868bf41fc4825b4f7d}} 

  129. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+skip\+\_\+t@{try\+\_\+skip\+\_\+t}}

  130. \index{try\+\_\+skip\+\_\+t@{try\+\_\+skip\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  131. \subsubsection{\texorpdfstring{try\+\_\+skip\+\_\+t}{try\_skip\_t}}

  132. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  133. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_a9d0825a40484e7868bf41fc4825b4f7d}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+skip\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().skip (declval$<$typename \+\_\+\+Tp\+::\+Speed$>$()))}

  134. 

  135. 

  136. 

  137. Definition at line 677 of file \+\_\+1wire.\+h.

  138. 

  139. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_ac6a2b551bcf51b426c2e8506ab2473fe}\label{namespaceutl_1_1__1wire__i__det_ac6a2b551bcf51b426c2e8506ab2473fe}} 

  140. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!try\+\_\+tx1\+\_\+t@{try\+\_\+tx1\+\_\+t}}

  141. \index{try\+\_\+tx1\+\_\+t@{try\+\_\+tx1\+\_\+t}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  142. \subsubsection{\texorpdfstring{try\+\_\+tx1\+\_\+t}{try\_tx1\_t}}

  143. {\footnotesize\ttfamily template$<$class \+\_\+\+Tp $>$ \\

  144. using \mbox{\hyperlink{namespaceutl_1_1__1wire__i__det_ac6a2b551bcf51b426c2e8506ab2473fe}{utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::try\+\_\+tx1\+\_\+t}} = typedef decltype (declval$<$\+\_\+\+Tp$>$().tx\+\_\+data (declval$<$\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}}$>$(), declval$<$typename \+\_\+\+Tp\+::\+Speed$>$()))}

  145. 

  146. 

  147. 

  148. Definition at line 673 of file \+\_\+1wire.\+h.

  149. 

  150. 

  151. 

  152. \subsection{Function Documentation}

  153. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a237719ffa105f988cb175d6720712a4a}\label{namespaceutl_1_1__1wire__i__det_a237719ffa105f988cb175d6720712a4a}} 

  154. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!\+\_\+first@{\+\_\+first}}

  155. \index{\+\_\+first@{\+\_\+first}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  156. \subsubsection{\texorpdfstring{\+\_\+first()}{\_first()}}

  157. {\footnotesize\ttfamily template$<$typename \+\_\+T $>$ \\

  158. \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+first (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj,  }\item[{typename \+\_\+\+T\+::\+Speed}]{s,  }\item[{bool}]{alarm }\end{DoxyParamCaption})}

  159. 

  160. 

  161. 

  162. \textquotesingle{}first\textquotesingle{} 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. 

  163. 

  164. 

  165. \begin{DoxyParams}{Parameters}

  166. {\em obj} & The object from which we call private members \\

  167. \hline

  168. {\em s} & The bus speed \\

  169. \hline

  170. \end{DoxyParams}

  171. \begin{DoxyReturn}{Returns}

  172. ID The rom\+ID \begin{DoxyItemize}

  173. \item null\+Dev Indicate no \mbox{[}more\mbox{]} device\mbox{[}s\mbox{]} \end{DoxyItemize}

  174. 

  175. \end{DoxyReturn}

  176. 

  177. 

  178. Definition at line 540 of file \+\_\+1wire.\+h.

  179. 

  180. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a1b07e623a39ce82f1514846169f3a954}\label{namespaceutl_1_1__1wire__i__det_a1b07e623a39ce82f1514846169f3a954}} 

  181. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!\+\_\+match@{\+\_\+match}}

  182. \index{\+\_\+match@{\+\_\+match}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  183. \subsubsection{\texorpdfstring{\+\_\+match()}{\_match()}}

  184. {\footnotesize\ttfamily template$<$typename \+\_\+T $>$ \\

  185. void utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj,  }\item[{\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{id,  }\item[{typename \+\_\+\+T\+::\+Speed}]{s }\end{DoxyParamCaption})}

  186. 

  187. Send match rom command 

  188. \begin{DoxyParams}{Parameters}

  189. {\em obj} & The object from which we call private members \\

  190. \hline

  191. {\em id} & The ID to select on the bus \\

  192. \hline

  193. {\em s} & The speed to use for the command \\

  194. \hline

  195. \end{DoxyParams}

  196. 

  197. 

  198. Definition at line 493 of file \+\_\+1wire.\+h.

  199. 

  200. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a1e14f734d5e232c914be6ea97982aa40}\label{namespaceutl_1_1__1wire__i__det_a1e14f734d5e232c914be6ea97982aa40}} 

  201. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!\+\_\+match\+\_\+n\+\_\+ovdr@{\+\_\+match\+\_\+n\+\_\+ovdr}}

  202. \index{\+\_\+match\+\_\+n\+\_\+ovdr@{\+\_\+match\+\_\+n\+\_\+ovdr}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  203. \subsubsection{\texorpdfstring{\+\_\+match\+\_\+n\+\_\+ovdr()}{\_match\_n\_ovdr()}}

  204. {\footnotesize\ttfamily template$<$typename \+\_\+T $>$ \\

  205. void utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+match\+\_\+n\+\_\+ovdr (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj,  }\item[{\mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} \&}]{id }\end{DoxyParamCaption})}

  206. 

  207. Match and overdrive sequence 

  208. \begin{DoxyParams}{Parameters}

  209. {\em obj} & The object from which we call private members \\

  210. \hline

  211. {\em id} & The ID to select on the bus \\

  212. \hline

  213. \end{DoxyParams}

  214. 

  215. 

  216. Definition at line 505 of file \+\_\+1wire.\+h.

  217. 

  218. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a1f7b692a40769ebe59343613b147e01d}\label{namespaceutl_1_1__1wire__i__det_a1f7b692a40769ebe59343613b147e01d}} 

  219. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!\+\_\+next@{\+\_\+next}}

  220. \index{\+\_\+next@{\+\_\+next}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  221. \subsubsection{\texorpdfstring{\+\_\+next()}{\_next()}}

  222. {\footnotesize\ttfamily template$<$typename \+\_\+T $>$ \\

  223. \mbox{\hyperlink{classutl_1_1__1wire__id__t}{\+\_\+1wire\+\_\+id\+\_\+t}} utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+next (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj,  }\item[{typename \+\_\+\+T\+::\+Speed}]{s,  }\item[{bool}]{alarm }\end{DoxyParamCaption})}

  224. 

  225. 

  226. 

  227. \textquotesingle{}next\textquotesingle{} operation, to search on the 1-\/\+Wire for the next device. This search is usually performed after a \textquotesingle{}first\textquotesingle{} operation or another \textquotesingle{}next\textquotesingle{} operation. Based on maxim-\/ic application note 187. 

  228. 

  229. 

  230. \begin{DoxyParams}{Parameters}

  231. {\em obj} & The object from which we call private members \\

  232. \hline

  233. {\em s} & The bus speed \\

  234. \hline

  235. \end{DoxyParams}

  236. \begin{DoxyReturn}{Returns}

  237. The rom\+ID \begin{DoxyItemize}

  238. \item null\+Dev Indicate no \mbox{[}more\mbox{]} device\mbox{[}s\mbox{]} \end{DoxyItemize}

  239. 

  240. \end{DoxyReturn}

  241. 

  242. 

  243. Definition at line 556 of file \+\_\+1wire.\+h.

  244. 

  245. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a9ea80f4ef2422a7fd71788c42b228053}\label{namespaceutl_1_1__1wire__i__det_a9ea80f4ef2422a7fd71788c42b228053}} 

  246. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!\+\_\+skip@{\+\_\+skip}}

  247. \index{\+\_\+skip@{\+\_\+skip}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  248. \subsubsection{\texorpdfstring{\+\_\+skip()}{\_skip()}}

  249. {\footnotesize\ttfamily template$<$typename \+\_\+T $>$ \\

  250. void utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj,  }\item[{typename \+\_\+\+T\+::\+Speed}]{s }\end{DoxyParamCaption})}

  251. 

  252. Send skip command to the bus 

  253. \begin{DoxyParams}{Parameters}

  254. {\em obj} & The object from which we call private members \\

  255. \hline

  256. {\em id} & The ID to select on the bus \\

  257. \hline

  258. \end{DoxyParams}

  259. 

  260. 

  261. Definition at line 517 of file \+\_\+1wire.\+h.

  262. 

  263. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_ace224a4d329166bfd9f3448e492baf2b}\label{namespaceutl_1_1__1wire__i__det_ace224a4d329166bfd9f3448e492baf2b}} 

  264. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!\+\_\+skip\+\_\+n\+\_\+ovdr@{\+\_\+skip\+\_\+n\+\_\+ovdr}}

  265. \index{\+\_\+skip\+\_\+n\+\_\+ovdr@{\+\_\+skip\+\_\+n\+\_\+ovdr}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  266. \subsubsection{\texorpdfstring{\+\_\+skip\+\_\+n\+\_\+ovdr()}{\_skip\_n\_ovdr()}}

  267. {\footnotesize\ttfamily template$<$typename \+\_\+T $>$ \\

  268. void utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+skip\+\_\+n\+\_\+ovdr (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj }\end{DoxyParamCaption})}

  269. 

  270. Send the Skip and Overdrive sequence 

  271. \begin{DoxyParams}{Parameters}

  272. {\em obj} & The object from which we call private members \\

  273. \hline

  274. \end{DoxyParams}

  275. 

  276. 

  277. Definition at line 526 of file \+\_\+1wire.\+h.

  278. 

  279. \mbox{\Hypertarget{namespaceutl_1_1__1wire__i__det_a85a3a19778edb037f6341f37135a5494}\label{namespaceutl_1_1__1wire__i__det_a85a3a19778edb037f6341f37135a5494}} 

  280. \index{utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}!\+\_\+touch@{\+\_\+touch}}

  281. \index{\+\_\+touch@{\+\_\+touch}!utl\+::\+\_\+1wire\+\_\+i\+\_\+det@{utl\+::\+\_\+1wire\+\_\+i\+\_\+det}}

  282. \subsubsection{\texorpdfstring{\+\_\+touch()}{\_touch()}}

  283. {\footnotesize\ttfamily template$<$typename \+\_\+T $>$ \\

  284. \mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}} utl\+::\+\_\+1wire\+\_\+i\+\_\+det\+::\+\_\+touch (\begin{DoxyParamCaption}\item[{\+\_\+T \&}]{obj,  }\item[{\mbox{\hyperlink{namespaceutl_a1427cb5a2b13313147a902173b91e3c1}{byte\+\_\+t}}}]{out,  }\item[{typename \+\_\+\+T\+::\+Speed}]{s }\end{DoxyParamCaption})}

  285. 

  286. 

  287. 

  288. Write a byte to 1-\/\+Wire bus and read the response. 

  289. 

  290. 

  291. \begin{DoxyParams}{Parameters}

  292. {\em obj} & The object from which we call private members \\

  293. \hline

  294. {\em b} & The byte to write \\

  295. \hline

  296. {\em s} & Bus speed to use \\

  297. \hline

  298. \end{DoxyParams}

  299. \begin{DoxyReturn}{Returns}

  300. The byte received. 

  301. \end{DoxyReturn}

  302. 

  303. 

  304. Definition at line 467 of file \+\_\+1wire.\+h.