specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
USB_Host_Shield_2.0/class_u_h_s2___g_p_i_o.html
Lauszus d4710bb19d deploy: b435996557
2021-03-23 11:43:48 +00:00

244 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: UHS2_GPIO 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" />
<link href="imageStyle.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">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="class_u_h_s2___g_p_i_o-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">UHS2_GPIO Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_u_h_s2__gpio_8h_source.html">UHS2_gpio.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:a17ed93e6b9a8e81df410ade377bf6413"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_h_s2___g_p_i_o.html#a17ed93e6b9a8e81df410ade377bf6413">UHS2_GPIO</a> (<a class="el" href="class_u_s_b.html">USB</a> *pUsb)</td></tr>
<tr class="memdesc:a17ed93e6b9a8e81df410ade377bf6413"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implement an instance of a <a class="el" href="class_u_h_s2___g_p_i_o.html">UHS2_GPIO</a> object. <a href="class_u_h_s2___g_p_i_o.html#a17ed93e6b9a8e81df410ade377bf6413">More...</a><br /></td></tr>
<tr class="separator:a17ed93e6b9a8e81df410ade377bf6413"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b8339cda815b0cf1e0692346fa60586"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_h_s2___g_p_i_o.html#a8b8339cda815b0cf1e0692346fa60586">digitalWrite</a> (uint8_t pin, uint8_t val)</td></tr>
<tr class="memdesc:a8b8339cda815b0cf1e0692346fa60586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a GPIO output value. <a href="class_u_h_s2___g_p_i_o.html#a8b8339cda815b0cf1e0692346fa60586">More...</a><br /></td></tr>
<tr class="separator:a8b8339cda815b0cf1e0692346fa60586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6fe71d23421ff4d28c7f197411b4a9c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_h_s2___g_p_i_o.html#ac6fe71d23421ff4d28c7f197411b4a9c">digitalRead</a> (uint8_t pin)</td></tr>
<tr class="memdesc:ac6fe71d23421ff4d28c7f197411b4a9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the value from a GPIO input pin. <a href="class_u_h_s2___g_p_i_o.html#ac6fe71d23421ff4d28c7f197411b4a9c">More...</a><br /></td></tr>
<tr class="separator:ac6fe71d23421ff4d28c7f197411b4a9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9613c4c7e4fcaedb147929b0543e0c6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_h_s2___g_p_i_o.html#ad9613c4c7e4fcaedb147929b0543e0c6">digitalReadOutput</a> (uint8_t pin)</td></tr>
<tr class="memdesc:ad9613c4c7e4fcaedb147929b0543e0c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the value from a GPIO output pin. <a href="class_u_h_s2___g_p_i_o.html#ad9613c4c7e4fcaedb147929b0543e0c6">More...</a><br /></td></tr>
<tr class="separator:ad9613c4c7e4fcaedb147929b0543e0c6"><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="definition">Definition at line <a class="el" href="_u_h_s2__gpio_8h_source.html#l00032">32</a> of file <a class="el" href="_u_h_s2__gpio_8h_source.html">UHS2_gpio.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a17ed93e6b9a8e81df410ade377bf6413"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17ed93e6b9a8e81df410ade377bf6413">&#9670;&nbsp;</a></span>UHS2_GPIO()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UHS2_GPIO::UHS2_GPIO </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td>
<td class="paramname"><em>pUsb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Implement an instance of a <a class="el" href="class_u_h_s2___g_p_i_o.html">UHS2_GPIO</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pUSB</td><td>Pointer to a UHS2 <a class="el" href="class_u_s_b.html">USB</a> object </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_u_h_s2__gpio_8cpp_source.html#l00032">32</a> of file <a class="el" href="_u_h_s2__gpio_8cpp_source.html">UHS2_gpio.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8b8339cda815b0cf1e0692346fa60586"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b8339cda815b0cf1e0692346fa60586">&#9670;&nbsp;</a></span>digitalWrite()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UHS2_GPIO::digitalWrite </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a GPIO output value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>GPIO output pin on <a class="el" href="class_u_s_b.html">USB</a> Host Shield to set </td></tr>
<tr><td class="paramname">val</td><td>Value to set the pin to (zero value will clear output, non-zero value will assert output) </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_u_h_s2__gpio_8cpp_source.html#l00040">40</a> of file <a class="el" href="_u_h_s2__gpio_8cpp_source.html">UHS2_gpio.cpp</a>.</p>
</div>
</div>
<a id="ac6fe71d23421ff4d28c7f197411b4a9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6fe71d23421ff4d28c7f197411b4a9c">&#9670;&nbsp;</a></span>digitalRead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int UHS2_GPIO::digitalRead </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pin</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the value from a GPIO input pin. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>GPIO input pin on <a class="el" href="class_u_s_b.html">USB</a> Host Shield to read </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">int</td><td>Value of GPIO input (-1 on fail) </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_u_h_s2__gpio_8cpp_source.html#l00055">55</a> of file <a class="el" href="_u_h_s2__gpio_8cpp_source.html">UHS2_gpio.cpp</a>.</p>
</div>
</div>
<a id="ad9613c4c7e4fcaedb147929b0543e0c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9613c4c7e4fcaedb147929b0543e0c6">&#9670;&nbsp;</a></span>digitalReadOutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int UHS2_GPIO::digitalReadOutput </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pin</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the value from a GPIO output pin. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>GPIO output pin on <a class="el" href="class_u_s_b.html">USB</a> Host Shield to read </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">int</td><td>Value of GPIO output (-1 on fail) </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Value of MAX3421E output register, i.e. what the device has been set to, not the physical value on the pin </dd></dl>
<p class="definition">Definition at line <a class="el" href="_u_h_s2__gpio_8cpp_source.html#l00068">68</a> of file <a class="el" href="_u_h_s2__gpio_8cpp_source.html">UHS2_gpio.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_u_h_s2__gpio_8h_source.html">UHS2_gpio.h</a></li>
<li><a class="el" href="_u_h_s2__gpio_8cpp_source.html">UHS2_gpio.cpp</a></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.17
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink