union_config.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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: Config Union 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-attribs">Public Attributes</a> &#124;
  66. <a href="union_config-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">Config Union Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>Union configuration register.
  72. <a href="union_config.html#details">More...</a></p>
  73. <p><code>#include &lt;<a class="el" href="_a_d_s1118_8h_source.html">ADS1118.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  76. Public Attributes</h2></td></tr>
  77. <tr class="memitem:a6a595b692a95c9ee30ba05ddd39983c2"><td class="memItemLeft" ><a id="a6a595b692a95c9ee30ba05ddd39983c2"></a>
  78. struct {</td></tr>
  79. <tr class="memitem:a7c1b785834e5236c970e504cf25076c6"><td class="memItemLeft" >
  80. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a86063c5813b60e24dc4b53620337fb81">reserved</a>:1</td></tr>
  81. <tr class="memdesc:a7c1b785834e5236c970e504cf25076c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">"Reserved" bit <br /></td></tr>
  82. <tr class="separator:a7c1b785834e5236c970e504cf25076c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a572ae977aeab156430f00a5d38481e74"><td class="memItemLeft" >
  84. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#aca5cedb4ac2d7fa28c9467bcc5dfdd30">noOperation</a>:2</td></tr>
  85. <tr class="memdesc:a572ae977aeab156430f00a5d38481e74"><td class="mdescLeft">&#160;</td><td class="mdescRight">"NOP" bits <br /></td></tr>
  86. <tr class="separator:a572ae977aeab156430f00a5d38481e74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a143fe9de03c811636603b7466e1ed3dc"><td class="memItemLeft" >
  88. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a384bc94c34f34120311b0fddb47fd310">pullUp</a>:1</td></tr>
  89. <tr class="memdesc:a143fe9de03c811636603b7466e1ed3dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">"PULL_UP_EN" bit <br /></td></tr>
  90. <tr class="separator:a143fe9de03c811636603b7466e1ed3dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a4a52a7306fcf667790946cb37a75ec0b"><td class="memItemLeft" >
  92. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a4ded6b547eab12b96dd4aae64ef1e54d">sensorMode</a>:1</td></tr>
  93. <tr class="memdesc:a4a52a7306fcf667790946cb37a75ec0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">"TS_MODE" bit <br /></td></tr>
  94. <tr class="separator:a4a52a7306fcf667790946cb37a75ec0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:af5f1585c7df3267bfb5ddb8054768dab"><td class="memItemLeft" >
  96. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a36aee2d940c4f67a376a93915d97a82a">rate</a>:3</td></tr>
  97. <tr class="memdesc:af5f1585c7df3267bfb5ddb8054768dab"><td class="mdescLeft">&#160;</td><td class="mdescRight">"DR" bits <br /></td></tr>
  98. <tr class="separator:af5f1585c7df3267bfb5ddb8054768dab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a17c8fa14e6640c1788798f29a34549c4"><td class="memItemLeft" >
  100. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#ab095a91d71a53f3eed6961f99c1fcc8b">operatingMode</a>:1</td></tr>
  101. <tr class="memdesc:a17c8fa14e6640c1788798f29a34549c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">"MODE" bit <br /></td></tr>
  102. <tr class="separator:a17c8fa14e6640c1788798f29a34549c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ac72230a8840405d6b7bba6dc9ca9757f"><td class="memItemLeft" >
  104. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a32de00c66e62581dd969c336ac1daae0">pga</a>:3</td></tr>
  105. <tr class="memdesc:ac72230a8840405d6b7bba6dc9ca9757f"><td class="mdescLeft">&#160;</td><td class="mdescRight">"PGA" bits <br /></td></tr>
  106. <tr class="separator:ac72230a8840405d6b7bba6dc9ca9757f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a715c19dfcc40b7e30057125db99ef254"><td class="memItemLeft" >
  108. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a827213c227200ea6d1495fdbd4832cbb">mux</a>:3</td></tr>
  109. <tr class="memdesc:a715c19dfcc40b7e30057125db99ef254"><td class="mdescLeft">&#160;</td><td class="mdescRight">"MUX" bits <br /></td></tr>
  110. <tr class="separator:a715c19dfcc40b7e30057125db99ef254"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a279bb4e99ee67daafc64639b88e4ed87"><td class="memItemLeft" >
  112. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a75dfa0206a4d86658d165163040905d7">singleStart</a>:1</td></tr>
  113. <tr class="memdesc:a279bb4e99ee67daafc64639b88e4ed87"><td class="mdescLeft">&#160;</td><td class="mdescRight">"SS" bit <br /></td></tr>
  114. <tr class="separator:a279bb4e99ee67daafc64639b88e4ed87"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a6a595b692a95c9ee30ba05ddd39983c2"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union_config.html#a6a595b692a95c9ee30ba05ddd39983c2">bits</a></td></tr>
  116. <tr class="memdesc:a6a595b692a95c9ee30ba05ddd39983c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure of the config register of the <a class="el" href="class_a_d_s1118.html">ADS1118</a>. (See datasheet [1]) <br /></td></tr>
  117. <tr class="separator:a6a595b692a95c9ee30ba05ddd39983c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a5f72e077843f5c9e51cdeb6ef2510df9"><td class="memItemLeft" align="right" valign="top"><a id="a5f72e077843f5c9e51cdeb6ef2510df9"></a>
  119. uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union_config.html#a5f72e077843f5c9e51cdeb6ef2510df9">word</a></td></tr>
  120. <tr class="memdesc:a5f72e077843f5c9e51cdeb6ef2510df9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Representation in word (16-bits) format. <br /></td></tr>
  121. <tr class="separator:a5f72e077843f5c9e51cdeb6ef2510df9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a35780eea5f07b69335bdfd7754eb12f1"><td class="memItemLeft" ><a id="a35780eea5f07b69335bdfd7754eb12f1"></a>
  123. struct {</td></tr>
  124. <tr class="memitem:a833d93cd01c8448f91b9ae6ffe23ffd5"><td class="memItemLeft" >
  125. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a39309b66a0f5c8ccd880c13f0fff6b71">lsb</a></td></tr>
  126. <tr class="memdesc:a833d93cd01c8448f91b9ae6ffe23ffd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Byte LSB. <br /></td></tr>
  127. <tr class="separator:a833d93cd01c8448f91b9ae6ffe23ffd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a968387f3d4a78b1b38b8a33f1ef8ae06"><td class="memItemLeft" >
  129. &#160;&#160;&#160;uint8_t&#160;&#160;&#160;<a class="el" href="union_config.html#a8ac34c174b84a90b17260847ddf749d7">msb</a></td></tr>
  130. <tr class="memdesc:a968387f3d4a78b1b38b8a33f1ef8ae06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Byte MSB. <br /></td></tr>
  131. <tr class="separator:a968387f3d4a78b1b38b8a33f1ef8ae06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a35780eea5f07b69335bdfd7754eb12f1"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="union_config.html#a35780eea5f07b69335bdfd7754eb12f1">byte</a></td></tr>
  133. <tr class="memdesc:a35780eea5f07b69335bdfd7754eb12f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Representation in bytes (8-bits) format. <br /></td></tr>
  134. <tr class="separator:a35780eea5f07b69335bdfd7754eb12f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  137. <div class="textblock"><p>Union configuration register. </p>
  138. <p>Union representing the "config register" in 3 ways: bits, word (16 bits) and nibbles (4 bits) (See the datasheet [1] for more information) </p>
  139. </div><hr/>The documentation for this union was generated from the following file:<ul>
  140. <li><a class="el" href="_a_d_s1118_8h_source.html">ADS1118.h</a></li>
  141. </ul>
  142. </div><!-- contents -->
  143. <!-- start footer part -->
  144. <hr class="footer"/><address class="footer"><small>
  145. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  146. <img class="footer" src="doxygen.png" alt="doxygen"/>
  147. </a> 1.8.14
  148. </small></address>
  149. </body>
  150. </html>