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 /watch__uart_8h_source.html | |
| parent | 12daf390078506a2a48c331752a5c69894aa01ec (diff) | |
| download | Sensor-Watch-595c3cb881c14a28d37a8a9a3e4aadc79285a673.tar.gz Sensor-Watch-595c3cb881c14a28d37a8a9a3e4aadc79285a673.tar.bz2 Sensor-Watch-595c3cb881c14a28d37a8a9a3e4aadc79285a673.zip | |
deploy: c74cacd34f68f2897fbd63e2ba90831f87cbad49
Diffstat (limited to 'watch__uart_8h_source.html')
| -rw-r--r-- | watch__uart_8h_source.html | 119 |
1 files changed, 59 insertions, 60 deletions
diff --git a/watch__uart_8h_source.html b/watch__uart_8h_source.html index 237d3729..83c579ac 100644 --- a/watch__uart_8h_source.html +++ b/watch__uart_8h_source.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: watch-library/shared/watch/watch_uart.h Source File</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> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -67,56 +67,55 @@ $(function() { </div> </div><!-- top --> <div class="header"> - <div class="headertitle"> -<div class="title">watch_uart.h</div> </div> + <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__uart.html#ga38e750d3e02939bf056fde77f4ef6235"> 42</a></span> <span class="keywordtype">void</span> <a class="code" href="group__uart.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__uart.html#ga5d62683298c511f24adaab4bf6615c50"> 47</a></span> <span class="keywordtype">void</span> <a class="code" href="group__uart.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__uart.html#ga0c400bfcd52bb71e8de62c5ab2373db6"> 53</a></span> <span class="keywordtype">char</span> <a class="code" href="group__uart.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__uart.html#gab9e48ca472abf422d1e6389f371d8fbf"> 60</a></span> <a class="code" href="group__uart.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__uart.html#ga42455c49e1756fc2eabbabec6f0bd530"> 66</a></span> <a class="code" href="group__uart.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated("Use <a class="code" href="group__uart.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__uart.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated("Use <a class="code" href="group__uart.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="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * MIT License</span></div> +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div> +<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Copyright (c) 2020 Joey Castillo</span></div> +<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *</span></div> +<div class="line"><a id="l00006" 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 id="l00007" 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 id="l00008" 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 id="l00009" 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 id="l00010" 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 id="l00011" 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 id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div> +<div class="line"><a id="l00013" 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 id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * copies or substantial portions of the Software.</span></div> +<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> *</span></div> +<div class="line"><a id="l00016" 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 id="l00017" 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 id="l00018" 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 id="l00019" 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 id="l00020" 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 id="l00021" 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 id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * SOFTWARE.</span></div> +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> */</span></div> +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#ifndef _WATCH_UART_H_INCLUDED</span></div> +<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#define _WATCH_UART_H_INCLUDED</span></div> +<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> +<div class="line"><a id="l00028" 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 id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> +<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="group__uart.html#ga38e750d3e02939bf056fde77f4ef6235"> 42</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__uart.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 id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> +<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="group__uart.html#ga5d62683298c511f24adaab4bf6615c50"> 47</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__uart.html#ga5d62683298c511f24adaab4bf6615c50">watch_uart_puts</a>(<span class="keywordtype">char</span> *s);</div> +<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> +<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="group__uart.html#ga0c400bfcd52bb71e8de62c5ab2373db6"> 53</a></span><span class="keywordtype">char</span> <a class="code hl_function" href="group__uart.html#ga0c400bfcd52bb71e8de62c5ab2373db6">watch_uart_getc</a>(<span class="keywordtype">void</span>);</div> +<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">// Begin deprecated functions:</span></div> +<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> +<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="group__uart.html#gab9e48ca472abf422d1e6389f371d8fbf"> 60</a></span><a class="code hl_function" href="group__uart.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated(<span class="stringliteral">"Use watch_enable_uart to enable the UART."</span>)))</div> +<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>void watch_enable_debug_uart(uint32_t baud);</div> +<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> +<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="group__uart.html#ga42455c49e1756fc2eabbabec6f0bd530"> 66</a></span><a class="code hl_function" href="group__uart.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated("Use <a class="code hl_function" href="group__uart.html#ga5d62683298c511f24adaab4bf6615c50">watch_uart_puts</a> to print to the UART, or printf to log debug messages over USB.")))</div> +<div class="line"><a id="l00067" 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 id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> +<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><a class="code hl_function" href="group__uart.html#gab9e48ca472abf422d1e6389f371d8fbf">__attribute__</a>((deprecated("Use <a class="code hl_function" href="group__uart.html#ga5d62683298c511f24adaab4bf6615c50">watch_uart_puts</a> to print to the UART, or printf to log debug messages over USB.")))</div> +<div class="line"><a id="l00073" 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 id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="preprocessor">#endif</span></div> <div class="ttc" id="agroup__uart_html_ga0c400bfcd52bb71e8de62c5ab2373db6"><div class="ttname"><a href="group__uart.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__uart_html_ga38e750d3e02939bf056fde77f4ef6235"><div class="ttname"><a href="group__uart.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__uart_html_ga5d62683298c511f24adaab4bf6615c50"><div class="ttname"><a href="group__uart.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> @@ -125,7 +124,7 @@ $(function() { </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 +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> |