<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>soundimpact library: soundimpact.h File Reference</title>
<link href="html/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="html/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 style="padding-left: 0.5em;">
<div id="projectname">soundimpact library
 <span id="projectnumber">v0.5</span>
</div>
<div id="projectbrief">Sound impact occurence counting from other cog.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="html/index.html"><span>Main Page</span></a></li>
<li class="current"><a href="html/files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="html/files.html"><span>File List</span></a></li>
<li><a href="html/globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">soundimpact.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Monitor sound impact occurrences from another cog. <br/>
<br/>
IMPORTANT: This library is only for making monitoring from another cog more convenient. Your application does not need this to check the sensor's output state. For that, all you need is: <br/>
<br/>
int state = input(pin); <br/>
<br/>
The value of pin should be Propeller I/O connected to sensor's SIG pin. The sensor returns a 1 to state if an impact is detected, or 0 if not.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "simpletools.h"</code><br/>
</div>
<p><a href="html/soundimpact_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aab39dffba4a8677c5077b32fad770c97"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="html/soundimpact_8h.html#aab39dffba4a8677c5077b32fad770c97">soundImpact_run</a> (int pin)</td></tr>
<tr class="memdesc:aab39dffba4a8677c5077b32fad770c97"><td class="mdescLeft"> </td><td class="mdescRight">Runs the sound impact tracking process in another cog. <a href="#aab39dffba4a8677c5077b32fad770c97"></a><br/></td></tr>
<tr class="memitem:ab42e600b5d990db9233f7205b3581ea6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="html/soundimpact_8h.html#ab42e600b5d990db9233f7205b3581ea6">soundImpact_end</a> (int *processID)</td></tr>
<tr class="memdesc:ab42e600b5d990db9233f7205b3581ea6"><td class="mdescLeft"> </td><td class="mdescRight">End sound impact tracking process and recovers cog and stack memory for other purposes. <a href="#ab42e600b5d990db9233f7205b3581ea6"></a><br/></td></tr>
<tr class="memitem:a82f46c8715e87f2ac1fb73d7b8b97b0d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="html/soundimpact_8h.html#a82f46c8715e87f2ac1fb73d7b8b97b0d">soundImpact_getCount</a> (void)</td></tr>
<tr class="memdesc:a82f46c8715e87f2ac1fb73d7b8b97b0d"><td class="mdescLeft"> </td><td class="mdescRight">Get number of impacts since last call to soundImpact_getCount. <a href="#a82f46c8715e87f2ac1fb73d7b8b97b0d"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Monitor sound impact occurrences from another cog. <br/>
<br/>
IMPORTANT: This library is only for making monitoring from another cog more convenient. Your application does not need this to check the sensor's output state. For that, all you need is: <br/>
<br/>
int state = input(pin); <br/>
<br/>
The value of pin should be Propeller I/O connected to sensor's SIG pin. The sensor returns a 1 to state if an impact is detected, or 0 if not. </p>
<dl class="section author"><dt>Author</dt><dd>Andy Lindsay</dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Parallax, Inc. 2014. All Rights MIT Licensed.</dd></dl>
<dl class="section user"><dt>Core Usage</dt><dd>Each call to soundImpact_run launches a monitoring loop into another core so that it. track the number of sound impacts during a certain time. The sensor can also be monitored without launching another core by simply checking its output state. See ...Documents/SimpleIDE/Learn/Examples/Devices/Sensor/Sound Impact for examples of both approaches.</dd></dl>
<dl class="section user"><dt>Memory Models</dt><dd>Use with CMM or LMM.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>0.5 </dd></dl>
</div><h2>Function Documentation</h2>
<a class="anchor" id="ab42e600b5d990db9233f7205b3581ea6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void soundImpact_end </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>processID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>End sound impact tracking process and recovers cog and stack memory for other purposes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">processID</td><td>process identifier returned by soundImpact_run. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a82f46c8715e87f2ac1fb73d7b8b97b0d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int soundImpact_getCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of impacts since last call to soundImpact_getCount. </p>
<dl class="section return"><dt>Returns</dt><dd>number of sound impacts since last call. </dd></dl>
</div>
</div>
<a class="anchor" id="aab39dffba4a8677c5077b32fad770c97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int* soundImpact_run </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>pin</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Runs the sound impact tracking process in another cog. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>Propeller I/O pin connected to sound impact SIG pin.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>*processID pointer to process identifier for use with soundImpact_end. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 9 2014 20:04:03 for soundimpact library by  <a href="html/http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>