raspberry_pi_iot 0.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. checksums.yaml +7 -0
  2. data/doc/Actuator.html +145 -0
  3. data/doc/BH1750.html +535 -0
  4. data/doc/BME280.html +276 -0
  5. data/doc/BMP280.html +276 -0
  6. data/doc/BMxSensor.html +559 -0
  7. data/doc/BinaryActuator.html +177 -0
  8. data/doc/BinaryEffector.html +246 -0
  9. data/doc/BinaryReceptor.html +387 -0
  10. data/doc/BinarySensor.html +168 -0
  11. data/doc/Bus.html +126 -0
  12. data/doc/Button.html +986 -0
  13. data/doc/DHT11.html +287 -0
  14. data/doc/DHT22.html +287 -0
  15. data/doc/DHTxxSensor.html +361 -0
  16. data/doc/DS18B20.html +339 -0
  17. data/doc/DigitalActuator.html +164 -0
  18. data/doc/DigitalEffector.html +636 -0
  19. data/doc/DigitalReceptor.html +242 -0
  20. data/doc/DigitalSensor.html +162 -0
  21. data/doc/Effector.html +257 -0
  22. data/doc/HCSR501.html +172 -0
  23. data/doc/HumitureSensor.html +453 -0
  24. data/doc/IoT.html +116 -0
  25. data/doc/LED.html +784 -0
  26. data/doc/MAX44009.html +830 -0
  27. data/doc/RaspberryPi.html +309 -0
  28. data/doc/Receptor.html +257 -0
  29. data/doc/Sensor.html +145 -0
  30. data/doc/TemperatureSensor.html +644 -0
  31. data/doc/_index.html +379 -0
  32. data/doc/class_list.html +51 -0
  33. data/doc/file_list.html +51 -0
  34. data/doc/frames.html +17 -0
  35. data/doc/index.html +379 -0
  36. data/doc/method_list.html +715 -0
  37. data/doc/top-level-namespace.html +112 -0
  38. data/lib/bh1750.rb +43 -0
  39. data/lib/binary_effector.rb +16 -0
  40. data/lib/binary_receptor.rb +23 -0
  41. data/lib/bmx_sensor.rb +86 -0
  42. data/lib/bus.rb +26 -0
  43. data/lib/button.rb +70 -0
  44. data/lib/dht_sensor.rb +36 -0
  45. data/lib/digital_effector.rb +56 -0
  46. data/lib/digital_receptor.rb +20 -0
  47. data/lib/ds18b20.rb +24 -0
  48. data/lib/effector.rb +32 -0
  49. data/lib/hcsr501.rb +7 -0
  50. data/lib/humiture_sensor.rb +26 -0
  51. data/lib/iot.rb +4 -0
  52. data/lib/led.rb +58 -0
  53. data/lib/led_pwm.rb +6 -0
  54. data/lib/led_rgb.rb +100 -0
  55. data/lib/max44009.rb +77 -0
  56. data/lib/raspberry_pi.rb +41 -0
  57. data/lib/raspberry_pi_iot.rb +3 -0
  58. data/lib/receptor.rb +33 -0
  59. data/lib/temperature_sensor.rb +49 -0
  60. data/lib/thermal_sensor.rb +22 -0
  61. metadata +203 -0
