mirror of
https://github.com/adafruit/Adafruit_BusIO.git
synced 2026-10-26 22:10:28 +00:00
Deploy docs to GitHub Pages from commit 4d276155d7
Commit: 4d276155d7
GitHub Actions run: 6459192134
This commit is contained in:
Doxygen CI committed
1 parent
51c4e0ddef
commit
84c9eaad7c
1 file changed
+5
-5
@@ -62,15 +62,15 @@ $(function() {
|
||||
<div class="title">Adafruit_I2CDevice.h</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef Adafruit_I2CDevice_h</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define Adafruit_I2CDevice_h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <Arduino.h></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <Wire.h></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="class_adafruit___i2_c_device.html"> 8</a></span> <span class="keyword">class </span><a class="code" href="class_adafruit___i2_c_device.html">Adafruit_I2CDevice</a> {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <a class="code" href="class_adafruit___i2_c_device.html#afea8ccedd8c77bff545c97520d8ec31c">Adafruit_I2CDevice</a>(uint8_t addr, TwoWire *theWire = &Wire);</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  uint8_t <a class="code" href="class_adafruit___i2_c_device.html#ae02c4691dbe893c3a5a3de478d776062">address</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#ada579d107621ac5f5e56f91f94a93be3">begin</a>(<span class="keywordtype">bool</span> addr_detect = <span class="keyword">true</span>);</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i2_c_device.html#afe9d8e8a154d29acaaeb1d00ddd8da08">end</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#ac7492b543fe4c0bb0d94a7bf1915cb2a">detected</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#afeeccb3147b2f0340c65d2c0c1ce3ea6">read</a>(uint8_t *buffer, <span class="keywordtype">size_t</span> len, <span class="keywordtype">bool</span> stop = <span class="keyword">true</span>);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#aa64a3c83aa776a3f383bc1df24ca1998">write</a>(<span class="keyword">const</span> uint8_t *buffer, <span class="keywordtype">size_t</span> len, <span class="keywordtype">bool</span> stop = <span class="keyword">true</span>,</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">const</span> uint8_t *prefix_buffer = <span class="keyword">nullptr</span>, <span class="keywordtype">size_t</span> prefix_len = 0);</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#af04af7e2918c873215ce949ce05ebe33">write_then_read</a>(<span class="keyword">const</span> uint8_t *write_buffer, <span class="keywordtype">size_t</span> write_len,</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  uint8_t *read_buffer, <span class="keywordtype">size_t</span> read_len,</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">bool</span> stop = <span class="keyword">false</span>);</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#a784c398626837ef911ce7e69b0807be7">setSpeed</a>(uint32_t desiredclk);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_adafruit___i2_c_device.html#a20c6ac28cbaa9e5f63ef6d4687fd4e60"> 26</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_adafruit___i2_c_device.html#a20c6ac28cbaa9e5f63ef6d4687fd4e60">maxBufferSize</a>() { <span class="keywordflow">return</span> _maxBufferSize; }<Line truncated
|
||||
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef Adafruit_I2CDevice_h</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define Adafruit_I2CDevice_h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <Arduino.h></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <Wire.h></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="class_adafruit___i2_c_device.html"> 8</a></span> <span class="keyword">class </span><a class="code" href="class_adafruit___i2_c_device.html">Adafruit_I2CDevice</a> {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <a class="code" href="class_adafruit___i2_c_device.html#afea8ccedd8c77bff545c97520d8ec31c">Adafruit_I2CDevice</a>(uint8_t addr, TwoWire *theWire = &Wire);</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  uint8_t <a class="code" href="class_adafruit___i2_c_device.html#ae02c4691dbe893c3a5a3de478d776062">address</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#ada579d107621ac5f5e56f91f94a93be3">begin</a>(<span class="keywordtype">bool</span> addr_detect = <span class="keyword">true</span>);</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i2_c_device.html#afe9d8e8a154d29acaaeb1d00ddd8da08">end</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#ac7492b543fe4c0bb0d94a7bf1915cb2a">detected</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#afeeccb3147b2f0340c65d2c0c1ce3ea6">read</a>(uint8_t *buffer, <span class="keywordtype">size_t</span> len, <span class="keywordtype">bool</span> stop = <span class="keyword">true</span>);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#aa64a3c83aa776a3f383bc1df24ca1998">write</a>(<span class="keyword">const</span> uint8_t *buffer, <span class="keywordtype">size_t</span> len, <span class="keywordtype">bool</span> stop = <span class="keyword">true</span>,</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">const</span> uint8_t *prefix_buffer = <span class="keyword">nullptr</span>, <span class="keywordtype">size_t</span> prefix_len = 0);</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#af04af7e2918c873215ce949ce05ebe33">write_then_read</a>(<span class="keyword">const</span> uint8_t *write_buffer, <span class="keywordtype">size_t</span> write_len,</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  uint8_t *read_buffer, <span class="keywordtype">size_t</span> read_len,</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordtype">bool</span> stop = <span class="keyword">false</span>);</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___i2_c_device.html#a784c398626837ef911ce7e69b0807be7">setSpeed</a>(uint32_t desiredclk);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_adafruit___i2_c_device.html#a20c6ac28cbaa9e5f63ef6d4687fd4e60"> 26</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_adafruit___i2_c_device.html#a20c6ac28cbaa9e5f63ef6d4687fd4e60">maxBufferSize</a>() { <span class="keywordflow">return</span> _maxBufferSize; }<Line truncated
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_afe9d8e8a154d29acaaeb1d00ddd8da08"><div class="ttname"><a href="class_adafruit___i2_c_device.html#afe9d8e8a154d29acaaeb1d00ddd8da08">Adafruit_I2CDevice::end</a></div><div class="ttdeci">void end(void)</div><div class="ttdoc">De-initialize device, turn off the Wire interface. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:43</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_aa64a3c83aa776a3f383bc1df24ca1998"><div class="ttname"><a href="class_adafruit___i2_c_device.html#aa64a3c83aa776a3f383bc1df24ca1998">Adafruit_I2CDevice::write</a></div><div class="ttdeci">bool write(const uint8_t *buffer, size_t len, bool stop=true, const uint8_t *prefix_buffer=nullptr, size_t prefix_len=0)</div><div class="ttdoc">Write a buffer or two to the I2C device. Cannot be more than maxBufferSize() bytes. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:95</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_afeeccb3147b2f0340c65d2c0c1ce3ea6"><div class="ttname"><a href="class_adafruit___i2_c_device.html#afeeccb3147b2f0340c65d2c0c1ce3ea6">Adafruit_I2CDevice::read</a></div><div class="ttdeci">bool read(uint8_t *buffer, size_t len, bool stop=true)</div><div class="ttdoc">Read from I2C into a buffer from the I2C device. Cannot be more than maxBufferSize() bytes...</div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:176</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_aa64a3c83aa776a3f383bc1df24ca1998"><div class="ttname"><a href="class_adafruit___i2_c_device.html#aa64a3c83aa776a3f383bc1df24ca1998">Adafruit_I2CDevice::write</a></div><div class="ttdeci">bool write(const uint8_t *buffer, size_t len, bool stop=true, const uint8_t *prefix_buffer=nullptr, size_t prefix_len=0)</div><div class="ttdoc">Write a buffer or two to the I2C device. Cannot be more than maxBufferSize() bytes. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:99</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_afeeccb3147b2f0340c65d2c0c1ce3ea6"><div class="ttname"><a href="class_adafruit___i2_c_device.html#afeeccb3147b2f0340c65d2c0c1ce3ea6">Adafruit_I2CDevice::read</a></div><div class="ttdeci">bool read(uint8_t *buffer, size_t len, bool stop=true)</div><div class="ttdoc">Read from I2C into a buffer from the I2C device. Cannot be more than maxBufferSize() bytes...</div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:180</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html"><div class="ttname"><a href="class_adafruit___i2_c_device.html">Adafruit_I2CDevice</a></div><div class="ttdoc">< The class which defines how we will talk to this device over I2C </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.h:8</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_af04af7e2918c873215ce949ce05ebe33"><div class="ttname"><a href="class_adafruit___i2_c_device.html#af04af7e2918c873215ce949ce05ebe33">Adafruit_I2CDevice::write_then_read</a></div><div class="ttdeci">bool write_then_read(const uint8_t *write_buffer, size_t write_len, uint8_t *read_buffer, size_t read_len, bool stop=false)</div><div class="ttdoc">Write some data, then read some data from I2C into another buffer. Cannot be more than maxBufferSize(...</div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:240</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_af04af7e2918c873215ce949ce05ebe33"><div class="ttname"><a href="class_adafruit___i2_c_device.html#af04af7e2918c873215ce949ce05ebe33">Adafruit_I2CDevice::write_then_read</a></div><div class="ttdeci">bool write_then_read(const uint8_t *write_buffer, size_t write_len, uint8_t *read_buffer, size_t read_len, bool stop=false)</div><div class="ttdoc">Write some data, then read some data from I2C into another buffer. Cannot be more than maxBufferSize(...</div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:244</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_ac7492b543fe4c0bb0d94a7bf1915cb2a"><div class="ttname"><a href="class_adafruit___i2_c_device.html#ac7492b543fe4c0bb0d94a7bf1915cb2a">Adafruit_I2CDevice::detected</a></div><div class="ttdeci">bool detected(void)</div><div class="ttdoc">Scans I2C for the address - note will give a false-positive if there&#39;s no pullups on I2C...</div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:62</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_afea8ccedd8c77bff545c97520d8ec31c"><div class="ttname"><a href="class_adafruit___i2_c_device.html#afea8ccedd8c77bff545c97520d8ec31c">Adafruit_I2CDevice::Adafruit_I2CDevice</a></div><div class="ttdeci">Adafruit_I2CDevice(uint8_t addr, TwoWire *theWire=&Wire)</div><div class="ttdoc">Create an I2C device at a given address. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:10</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_ae02c4691dbe893c3a5a3de478d776062"><div class="ttname"><a href="class_adafruit___i2_c_device.html#ae02c4691dbe893c3a5a3de478d776062">Adafruit_I2CDevice::address</a></div><div class="ttdeci">uint8_t address(void)</div><div class="ttdoc">Returns the 7-bit address of this device. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:254</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_ae02c4691dbe893c3a5a3de478d776062"><div class="ttname"><a href="class_adafruit___i2_c_device.html#ae02c4691dbe893c3a5a3de478d776062">Adafruit_I2CDevice::address</a></div><div class="ttdeci">uint8_t address(void)</div><div class="ttdoc">Returns the 7-bit address of this device. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:258</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_a20c6ac28cbaa9e5f63ef6d4687fd4e60"><div class="ttname"><a href="class_adafruit___i2_c_device.html#a20c6ac28cbaa9e5f63ef6d4687fd4e60">Adafruit_I2CDevice::maxBufferSize</a></div><div class="ttdeci">size_t maxBufferSize()</div><div class="ttdoc">How many bytes we can read in a transaction. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.h:26</div></div>
|
||||
<div class="ttc" id="class_adafruit___i2_c_device_html_ada579d107621ac5f5e56f91f94a93be3"><div class="ttname"><a href="class_adafruit___i2_c_device.html#ada579d107621ac5f5e56f91f94a93be3">Adafruit_I2CDevice::begin</a></div><div class="ttdeci">bool begin(bool addr_detect=true)</div><div class="ttdoc">Initializes and does basic address detection. </div><div class="ttdef"><b>Definition:</b> Adafruit_I2CDevice.cpp:30</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
|
||||
Reference in new issue
Block a user