Michel2/Adafruit_BusIO
1
0
Fork 0
mirror of https://github.com/adafruit/Adafruit_BusIO.git synced 2026-07-27 20:06:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deploy docs to GitHub Pages from commit 055013b58d

Browse Source 
Commit: 055013b58d
GitHub Actions run: 12678275228
This commit is contained in:
Doxygen CI
2025-01-08 20:14:15 +00:00
parent 56804dba57
commit a88435ec72
9 changed files with 34 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
html/_adafruit___bus_i_o___register_8h_source.html
+1 -1
View File
@@ -72,7 +72,7 @@ $(function() {
<div class="ttc" id="class_adafruit___bus_i_o___register_html_a421a7c74ab0faafe243060af1883717a"><div class="ttname"><a href="class_adafruit___bus_i_o___register.html#a421a7c74ab0faafe243060af1883717a">Adafruit_BusIO_Register::setAddressWidth</a></div><div class="ttdeci">void setAddressWidth(uint16_t address_width)</div><div class="ttdoc">Set the width of register address. </div><div class="ttdef"><b>Definition:</b> Adafruit_BusIO_Register.cpp:380</div></div>
<div class="ttc" id="class_adafruit___bus_i_o___register_html_a7de4a4cbb3e8cdfebac31344e8ab6c8c"><div class="ttname"><a href="class_adafruit___bus_i_o___register.html#a7de4a4cbb3e8cdfebac31344e8ab6c8c">Adafruit_BusIO_Register::Adafruit_BusIO_Register</a></div><div class="ttdeci">Adafruit_BusIO_Register(Adafruit_I2CDevice *i2cdevice, uint16_t reg_addr, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)</div><div class="ttdoc">Create a register we access over an I2C Device (which defines the bus and address) ...</div><div class="ttdef"><b>Definition:</b> Adafruit_BusIO_Register.cpp:18</div></div>
<div class="ttc" id="class_adafruit___bus_i_o___register_html_a9738fbb8c088d5cf6d381f87dc9288bb"><div class="ttname"><a href="class_adafruit___bus_i_o___register.html#a9738fbb8c088d5cf6d381f87dc9288bb">Adafruit_BusIO_Register::readCached</a></div><div class="ttdeci">uint32_t readCached(void)</div><div class="ttdoc">Read cached data from last time we wrote to this register. </div><div class="ttdef"><b>Definition:</b> Adafruit_BusIO_Register.cpp:211</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:19</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___s_p_i_device_html"><div class="ttname"><a href="class_adafruit___s_p_i_device.html">Adafruit_SPIDevice</a></div><div class="ttdef"><b>Definition:</b> Adafruit_SPIDevice.h:94</div></div>
<div class="ttc" id="class_adafruit___bus_i_o___register_html_a699434b2567ae8fce541b8048d891252"><div class="ttname"><a href="class_adafruit___bus_i_o___register.html#a699434b2567ae8fce541b8048d891252">Adafruit_BusIO_Register::read</a></div><div class="ttdeci">uint32_t read(void)</div><div class="ttdoc">Read data from the register location. This does not do any error checking! </div><div class="ttdef"><b>Definition:</b> Adafruit_BusIO_Register.cpp:188</div></div>
<div class="ttc" id="class_adafruit___bus_i_o___register_html_abf1eaeb0ae836be082a73dae14e7e352"><div class="ttname"><a href="class_adafruit___bus_i_o___register.html#abf1eaeb0ae836be082a73dae14e7e352">Adafruit_BusIO_Register::width</a></div><div class="ttdeci">uint8_t width(void)</div><div class="ttdoc">The width of the register data, helpful for doing calculations. </div><div class="ttdef"><b>Definition:</b> Adafruit_BusIO_Register.cpp:360</div></div>
html/_adafruit___generic_device_8h_source.html
+12 -12
View File
File diff suppressed because one or more lines are too long
html/_adafruit___s_p_i_device_8h_source.html
+1 -1
View File
File diff suppressed because one or more lines are too long
html/class_adafruit___generic_device-members.html
+1 -1
View File
@@ -70,7 +70,7 @@ $(function() {
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___generic_device.html#aaa284353a4aa9bb1b6e87084d98bb615">_readreg_func</a></td><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="class_adafruit___generic_device.html#a599a58418b671e73262496821f0ad6a0">_write_func</a></td><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___generic_device.html#a13630990b49ab7dccca601dfaa90f9be">_writereg_func</a></td><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="class_adafruit___generic_device.html#afde6690edb3e5dc469a604ed3e2c6f54">Adafruit_GenericDevice</a>(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><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><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><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_adafruit___generic_device.html#a6894812dfd41b7080a35e5be635d687f">begin</a>(void)</td><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_adafruit___generic_device.html#a90de855895eb2b2a431569107501cd95">read</a>(uint8_t *buffer, size_t len)</td><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><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><td class="entry"><a class="el" href="class_adafruit___generic_device.html">Adafruit_GenericDevice</a></td><td class="entry"></td></tr>
html/class_adafruit___generic_device.html
+15 -8
View File
@@ -74,11 +74,11 @@ $(function() {
<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:afde6690edb3e5dc469a604ed3e2c6f54"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___generic_device.html#afde6690edb3e5dc469a604ed3e2c6f54">Adafruit_GenericDevice</a> (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:afde6690edb3e5dc469a604ed3e2c6f54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a Generic device with the provided read/write functions. <a href="#afde6690edb3e5dc469a604ed3e2c6f54">More...</a><br /></td></tr>
<tr class="separator:afde6690edb3e5dc469a604ed3e2c6f54"><td class="memSeparator" colspan="2">&#160;</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">Initializes the device. <a href="#a6894812dfd41b7080a35e5be635d687f">More...</a><br /></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>
@@ -117,8 +117,8 @@ busio_genericdevice_writereg_t&#160;</td><td class="memItemRight" valign="bottom
<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="afde6690edb3e5dc469a604ed3e2c6f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afde6690edb3e5dc469a604ed3e2c6f54">&#9670;&nbsp;</a></span>Adafruit_GenericDevice()</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">
@@ -126,6 +126,12 @@ busio_genericdevice_writereg_t&#160;</td><td class="memItemRight" valign="bottom
<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>
@@ -158,6 +164,7 @@ busio_genericdevice_writereg_t&#160;</td><td class="memItemRight" valign="bottom
<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>
@@ -185,8 +192,8 @@ busio_genericdevice_writereg_t&#160;</td><td class="memItemRight" valign="bottom
</table>
</div><div class="memdoc">
<p>Initializes the device. </p>
<dl class="section return"><dt>Returns</dt><dd>true if initialization was successful, otherwise false </dd></dl>
<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>
html/functions.html
+1 -1
View File
@@ -87,7 +87,7 @@ $(function() {
: <a class="el" href="class_adafruit___bus_i_o___register_bits.html#a369a5c8d03df7da82f8f46f00bd73855">Adafruit_BusIO_RegisterBits</a>
</li>
<li>Adafruit_GenericDevice()
: <a class="el" href="class_adafruit___generic_device.html#afde6690edb3e5dc469a604ed3e2c6f54">Adafruit_GenericDevice</a>
: <a class="el" href="class_adafruit___generic_device.html#af35fe023168feebc94abecaff3562cf4">Adafruit_GenericDevice</a>
</li>
<li>Adafruit_I2CDevice()
: <a class="el" href="class_adafruit___i2_c_device.html#afea8ccedd8c77bff545c97520d8ec31c">Adafruit_I2CDevice</a>
html/functions_func.html
+1 -1
View File
@@ -68,7 +68,7 @@ $(function() {
: <a class="el" href="class_adafruit___bus_i_o___register_bits.html#a369a5c8d03df7da82f8f46f00bd73855">Adafruit_BusIO_RegisterBits</a>
</li>
<li>Adafruit_GenericDevice()
: <a class="el" href="class_adafruit___generic_device.html#afde6690edb3e5dc469a604ed3e2c6f54">Adafruit_GenericDevice</a>
: <a class="el" href="class_adafruit___generic_device.html#af35fe023168feebc94abecaff3562cf4">Adafruit_GenericDevice</a>
</li>
<li>Adafruit_I2CDevice()
: <a class="el" href="class_adafruit___i2_c_device.html#afea8ccedd8c77bff545c97520d8ec31c">Adafruit_I2CDevice</a>
html/search/all_1.js
+1 -1
View File
@@ -2,7 +2,7 @@ var searchData=
[
['adafruit_5fbusio_5fregister',['Adafruit_BusIO_Register',['../class_adafruit___bus_i_o___register.html',1,'Adafruit_BusIO_Register'],['../class_adafruit___bus_i_o___register.html#a7de4a4cbb3e8cdfebac31344e8ab6c8c',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_I2CDevice *i2cdevice, uint16_t reg_addr, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)'],['../class_adafruit___bus_i_o___register.html#a89e57552743a5f15c99cb7aa27b3ca13',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_SPIDevice *spidevice, uint16_t reg_addr, Adafruit_BusIO_SPIRegType type, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)'],['../class_adafruit___bus_i_o___register.html#a300a0297429df441bc88dbb37eac1a06',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_I2CDevice *i2cdevice, Adafruit_SPIDevice *spidevice, Adafruit_BusIO_SPIRegType type, uint16_t reg_addr, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)'],['../class_adafruit___bus_i_o___register.html#aaa8d917f7f30865cbee837a2ecd918ca',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_GenericDevice *genericdevice, uint16_t reg_addr, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)']]],
['adafruit_5fbusio_5fregisterbits',['Adafruit_BusIO_RegisterBits',['../class_adafruit___bus_i_o___register_bits.html',1,'Adafruit_BusIO_RegisterBits'],['../class_adafruit___bus_i_o___register_bits.html#a369a5c8d03df7da82f8f46f00bd73855',1,'Adafruit_BusIO_RegisterBits::Adafruit_BusIO_RegisterBits()']]],
['adafruit_5fgenericdevice',['Adafruit_GenericDevice',['../class_adafruit___generic_device.html',1,'Adafruit_GenericDevice'],['../class_adafruit___generic_device.html#afde6690edb3e5dc469a604ed3e2c6f54',1,'Adafruit_GenericDevice::Adafruit_GenericDevice()']]],
['adafruit_5fgenericdevice',['Adafruit_GenericDevice',['../class_adafruit___generic_device.html',1,'Adafruit_GenericDevice'],['../class_adafruit___generic_device.html#af35fe023168feebc94abecaff3562cf4',1,'Adafruit_GenericDevice::Adafruit_GenericDevice()']]],
['adafruit_5fi2cdevice',['Adafruit_I2CDevice',['../class_adafruit___i2_c_device.html',1,'Adafruit_I2CDevice'],['../class_adafruit___i2_c_device.html#afea8ccedd8c77bff545c97520d8ec31c',1,'Adafruit_I2CDevice::Adafruit_I2CDevice()']]],
['adafruit_5fspidevice',['Adafruit_SPIDevice',['../class_adafruit___s_p_i_device.html',1,'Adafruit_SPIDevice'],['../class_adafruit___s_p_i_device.html#a3b58c1ebba22985823848654e24d1fc9',1,'Adafruit_SPIDevice::Adafruit_SPIDevice(int8_t cspin, uint32_t freq=1000000, BusIOBitOrder dataOrder=SPI_BITORDER_MSBFIRST, uint8_t dataMode=SPI_MODE0, SPIClass *theSPI=&amp;SPI)'],['../class_adafruit___s_p_i_device.html#a6fe83560f80083c5e6580b5e2e6b4cc6',1,'Adafruit_SPIDevice::Adafruit_SPIDevice(int8_t cspin, int8_t sck, int8_t miso, int8_t mosi, uint32_t freq=1000000, BusIOBitOrder dataOrder=SPI_BITORDER_MSBFIRST, uint8_t dataMode=SPI_MODE0)']]],
['address',['address',['../class_adafruit___i2_c_device.html#ae02c4691dbe893c3a5a3de478d776062',1,'Adafruit_I2CDevice']]]
html/search/functions_0.js
+1 -1
View File
@@ -2,7 +2,7 @@ var searchData=
[
['adafruit_5fbusio_5fregister',['Adafruit_BusIO_Register',['../class_adafruit___bus_i_o___register.html#a7de4a4cbb3e8cdfebac31344e8ab6c8c',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_I2CDevice *i2cdevice, uint16_t reg_addr, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)'],['../class_adafruit___bus_i_o___register.html#a89e57552743a5f15c99cb7aa27b3ca13',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_SPIDevice *spidevice, uint16_t reg_addr, Adafruit_BusIO_SPIRegType type, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)'],['../class_adafruit___bus_i_o___register.html#a300a0297429df441bc88dbb37eac1a06',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_I2CDevice *i2cdevice, Adafruit_SPIDevice *spidevice, Adafruit_BusIO_SPIRegType type, uint16_t reg_addr, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)'],['../class_adafruit___bus_i_o___register.html#aaa8d917f7f30865cbee837a2ecd918ca',1,'Adafruit_BusIO_Register::Adafruit_BusIO_Register(Adafruit_GenericDevice *genericdevice, uint16_t reg_addr, uint8_t width=1, uint8_t byteorder=LSBFIRST, uint8_t address_width=1)']]],
['adafruit_5fbusio_5fregisterbits',['Adafruit_BusIO_RegisterBits',['../class_adafruit___bus_i_o___register_bits.html#a369a5c8d03df7da82f8f46f00bd73855',1,'Adafruit_BusIO_RegisterBits']]],
['adafruit_5fgenericdevice',['Adafruit_GenericDevice',['../class_adafruit___generic_device.html#afde6690edb3e5dc469a604ed3e2c6f54',1,'Adafruit_GenericDevice']]],
['adafruit_5fgenericdevice',['Adafruit_GenericDevice',['../class_adafruit___generic_device.html#af35fe023168feebc94abecaff3562cf4',1,'Adafruit_GenericDevice']]],
['adafruit_5fi2cdevice',['Adafruit_I2CDevice',['../class_adafruit___i2_c_device.html#afea8ccedd8c77bff545c97520d8ec31c',1,'Adafruit_I2CDevice']]],
['adafruit_5fspidevice',['Adafruit_SPIDevice',['../class_adafruit___s_p_i_device.html#a3b58c1ebba22985823848654e24d1fc9',1,'Adafruit_SPIDevice::Adafruit_SPIDevice(int8_t cspin, uint32_t freq=1000000, BusIOBitOrder dataOrder=SPI_BITORDER_MSBFIRST, uint8_t dataMode=SPI_MODE0, SPIClass *theSPI=&amp;SPI)'],['../class_adafruit___s_p_i_device.html#a6fe83560f80083c5e6580b5e2e6b4cc6',1,'Adafruit_SPIDevice::Adafruit_SPIDevice(int8_t cspin, int8_t sck, int8_t miso, int8_t mosi, uint32_t freq=1000000, BusIOBitOrder dataOrder=SPI_BITORDER_MSBFIRST, uint8_t dataMode=SPI_MODE0)']]],
['address',['address',['../class_adafruit___i2_c_device.html#ae02c4691dbe893c3a5a3de478d776062',1,'Adafruit_I2CDevice']]]