mirror of
https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git
synced 2025-04-21 21:30:05 +08:00
181 lines
20 KiB
HTML
181 lines
20 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">
|
|
<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>ESP3D: esp3d/src/modules/buzzer/buzzer.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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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="projectlogo"><img alt="Logo" src="ESP3D_social_mini.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ESP3D
|
|
 <span id="projectnumber">3.0</span>
|
|
</div>
|
|
<div id="projectbrief">Firmware for ESP boards connected to 3D Printer</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&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&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>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('buzzer_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">buzzer.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="buzzer_8h.html">Go to the documentation of this file.</a><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"> buzzer.h - ESP3D buzzer class</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) 2014 Luc Lebosse. All rights reserved.</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"> This library is free software; you can redistribute it and/or</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> License as published by the Free Software Foundation; either</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Lesser General Public License for more details.</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"> You should have received a copy of the GNU Lesser General Public</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> License along with this library; if not, write to the Free Software</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef _BUZZER_H</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _BUZZER_H</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="buzzer_8h.html#afffeeea9c511d12bf1c0583dcb622d2d"> 22</a></span> <span class="preprocessor">#define BEEP_FREQUENCY 3000</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structtone__data.html"> 24</a></span> <span class="keyword">struct </span><a class="code" href="structtone__data.html">tone_data</a> {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structtone__data.html#ad87384e59ca50d63cda8252d7a646d53"> 25</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtone__data.html#ad87384e59ca50d63cda8252d7a646d53">frequency</a>;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structtone__data.html#a1ba78a563ba27accf43a965393225daf"> 26</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtone__data.html#a1ba78a563ba27accf43a965393225daf">duration</a>;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structtone__data.html#a05281a3a853e06d71eec84bcd728ebf4"> 27</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structtone__data.html#a05281a3a853e06d71eec84bcd728ebf4">processing</a>;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structtone__data.html#a8cee9f99c3db08c2e6388b883a9a2337"> 28</a></span>  <a class="code" href="structtone__data.html">tone_data</a> * <a class="code" href="structtone__data.html#a8cee9f99c3db08c2e6388b883a9a2337">_next</a>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="class_buzzer_device.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="class_buzzer_device.html">BuzzerDevice</a></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="class_buzzer_device.html#ac613156c269d5dd25ece4a9615c3c21e">BuzzerDevice</a>();</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="class_buzzer_device.html#a521b1019164d20491b199300022207bb">~BuzzerDevice</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">void</span> <a class="code" href="class_buzzer_device.html#af9f27a30adb9e0c10d3bf7508fcf81e9">playsound</a>(<span class="keywordtype">int</span> frequency, <span class="keywordtype">int</span> duration);</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_buzzer_device.html#afff43d58fd798ef52596b352ae1cc3ec"> 37</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_buzzer_device.html#afff43d58fd798ef52596b352ae1cc3ec">started</a>()</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">return</span> _started;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">bool</span> <a class="code" href="class_buzzer_device.html#aeb73fb085b2cdc29243a0bed1f140b24">begin</a>();</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="class_buzzer_device.html#aacdbe3fcdd3f285c261e0e8b816fc65a">end</a>();</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="class_buzzer_device.html#a64b53652e0ae808d8552bd03e645384a">handle</a>();</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="structtone__data.html">tone_data</a> * <a class="code" href="class_buzzer_device.html#aa5ebbd54190bda93711543a1f8d81fe1">getNextTone</a>();</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">bool</span> <a class="code" href="class_buzzer_device.html#a7def8f263d4c13aeec53daa3772b11b9">isPlaying</a>();</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> <a class="code" href="class_buzzer_device.html#a9d315c238bef23624228a141badcac54">waitWhilePlaying</a>();</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> <a class="code" href="class_buzzer_device.html#adb92bb97bc60037176924e6cbb58844d">beep</a>(<span class="keywordtype">int</span> count=1, <span class="keywordtype">int</span> delay = 0, <span class="keywordtype">int</span> frequency = <a class="code" href="buzzer_8h.html#afffeeea9c511d12bf1c0583dcb622d2d">BEEP_FREQUENCY</a>);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="structtone__data.html">tone_data</a> * _head;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="structtone__data.html">tone_data</a> * _tail;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">bool</span> _started;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> purgeData();</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">bool</span> addToneToList(<span class="keywordtype">int</span> frequency, <span class="keywordtype">int</span> duration);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> no_tone();</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">extern</span> <a class="code" href="class_buzzer_device.html">BuzzerDevice</a> <a class="code" href="buzzer_8h.html#a347399418a94f80399402f92e9f42839">esp3d_buzzer</a>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif //_BUZZER_H</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="astructtone__data_html"><div class="ttname"><a href="structtone__data.html">tone_data</a></div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00024">buzzer.h:24</a></div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_afff43d58fd798ef52596b352ae1cc3ec"><div class="ttname"><a href="class_buzzer_device.html#afff43d58fd798ef52596b352ae1cc3ec">BuzzerDevice::started</a></div><div class="ttdeci">bool started()</div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00037">buzzer.h:37</a></div></div>
|
|
<div class="ttc" id="astructtone__data_html_a05281a3a853e06d71eec84bcd728ebf4"><div class="ttname"><a href="structtone__data.html#a05281a3a853e06d71eec84bcd728ebf4">tone_data::processing</a></div><div class="ttdeci">bool processing</div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00027">buzzer.h:27</a></div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_a64b53652e0ae808d8552bd03e645384a"><div class="ttname"><a href="class_buzzer_device.html#a64b53652e0ae808d8552bd03e645384a">BuzzerDevice::handle</a></div><div class="ttdeci">void handle()</div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_af9f27a30adb9e0c10d3bf7508fcf81e9"><div class="ttname"><a href="class_buzzer_device.html#af9f27a30adb9e0c10d3bf7508fcf81e9">BuzzerDevice::playsound</a></div><div class="ttdeci">void playsound(int frequency, int duration)</div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_a9d315c238bef23624228a141badcac54"><div class="ttname"><a href="class_buzzer_device.html#a9d315c238bef23624228a141badcac54">BuzzerDevice::waitWhilePlaying</a></div><div class="ttdeci">void waitWhilePlaying()</div></div>
|
|
<div class="ttc" id="astructtone__data_html_ad87384e59ca50d63cda8252d7a646d53"><div class="ttname"><a href="structtone__data.html#ad87384e59ca50d63cda8252d7a646d53">tone_data::frequency</a></div><div class="ttdeci">int frequency</div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00025">buzzer.h:25</a></div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html"><div class="ttname"><a href="class_buzzer_device.html">BuzzerDevice</a></div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00031">buzzer.h:31</a></div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_adb92bb97bc60037176924e6cbb58844d"><div class="ttname"><a href="class_buzzer_device.html#adb92bb97bc60037176924e6cbb58844d">BuzzerDevice::beep</a></div><div class="ttdeci">void beep(int count=1, int delay=0, int frequency=BEEP_FREQUENCY)</div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_aacdbe3fcdd3f285c261e0e8b816fc65a"><div class="ttname"><a href="class_buzzer_device.html#aacdbe3fcdd3f285c261e0e8b816fc65a">BuzzerDevice::end</a></div><div class="ttdeci">void end()</div></div>
|
|
<div class="ttc" id="abuzzer_8h_html_afffeeea9c511d12bf1c0583dcb622d2d"><div class="ttname"><a href="buzzer_8h.html#afffeeea9c511d12bf1c0583dcb622d2d">BEEP_FREQUENCY</a></div><div class="ttdeci">#define BEEP_FREQUENCY</div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00022">buzzer.h:22</a></div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_a521b1019164d20491b199300022207bb"><div class="ttname"><a href="class_buzzer_device.html#a521b1019164d20491b199300022207bb">BuzzerDevice::~BuzzerDevice</a></div><div class="ttdeci">~BuzzerDevice()</div></div>
|
|
<div class="ttc" id="astructtone__data_html_a1ba78a563ba27accf43a965393225daf"><div class="ttname"><a href="structtone__data.html#a1ba78a563ba27accf43a965393225daf">tone_data::duration</a></div><div class="ttdeci">int duration</div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00026">buzzer.h:26</a></div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_aeb73fb085b2cdc29243a0bed1f140b24"><div class="ttname"><a href="class_buzzer_device.html#aeb73fb085b2cdc29243a0bed1f140b24">BuzzerDevice::begin</a></div><div class="ttdeci">bool begin()</div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_ac613156c269d5dd25ece4a9615c3c21e"><div class="ttname"><a href="class_buzzer_device.html#ac613156c269d5dd25ece4a9615c3c21e">BuzzerDevice::BuzzerDevice</a></div><div class="ttdeci">BuzzerDevice()</div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_a7def8f263d4c13aeec53daa3772b11b9"><div class="ttname"><a href="class_buzzer_device.html#a7def8f263d4c13aeec53daa3772b11b9">BuzzerDevice::isPlaying</a></div><div class="ttdeci">bool isPlaying()</div></div>
|
|
<div class="ttc" id="aclass_buzzer_device_html_aa5ebbd54190bda93711543a1f8d81fe1"><div class="ttname"><a href="class_buzzer_device.html#aa5ebbd54190bda93711543a1f8d81fe1">BuzzerDevice::getNextTone</a></div><div class="ttdeci">tone_data * getNextTone()</div></div>
|
|
<div class="ttc" id="abuzzer_8h_html_a347399418a94f80399402f92e9f42839"><div class="ttname"><a href="buzzer_8h.html#a347399418a94f80399402f92e9f42839">esp3d_buzzer</a></div><div class="ttdeci">BuzzerDevice esp3d_buzzer</div></div>
|
|
<div class="ttc" id="astructtone__data_html_a8cee9f99c3db08c2e6388b883a9a2337"><div class="ttname"><a href="structtone__data.html#a8cee9f99c3db08c2e6388b883a9a2337">tone_data::_next</a></div><div class="ttdeci">tone_data * _next</div><div class="ttdef"><b>Definition:</b> <a href="buzzer_8h_source.html#l00028">buzzer.h:28</a></div></div>
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_26e324fd2d3b807b96644664d24a0768.html">esp3d</a></li><li class="navelem"><a class="el" href="dir_8d0579f238dc492a9f9393e76adf8153.html">src</a></li><li class="navelem"><a class="el" href="dir_2c1830491e0576ae3395f8c2f91c7d85.html">modules</a></li><li class="navelem"><a class="el" href="dir_4eea67c7b78c77ba5d9b19169fb23a47.html">buzzer</a></li><li class="navelem"><a class="el" href="buzzer_8h.html">buzzer.h</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|