Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathsrc_module_Led.js.html
More file actions
316 lines (288 loc) · 10.6 KB
/
Copy pathsrc_module_Led.js.html
File metadata and controls
316 lines (288 loc) · 10.6 KB
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>src/module/Led.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/Led.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 Pin = scope.Pin,
Module = scope.Module,
BoardEvent = scope.BoardEvent,
proto;
/**
* The Led class.
*
* @namespace webduino.module
* @class Led
* @constructor
* @param {webduino.Board} board The board the LED is attached to.
* @param {webduino.Pin} pin The pin the LED is connected to.
* @param {Number} [driveMode] Drive mode the LED is operating at, either Led.SOURCE_DRIVE or Led.SYNC_DRIVE.
* @extends webduino.Module
*/
function Led(board, pin, driveMode) {
Module.call(this);
this._board = board;
this._pin = pin;
this._driveMode = driveMode || Led.SOURCE_DRIVE;
this._supportsPWM = undefined;
this._blinkTimer = null;
this._board.on(BoardEvent.BEFOREDISCONNECT, this._clearBlinkTimer.bind(this));
this._board.on(BoardEvent.ERROR, this._clearBlinkTimer.bind(this));
if (this._driveMode === Led.SOURCE_DRIVE) {
this._onValue = 1;
this._offValue = 0;
} else if (this._driveMode === Led.SYNC_DRIVE) {
this._onValue = 0;
this._offValue = 1;
} else {
throw new Error('driveMode should be Led.SOURCE_DRIVE or Led.SYNC_DRIVE');
}
if (pin.capabilities[Pin.PWM]) {
board.setDigitalPinMode(pin.number, Pin.PWM);
this._supportsPWM = true;
} else {
board.setDigitalPinMode(pin.number, Pin.DOUT);
this._supportsPWM = false;
}
}
function checkPinState(self, pin, state, callback) {
self._board.queryPinState(pin, function (pin) {
if (pin.state === state) {
callback.call(self);
}
});
}
Led.prototype = proto = Object.create(Module.prototype, {
constructor: {
value: Led
},
/**
* Intensity of the LED.
*
* @attribute intensity
* @type {Number}
*/
intensity: {
get: function () {
return this._pin.value;
},
set: function (val) {
if (!this._supportsPWM) {
if (val < 0.5) {
val = 0;
} else {
val = 1;
}
}
if (this._driveMode === Led.SOURCE_DRIVE) {
this._pin.value = val;
} else if (this._driveMode === Led.SYNC_DRIVE) {
this._pin.value = 1 - val;
}
}
}
});
/**
* Light up the LED.
*
* @method on
* @param {Function} [callback] LED state changed callback.
*/
proto.on = function (callback) {
this._clearBlinkTimer();
this._pin.value = this._onValue;
if (typeof callback === 'function') {
checkPinState(this, this._pin, this._pin.value, callback);
}
};
/**
* Dim the LED.
*
* @method off
* @param {Function} [callback] LED state changed callback.
*/
proto.off = function (callback) {
this._clearBlinkTimer();
this._pin.value = this._offValue;
if (typeof callback === 'function') {
checkPinState(this, this._pin, this._pin.value, callback);
}
};
/**
* Toggle LED state between on/off.
*
* @method toggle
* @param {Function} [callback] State changed callback.
*/
proto.toggle = function (callback) {
if (this._blinkTimer) {
this.off();
} else {
this._pin.value = 1 - this._pin.value;
}
if (typeof callback === 'function') {
checkPinState(this, this._pin, this._pin.value, callback);
}
};
/**
* Blink the LED.
*
* @method blink
* @param {Number} [interval=1000] Led blinking interval.
* @param {Function} [callback] Led state changed callback.
*/
proto.blink = function (interval, callback) {
if (arguments.length === 1 && typeof arguments[0] === 'function') {
callback = arguments[0];
}
interval = parseInt(interval);
interval = isNaN(interval) || interval <= 0 ? 1000 : interval;
this._clearBlinkTimer();
this._blinkTimer = this._blink(interval, callback);
};
proto._blink = function (interval, callback) {
var self = this;
return setTimeout(function () {
self._pin.value = 1 - self._pin.value;
if (typeof callback === 'function') {
checkPinState(self, self._pin, self._pin.value, callback);
}
self._blinkTimer = self._blink(interval, callback);
}, interval);
};
proto._clearBlinkTimer = function () {
if (this._blinkTimer) {
clearTimeout(this._blinkTimer);
this._blinkTimer = null;
}
};
/**
* Indicates the source LED drive mode.
*
* @property SOURCE_DRIVE
* @type Number
* @static
* @final
*/
Led.SOURCE_DRIVE = 0;
/**
* Indicates the synchronous LED drive mode.
*
* @property SYNC_DRIVE
* @type Number
* @static
* @final
*/
Led.SYNC_DRIVE = 1;
scope.module.Led = Led;
}));
</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>
You can’t perform that action at this time.