diff options
| author | joeycastillo <joeycastillo@users.noreply.github.com> | 2022-02-05 18:37:05 +0000 |
|---|---|---|
| committer | joeycastillo <joeycastillo@users.noreply.github.com> | 2022-02-05 18:37:05 +0000 |
| commit | 595c3cb881c14a28d37a8a9a3e4aadc79285a673 (patch) | |
| tree | dee69ea8a38ab86fce7496f39c402244c75b7878 /group__led.html | |
| parent | 12daf390078506a2a48c331752a5c69894aa01ec (diff) | |
| download | Sensor-Watch-595c3cb881c14a28d37a8a9a3e4aadc79285a673.tar.gz Sensor-Watch-595c3cb881c14a28d37a8a9a3e4aadc79285a673.tar.bz2 Sensor-Watch-595c3cb881c14a28d37a8a9a3e4aadc79285a673.zip | |
deploy: c74cacd34f68f2897fbd63e2ba90831f87cbad49
Diffstat (limited to 'group__led.html')
| -rw-r--r-- | group__led.html | 59 |
1 files changed, 29 insertions, 30 deletions
diff --git a/group__led.html b/group__led.html index f21e92c1..99419fbb 100644 --- a/group__led.html +++ b/group__led.html @@ -2,8 +2,8 @@ <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.9.1"/> +<meta http-equiv="X-UA-Compatible" content="IE=11"/> +<meta name="generator" content="Doxygen 1.9.3"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Sensor Watch: LED Control</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -19,10 +19,9 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr style="height: 56px;"> - <td id="projectalign" style="padding-left: 0.5em;"> - <div id="projectname">Sensor Watch -  <span id="projectnumber">0.0.0</span> + <tr id="projectrow"> + <td id="projectalign"> + <div id="projectname">Sensor Watch<span id="projectnumber"> 0.0.0</span> </div> <div id="projectbrief">A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.</div> </td> @@ -31,21 +30,22 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.1 --> +<!-- Generated by Doxygen 1.9.3 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search",'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +/* @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> +/* @license-end */ +</script> <div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> @@ -65,15 +65,14 @@ $(function() { <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">LED Control</div> </div> + <div class="headertitle"><div class="title">LED Control</div></div> </div><!--header--> <div class="contents"> <p>This section covers functions related to the bi-color red/green LED mounted behind the LCD. <a href="#details">More...</a></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga86ce31dc95137ed41983fb7c6af5502a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#ga86ce31dc95137ed41983fb7c6af5502a">watch_enable_leds</a> (void)</td></tr> <tr class="memdesc:ga86ce31dc95137ed41983fb7c6af5502a"><td class="mdescLeft"> </td><td class="mdescRight">Enables the bi-color LED. <a href="group__led.html#ga86ce31dc95137ed41983fb7c6af5502a">More...</a><br /></td></tr> @@ -93,22 +92,22 @@ Functions</h2></td></tr> <tr class="memitem:ga51ba53c3281ad8724d98af27eacc3de0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#ga51ba53c3281ad8724d98af27eacc3de0">watch_set_led_yellow</a> (void)</td></tr> <tr class="memdesc:ga51ba53c3281ad8724d98af27eacc3de0"><td class="mdescLeft"> </td><td class="mdescRight">Sets both red and green LEDs to full brightness. <a href="group__led.html#ga51ba53c3281ad8724d98af27eacc3de0">More...</a><br /></td></tr> <tr class="separator:ga51ba53c3281ad8724d98af27eacc3de0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga8619f040ff7364285398412a4c420cae"><td class="memItemLeft" align="right" valign="top"><a id="ga8619f040ff7364285398412a4c420cae"></a> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__led.html#ga8619f040ff7364285398412a4c420cae">watch_set_led_off</a> (void)</td></tr> +<tr class="memitem:ga8619f040ff7364285398412a4c420cae"><td class="memItemLeft" align="right" valign="top"><a id="ga8619f040ff7364285398412a4c420cae" name="ga8619f040ff7364285398412a4c420cae"></a> +void </td><td class="memItemRight" valign="bottom"><b>watch_set_led_off</b> (void)</td></tr> <tr class="memdesc:ga8619f040ff7364285398412a4c420cae"><td class="mdescLeft"> </td><td class="mdescRight">Turns both the red and the green LEDs off. <br /></td></tr> <tr class="separator:ga8619f040ff7364285398412a4c420cae"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga510b8e59dc64c9880c3eda27270722d8"><td class="memItemLeft" align="right" valign="top"><a id="ga510b8e59dc64c9880c3eda27270722d8"></a> +<tr class="memitem:ga510b8e59dc64c9880c3eda27270722d8"><td class="memItemLeft" align="right" valign="top"><a id="ga510b8e59dc64c9880c3eda27270722d8" name="ga510b8e59dc64c9880c3eda27270722d8"></a>  </td><td class="memItemRight" valign="bottom"><b>__attribute__</b> ((deprecated("Use <a class="el" href="group__led.html#ga86ce31dc95137ed41983fb7c6af5502a">watch_enable_leds</a> instead"))) void watch_enable_led(bool unused)</td></tr> <tr class="separator:ga510b8e59dc64c9880c3eda27270722d8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaca8285070363eed34dbb31c470d9d5bb"><td class="memItemLeft" align="right" valign="top"><a id="gaca8285070363eed34dbb31c470d9d5bb"></a> +<tr class="memitem:gaca8285070363eed34dbb31c470d9d5bb"><td class="memItemLeft" align="right" valign="top"><a id="gaca8285070363eed34dbb31c470d9d5bb" name="gaca8285070363eed34dbb31c470d9d5bb"></a>  </td><td class="memItemRight" valign="bottom"><b>__attribute__</b> ((deprecated("Use <a class="el" href="group__led.html#ga883bf171196fb5a7a57ef727dca6e04a">watch_disable_leds</a> instead"))) void watch_disable_led(bool unused)</td></tr> <tr class="separator:gaca8285070363eed34dbb31c470d9d5bb"><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 the bi-color red/green LED mounted behind the LCD. </p> -<p>The SAM L22 is an exceedingly power efficient chip, whereas the LED's are relatively power- hungry. The green LED, at full power, consumes more power than the whole chip in active mode, and the red LED consumes about twelve times as much power! The LED's should thus be used only sparingly in order to preserve battery life. </p><dl class="section note"><dt>Note</dt><dd>Some watches use a red/blue LED instead of a red/green LED. You will be able to determine this easily when you double tap the reset button: if the pulsing bootloader LED is red, you have a red/green edition; if it is blue, you have a red/blue edition. For red/blue watches, build your project with the command <code>make LED=BLUE</code>, and the watch library will automatically swap the pins so that watch_set_led_red sets the red LED, and watch_set_led_green sets the blue one. </dd></dl> +<p >This section covers functions related to the bi-color red/green LED mounted behind the LCD. </p> +<p >The SAM L22 is an exceedingly power efficient chip, whereas the LED's are relatively power- hungry. The green LED, at full power, consumes more power than the whole chip in active mode, and the red LED consumes about twelve times as much power! The LED's should thus be used only sparingly in order to preserve battery life. </p><dl class="section note"><dt>Note</dt><dd>Some watches use a red/blue LED instead of a red/green LED. You will be able to determine this easily when you double tap the reset button: if the pulsing bootloader LED is red, you have a red/green edition; if it is blue, you have a red/blue edition. For red/blue watches, build your project with the command <code>make LED=BLUE</code>, and the watch library will automatically swap the pins so that watch_set_led_red sets the red LED, and watch_set_led_green sets the blue one. </dd></dl> <h2 class="groupheader">Function Documentation</h2> -<a id="ga883bf171196fb5a7a57ef727dca6e04a"></a> +<a id="ga883bf171196fb5a7a57ef727dca6e04a" name="ga883bf171196fb5a7a57ef727dca6e04a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga883bf171196fb5a7a57ef727dca6e04a">◆ </a></span>watch_disable_leds()</h2> <div class="memitem"> @@ -129,7 +128,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="ga86ce31dc95137ed41983fb7c6af5502a"></a> +<a id="ga86ce31dc95137ed41983fb7c6af5502a" name="ga86ce31dc95137ed41983fb7c6af5502a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga86ce31dc95137ed41983fb7c6af5502a">◆ </a></span>watch_enable_leds()</h2> <div class="memitem"> @@ -150,7 +149,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="ga042bcc9220ab05d1de8389cf0067511b"></a> +<a id="ga042bcc9220ab05d1de8389cf0067511b" name="ga042bcc9220ab05d1de8389cf0067511b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga042bcc9220ab05d1de8389cf0067511b">◆ </a></span>watch_set_led_color()</h2> <div class="memitem"> @@ -188,7 +187,7 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div> </div> -<a id="gab01a29900ddc5315c0e752e63d748f41"></a> +<a id="gab01a29900ddc5315c0e752e63d748f41" name="gab01a29900ddc5315c0e752e63d748f41"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab01a29900ddc5315c0e752e63d748f41">◆ </a></span>watch_set_led_green()</h2> <div class="memitem"> @@ -205,11 +204,11 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div><div class="memdoc"> <p>Sets the green LED to full brightness, and turns the red LED off. </p> -<p>Of the two LED's in the RG bi-color LED, the green LED is the more power-efficient one (~0.44 mA). </p><dl class="section note"><dt>Note</dt><dd>If your watch has a red/blue LED, this method will set the LED to blue. </dd></dl> +<p >Of the two LED's in the RG bi-color LED, the green LED is the more power-efficient one (~0.44 mA). </p><dl class="section note"><dt>Note</dt><dd>If your watch has a red/blue LED, this method will set the LED to blue. </dd></dl> </div> </div> -<a id="ga36d89031d8e8813dfab5f6cff9c6ee40"></a> +<a id="ga36d89031d8e8813dfab5f6cff9c6ee40" name="ga36d89031d8e8813dfab5f6cff9c6ee40"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga36d89031d8e8813dfab5f6cff9c6ee40">◆ </a></span>watch_set_led_red()</h2> <div class="memitem"> @@ -226,11 +225,11 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div><div class="memdoc"> <p>Sets the red LED to full brightness, and turns the green LED off. </p> -<p>Of the two LED's in the RG bi-color LED, the red LED is the less power-efficient one (~4.5 mA). </p> +<p >Of the two LED's in the RG bi-color LED, the red LED is the less power-efficient one (~4.5 mA). </p> </div> </div> -<a id="ga51ba53c3281ad8724d98af27eacc3de0"></a> +<a id="ga51ba53c3281ad8724d98af27eacc3de0" name="ga51ba53c3281ad8724d98af27eacc3de0"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga51ba53c3281ad8724d98af27eacc3de0">◆ </a></span>watch_set_led_yellow()</h2> <div class="memitem"> @@ -247,14 +246,14 @@ void </td><td class="memItemRight" valign="bottom"><a class="el" href="grou </div><div class="memdoc"> <p>Sets both red and green LEDs to full brightness. </p> -<p>The total current draw between the two LED's in this mode will be ~5 mA, which is more than the watch draws in any other mode. Take care not to drain the battery. </p><dl class="section note"><dt>Note</dt><dd>If your watch has a red/blue LED, this method will set the LED to pink. </dd></dl> +<p >The total current draw between the two LED's in this mode will be ~5 mA, which is more than the watch draws in any other mode. Take care not to drain the battery. </p><dl class="section note"><dt>Note</dt><dd>If your watch has a red/blue LED, this method will set the LED to pink. </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.1 +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.3 </small></address> </body> </html> |