diff options
| author | joeycastillo <joeycastillo@users.noreply.github.com> | 2022-01-27 15:47:25 +0000 |
|---|---|---|
| committer | joeycastillo <joeycastillo@users.noreply.github.com> | 2022-01-27 15:47:25 +0000 |
| commit | c0090716995447bd59954c8a7e24cd5c20598f7a (patch) | |
| tree | fd06dac4eb9e8c0d28e04f9e1393ec0c338212c4 /watch__uart_8h_source.html | |
| parent | fabc6d28eaf6e0227c68673d3c564c31f4c01a17 (diff) | |
| download | Sensor-Watch-c0090716995447bd59954c8a7e24cd5c20598f7a.tar.gz Sensor-Watch-c0090716995447bd59954c8a7e24cd5c20598f7a.tar.bz2 Sensor-Watch-c0090716995447bd59954c8a7e24cd5c20598f7a.zip | |
deploy: 29fa6052831f8d26815405d4652b5799e3c74147
Diffstat (limited to 'watch__uart_8h_source.html')
| -rw-r--r-- | watch__uart_8h_source.html | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/watch__uart_8h_source.html b/watch__uart_8h_source.html new file mode 100644 index 00000000..9e723208 --- /dev/null +++ b/watch__uart_8h_source.html @@ -0,0 +1,131 @@ +<!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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Sensor Watch: watch-library/shared/watch/watch_uart.h Source File</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">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> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<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-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 */ +$(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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_f1a087a6659d970f5756e21fc1ac4961.html">watch-library</a></li><li class="navelem"><a class="el" href="dir_3351a3556ab4b770be21f3a77a6d7b80.html">shared</a></li><li class="navelem"><a class="el" href="dir_280ec1f3fe74f12cdd5c78898ed1ca3c.html">watch</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">watch_uart.h</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * MIT License</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2020 Joey Castillo</span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * in the Software without restriction, including without limitation the rights</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef _WATCH_UART_H_INCLUDED</span></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define _WATCH_UART_H_INCLUDED</span></div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="watch_8h.html">watch.h</a>"</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> +<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="group__debug.html#ga38e750d3e02939bf056fde77f4ef6235"> 42</a></span> <span class="keywordtype">void</span> <a class="code" href="group__debug.html#ga38e750d3e02939bf056fde77f4ef6235">watch_enable_uart</a>(<span class="keyword">const</span> uint8_t tx_pin, <span class="keyword">const</span> uint8_t rx_pin, uint32_t baud);</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> +<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__debug.html#ga5d62683298c511f24adaab4bf6615c50"> 47</a></span> <span class="keywordtype">void</span> <a class="code" href="group__debug.html#ga5d62683298c511f24adaab4bf6615c50">watch_uart_puts</a>(<span class="keywordtype">char</span> *s);</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div> +<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__debug.html#ga0c400bfcd52bb71e8de62c5ab2373db6"> 53</a></span> <span class="keywordtype">char</span> <a class="code" href="group__debug.html#ga0c400bfcd52bb71e8de62c5ab2373db6">watch_uart_getc</a>(<span class="keywordtype">void</span>);</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// Begin deprecated functions:</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> +<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="group__debug.html#gab9e48ca472abf422d1e6389f371d8fbf"> 60</a></span> <a class="code" href="group__debug.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated(<span class="stringliteral">"Use watch_enable_uart to enable the UART."</span>)))</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> void watch_enable_debug_uart(uint32_t baud);</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div> +<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="group__debug.html#ga42455c49e1756fc2eabbabec6f0bd530"> 66</a></span> <a class="code" href="group__debug.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated("Use <a class="code" href="group__debug.html#ga5d62683298c511f24adaab4bf6615c50">watch_uart_puts</a> to print to the UART, or printf to log debug messages over USB.")))</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> watch_debug_putc(<span class="keywordtype">char</span> c);</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <a class="code" href="group__debug.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated("Use <a class="code" href="group__debug.html#ga5d62683298c511f24adaab4bf6615c50">watch_uart_puts</a> to print to the UART, or printf to log debug messages over USB.")))</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">void</span> watch_debug_puts(<span class="keywordtype">char</span> *s);</div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div> +<div class="ttc" id="agroup__debug_html_ga0c400bfcd52bb71e8de62c5ab2373db6"><div class="ttname"><a href="group__debug.html#ga0c400bfcd52bb71e8de62c5ab2373db6">watch_uart_getc</a></div><div class="ttdeci">char watch_uart_getc(void)</div><div class="ttdoc">Receives a single byte from the UART's RX pin.</div></div> +<div class="ttc" id="agroup__debug_html_ga38e750d3e02939bf056fde77f4ef6235"><div class="ttname"><a href="group__debug.html#ga38e750d3e02939bf056fde77f4ef6235">watch_enable_uart</a></div><div class="ttdeci">void watch_enable_uart(const uint8_t tx_pin, const uint8_t rx_pin, uint32_t baud)</div><div class="ttdoc">Initializes the debug UART.</div></div> +<div class="ttc" id="agroup__debug_html_ga5d62683298c511f24adaab4bf6615c50"><div class="ttname"><a href="group__debug.html#ga5d62683298c511f24adaab4bf6615c50">watch_uart_puts</a></div><div class="ttdeci">void watch_uart_puts(char *s)</div><div class="ttdoc">Transmits a string of bytes on the UART's TX pin.</div></div> +<div class="ttc" id="agroup__debug_html_gab9e48ca472abf422d1e6389f371d8fbf"><div class="ttname"><a href="group__debug.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a></div><div class="ttdeci">__attribute__((deprecated("Use watch_enable_uart to enable the UART."))) void watch_enable_debug_uart(uint32_t baud)</div><div class="ttdoc">Initializes the debug UART.</div></div> +<div class="ttc" id="awatch_8h_html"><div class="ttname"><a href="watch_8h.html">watch.h</a></div></div> +</div><!-- fragment --></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 +</small></address> +</body> +</html> |