Skip to content

Commit

Permalink
Regenerates documentation for v0.5.5
Browse files Browse the repository at this point in the history
  • Loading branch information
hlapp committed Feb 12, 2017
1 parent 029cdb9 commit d752c5c
Show file tree
Hide file tree
Showing 46 changed files with 22,716 additions and 0 deletions.
258 changes: 258 additions & 0 deletions docs/wirelesstags/0.5.5/MonitoringConfig.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: MonitoringConfig</title>

<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

<h1 class="page-title">Class: MonitoringConfig</h1>






<section>

<header>

<h2>MonitoringConfig</h2>


</header>

<article>
<div class="container-overview">





<h4 class="name" id="MonitoringConfig"><span class="type-signature"></span>new MonitoringConfig<span class="signature">(sensorType, data<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>





<div class="description">
<p>The monitoring configuration of a <a href="WirelessTagSensor.html"><code>WirelessTagSensor</code></a>.</p>
<p>A user will not normally need to create instances directly; instead
they are returned from <code>WirelessTagSensor#monitoringConfig</code>.</p>
</div>









<h5>Parameters:</h5>


<table class="params">
<thead>
<tr>

<th>Name</th>


<th>Type</th>


<th>Attributes</th>




<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>sensorType</code></td>


<td class="type">


<span class="param-type">string</span>



</td>


<td class="attributes">





</td>




<td class="description last"><p>the type of the sensor</p></td>
</tr>



<tr>

<td class="name"><code>data</code></td>


<td class="type">


<span class="param-type">Object</span>



</td>


<td class="attributes">

&lt;optional><br>





</td>




<td class="description last"><p>the object with the status properties and
values for this monitoring configuration, as
returned by the API endpoint</p></td>
</tr>


</tbody>
</table>






<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_sensor.js.html">lib/sensor.js</a>, <a href="lib_sensor.js.html#line683">line 683</a>
</li></ul></dd>







</dl>

















</div>


















</article>

</section>




</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-lib_platform.html">lib/platform</a></li><li><a href="module-plugins_interval-updater.html">plugins/interval-updater</a></li><li><a href="module-plugins_polling-updater.html">plugins/polling-updater</a></li><li><a href="module-wirelesstags.html">wirelesstags</a></li></ul><h3>Classes</h3><ul><li><a href="module-plugins_interval-updater-TimedTagUpdater.html">TimedTagUpdater</a></li><li><a href="module-plugins_polling-updater-PollingTagUpdater.html">PollingTagUpdater</a></li><li><a href="MonitoringConfig.html">MonitoringConfig</a></li><li><a href="WirelessTag.html">WirelessTag</a></li><li><a href="WirelessTagManager.html">WirelessTagManager</a></li><li><a href="WirelessTagPlatform.html">WirelessTagPlatform</a></li><li><a href="WirelessTagSensor.html">WirelessTagSensor</a></li></ul><h3>Events</h3><ul><li><a href="WirelessTagPlatform.html#event:connect">connect</a></li><li><a href="WirelessTagPlatform.html#event:discover">discover</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-auto-update-polling.js.html">auto-update-polling.js</a></li><li><a href="tutorial-read-sensors.js.html">read-sensors.js</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Loading

0 comments on commit d752c5c

Please sign in to comment.