@@ -0,0 +1,559 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: BMxSensor
8
+
9
+ &mdash; Documentation by YARD 0.9.16
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "BMxSensor";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (B)</a> &raquo;
40
+
41
+
42
+ <span class="title">BMxSensor</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: BMxSensor
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="HumitureSensor.html" title="HumitureSensor (class)">HumitureSensor</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Receptor.html" title="Receptor (class)">Receptor</a></span></li>
78
+
79
+ <li class="next"><span class='object_link'><a href="DigitalReceptor.html" title="DigitalReceptor (class)">DigitalReceptor</a></span></li>
80
+
81
+ <li class="next"><span class='object_link'><a href="DigitalSensor.html" title="DigitalSensor (class)">DigitalSensor</a></span></li>
82
+
83
+ <li class="next"><span class='object_link'><a href="TemperatureSensor.html" title="TemperatureSensor (class)">TemperatureSensor</a></span></li>
84
+
85
+ <li class="next"><span class='object_link'><a href="HumitureSensor.html" title="HumitureSensor (class)">HumitureSensor</a></span></li>
86
+
87
+ <li class="next">BMxSensor</li>
88
+
89
+ </ul>
90
+ <a href="#" class="inheritanceTree">show all</a>
91
+
92
+ </dd>
93
+ </dl>
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+ <dl>
106
+ <dt>Defined in:</dt>
107
+ <dd>lib/bmx_sensor.rb</dd>
108
+ </dl>
109
+
110
+ </div>
111
+
112
+ <h2>Overview</h2><div class="docstring">
113
+ <div class="discussion">
114
+
115
+ <p>BMP/BME humidity, temperature &amp; atmospheric pressure sensor family</p>
116
+
117
+
118
+ </div>
119
+ </div>
120
+ <div class="tags">
121
+
122
+
123
+ </div><div id="subclasses">
124
+ <h2>Direct Known Subclasses</h2>
125
+ <p class="children"><span class='object_link'><a href="BME280.html" title="BME280 (class)">BME280</a></span>, <span class='object_link'><a href="BMP280.html" title="BMP280 (class)">BMP280</a></span></p>
126
+ </div>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <h2>
136
+ Instance Method Summary
137
+ <small><a href="#" class="summary_toggle">collapse</a></small>
138
+ </h2>
139
+
140
+ <ul class="summary">
141
+
142
+ <li class="public ">
143
+ <span class="summary_signature">
144
+
145
+ <a href="#hPa-instance_method" title="#hPa (instance method)">#<strong>hPa</strong> &#x21d2; Object </a>
146
+
147
+
148
+
149
+ </span>
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'>
160
+ <p>standard atmospheric pressure @ sea level = 1.01325 bar = 1013.25 mbar =
161
+ 101.325 kPa.</p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(sensor_name) &#x21d2; BMxSensor </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+
177
+ <span class="note title constructor">constructor</span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ <span class="summary_desc"><div class='inline'>
187
+ <p>A new instance of BMxSensor.</p>
188
+ </div></span>
189
+
190
+ </li>
191
+
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#pressure-instance_method" title="#pressure (instance method)">#<strong>pressure</strong>(mode = :hPa) &#x21d2; Object </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'></div></span>
211
+
212
+ </li>
213
+
214
+
215
+ <li class="public ">
216
+ <span class="summary_signature">
217
+
218
+ <a href="#read_data-instance_method" title="#read_data (instance method)">#<strong>read_data</strong> &#x21d2; Object </a>
219
+
220
+
221
+
222
+ </span>
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+ <span class="summary_desc"><div class='inline'></div></span>
233
+
234
+ </li>
235
+
236
+
237
+ <li class="public ">
238
+ <span class="summary_signature">
239
+
240
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
241
+
242
+
243
+
244
+ </span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+ <span class="summary_desc"><div class='inline'></div></span>
255
+
256
+ </li>
257
+
258
+
259
+ </ul>
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="HumitureSensor.html" title="HumitureSensor (class)">HumitureSensor</a></span></h3>
272
+ <p class="inherited"><span class='object_link'><a href="HumitureSensor.html#humidity-instance_method" title="HumitureSensor#humidity (method)">#humidity</a></span></p>
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="TemperatureSensor.html" title="TemperatureSensor (class)">TemperatureSensor</a></span></h3>
283
+ <p class="inherited"><span class='object_link'><a href="TemperatureSensor.html#celsius-instance_method" title="TemperatureSensor#celsius (method)">#celsius</a></span>, <span class='object_link'><a href="TemperatureSensor.html#fahrenheit-instance_method" title="TemperatureSensor#fahrenheit (method)">#fahrenheit</a></span>, <span class='object_link'><a href="TemperatureSensor.html#kelvin-instance_method" title="TemperatureSensor#kelvin (method)">#kelvin</a></span>, <span class='object_link'><a href="TemperatureSensor.html#reaumur-instance_method" title="TemperatureSensor#reaumur (method)">#reaumur</a></span>, <span class='object_link'><a href="TemperatureSensor.html#temperature-instance_method" title="TemperatureSensor#temperature (method)">#temperature</a></span></p>
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="DigitalReceptor.html" title="DigitalReceptor (class)">DigitalReceptor</a></span></h3>
300
+ <p class="inherited"><span class='object_link'><a href="DigitalReceptor.html#one_wire_file-class_method" title="DigitalReceptor.one_wire_file (method)">one_wire_file</a></span></p>
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Receptor.html" title="Receptor (class)">Receptor</a></span></h3>
311
+ <p class="inherited"><span class='object_link'><a href="Receptor.html#model_name-instance_method" title="Receptor#model_name (method)">#model_name</a></span>, <span class='object_link'><a href="Receptor.html#name-instance_method" title="Receptor#name (method)">#name</a></span></p>
312
+ <div id="constructor_details" class="method_details_list">
313
+ <h2>Constructor Details</h2>
314
+
315
+ <div class="method_details first">
316
+ <h3 class="signature first" id="initialize-instance_method">
317
+
318
+ #<strong>initialize</strong>(sensor_name) &#x21d2; <tt><span class='object_link'><a href="" title="BMxSensor (class)">BMxSensor</a></span></tt>
319
+
320
+
321
+
322
+
323
+
324
+ </h3><div class="docstring">
325
+ <div class="discussion">
326
+
327
+ <p>Returns a new instance of BMxSensor</p>
328
+
329
+
330
+ </div>
331
+ </div>
332
+ <div class="tags">
333
+
334
+
335
+ </div><table class="source_code">
336
+ <tr>
337
+ <td>
338
+ <pre class="lines">
339
+
340
+
341
+ 8
342
+ 9
343
+ 10
344
+ 11
345
+ 12
346
+ 13</pre>
347
+ </td>
348
+ <td>
349
+ <pre class="code"><span class="info file"># File 'lib/bmx_sensor.rb', line 8</span>
350
+
351
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_sensor_name'>sensor_name</span><span class='rparen'>)</span>
352
+ <span class='ivar'>@sensor_name</span> <span class='op'>=</span> <span class='id identifier rubyid_sensor_name'>sensor_name</span>
353
+
354
+ <span class='ivar'>@sensor</span> <span class='op'>=</span> <span class='const'>I2CDevice</span><span class='op'>::</span><span class='const'>Bme280</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
355
+ <span class='ivar'>@temperature</span><span class='comma'>,</span> <span class='ivar'>@humidity</span><span class='comma'>,</span> <span class='ivar'>@pressure</span> <span class='op'>=</span> <span class='id identifier rubyid_read_data'>read_data</span>
356
+ <span class='kw'>end</span></pre>
357
+ </td>
358
+ </tr>
359
+ </table>
360
+ </div>
361
+
362
+ </div>
363
+
364
+
365
+ <div id="instance_method_details" class="method_details_list">
366
+ <h2>Instance Method Details</h2>
367
+
368
+
369
+ <div class="method_details first">
370
+ <h3 class="signature first" id="hPa-instance_method">
371
+
372
+ #<strong>hPa</strong> &#x21d2; <tt>Object</tt>
373
+
374
+
375
+
376
+
377
+
378
+ </h3><div class="docstring">
379
+ <div class="discussion">
380
+
381
+ <p>standard atmospheric pressure @ sea level = 1.01325 bar = 1013.25 mbar =
382
+ 101.325 kPa</p>
383
+
384
+
385
+ </div>
386
+ </div>
387
+ <div class="tags">
388
+
389
+
390
+ </div><table class="source_code">
391
+ <tr>
392
+ <td>
393
+ <pre class="lines">
394
+
395
+
396
+ 24
397
+ 25
398
+ 26</pre>
399
+ </td>
400
+ <td>
401
+ <pre class="code"><span class="info file"># File 'lib/bmx_sensor.rb', line 24</span>
402
+
403
+ <span class='kw'>def</span> <span class='id identifier rubyid_hPa'>hPa</span>
404
+ <span class='ivar'>@pressure</span>
405
+ <span class='kw'>end</span></pre>
406
+ </td>
407
+ </tr>
408
+ </table>
409
+ </div>
410
+
411
+ <div class="method_details ">
412
+ <h3 class="signature " id="pressure-instance_method">
413
+
414
+ #<strong>pressure</strong>(mode = :hPa) &#x21d2; <tt>Object</tt>
415
+
416
+
417
+
418
+
419
+
420
+ </h3><table class="source_code">
421
+ <tr>
422
+ <td>
423
+ <pre class="lines">
424
+
425
+
426
+ 28
427
+ 29
428
+ 30
429
+ 31
430
+ 32
431
+ 33
432
+ 34
433
+ 35
434
+ 36
435
+ 37
436
+ 38
437
+ 39
438
+ 40
439
+ 41
440
+ 42
441
+ 43
442
+ 44
443
+ 45
444
+ 46
445
+ 47
446
+ 48
447
+ 49</pre>
448
+ </td>
449
+ <td>
450
+ <pre class="code"><span class="info file"># File 'lib/bmx_sensor.rb', line 28</span>
451
+
452
+ <span class='kw'>def</span> <span class='id identifier rubyid_pressure'>pressure</span><span class='lparen'>(</span><span class='id identifier rubyid_mode'>mode</span><span class='op'>=</span><span class='symbol'>:hPa</span><span class='rparen'>)</span>
453
+ <span class='kw'>case</span> <span class='id identifier rubyid_mode'>mode</span>
454
+ <span class='kw'>when</span> <span class='symbol'>:hPa</span> <span class='comment'># 1 hPa = 100 Pa = 1 mbar = 1 hPa = 0.750062 mmHg [@ 0°C]
455
+ </span> <span class='id identifier rubyid_hPa'>hPa</span>
456
+ <span class='kw'>when</span> <span class='symbol'>:kPa</span> <span class='comment'># 1 kPa = 1000 Pa = 10 hPa
457
+ </span> <span class='id identifier rubyid_hPa'>hPa</span> <span class='op'>/</span> <span class='float'>10.0</span>
458
+ <span class='kw'>when</span> <span class='symbol'>:Pa</span> <span class='comment'># 1 Pa = 0.01 hPa = 0.001 kPa
459
+ </span> <span class='id identifier rubyid_hPa'>hPa</span> <span class='op'>*</span> <span class='float'>100.0</span>
460
+ <span class='kw'>when</span> <span class='symbol'>:mmHg</span> <span class='comment'># 1 mmHg = 1.3332236842105263 hPa = 133.322387415 Pa = 1.000000142466321... Torr
461
+ </span> <span class='id identifier rubyid_hPa'>hPa</span> <span class='op'>/</span> <span class='lparen'>(</span><span class='float'>1013.25</span> <span class='op'>/</span> <span class='int'>760</span><span class='rparen'>)</span> <span class='comment'># 760 mmHg = 101.3250144354 kPa
462
+ </span> <span class='kw'>when</span> <span class='symbol'>:atm</span> <span class='comment'># 1 atm = 101325 Pa = 101.325 kPa
463
+ </span> <span class='id identifier rubyid_hPa'>hPa</span> <span class='op'>/</span> <span class='float'>1013.25</span>
464
+ <span class='kw'>when</span> <span class='symbol'>:bar</span> <span class='comment'># 1 bar ≡ 100000 Pa = 1000 hPa = 0.987 atm = 750.06 mmHg = 750.06 Torr
465
+ </span> <span class='id identifier rubyid_hPa'>hPa</span> <span class='op'>/</span> <span class='float'>1000.0</span>
466
+ <span class='kw'>when</span> <span class='symbol'>:mbar</span> <span class='comment'># 1 mbar = 0.001 bar
467
+ </span> <span class='id identifier rubyid_bar'>bar</span> <span class='op'>*</span> <span class='float'>1000.0</span>
468
+ <span class='kw'>when</span> <span class='symbol'>:Torr</span> <span class='comment'># 1 Torr = 1/760 atm = 101325/760 Pa = 0.999999857533699... mmHg
469
+ </span> <span class='lparen'>(</span><span class='id identifier rubyid_hPa'>hPa</span> <span class='op'>/</span> <span class='float'>1013.25</span><span class='rparen'>)</span> <span class='op'>/</span> <span class='int'>760</span>
470
+ <span class='kw'>else</span>
471
+ <span class='id identifier rubyid_hPa'>hPa</span>
472
+ <span class='kw'>end</span>
473
+ <span class='kw'>end</span></pre>
474
+ </td>
475
+ </tr>
476
+ </table>
477
+ </div>
478
+
479
+ <div class="method_details ">
480
+ <h3 class="signature " id="read_data-instance_method">
481
+
482
+ #<strong>read_data</strong> &#x21d2; <tt>Object</tt>
483
+
484
+
485
+
486
+
487
+
488
+ </h3><table class="source_code">
489
+ <tr>
490
+ <td>
491
+ <pre class="lines">
492
+
493
+
494
+ 15
495
+ 16
496
+ 17
497
+ 18
498
+ 19
499
+ 20
500
+ 21</pre>
501
+ </td>
502
+ <td>
503
+ <pre class="code"><span class="info file"># File 'lib/bmx_sensor.rb', line 15</span>
504
+
505
+ <span class='kw'>def</span> <span class='id identifier rubyid_read_data'>read_data</span>
506
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@sensor</span><span class='period'>.</span><span class='id identifier rubyid_calc_sensor_data'>calc_sensor_data</span>
507
+ <span class='ivar'>@temperature</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:temp</span><span class='rbracket'>]</span>
508
+ <span class='ivar'>@pressure</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:pressure</span><span class='rbracket'>]</span>
509
+ <span class='ivar'>@humidity</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hum</span><span class='rbracket'>]</span>
510
+ <span class='lbracket'>[</span><span class='ivar'>@temperature</span><span class='comma'>,</span> <span class='ivar'>@humidity</span><span class='comma'>,</span> <span class='ivar'>@pressure</span><span class='rbracket'>]</span>
511
+ <span class='kw'>end</span></pre>
512
+ </td>
513
+ </tr>
514
+ </table>
515
+ </div>
516
+
517
+ <div class="method_details ">
518
+ <h3 class="signature " id="to_s-instance_method">
519
+
520
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
521
+
522
+
523
+
524
+
525
+
526
+ </h3><table class="source_code">
527
+ <tr>
528
+ <td>
529
+ <pre class="lines">
530
+
531
+
532
+ 51
533
+ 52
534
+ 53</pre>
535
+ </td>
536
+ <td>
537
+ <pre class="code"><span class="info file"># File 'lib/bmx_sensor.rb', line 51</span>
538
+
539
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
540
+ <span class='id identifier rubyid_sprintf'>sprintf</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%5.2f°C, %5.2f %%, %5.2f mmHg</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='ivar'>@temperature</span><span class='comma'>,</span> <span class='ivar'>@humidity</span><span class='comma'>,</span> <span class='id identifier rubyid_pressure'>pressure</span><span class='lparen'>(</span><span class='symbol'>:mmHg</span><span class='rparen'>)</span>
541
+ <span class='kw'>end</span></pre>
542
+ </td>
543
+ </tr>
544
+ </table>
545
+ </div>
546
+
547
+ </div>
548
+
549
+ </div>
550
+
551
+ <div id="footer">
552
+ Generated on Tue Dec 11 17:46:27 2018 by
553
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
554
+ 0.9.16 (ruby-2.3.3).
555
+ </div>
556
+
557
+ </div>
558
+ </body>
559
+ </html>