-
Notifications
You must be signed in to change notification settings - Fork 24
/
Copy pathsrc_module_Soil.js.html
234 lines (212 loc) · 8.4 KB
/
src_module_Soil.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>src/module/Soil.js - webduino-js</title>
<link rel="stylesheet" href="">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="stylesheet" href="../assets/css/custom.css">
<link rel="stylesheet" href="../assets/css/lucid.css">
<link rel="stylesheet" href="../assets/vendor/bootstrap/css/bootstrap.css">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
</head>
<body class="yui3-skin-sam">
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20px; margin-left: 0;">
webduino-js
</h1>
<div class="nav">
<li class="divider-vertical"></li>
<li>
<p class="navbar-text">
API Docs for Version: <b>0.7.0</b>
</p>
</li>
</div>
<form class="navbar-form pull-right" style="line-height: 40px; height: 40px;">
<input style="margin-top: 0;" type="text" class="search-query" placeholder="Search for classes/modules..." data-obj='["classes/webduino.Board", "classes/webduino.EventEmitter", "classes/webduino.Module", "classes/webduino.module.ADXL345", "classes/webduino.module.Barcode", "classes/webduino.module.Button", "classes/webduino.module.Buzzer", "classes/webduino.module.Dht", "classes/webduino.module.HX711", "classes/webduino.module.IRLed", "classes/webduino.module.IRRecv", "classes/webduino.module.Led", "classes/webduino.module.Max7219", "classes/webduino.module.Photocell", "classes/webduino.module.RFID", "classes/webduino.module.RGBLed", "classes/webduino.module.Soil", "classes/webduino.module.Ultrasonic", "classes/webduino.Transport", "classes/webduino.transport.MqttTransport", "classes/webduino.transport.NodeMqttTransport"]'>
</form>
</div>
</div>
<div class="container">
<div class="row">
<div class="span3">
<div>
<div id="sidebar">
<div id="classes">
<ul id="api-classes" class="nav nav-list">
<li><a href="../classes/webduino.Board.html">webduino.Board</a></li>
<li><a href="../classes/webduino.EventEmitter.html">webduino.EventEmitter</a></li>
<li><a href="../classes/webduino.Module.html">webduino.Module</a></li>
<li><a href="../classes/webduino.module.ADXL345.html">webduino.module.ADXL345</a></li>
<li><a href="../classes/webduino.module.Barcode.html">webduino.module.Barcode</a></li>
<li><a href="../classes/webduino.module.Button.html">webduino.module.Button</a></li>
<li><a href="../classes/webduino.module.Buzzer.html">webduino.module.Buzzer</a></li>
<li><a href="../classes/webduino.module.Dht.html">webduino.module.Dht</a></li>
<li><a href="../classes/webduino.module.HX711.html">webduino.module.HX711</a></li>
<li><a href="../classes/webduino.module.IRLed.html">webduino.module.IRLed</a></li>
<li><a href="../classes/webduino.module.IRRecv.html">webduino.module.IRRecv</a></li>
<li><a href="../classes/webduino.module.Led.html">webduino.module.Led</a></li>
<li><a href="../classes/webduino.module.Max7219.html">webduino.module.Max7219</a></li>
<li><a href="../classes/webduino.module.Photocell.html">webduino.module.Photocell</a></li>
<li><a href="../classes/webduino.module.RFID.html">webduino.module.RFID</a></li>
<li><a href="../classes/webduino.module.RGBLed.html">webduino.module.RGBLed</a></li>
<li><a href="../classes/webduino.module.Soil.html">webduino.module.Soil</a></li>
<li><a href="../classes/webduino.module.Ultrasonic.html">webduino.module.Ultrasonic</a></li>
<li><a href="../classes/webduino.Transport.html">webduino.Transport</a></li>
<li><a href="../classes/webduino.transport.MqttTransport.html">webduino.transport.MqttTransport</a></li>
<li><a href="../classes/webduino.transport.NodeMqttTransport.html">webduino.transport.NodeMqttTransport</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="span9">
<form id="options-form" class="form-inline pull-right">
Show:
<label for="api-show-inherited" class="checkbox">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected" class="checkbox">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private" class="checkbox">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated" class="checkbox">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</form>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<div class="page-header">
<h1>src/module/Soil.js <small>File</small></h1>
</div>
<div class="file">
<pre class="prettyprint linenums">
+(function (global, factory) {
if (typeof exports === 'undefined') {
factory(global.webduino || {});
} else {
module.exports = factory;
}
}(this, function (scope) {
'use strict';
var Module = scope.Module,
BoardEvent = scope.BoardEvent,
proto;
var SoilEvent = {
/**
* Fires when the value of humidity has changed.
*
* @event PhotocellEvent.MESSAGE
*/
MESSAGE: 'message'
};
/**
* The Soil class.
*
* @namespace webduino.module
* @class Soil
* @constructor
* @param {webduino.Board} board Board that the soil is attached to.
* @param {Integer} analogPinNumber The pin that soil is attached to.
* @extends webduino.Module
*/
function Soil(board, analogPinNumber) {
Module.call(this);
this._board = board;
this._pinNumber = Number(analogPinNumber);
this._messageHandler = onMessage.bind(this);
}
function formatter(val) {
val = Math.round(val * 10000) / 100;
return val;
}
function onMessage(event) {
var pin = event.pin;
if (this._pinNumber !== pin.analogNumber) {
return false;
}
this.emit(SoilEvent.MESSAGE, formatter(pin.value));
}
Soil.prototype = proto = Object.create(Module.prototype, {
constructor: {
value: Soil
},
/**
* The state indicating whether the module is scanning.
*
* @attribute state
* @type {String} `on` or `off`
*/
state: {
get: function() {
return this._state;
},
set: function(val) {
this._state = val;
}
}
});
/**
* Start detection.
*
* @method measure
* @param {Function} [callback] Callback after starting detection.
*/
/**
* Start detection.
*
* @method on
* @param {Function} [callback] Callback after starting detection.
* @deprecated `on()` is deprecated, use `measure()` instead.
*/
proto.measure = proto.on = function(callback) {
this._board.enableAnalogPin(this._pinNumber);
if (typeof callback !== 'function') {
callback = function() {};
}
this._callback = function(val) {
callback(val);
};
this._state = 'on';
this._board.on(BoardEvent.ANALOG_DATA, this._messageHandler);
this.addListener(SoilEvent.MESSAGE, this._callback);
};
/**
* Stop detection.
*
* @method off
*/
proto.off = function() {
this._state = 'off';
this._board.disableAnalogPin(this._pinNumber);
this._board.removeListener(BoardEvent.ANALOG_DATA, this._messageHandler);
this.removeListener(SoilEvent.MESSAGE, this._callback);
this._callback = null;
};
scope.module.Soil = Soil;
}));
</pre>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/jquery/jquery-1.8.2.min.js"></script>
<script src="../assets/vendor/bootstrap/js/bootstrap.js"></script>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script src="../assets/js/yuidoc-bootstrap.js"></script>
<script>prettyPrint();</script>
</body>
</html>