Files
Adafruit_BusIO/html/class_adafruit___generic_device.html
T
2025-01-08 20:14:15 +00:00

417 lines
20 KiB
HTML

<!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 Class Reference</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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_adafruit___generic_device-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Adafruit_GenericDevice Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class for communicating with a device via generic read/write functions.
<a href="class_adafruit___generic_device.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_adafruit___generic_device_8h_source.html">Adafruit_GenericDevice.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af35fe023168feebc94abecaff3562cf4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#af35fe023168feebc94abecaff3562cf4">Adafruit_GenericDevice</a> (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)</td></tr>
<tr class="memdesc:af35fe023168feebc94abecaff3562cf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a Generic device with the provided read/write functions. <a href="#af35fe023168feebc94abecaff3562cf4">More...</a><br /></td></tr>
<tr class="separator:af35fe023168feebc94abecaff3562cf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6894812dfd41b7080a35e5be635d687f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#a6894812dfd41b7080a35e5be635d687f">begin</a> (void)</td></tr>
<tr class="memdesc:a6894812dfd41b7080a35e5be635d687f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple begin function (doesn't do much at this time) <a href="#a6894812dfd41b7080a35e5be635d687f">More...</a><br /></td></tr>
<tr class="separator:a6894812dfd41b7080a35e5be635d687f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90de855895eb2b2a431569107501cd95"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#a90de855895eb2b2a431569107501cd95">read</a> (uint8_t *buffer, size_t len)</td></tr>
<tr class="memdesc:a90de855895eb2b2a431569107501cd95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data into a buffer. <a href="#a90de855895eb2b2a431569107501cd95">More...</a><br /></td></tr>
<tr class="separator:a90de855895eb2b2a431569107501cd95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4323c319132fead94381d136dd68b0e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#ac4323c319132fead94381d136dd68b0e">write</a> (const uint8_t *buffer, size_t len)</td></tr>
<tr class="memdesc:ac4323c319132fead94381d136dd68b0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a buffer of data. <a href="#ac4323c319132fead94381d136dd68b0e">More...</a><br /></td></tr>
<tr class="separator:ac4323c319132fead94381d136dd68b0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0fbb534b70756451e67bd35c92e0afc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#aa0fbb534b70756451e67bd35c92e0afc">readRegister</a> (uint8_t *addr_buf, uint8_t addrsiz, uint8_t *buf, uint16_t bufsiz)</td></tr>
<tr class="memdesc:aa0fbb534b70756451e67bd35c92e0afc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read from a register location. <a href="#aa0fbb534b70756451e67bd35c92e0afc">More...</a><br /></td></tr>
<tr class="separator:aa0fbb534b70756451e67bd35c92e0afc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab124baf3baea9203db0ddbc65fd733b7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#ab124baf3baea9203db0ddbc65fd733b7">writeRegister</a> (uint8_t *addr_buf, uint8_t addrsiz, const uint8_t *buf, uint16_t bufsiz)</td></tr>
<tr class="memdesc:ab124baf3baea9203db0ddbc65fd733b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write to a register location. <a href="#ab124baf3baea9203db0ddbc65fd733b7">More...</a><br /></td></tr>
<tr class="separator:ab124baf3baea9203db0ddbc65fd733b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8"><td class="memItemLeft" align="right" valign="top"><a id="af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8"></a>
busio_genericdevice_read_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8">_read_func</a></td></tr>
<tr class="memdesc:af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer for reading raw data from the device. <br /></td></tr>
<tr class="separator:af3f8ed0f5cf9c4c83d2ba2cffc9ee2d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a599a58418b671e73262496821f0ad6a0"><td class="memItemLeft" align="right" valign="top"><a id="a599a58418b671e73262496821f0ad6a0"></a>
busio_genericdevice_write_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#a599a58418b671e73262496821f0ad6a0">_write_func</a></td></tr>
<tr class="memdesc:a599a58418b671e73262496821f0ad6a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer for writing raw data to the device. <br /></td></tr>
<tr class="separator:a599a58418b671e73262496821f0ad6a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa284353a4aa9bb1b6e87084d98bb615"><td class="memItemLeft" align="right" valign="top"><a id="aaa284353a4aa9bb1b6e87084d98bb615"></a>
busio_genericdevice_readreg_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#aaa284353a4aa9bb1b6e87084d98bb615">_readreg_func</a></td></tr>
<tr class="memdesc:aaa284353a4aa9bb1b6e87084d98bb615"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer for reading a 'register' from the device. <br /></td></tr>
<tr class="separator:aaa284353a4aa9bb1b6e87084d98bb615"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13630990b49ab7dccca601dfaa90f9be"><td class="memItemLeft" align="right" valign="top"><a id="a13630990b49ab7dccca601dfaa90f9be"></a>
busio_genericdevice_writereg_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#a13630990b49ab7dccca601dfaa90f9be">_writereg_func</a></td></tr>
<tr class="memdesc:a13630990b49ab7dccca601dfaa90f9be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer for writing a 'register' to the device. <br /></td></tr>
<tr class="separator:a13630990b49ab7dccca601dfaa90f9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d42ac44c292001285f293dcf1c1fe84"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#a6d42ac44c292001285f293dcf1c1fe84">_begun</a></td></tr>
<tr class="separator:a6d42ac44c292001285f293dcf1c1fe84"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for communicating with a device via generic read/write functions. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af35fe023168feebc94abecaff3562cf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af35fe023168feebc94abecaff3562cf4">&#9670;&nbsp;</a></span>Adafruit_GenericDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Adafruit_GenericDevice::Adafruit_GenericDevice </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">busio_genericdevice_read_t&#160;</td>
<td class="paramname"><em>read_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">busio_genericdevice_write_t&#160;</td>
<td class="paramname"><em>write_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">busio_genericdevice_readreg_t&#160;</td>
<td class="paramname"><em>readreg_func</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">busio_genericdevice_writereg_t&#160;</td>
<td class="paramname"><em>writereg_func</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a Generic device with the provided read/write functions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>Pointer to object instance </td></tr>
<tr><td class="paramname">read_func</td><td>Function pointer for reading raw data </td></tr>
<tr><td class="paramname">write_func</td><td>Function pointer for writing raw data </td></tr>
<tr><td class="paramname">readreg_func</td><td>Function pointer for reading registers (optional) </td></tr>
<tr><td class="paramname">writereg_func</td><td>Function pointer for writing registers (optional) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6894812dfd41b7080a35e5be635d687f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6894812dfd41b7080a35e5be635d687f">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_GenericDevice::begin </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simple begin function (doesn't do much at this time) </p>
<dl class="section return"><dt>Returns</dt><dd>true always </dd></dl>
</div>
</div>
<a id="a90de855895eb2b2a431569107501cd95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90de855895eb2b2a431569107501cd95">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_GenericDevice::read </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data into a buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>Pointer to buffer to read data into </td></tr>
<tr><td class="paramname">len</td><td>Number of bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if read was successful, otherwise false </dd></dl>
</div>
</div>
<a id="ac4323c319132fead94381d136dd68b0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4323c319132fead94381d136dd68b0e">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_GenericDevice::write </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a buffer of data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>Pointer to buffer of data to write </td></tr>
<tr><td class="paramname">len</td><td>Number of bytes to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if write was successful, otherwise false </dd></dl>
</div>
</div>
<a id="aa0fbb534b70756451e67bd35c92e0afc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0fbb534b70756451e67bd35c92e0afc">&#9670;&nbsp;</a></span>readRegister()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_GenericDevice::readRegister </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>addr_buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>addrsiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>bufsiz</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read from a register location. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr_buf</td><td>Buffer containing register address </td></tr>
<tr><td class="paramname">addrsiz</td><td>Size of register address in bytes </td></tr>
<tr><td class="paramname">buf</td><td>Buffer to store read data </td></tr>
<tr><td class="paramname">bufsiz</td><td>Size of data to read in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if read was successful, otherwise false </dd></dl>
</div>
</div>
<a id="ab124baf3baea9203db0ddbc65fd733b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab124baf3baea9203db0ddbc65fd733b7">&#9670;&nbsp;</a></span>writeRegister()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_GenericDevice::writeRegister </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>addr_buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>addrsiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>bufsiz</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write to a register location. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr_buf</td><td>Buffer containing register address </td></tr>
<tr><td class="paramname">addrsiz</td><td>Size of register address in bytes </td></tr>
<tr><td class="paramname">buf</td><td>Buffer containing data to write </td></tr>
<tr><td class="paramname">bufsiz</td><td>Size of data to write in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if write was successful, otherwise false </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6d42ac44c292001285f293dcf1c1fe84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d42ac44c292001285f293dcf1c1fe84">&#9670;&nbsp;</a></span>_begun</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Adafruit_GenericDevice::_begun</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>whether we have initialized yet (in case the function needs to do something) </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_adafruit___generic_device_8h_source.html">Adafruit_GenericDevice.h</a></li>
<li>Adafruit_GenericDevice.cpp</li>
</ul>
</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>