339 lines
16 KiB
HTML
339 lines
16 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Sensor Watch: Digital Input and Output</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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">Sensor Watch<span id="projectnumber"> 0.0.2</span>
|
|
</div>
|
|
<div id="projectbrief">A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Digital Input and Output</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This section covers functions related to general-purpose input and output signals.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga8f6035dc4a5226fa34504e8a5a930e0c" id="r_ga8f6035dc4a5226fa34504e8a5a930e0c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#ga8f6035dc4a5226fa34504e8a5a930e0c">watch_enable_digital_input</a> (const uint8_t pin)</td></tr>
|
|
<tr class="memdesc:ga8f6035dc4a5226fa34504e8a5a930e0c"><td class="mdescLeft"> </td><td class="mdescRight">Configures the selected pin for digital input. <br /></td></tr>
|
|
<tr class="separator:ga8f6035dc4a5226fa34504e8a5a930e0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae58e015e96f9e9c42a664b69185265b9" id="r_gae58e015e96f9e9c42a664b69185265b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#gae58e015e96f9e9c42a664b69185265b9">watch_disable_digital_input</a> (const uint8_t pin)</td></tr>
|
|
<tr class="memdesc:gae58e015e96f9e9c42a664b69185265b9"><td class="mdescLeft"> </td><td class="mdescRight">Disables any digital input, along with any pull-up or pull-down configuration. <br /></td></tr>
|
|
<tr class="separator:gae58e015e96f9e9c42a664b69185265b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga55a16884f634ee0eb2c981d1b9a06a4d" id="r_ga55a16884f634ee0eb2c981d1b9a06a4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#ga55a16884f634ee0eb2c981d1b9a06a4d">watch_enable_pull_up</a> (const uint8_t pin)</td></tr>
|
|
<tr class="memdesc:ga55a16884f634ee0eb2c981d1b9a06a4d"><td class="mdescLeft"> </td><td class="mdescRight">Enables a pull-up resistor on the selected pin. <br /></td></tr>
|
|
<tr class="separator:ga55a16884f634ee0eb2c981d1b9a06a4d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae974fce4ac5d38ffe256186a84c63ff9" id="r_gae974fce4ac5d38ffe256186a84c63ff9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#gae974fce4ac5d38ffe256186a84c63ff9">watch_enable_pull_down</a> (const uint8_t pin)</td></tr>
|
|
<tr class="memdesc:gae974fce4ac5d38ffe256186a84c63ff9"><td class="mdescLeft"> </td><td class="mdescRight">Enables a pull-down resistor on the selected pin. <br /></td></tr>
|
|
<tr class="separator:gae974fce4ac5d38ffe256186a84c63ff9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacc7c5e867c05cd03f5955e8e8036b879" id="r_gacc7c5e867c05cd03f5955e8e8036b879"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#gacc7c5e867c05cd03f5955e8e8036b879">watch_get_pin_level</a> (const uint8_t pin)</td></tr>
|
|
<tr class="memdesc:gacc7c5e867c05cd03f5955e8e8036b879"><td class="mdescLeft"> </td><td class="mdescRight">Gets the level of the selected pin. <br /></td></tr>
|
|
<tr class="separator:gacc7c5e867c05cd03f5955e8e8036b879"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf73a6405eb90bc6de32fb66f512fe4a9" id="r_gaf73a6405eb90bc6de32fb66f512fe4a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#gaf73a6405eb90bc6de32fb66f512fe4a9">watch_enable_digital_output</a> (const uint8_t pin)</td></tr>
|
|
<tr class="memdesc:gaf73a6405eb90bc6de32fb66f512fe4a9"><td class="mdescLeft"> </td><td class="mdescRight">Configures the selected pin for digital output. <br /></td></tr>
|
|
<tr class="separator:gaf73a6405eb90bc6de32fb66f512fe4a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga15b40170b4225ac6a927da1d76e4fd3d" id="r_ga15b40170b4225ac6a927da1d76e4fd3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#ga15b40170b4225ac6a927da1d76e4fd3d">watch_disable_digital_output</a> (const uint8_t pin)</td></tr>
|
|
<tr class="memdesc:ga15b40170b4225ac6a927da1d76e4fd3d"><td class="mdescLeft"> </td><td class="mdescRight">Disables digital output on the selected pin. <br /></td></tr>
|
|
<tr class="separator:ga15b40170b4225ac6a927da1d76e4fd3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2e781c7e15045d2270f0cb3f87d619d6" id="r_ga2e781c7e15045d2270f0cb3f87d619d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__gpio.html#ga2e781c7e15045d2270f0cb3f87d619d6">watch_set_pin_level</a> (const uint8_t pin, const bool level)</td></tr>
|
|
<tr class="memdesc:ga2e781c7e15045d2270f0cb3f87d619d6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the level of the selected pin. <br /></td></tr>
|
|
<tr class="separator:ga2e781c7e15045d2270f0cb3f87d619d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>This section covers functions related to general-purpose input and output signals. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gae58e015e96f9e9c42a664b69185265b9" name="gae58e015e96f9e9c42a664b69185265b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae58e015e96f9e9c42a664b69185265b9">◆ </a></span>watch_disable_digital_input()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void watch_disable_digital_input </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables any digital input, along with any pull-up or pull-down configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin that you wish to disable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga15b40170b4225ac6a927da1d76e4fd3d" name="ga15b40170b4225ac6a927da1d76e4fd3d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga15b40170b4225ac6a927da1d76e4fd3d">◆ </a></span>watch_disable_digital_output()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void watch_disable_digital_output </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables digital output on the selected pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin that you wish disable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8f6035dc4a5226fa34504e8a5a930e0c" name="ga8f6035dc4a5226fa34504e8a5a930e0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8f6035dc4a5226fa34504e8a5a930e0c">◆ </a></span>watch_enable_digital_input()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void watch_enable_digital_input </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures the selected pin for digital input. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin that you wish to act as an input. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf73a6405eb90bc6de32fb66f512fe4a9" name="gaf73a6405eb90bc6de32fb66f512fe4a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf73a6405eb90bc6de32fb66f512fe4a9">◆ </a></span>watch_enable_digital_output()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void watch_enable_digital_output </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures the selected pin for digital output. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin that you wish to act as an output. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae974fce4ac5d38ffe256186a84c63ff9" name="gae974fce4ac5d38ffe256186a84c63ff9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae974fce4ac5d38ffe256186a84c63ff9">◆ </a></span>watch_enable_pull_down()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void watch_enable_pull_down </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables a pull-down resistor on the selected pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin that you wish to configure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga55a16884f634ee0eb2c981d1b9a06a4d" name="ga55a16884f634ee0eb2c981d1b9a06a4d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga55a16884f634ee0eb2c981d1b9a06a4d">◆ </a></span>watch_enable_pull_up()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void watch_enable_pull_up </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables a pull-up resistor on the selected pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin that you wish to configure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacc7c5e867c05cd03f5955e8e8036b879" name="gacc7c5e867c05cd03f5955e8e8036b879"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacc7c5e867c05cd03f5955e8e8036b879">◆ </a></span>watch_get_pin_level()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool watch_get_pin_level </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the level of the selected pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin whose value you wish to read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the pin was logic high; otherwise, false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2e781c7e15045d2270f0cb3f87d619d6" name="ga2e781c7e15045d2270f0cb3f87d619d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2e781c7e15045d2270f0cb3f87d619d6">◆ </a></span>watch_set_pin_level()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void watch_set_pin_level </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>level</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the level of the selected pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>The pin whose value you wish to set. </td></tr>
|
|
<tr><td class="paramname">level</td><td>The level you wish to set: true for high, false for low. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|