class_a_d_s1118.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601
  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>ADS1118: ADS1118 Class 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="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">ADS1118
  25. &#160;<span id="projectnumber">1.0.0</span>
  26. </div>
  27. <div id="projectbrief">Arduino library for Texas Instruments ADS1118 chip</div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.14 -->
  35. <script type="text/javascript">
  36. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. /* @license-end */
  39. </script>
  40. <script type="text/javascript" src="menudata.js"></script>
  41. <script type="text/javascript" src="menu.js"></script>
  42. <script type="text/javascript">
  43. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  44. $(function() {
  45. initMenu('',true,false,'search.php','Search');
  46. $(document).ready(function() { init_search(); });
  47. });
  48. /* @license-end */</script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pub-attribs">Public Attributes</a> &#124;
  67. <a href="class_a_d_s1118-members.html">List of all members</a> </div>
  68. <div class="headertitle">
  69. <div class="title">ADS1118 Class Reference</div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <p><code>#include &lt;<a class="el" href="_a_d_s1118_8h_source.html">ADS1118.h</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <tr class="memitem:afaddf1d46e3b32d433c67122d96a6ebb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#afaddf1d46e3b32d433c67122d96a6ebb">ADS1118</a> (uint8_t io_pin_cs)</td></tr>
  77. <tr class="memdesc:afaddf1d46e3b32d433c67122d96a6ebb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#afaddf1d46e3b32d433c67122d96a6ebb">More...</a><br /></td></tr>
  78. <tr class="separator:afaddf1d46e3b32d433c67122d96a6ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a817f1a7619d97e19475458dc3eea5f88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a817f1a7619d97e19475458dc3eea5f88">begin</a> ()</td></tr>
  80. <tr class="memdesc:a817f1a7619d97e19475458dc3eea5f88"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method initialize the SPI port and the config register. <a href="#a817f1a7619d97e19475458dc3eea5f88">More...</a><br /></td></tr>
  81. <tr class="separator:a817f1a7619d97e19475458dc3eea5f88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:acf67a3c09b9d165f04e2e37e618e4fcb"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#acf67a3c09b9d165f04e2e37e618e4fcb">getTemperature</a> ()</td></tr>
  83. <tr class="memdesc:acf67a3c09b9d165f04e2e37e618e4fcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getting the temperature in degrees celsius from the internal sensor of the <a class="el" href="class_a_d_s1118.html">ADS1118</a>. <a href="#acf67a3c09b9d165f04e2e37e618e4fcb">More...</a><br /></td></tr>
  84. <tr class="separator:acf67a3c09b9d165f04e2e37e618e4fcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:adf872650d20977b5872f88fa36182d3a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#adf872650d20977b5872f88fa36182d3a">getADCValue</a> (uint8_t inputs)</td></tr>
  86. <tr class="memdesc:adf872650d20977b5872f88fa36182d3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getting a sample from the specified input. <a href="#adf872650d20977b5872f88fa36182d3a">More...</a><br /></td></tr>
  87. <tr class="separator:adf872650d20977b5872f88fa36182d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a11e4c070217773d71da1d22506e64c00"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a11e4c070217773d71da1d22506e64c00">getMilliVolts</a> (uint8_t inputs)</td></tr>
  89. <tr class="memdesc:a11e4c070217773d71da1d22506e64c00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getting the millivolts from the specified inputs. <a href="#a11e4c070217773d71da1d22506e64c00">More...</a><br /></td></tr>
  90. <tr class="separator:a11e4c070217773d71da1d22506e64c00"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a5d88241e78575ca86f6206f02cec0614"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a5d88241e78575ca86f6206f02cec0614">getMilliVolts</a> ()</td></tr>
  92. <tr class="memdesc:a5d88241e78575ca86f6206f02cec0614"><td class="mdescLeft">&#160;</td><td class="mdescRight">Getting the millivolts from the settled inputs. <a href="#a5d88241e78575ca86f6206f02cec0614">More...</a><br /></td></tr>
  93. <tr class="separator:a5d88241e78575ca86f6206f02cec0614"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a8d79b157a07574bd8745137a8347649e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a8d79b157a07574bd8745137a8347649e">decodeConfigRegister</a> (union <a class="el" href="union_config.html">Config</a> <a class="el" href="class_a_d_s1118.html#ab41e0ba159527f2fc8d48cbedc653380">configRegister</a>)</td></tr>
  95. <tr class="memdesc:a8d79b157a07574bd8745137a8347649e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decoding a configRegister structure and then print it out to the Serial port. <a href="#a8d79b157a07574bd8745137a8347649e">More...</a><br /></td></tr>
  96. <tr class="separator:a8d79b157a07574bd8745137a8347649e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:abcabaf741cc3e45e53a6967e0d113073"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#abcabaf741cc3e45e53a6967e0d113073">setSampligRate</a> (uint8_t samplingRate)</td></tr>
  98. <tr class="memdesc:abcabaf741cc3e45e53a6967e0d113073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setting the sampling rate specified in the config register. <a href="#abcabaf741cc3e45e53a6967e0d113073">More...</a><br /></td></tr>
  99. <tr class="separator:abcabaf741cc3e45e53a6967e0d113073"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a15fcd99b88c988fef9b4cc04347b08a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a15fcd99b88c988fef9b4cc04347b08a5">setFullScaleRange</a> (uint8_t fsr)</td></tr>
  101. <tr class="memdesc:a15fcd99b88c988fef9b4cc04347b08a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setting the full scale range in the config register. <a href="#a15fcd99b88c988fef9b4cc04347b08a5">More...</a><br /></td></tr>
  102. <tr class="separator:a15fcd99b88c988fef9b4cc04347b08a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:af739fb00547d7a5df8c5010c40b64c6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#af739fb00547d7a5df8c5010c40b64c6a">setContinuousMode</a> ()</td></tr>
  104. <tr class="memdesc:af739fb00547d7a5df8c5010c40b64c6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setting to continuous adquisition mode. <a href="#af739fb00547d7a5df8c5010c40b64c6a">More...</a><br /></td></tr>
  105. <tr class="separator:af739fb00547d7a5df8c5010c40b64c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a9e2e456dee0ee957fe89319d12bd833c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a9e2e456dee0ee957fe89319d12bd833c">setSingleShotMode</a> ()</td></tr>
  107. <tr class="memdesc:a9e2e456dee0ee957fe89319d12bd833c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setting to single shot adquisition and power down mode. <a href="#a9e2e456dee0ee957fe89319d12bd833c">More...</a><br /></td></tr>
  108. <tr class="separator:a9e2e456dee0ee957fe89319d12bd833c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a649c53bdf46a93b5ab682d04b9f9df5e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a649c53bdf46a93b5ab682d04b9f9df5e">disablePullup</a> ()</td></tr>
  110. <tr class="memdesc:a649c53bdf46a93b5ab682d04b9f9df5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disabling the internal pull-up resistor of the DOUT pin. <a href="#a649c53bdf46a93b5ab682d04b9f9df5e">More...</a><br /></td></tr>
  111. <tr class="separator:a649c53bdf46a93b5ab682d04b9f9df5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a833326b882b86608d62450fcedabbe4a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a833326b882b86608d62450fcedabbe4a">enablePullup</a> ()</td></tr>
  113. <tr class="memdesc:a833326b882b86608d62450fcedabbe4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enabling the internal pull-up resistor of the DOUT pin. <a href="#a833326b882b86608d62450fcedabbe4a">More...</a><br /></td></tr>
  114. <tr class="separator:a833326b882b86608d62450fcedabbe4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a074c71a9eeb1d0db946f5f4b1308c69f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a074c71a9eeb1d0db946f5f4b1308c69f">setInputSelected</a> (uint8_t input)</td></tr>
  116. <tr class="memdesc:a074c71a9eeb1d0db946f5f4b1308c69f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setting the inputs to be adquired in the config register. <a href="#a074c71a9eeb1d0db946f5f4b1308c69f">More...</a><br /></td></tr>
  117. <tr class="separator:a074c71a9eeb1d0db946f5f4b1308c69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  120. Public Attributes</h2></td></tr>
  121. <tr class="memitem:ad655c0ffe0e3fb2c8c2644176c67f1aa"><td class="memItemLeft" align="right" valign="top"><a id="ad655c0ffe0e3fb2c8c2644176c67f1aa"></a>
  122. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#ad655c0ffe0e3fb2c8c2644176c67f1aa">DIFF_0_1</a> = 0b000</td></tr>
  123. <tr class="memdesc:ad655c0ffe0e3fb2c8c2644176c67f1aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Differential input: Vin=A0-A1. <br /></td></tr>
  124. <tr class="separator:ad655c0ffe0e3fb2c8c2644176c67f1aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a1caeae913293ef4806516976a2dc7f4b"><td class="memItemLeft" align="right" valign="top"><a id="a1caeae913293ef4806516976a2dc7f4b"></a>
  126. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a1caeae913293ef4806516976a2dc7f4b">DIFF_0_3</a> = 0b001</td></tr>
  127. <tr class="memdesc:a1caeae913293ef4806516976a2dc7f4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Differential input: Vin=A0-A3. <br /></td></tr>
  128. <tr class="separator:a1caeae913293ef4806516976a2dc7f4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a683b66748ece91703c8ccc1920a6f762"><td class="memItemLeft" align="right" valign="top"><a id="a683b66748ece91703c8ccc1920a6f762"></a>
  130. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a683b66748ece91703c8ccc1920a6f762">DIFF_1_3</a> = 0b010</td></tr>
  131. <tr class="memdesc:a683b66748ece91703c8ccc1920a6f762"><td class="mdescLeft">&#160;</td><td class="mdescRight">Differential input: Vin=A1-A3. <br /></td></tr>
  132. <tr class="separator:a683b66748ece91703c8ccc1920a6f762"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a8e9e4f86cb2487a24b539c2f7424324d"><td class="memItemLeft" align="right" valign="top"><a id="a8e9e4f86cb2487a24b539c2f7424324d"></a>
  134. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a8e9e4f86cb2487a24b539c2f7424324d">DIFF_2_3</a> = 0b011</td></tr>
  135. <tr class="memdesc:a8e9e4f86cb2487a24b539c2f7424324d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Differential input: Vin=A2-A3. <br /></td></tr>
  136. <tr class="separator:a8e9e4f86cb2487a24b539c2f7424324d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:aca6400b67c3254276ac2bee98153ce1b"><td class="memItemLeft" align="right" valign="top"><a id="aca6400b67c3254276ac2bee98153ce1b"></a>
  138. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#aca6400b67c3254276ac2bee98153ce1b">AIN_0</a> = 0b100</td></tr>
  139. <tr class="memdesc:aca6400b67c3254276ac2bee98153ce1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single ended input: Vin=A0. <br /></td></tr>
  140. <tr class="separator:aca6400b67c3254276ac2bee98153ce1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a252939e56baf2c563a81778d36471b57"><td class="memItemLeft" align="right" valign="top"><a id="a252939e56baf2c563a81778d36471b57"></a>
  142. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a252939e56baf2c563a81778d36471b57">AIN_1</a> = 0b101</td></tr>
  143. <tr class="memdesc:a252939e56baf2c563a81778d36471b57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single ended input: Vin=A1. <br /></td></tr>
  144. <tr class="separator:a252939e56baf2c563a81778d36471b57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ae54c53aaa6546ca3d6ff0a5f94bca2da"><td class="memItemLeft" align="right" valign="top"><a id="ae54c53aaa6546ca3d6ff0a5f94bca2da"></a>
  146. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#ae54c53aaa6546ca3d6ff0a5f94bca2da">AIN_2</a> = 0b110</td></tr>
  147. <tr class="memdesc:ae54c53aaa6546ca3d6ff0a5f94bca2da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single ended input: Vin=A2. <br /></td></tr>
  148. <tr class="separator:ae54c53aaa6546ca3d6ff0a5f94bca2da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a960aed37cacaba71cdc4d4761bce7fd4"><td class="memItemLeft" align="right" valign="top"><a id="a960aed37cacaba71cdc4d4761bce7fd4"></a>
  150. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a960aed37cacaba71cdc4d4761bce7fd4">AIN_3</a> = 0b111</td></tr>
  151. <tr class="memdesc:a960aed37cacaba71cdc4d4761bce7fd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single ended input: Vin=A3. <br /></td></tr>
  152. <tr class="separator:a960aed37cacaba71cdc4d4761bce7fd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:ab41e0ba159527f2fc8d48cbedc653380"><td class="memItemLeft" align="right" valign="top"><a id="ab41e0ba159527f2fc8d48cbedc653380"></a>
  154. union <a class="el" href="union_config.html">Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#ab41e0ba159527f2fc8d48cbedc653380">configRegister</a></td></tr>
  155. <tr class="memdesc:ab41e0ba159527f2fc8d48cbedc653380"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="union_config.html" title="Union configuration register. ">Config</a> register. <br /></td></tr>
  156. <tr class="separator:ab41e0ba159527f2fc8d48cbedc653380"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a2e1f9b252a8468439c3c4a8b46ec5b9e"><td class="memItemLeft" align="right" valign="top"><a id="a2e1f9b252a8468439c3c4a8b46ec5b9e"></a>
  158. const uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a2e1f9b252a8468439c3c4a8b46ec5b9e">SCLK</a> = 2000000</td></tr>
  159. <tr class="memdesc:a2e1f9b252a8468439c3c4a8b46ec5b9e"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_a_d_s1118.html">ADS1118</a> SCLK frequency: 4000000 Hz Maximum for <a class="el" href="class_a_d_s1118.html">ADS1118</a>. <br /></td></tr>
  160. <tr class="separator:a2e1f9b252a8468439c3c4a8b46ec5b9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:af146984531345834e8caaf0ffe017735"><td class="memItemLeft" align="right" valign="top"><a id="af146984531345834e8caaf0ffe017735"></a>
  162. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#af146984531345834e8caaf0ffe017735">START_NOW</a> = 1</td></tr>
  163. <tr class="memdesc:af146984531345834e8caaf0ffe017735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start of conversion in single-shot mode. <br /></td></tr>
  164. <tr class="separator:af146984531345834e8caaf0ffe017735"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:ace81e16e9c09d65487c451dbc0c86cc5"><td class="memItemLeft" align="right" valign="top"><a id="ace81e16e9c09d65487c451dbc0c86cc5"></a>
  166. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#ace81e16e9c09d65487c451dbc0c86cc5">ADC_MODE</a> = 0</td></tr>
  167. <tr class="memdesc:ace81e16e9c09d65487c451dbc0c86cc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">External (inputs) voltage reading mode. <br /></td></tr>
  168. <tr class="separator:ace81e16e9c09d65487c451dbc0c86cc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:aae519c1c967c59c8d40e06f7517fca0c"><td class="memItemLeft" align="right" valign="top"><a id="aae519c1c967c59c8d40e06f7517fca0c"></a>
  170. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#aae519c1c967c59c8d40e06f7517fca0c">TEMP_MODE</a> = 1</td></tr>
  171. <tr class="memdesc:aae519c1c967c59c8d40e06f7517fca0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal temperature sensor reading mode. <br /></td></tr>
  172. <tr class="separator:aae519c1c967c59c8d40e06f7517fca0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:ac79cd7f4808c3b4ff2721e2e8b6140ba"><td class="memItemLeft" align="right" valign="top"><a id="ac79cd7f4808c3b4ff2721e2e8b6140ba"></a>
  174. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#ac79cd7f4808c3b4ff2721e2e8b6140ba">CONTINUOUS</a> = 0</td></tr>
  175. <tr class="memdesc:ac79cd7f4808c3b4ff2721e2e8b6140ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Continuous conversion mode. <br /></td></tr>
  176. <tr class="separator:ac79cd7f4808c3b4ff2721e2e8b6140ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a71a3c608158cd617c24b51986f2fccc0"><td class="memItemLeft" align="right" valign="top"><a id="a71a3c608158cd617c24b51986f2fccc0"></a>
  178. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a71a3c608158cd617c24b51986f2fccc0">SINGLE_SHOT</a> = 1</td></tr>
  179. <tr class="memdesc:a71a3c608158cd617c24b51986f2fccc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single-shot conversion and power down mode. <br /></td></tr>
  180. <tr class="separator:a71a3c608158cd617c24b51986f2fccc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:ab5035f17d58adff567e8002d3e5c40fa"><td class="memItemLeft" align="right" valign="top"><a id="ab5035f17d58adff567e8002d3e5c40fa"></a>
  182. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#ab5035f17d58adff567e8002d3e5c40fa">PULLUP</a> = 1</td></tr>
  183. <tr class="memdesc:ab5035f17d58adff567e8002d3e5c40fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal pull-up resistor enabled for DOUT ***DEFAULT. <br /></td></tr>
  184. <tr class="separator:ab5035f17d58adff567e8002d3e5c40fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:a9c4404b5040ec1b5f43094961e2f62d5"><td class="memItemLeft" align="right" valign="top"><a id="a9c4404b5040ec1b5f43094961e2f62d5"></a>
  186. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a9c4404b5040ec1b5f43094961e2f62d5">NO_PULLUP</a> = 0</td></tr>
  187. <tr class="memdesc:a9c4404b5040ec1b5f43094961e2f62d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal pull-up resistor disabled. <br /></td></tr>
  188. <tr class="separator:a9c4404b5040ec1b5f43094961e2f62d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:afc7ff1f66a8cda9826daeaf3fe5ba6ab"><td class="memItemLeft" align="right" valign="top"><a id="afc7ff1f66a8cda9826daeaf3fe5ba6ab"></a>
  190. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#afc7ff1f66a8cda9826daeaf3fe5ba6ab">VALID_CFG</a> = 0b01</td></tr>
  191. <tr class="memdesc:afc7ff1f66a8cda9826daeaf3fe5ba6ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data will be written to <a class="el" href="union_config.html" title="Union configuration register. ">Config</a> register. <br /></td></tr>
  192. <tr class="separator:afc7ff1f66a8cda9826daeaf3fe5ba6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:aca0198f642c007b7ae32728ecc7b4b1f"><td class="memItemLeft" align="right" valign="top"><a id="aca0198f642c007b7ae32728ecc7b4b1f"></a>
  194. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#aca0198f642c007b7ae32728ecc7b4b1f">NO_VALID_CFG</a> = 0b00</td></tr>
  195. <tr class="memdesc:aca0198f642c007b7ae32728ecc7b4b1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data won't be written to <a class="el" href="union_config.html" title="Union configuration register. ">Config</a> register. <br /></td></tr>
  196. <tr class="separator:aca0198f642c007b7ae32728ecc7b4b1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:addf0469ded07f0cf2c7566745a9bf197"><td class="memItemLeft" align="right" valign="top"><a id="addf0469ded07f0cf2c7566745a9bf197"></a>
  198. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#addf0469ded07f0cf2c7566745a9bf197">RESERVED</a> = 1</td></tr>
  199. <tr class="memdesc:addf0469ded07f0cf2c7566745a9bf197"><td class="mdescLeft">&#160;</td><td class="mdescRight">Its value is always 1, reserved. <br /></td></tr>
  200. <tr class="separator:addf0469ded07f0cf2c7566745a9bf197"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:afc58ecaefacef5592c90c4c843d81dde"><td class="memItemLeft" align="right" valign="top"><a id="afc58ecaefacef5592c90c4c843d81dde"></a>
  202. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#afc58ecaefacef5592c90c4c843d81dde">FSR_6144</a> = 0b000</td></tr>
  203. <tr class="memdesc:afc58ecaefacef5592c90c4c843d81dde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Range: ±6.144 v. LSB SIZE = 187.5μV. <br /></td></tr>
  204. <tr class="separator:afc58ecaefacef5592c90c4c843d81dde"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a9ef5d9e47353e4e30ceab533e2edf3ad"><td class="memItemLeft" align="right" valign="top"><a id="a9ef5d9e47353e4e30ceab533e2edf3ad"></a>
  206. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a9ef5d9e47353e4e30ceab533e2edf3ad">FSR_4096</a> = 0b001</td></tr>
  207. <tr class="memdesc:a9ef5d9e47353e4e30ceab533e2edf3ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Range: ±4.096 v. LSB SIZE = 125μV. <br /></td></tr>
  208. <tr class="separator:a9ef5d9e47353e4e30ceab533e2edf3ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="memitem:a2acfebaaa24ac5a6925be110a5a3edfa"><td class="memItemLeft" align="right" valign="top"><a id="a2acfebaaa24ac5a6925be110a5a3edfa"></a>
  210. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a2acfebaaa24ac5a6925be110a5a3edfa">FSR_2048</a> = 0b010</td></tr>
  211. <tr class="memdesc:a2acfebaaa24ac5a6925be110a5a3edfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Range: ±2.048 v. LSB SIZE = 62.5μV ***DEFAULT. <br /></td></tr>
  212. <tr class="separator:a2acfebaaa24ac5a6925be110a5a3edfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <tr class="memitem:a64ab7dc3b0b643889a45b4a8a15ed73b"><td class="memItemLeft" align="right" valign="top"><a id="a64ab7dc3b0b643889a45b4a8a15ed73b"></a>
  214. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a64ab7dc3b0b643889a45b4a8a15ed73b">FSR_1024</a> = 0b011</td></tr>
  215. <tr class="memdesc:a64ab7dc3b0b643889a45b4a8a15ed73b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Range: ±1.024 v. LSB SIZE = 31.25μV. <br /></td></tr>
  216. <tr class="separator:a64ab7dc3b0b643889a45b4a8a15ed73b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. <tr class="memitem:aa90c0882b487e68fa6cfe27790d6a5fa"><td class="memItemLeft" align="right" valign="top"><a id="aa90c0882b487e68fa6cfe27790d6a5fa"></a>
  218. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#aa90c0882b487e68fa6cfe27790d6a5fa">FSR_0512</a> = 0b100</td></tr>
  219. <tr class="memdesc:aa90c0882b487e68fa6cfe27790d6a5fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Range: ±0.512 v. LSB SIZE = 15.625μV. <br /></td></tr>
  220. <tr class="separator:aa90c0882b487e68fa6cfe27790d6a5fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  221. <tr class="memitem:a5b0abd4476219e551141a10c1266c451"><td class="memItemLeft" align="right" valign="top"><a id="a5b0abd4476219e551141a10c1266c451"></a>
  222. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a5b0abd4476219e551141a10c1266c451">FSR_0256</a> = 0b111</td></tr>
  223. <tr class="memdesc:a5b0abd4476219e551141a10c1266c451"><td class="mdescLeft">&#160;</td><td class="mdescRight">Range: ±0.256 v. LSB SIZE = 7.8125μV. <br /></td></tr>
  224. <tr class="separator:a5b0abd4476219e551141a10c1266c451"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. <tr class="memitem:a693fdcb47c270a6f3244df1eefdca4ca"><td class="memItemLeft" align="right" valign="top"><a id="a693fdcb47c270a6f3244df1eefdca4ca"></a>
  226. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a693fdcb47c270a6f3244df1eefdca4ca">RATE_8SPS</a> = 0b000</td></tr>
  227. <tr class="memdesc:a693fdcb47c270a6f3244df1eefdca4ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">8 samples/s, Tconv=125ms <br /></td></tr>
  228. <tr class="separator:a693fdcb47c270a6f3244df1eefdca4ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <tr class="memitem:a6b92ca329799360f0dfc19bec589280c"><td class="memItemLeft" align="right" valign="top"><a id="a6b92ca329799360f0dfc19bec589280c"></a>
  230. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a6b92ca329799360f0dfc19bec589280c">RATE_16SPS</a> = 0b001</td></tr>
  231. <tr class="memdesc:a6b92ca329799360f0dfc19bec589280c"><td class="mdescLeft">&#160;</td><td class="mdescRight">16 samples/s, Tconv=62.5ms <br /></td></tr>
  232. <tr class="separator:a6b92ca329799360f0dfc19bec589280c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  233. <tr class="memitem:af9f2d072f99bdce404c613135ba07829"><td class="memItemLeft" align="right" valign="top"><a id="af9f2d072f99bdce404c613135ba07829"></a>
  234. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#af9f2d072f99bdce404c613135ba07829">RATE_32SPS</a> = 0b010</td></tr>
  235. <tr class="memdesc:af9f2d072f99bdce404c613135ba07829"><td class="mdescLeft">&#160;</td><td class="mdescRight">32 samples/s, Tconv=31.25ms <br /></td></tr>
  236. <tr class="separator:af9f2d072f99bdce404c613135ba07829"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:a6f1e5499c69409830f3dad1c0c66fc07"><td class="memItemLeft" align="right" valign="top"><a id="a6f1e5499c69409830f3dad1c0c66fc07"></a>
  238. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a6f1e5499c69409830f3dad1c0c66fc07">RATE_64SPS</a> = 0b011</td></tr>
  239. <tr class="memdesc:a6f1e5499c69409830f3dad1c0c66fc07"><td class="mdescLeft">&#160;</td><td class="mdescRight">64 samples/s, Tconv=15.625ms <br /></td></tr>
  240. <tr class="separator:a6f1e5499c69409830f3dad1c0c66fc07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  241. <tr class="memitem:a10ab539a0704cc42d3441f3c94a9a649"><td class="memItemLeft" align="right" valign="top"><a id="a10ab539a0704cc42d3441f3c94a9a649"></a>
  242. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a10ab539a0704cc42d3441f3c94a9a649">RATE_128SPS</a> = 0b100</td></tr>
  243. <tr class="memdesc:a10ab539a0704cc42d3441f3c94a9a649"><td class="mdescLeft">&#160;</td><td class="mdescRight">128 samples/s, Tconv=7.8125ms <br /></td></tr>
  244. <tr class="separator:a10ab539a0704cc42d3441f3c94a9a649"><td class="memSeparator" colspan="2">&#160;</td></tr>
  245. <tr class="memitem:a6deae5bd5b8578a481b376349edcebe1"><td class="memItemLeft" align="right" valign="top"><a id="a6deae5bd5b8578a481b376349edcebe1"></a>
  246. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a6deae5bd5b8578a481b376349edcebe1">RATE_250SPS</a> = 0b101</td></tr>
  247. <tr class="memdesc:a6deae5bd5b8578a481b376349edcebe1"><td class="mdescLeft">&#160;</td><td class="mdescRight">250 samples/s, Tconv=4ms <br /></td></tr>
  248. <tr class="separator:a6deae5bd5b8578a481b376349edcebe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  249. <tr class="memitem:a5682051293d721f5efc05d05f997d150"><td class="memItemLeft" align="right" valign="top"><a id="a5682051293d721f5efc05d05f997d150"></a>
  250. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#a5682051293d721f5efc05d05f997d150">RATE_475SPS</a> = 0b110</td></tr>
  251. <tr class="memdesc:a5682051293d721f5efc05d05f997d150"><td class="mdescLeft">&#160;</td><td class="mdescRight">475 samples/s, Tconv=2.105ms <br /></td></tr>
  252. <tr class="separator:a5682051293d721f5efc05d05f997d150"><td class="memSeparator" colspan="2">&#160;</td></tr>
  253. <tr class="memitem:adaff9f6a747f4b3b6cb10608b8581ab0"><td class="memItemLeft" align="right" valign="top"><a id="adaff9f6a747f4b3b6cb10608b8581ab0"></a>
  254. const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_d_s1118.html#adaff9f6a747f4b3b6cb10608b8581ab0">RATE_860SPS</a> = 0b111</td></tr>
  255. <tr class="memdesc:adaff9f6a747f4b3b6cb10608b8581ab0"><td class="mdescLeft">&#160;</td><td class="mdescRight">860 samples/s, Tconv=1.163ms <br /></td></tr>
  256. <tr class="separator:adaff9f6a747f4b3b6cb10608b8581ab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  257. </table>
  258. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  259. <div class="textblock"><p>Class representing the <a class="el" href="class_a_d_s1118.html">ADS1118</a> sensor chip </p><dl class="section author"><dt>Author</dt><dd>Alvaro Salazar <a href="#" onclick="location.href='mai'+'lto:'+'alv'+'ar'+'o@d'+'en'+'kit'+'ro'+'nik'+'.c'+'om'; return false;">alvar<span style="display: none;">.nosp@m.</span>o@de<span style="display: none;">.nosp@m.</span>nkitr<span style="display: none;">.nosp@m.</span>onik<span style="display: none;">.nosp@m.</span>.com</a> </dd></dl>
  260. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  261. <a id="afaddf1d46e3b32d433c67122d96a6ebb"></a>
  262. <h2 class="memtitle"><span class="permalink"><a href="#afaddf1d46e3b32d433c67122d96a6ebb">&#9670;&nbsp;</a></span>ADS1118()</h2>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">ADS1118::ADS1118 </td>
  268. <td>(</td>
  269. <td class="paramtype">uint8_t&#160;</td>
  270. <td class="paramname"><em>io_pin_cs</em></td><td>)</td>
  271. <td></td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. <p>Constructor. </p>
  276. <p>Constructor of the class </p><dl class="params"><dt>Parameters</dt><dd>
  277. <table class="params">
  278. <tr><td class="paramname">io_pin_cs</td><td>a byte indicating the pin to be use as the chip select pin (CS) </td></tr>
  279. </table>
  280. </dd>
  281. </dl>
  282. </div>
  283. </div>
  284. <h2 class="groupheader">Member Function Documentation</h2>
  285. <a id="a817f1a7619d97e19475458dc3eea5f88"></a>
  286. <h2 class="memtitle"><span class="permalink"><a href="#a817f1a7619d97e19475458dc3eea5f88">&#9670;&nbsp;</a></span>begin()</h2>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname">void ADS1118::begin </td>
  292. <td>(</td>
  293. <td class="paramname"></td><td>)</td>
  294. <td></td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. <p>This method initialize the SPI port and the config register. </p>
  299. <p>This method initialize the SPI port and the config register </p>
  300. </div>
  301. </div>
  302. <a id="a8d79b157a07574bd8745137a8347649e"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#a8d79b157a07574bd8745137a8347649e">&#9670;&nbsp;</a></span>decodeConfigRegister()</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">void ADS1118::decodeConfigRegister </td>
  309. <td>(</td>
  310. <td class="paramtype">union <a class="el" href="union_config.html">Config</a>&#160;</td>
  311. <td class="paramname"><em>configRegister</em></td><td>)</td>
  312. <td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>Decoding a configRegister structure and then print it out to the Serial port. </p>
  317. <p>Decoding a configRegister structure and then print it out to the Serial port </p><dl class="params"><dt>Parameters</dt><dd>
  318. <table class="params">
  319. <tr><td class="paramname">configRegister</td><td>The config register in "union Config" format </td></tr>
  320. </table>
  321. </dd>
  322. </dl>
  323. </div>
  324. </div>
  325. <a id="a649c53bdf46a93b5ab682d04b9f9df5e"></a>
  326. <h2 class="memtitle"><span class="permalink"><a href="#a649c53bdf46a93b5ab682d04b9f9df5e">&#9670;&nbsp;</a></span>disablePullup()</h2>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">void ADS1118::disablePullup </td>
  332. <td>(</td>
  333. <td class="paramname"></td><td>)</td>
  334. <td></td>
  335. </tr>
  336. </table>
  337. </div><div class="memdoc">
  338. <p>Disabling the internal pull-up resistor of the DOUT pin. </p>
  339. <p>Disabling the internal pull-up resistor of the DOUT pin </p>
  340. </div>
  341. </div>
  342. <a id="a833326b882b86608d62450fcedabbe4a"></a>
  343. <h2 class="memtitle"><span class="permalink"><a href="#a833326b882b86608d62450fcedabbe4a">&#9670;&nbsp;</a></span>enablePullup()</h2>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="memname">
  347. <tr>
  348. <td class="memname">void ADS1118::enablePullup </td>
  349. <td>(</td>
  350. <td class="paramname"></td><td>)</td>
  351. <td></td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Enabling the internal pull-up resistor of the DOUT pin. </p>
  356. <p>Enabling the internal pull-up resistor of the DOUT pin </p>
  357. </div>
  358. </div>
  359. <a id="adf872650d20977b5872f88fa36182d3a"></a>
  360. <h2 class="memtitle"><span class="permalink"><a href="#adf872650d20977b5872f88fa36182d3a">&#9670;&nbsp;</a></span>getADCValue()</h2>
  361. <div class="memitem">
  362. <div class="memproto">
  363. <table class="memname">
  364. <tr>
  365. <td class="memname">uint16_t ADS1118::getADCValue </td>
  366. <td>(</td>
  367. <td class="paramtype">uint8_t&#160;</td>
  368. <td class="paramname"><em>inputs</em></td><td>)</td>
  369. <td></td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <p>Getting a sample from the specified input. </p>
  374. <p>Getting a sample from the specified input </p><dl class="params"><dt>Parameters</dt><dd>
  375. <table class="params">
  376. <tr><td class="paramname">inputs</td><td>Sets the input of the ADC: Diferential inputs: DIFF_0_1, DIFF_0_3, DIFF_1_3, DIFF_2_3. Single ended input: AIN_0, AIN_1, AIN_2, AIN_3 </td></tr>
  377. </table>
  378. </dd>
  379. </dl>
  380. <dl class="section return"><dt>Returns</dt><dd>A word containing the ADC value </dd></dl>
  381. </div>
  382. </div>
  383. <a id="a11e4c070217773d71da1d22506e64c00"></a>
  384. <h2 class="memtitle"><span class="permalink"><a href="#a11e4c070217773d71da1d22506e64c00">&#9670;&nbsp;</a></span>getMilliVolts() <span class="overload">[1/2]</span></h2>
  385. <div class="memitem">
  386. <div class="memproto">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">double ADS1118::getMilliVolts </td>
  390. <td>(</td>
  391. <td class="paramtype">uint8_t&#160;</td>
  392. <td class="paramname"><em>inputs</em></td><td>)</td>
  393. <td></td>
  394. </tr>
  395. </table>
  396. </div><div class="memdoc">
  397. <p>Getting the millivolts from the specified inputs. </p>
  398. <p>Getting the millivolts from the specified inputs </p><dl class="params"><dt>Parameters</dt><dd>
  399. <table class="params">
  400. <tr><td class="paramname">inputs</td><td>Sets the inputs to be adquired. Diferential inputs: DIFF_0_1, DIFF_0_3, DIFF_1_3, DIFF_2_3. Single ended input: AIN_0, AIN_1, AIN_2, AIN_3 </td></tr>
  401. </table>
  402. </dd>
  403. </dl>
  404. <dl class="section return"><dt>Returns</dt><dd>A double (32bits) containing the ADC value in millivolts </dd></dl>
  405. </div>
  406. </div>
  407. <a id="a5d88241e78575ca86f6206f02cec0614"></a>
  408. <h2 class="memtitle"><span class="permalink"><a href="#a5d88241e78575ca86f6206f02cec0614">&#9670;&nbsp;</a></span>getMilliVolts() <span class="overload">[2/2]</span></h2>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <table class="memname">
  412. <tr>
  413. <td class="memname">double ADS1118::getMilliVolts </td>
  414. <td>(</td>
  415. <td class="paramname"></td><td>)</td>
  416. <td></td>
  417. </tr>
  418. </table>
  419. </div><div class="memdoc">
  420. <p>Getting the millivolts from the settled inputs. </p>
  421. <p>Getting the millivolts from the settled inputs </p><dl class="section return"><dt>Returns</dt><dd>A double (32bits) containing the ADC value in millivolts </dd></dl>
  422. </div>
  423. </div>
  424. <a id="acf67a3c09b9d165f04e2e37e618e4fcb"></a>
  425. <h2 class="memtitle"><span class="permalink"><a href="#acf67a3c09b9d165f04e2e37e618e4fcb">&#9670;&nbsp;</a></span>getTemperature()</h2>
  426. <div class="memitem">
  427. <div class="memproto">
  428. <table class="memname">
  429. <tr>
  430. <td class="memname">double ADS1118::getTemperature </td>
  431. <td>(</td>
  432. <td class="paramname"></td><td>)</td>
  433. <td></td>
  434. </tr>
  435. </table>
  436. </div><div class="memdoc">
  437. <p>Getting the temperature in degrees celsius from the internal sensor of the <a class="el" href="class_a_d_s1118.html">ADS1118</a>. </p>
  438. <p>Getting the temperature in degrees celsius from the internal sensor of the <a class="el" href="class_a_d_s1118.html">ADS1118</a> </p><dl class="section return"><dt>Returns</dt><dd>A double (32bits) containing the temperature in degrees celsius of the internal sensor </dd></dl>
  439. </div>
  440. </div>
  441. <a id="af739fb00547d7a5df8c5010c40b64c6a"></a>
  442. <h2 class="memtitle"><span class="permalink"><a href="#af739fb00547d7a5df8c5010c40b64c6a">&#9670;&nbsp;</a></span>setContinuousMode()</h2>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <table class="memname">
  446. <tr>
  447. <td class="memname">void ADS1118::setContinuousMode </td>
  448. <td>(</td>
  449. <td class="paramname"></td><td>)</td>
  450. <td></td>
  451. </tr>
  452. </table>
  453. </div><div class="memdoc">
  454. <p>Setting to continuous adquisition mode. </p>
  455. <p>Setting to continuous adquisition mode </p>
  456. </div>
  457. </div>
  458. <a id="a15fcd99b88c988fef9b4cc04347b08a5"></a>
  459. <h2 class="memtitle"><span class="permalink"><a href="#a15fcd99b88c988fef9b4cc04347b08a5">&#9670;&nbsp;</a></span>setFullScaleRange()</h2>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="memname">
  463. <tr>
  464. <td class="memname">void ADS1118::setFullScaleRange </td>
  465. <td>(</td>
  466. <td class="paramtype">uint8_t&#160;</td>
  467. <td class="paramname"><em>fsr</em></td><td>)</td>
  468. <td></td>
  469. </tr>
  470. </table>
  471. </div><div class="memdoc">
  472. <p>Setting the full scale range in the config register. </p>
  473. <p>Setting the full scale range in the config register </p><dl class="params"><dt>Parameters</dt><dd>
  474. <table class="params">
  475. <tr><td class="paramname">fsr</td><td>The full scale range: FSR_6144 (±6.144V)*, FSR_4096(±4.096V)*, FSR_2048(±2.048V), FSR_1024(±1.024V), FSR_0512(±0.512V), FSR_0256(±0.256V). (*) No more than VDD + 0.3 V must be applied to this device. </td></tr>
  476. </table>
  477. </dd>
  478. </dl>
  479. </div>
  480. </div>
  481. <a id="a074c71a9eeb1d0db946f5f4b1308c69f"></a>
  482. <h2 class="memtitle"><span class="permalink"><a href="#a074c71a9eeb1d0db946f5f4b1308c69f">&#9670;&nbsp;</a></span>setInputSelected()</h2>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="memname">
  486. <tr>
  487. <td class="memname">void ADS1118::setInputSelected </td>
  488. <td>(</td>
  489. <td class="paramtype">uint8_t&#160;</td>
  490. <td class="paramname"><em>input</em></td><td>)</td>
  491. <td></td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>Setting the inputs to be adquired in the config register. </p>
  496. <p>Setting the inputs to be adquired in the config register. </p><dl class="params"><dt>Parameters</dt><dd>
  497. <table class="params">
  498. <tr><td class="paramname">input</td><td>The input selected: Diferential inputs: DIFF_0_1, DIFF_0_3, DIFF_1_3, DIFF_2_3. Single ended input: AIN_0, AIN_1, AIN_2, AIN_3 </td></tr>
  499. </table>
  500. </dd>
  501. </dl>
  502. </div>
  503. </div>
  504. <a id="abcabaf741cc3e45e53a6967e0d113073"></a>
  505. <h2 class="memtitle"><span class="permalink"><a href="#abcabaf741cc3e45e53a6967e0d113073">&#9670;&nbsp;</a></span>setSampligRate()</h2>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="memname">
  509. <tr>
  510. <td class="memname">void ADS1118::setSampligRate </td>
  511. <td>(</td>
  512. <td class="paramtype">uint8_t&#160;</td>
  513. <td class="paramname"><em>samplingRate</em></td><td>)</td>
  514. <td></td>
  515. </tr>
  516. </table>
  517. </div><div class="memdoc">
  518. <p>Setting the sampling rate specified in the config register. </p>
  519. <p>Setting the sampling rate specified in the config register </p><dl class="params"><dt>Parameters</dt><dd>
  520. <table class="params">
  521. <tr><td class="paramname">samplingRate</td><td>It's the sampling rate: RATE_8SPS, RATE_16SPS, RATE_32SPS, RATE_64SPS, RATE_128SPS, RATE_250SPS, RATE_475SPS, RATE_860SPS </td></tr>
  522. </table>
  523. </dd>
  524. </dl>
  525. </div>
  526. </div>
  527. <a id="a9e2e456dee0ee957fe89319d12bd833c"></a>
  528. <h2 class="memtitle"><span class="permalink"><a href="#a9e2e456dee0ee957fe89319d12bd833c">&#9670;&nbsp;</a></span>setSingleShotMode()</h2>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="memname">
  532. <tr>
  533. <td class="memname">void ADS1118::setSingleShotMode </td>
  534. <td>(</td>
  535. <td class="paramname"></td><td>)</td>
  536. <td></td>
  537. </tr>
  538. </table>
  539. </div><div class="memdoc">
  540. <p>Setting to single shot adquisition and power down mode. </p>
  541. <p>Setting to single shot adquisition and power down mode </p>
  542. </div>
  543. </div>
  544. <hr/>The documentation for this class was generated from the following files:<ul>
  545. <li><a class="el" href="_a_d_s1118_8h_source.html">ADS1118.h</a></li>
  546. <li>ADS1118.cpp</li>
  547. </ul>
  548. </div><!-- contents -->
  549. <!-- start footer part -->
  550. <hr class="footer"/><address class="footer"><small>
  551. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  552. <img class="footer" src="doxygen.png" alt="doxygen"/>
  553. </a> 1.8.14
  554. </small></address>
  555. </body>
  556. </html>