Michel2/Adafruit_BusIO
1
0
Fork 0
mirror of https://github.com/adafruit/Adafruit_BusIO.git synced 2026-09-15 19:22:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
052594eb2c19a6310db4ec14c361a02170f4e4ea
Adafruit_BusIO/html/_adafruit___generic_device_8h_source.html
T
Doxygen CI 27f8e7377f Deploy docs to GitHub Pages from commit e75ac29ca6 
Commit: e75ac29ca6
GitHub Actions run: 15949249679
2025-06-28 23:34:26 +00:00

87 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Adafruit Bus IO Library: Adafruit_GenericDevice.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Adafruit Bus IO Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Adafruit_GenericDevice.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef ADAFRUIT_GENERICDEVICE_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define ADAFRUIT_GENERICDEVICE_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;Arduino.h&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">typedef</span> bool (*busio_genericdevice_read_t)(<span class="keywordtype">void</span> *obj, uint8_t *buffer,</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">typedef</span> bool (*busio_genericdevice_write_t)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> uint8_t *buffer,</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">typedef</span> bool (*busio_genericdevice_readreg_t)(<span class="keywordtype">void</span> *obj, uint8_t *addr_buf,</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; uint8_t addrsiz, uint8_t *data,</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; uint16_t datalen);</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">typedef</span> bool (*busio_genericdevice_writereg_t)(<span class="keywordtype">void</span> *obj, uint8_t *addr_buf,</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; uint8_t addrsiz,</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">const</span> uint8_t *data,</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; uint16_t datalen);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="class_adafruit___generic_device.html"> 21</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <a class="code" href="class_adafruit___generic_device.html#af35fe023168feebc94abecaff3562cf4">Adafruit_GenericDevice</a>(</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordtype">void</span> *obj, busio_genericdevice_read_t read_func,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; busio_genericdevice_write_t write_func,</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; busio_genericdevice_readreg_t readreg_func = <span class="keyword">nullptr</span>,</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; busio_genericdevice_writereg_t writereg_func = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___generic_device.html#a6894812dfd41b7080a35e5be635d687f">begin</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_adafruit___generic_device.html#a5f7b67b4a04a98bf17314d266a0d4ef5">end</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___generic_device.html#a90de855895eb2b2a431569107501cd95">read</a>(uint8_t *buffer, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___generic_device.html#ac4323c319132fead94381d136dd68b0e">write</a>(<span class="keyword">const</span> uint8_t *buffer, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___generic_device.html#aa0fbb534b70756451e67bd35c92e0afc">readRegister</a>(uint8_t *addr_buf, uint8_t addrsiz, uint8_t *buf,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; uint16_t bufsiz);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___generic_device.html#ab124baf3baea9203db0ddbc65fd733b7">writeRegister</a>(uint8_t *addr_buf, uint8_t addrsiz, <span class="keyword">const</span> uint8_t *buf,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; uint16_t bufsiz);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_adafruit___generic_device.html#af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8"> 41</a></span>&#160; busio_genericdevice_read_t <a class="code" href="class_adafruit___generic_device.html#af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8">_read_func</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_adafruit___generic_device.html#a599a58418b671e73262496821f0ad6a0"> 43</a></span>&#160; busio_genericdevice_write_t <a class="code" href="class_adafruit___generic_device.html#a599a58418b671e73262496821f0ad6a0">_write_func</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_adafruit___generic_device.html#aaa284353a4aa9bb1b6e87084d98bb615"> 45</a></span>&#160; busio_genericdevice_readreg_t <a class="code" href="class_adafruit___generic_device.html#aaa284353a4aa9bb1b6e87084d98bb615">_readreg_func</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_adafruit___generic_device.html#a13630990b49ab7dccca601dfaa90f9be"> 47</a></span>&#160; busio_genericdevice_writereg_t <a class="code" href="class_adafruit___generic_device.html#a13630990b49ab7dccca601dfaa90f9be">_writereg_func</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="class_adafruit___generic_device.html#a6d42ac44c292001285f293dcf1c1fe84"> 49</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_adafruit___generic_device.html#a6d42ac44c292001285f293dcf1c1fe84">_begun</a>; </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">void</span> *_obj; </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif // ADAFRUIT_GENERICDEVICE_H</span></div><div class="ttc" id="class_adafruit___generic_device_html_a90de855895eb2b2a431569107501cd95"><div class="ttname"><a href="class_adafruit___generic_device.html#a90de855895eb2b2a431569107501cd95">Adafruit_GenericDevice::read</a></div><div class="ttdeci">bool read(uint8_t *buffer, size_t len)</div><div class="ttdoc">Read data into a buffer. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.cpp:59</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_a5f7b67b4a04a98bf17314d266a0d4ef5"><div class="ttname"><a href="class_adafruit___generic_device.html#a5f7b67b4a04a98bf17314d266a0d4ef5">Adafruit_GenericDevice::end</a></div><div class="ttdeci">void end(void)</div><div class="ttdoc">Marks the GenericDevice as no longer in use. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.cpp:43</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8"><div class="ttname"><a href="class_adafruit___generic_device.html#af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8">Adafruit_GenericDevice::_read_func</a></div><div class="ttdeci">busio_genericdevice_read_t _read_func</div><div class="ttdoc">Function pointer for reading raw data from the device. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.h:41</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_ab124baf3baea9203db0ddbc65fd733b7"><div class="ttname"><a href="class_adafruit___generic_device.html#ab124baf3baea9203db0ddbc65fd733b7">Adafruit_GenericDevice::writeRegister</a></div><div class="ttdeci">bool writeRegister(uint8_t *addr_buf, uint8_t addrsiz, const uint8_t *buf, uint16_t bufsiz)</div><div class="ttdoc">Write to a register location. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.cpp:84</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_a6894812dfd41b7080a35e5be635d687f"><div class="ttname"><a href="class_adafruit___generic_device.html#a6894812dfd41b7080a35e5be635d687f">Adafruit_GenericDevice::begin</a></div><div class="ttdeci">bool begin(void)</div><div class="ttdoc">Simple begin function (doesn&amp;#39;t do much at this time) </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.cpp:32</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_a6d42ac44c292001285f293dcf1c1fe84"><div class="ttname"><a href="class_adafruit___generic_device.html#a6d42ac44c292001285f293dcf1c1fe84">Adafruit_GenericDevice::_begun</a></div><div class="ttdeci">bool _begun</div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.h:49</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_aaa284353a4aa9bb1b6e87084d98bb615"><div class="ttname"><a href="class_adafruit___generic_device.html#aaa284353a4aa9bb1b6e87084d98bb615">Adafruit_GenericDevice::_readreg_func</a></div><div class="ttdeci">busio_genericdevice_readreg_t _readreg_func</div><div class="ttdoc">Function pointer for reading a &amp;#39;register&amp;#39; from the device. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.h:45</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_aa0fbb534b70756451e67bd35c92e0afc"><div class="ttname"><a href="class_adafruit___generic_device.html#aa0fbb534b70756451e67bd35c92e0afc">Adafruit_GenericDevice::readRegister</a></div><div class="ttdeci">bool readRegister(uint8_t *addr_buf, uint8_t addrsiz, uint8_t *buf, uint16_t bufsiz)</div><div class="ttdoc">Read from a register location. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.cpp:71</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_a599a58418b671e73262496821f0ad6a0"><div class="ttname"><a href="class_adafruit___generic_device.html#a599a58418b671e73262496821f0ad6a0">Adafruit_GenericDevice::_write_func</a></div><div class="ttdeci">busio_genericdevice_write_t _write_func</div><div class="ttdoc">Function pointer for writing raw data to the device. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.h:43</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_a13630990b49ab7dccca601dfaa90f9be"><div class="ttname"><a href="class_adafruit___generic_device.html#a13630990b49ab7dccca601dfaa90f9be">Adafruit_GenericDevice::_writereg_func</a></div><div class="ttdeci">busio_genericdevice_writereg_t _writereg_func</div><div class="ttdoc">Function pointer for writing a &amp;#39;register&amp;#39; to the device. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.h:47</div></div>
<div class="ttc" id="class_adafruit___generic_device_html"><div class="ttname"><a href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></div><div class="ttdoc">Class for communicating with a device via generic read/write functions. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.h:21</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_ac4323c319132fead94381d136dd68b0e"><div class="ttname"><a href="class_adafruit___generic_device.html#ac4323c319132fead94381d136dd68b0e">Adafruit_GenericDevice::write</a></div><div class="ttdeci">bool write(const uint8_t *buffer, size_t len)</div><div class="ttdoc">Write a buffer of data. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.cpp:49</div></div>
<div class="ttc" id="class_adafruit___generic_device_html_af35fe023168feebc94abecaff3562cf4"><div class="ttname"><a href="class_adafruit___generic_device.html#af35fe023168feebc94abecaff3562cf4">Adafruit_GenericDevice::Adafruit_GenericDevice</a></div><div class="ttdeci">Adafruit_GenericDevice(void *obj, busio_genericdevice_read_t read_func, busio_genericdevice_write_t write_func, busio_genericdevice_readreg_t readreg_func=nullptr, busio_genericdevice_writereg_t writereg_func=nullptr)</div><div class="ttdoc">Create a Generic device with the provided read/write functions. </div><div class="ttdef"><b>Definition:</b> Adafruit_GenericDevice.cpp:16</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink