helium-ruby 0.20.0 → 0.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +47 -0
- data/docs/Helium.html +6 -6
- data/docs/Helium/Client.html +62 -34
- data/docs/Helium/Client/Configurations.html +296 -0
- data/docs/Helium/Client/DeviceConfigurations.html +465 -0
- data/docs/Helium/Client/Elements.html +92 -18
- data/docs/Helium/Client/Http.html +86 -28
- data/docs/Helium/Client/Labels.html +29 -86
- data/docs/Helium/Client/Organizations.html +5 -75
- data/docs/Helium/Client/Sensors.html +147 -17
- data/docs/Helium/Client/Users.html +5 -9
- data/docs/Helium/ClientError.html +3 -3
- data/docs/Helium/Collection.html +1053 -0
- data/docs/Helium/Configuration.html +380 -0
- data/docs/Helium/Cursor.html +7 -3
- data/docs/Helium/DataPoint.html +16 -5
- data/docs/Helium/DeviceConfiguration.html +476 -0
- data/docs/Helium/Element.html +203 -43
- data/docs/Helium/Error.html +15 -5
- data/docs/Helium/InvalidApiKey.html +3 -3
- data/docs/Helium/Label.html +35 -36
- data/docs/Helium/Metadata.html +589 -0
- data/docs/Helium/Organization.html +236 -17
- data/docs/Helium/Resource.html +655 -161
- data/docs/Helium/Sensor.html +345 -111
- data/docs/Helium/Timeseries.html +354 -0
- data/docs/Helium/User.html +161 -18
- data/docs/Helium/Utils.html +56 -4
- data/docs/_index.html +72 -7
- data/docs/class_list.html +1 -1
- data/docs/css/style.css +8 -1
- data/docs/file.README.html +66 -6
- data/docs/frames.html +1 -1
- data/docs/index.html +66 -6
- data/docs/method_list.html +619 -139
- data/docs/top-level-namespace.html +3 -3
- data/lib/helium.rb +2 -0
- data/lib/helium/client/configurations.rb +0 -12
- data/lib/helium/client/elements.rb +0 -12
- data/lib/helium/client/labels.rb +1 -12
- data/lib/helium/client/organizations.rb +1 -47
- data/lib/helium/client/sensors.rb +0 -12
- data/lib/helium/client/users.rb +1 -3
- data/lib/helium/collection.rb +129 -0
- data/lib/helium/configuration.rb +5 -1
- data/lib/helium/element.rb +1 -1
- data/lib/helium/label.rb +1 -3
- data/lib/helium/metadata.rb +58 -0
- data/lib/helium/organization.rb +4 -4
- data/lib/helium/resource.rb +28 -29
- data/lib/helium/sensor.rb +1 -1
- data/lib/helium/version.rb +1 -1
- metadata +11 -2
data/docs/Helium/Sensor.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: Helium::Sensor
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.5
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -113,7 +113,7 @@
|
|
113
113
|
<li class="public ">
|
114
114
|
<span class="summary_signature">
|
115
115
|
|
116
|
-
<a href="#
|
116
|
+
<a href="#last_seen-instance_method" title="#last_seen (instance method)">#<strong>last_seen</strong> ⇒ DateTime<sup>?</sup> </a>
|
117
117
|
|
118
118
|
|
119
119
|
|
@@ -132,7 +132,7 @@
|
|
132
132
|
|
133
133
|
|
134
134
|
|
135
|
-
<span class="summary_desc"><div class='inline'><p>
|
135
|
+
<span class="summary_desc"><div class='inline'><p>When the resource was last seen.</p>
|
136
136
|
</div></span>
|
137
137
|
|
138
138
|
</li>
|
@@ -141,7 +141,7 @@
|
|
141
141
|
<li class="public ">
|
142
142
|
<span class="summary_signature">
|
143
143
|
|
144
|
-
<a href="#
|
144
|
+
<a href="#mac-instance_method" title="#mac (instance method)">#<strong>mac</strong> ⇒ Object </a>
|
145
145
|
|
146
146
|
|
147
147
|
|
@@ -160,7 +160,7 @@
|
|
160
160
|
|
161
161
|
|
162
162
|
|
163
|
-
<span class="summary_desc"><div class='inline'><p>
|
163
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute mac.</p>
|
164
164
|
</div></span>
|
165
165
|
|
166
166
|
</li>
|
@@ -169,7 +169,7 @@
|
|
169
169
|
<li class="public ">
|
170
170
|
<span class="summary_signature">
|
171
171
|
|
172
|
-
<a href="#
|
172
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a>
|
173
173
|
|
174
174
|
|
175
175
|
|
@@ -188,7 +188,7 @@
|
|
188
188
|
|
189
189
|
|
190
190
|
|
191
|
-
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute
|
191
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p>
|
192
192
|
</div></span>
|
193
193
|
|
194
194
|
</li>
|
@@ -197,7 +197,7 @@
|
|
197
197
|
<li class="public ">
|
198
198
|
<span class="summary_signature">
|
199
199
|
|
200
|
-
<a href="#
|
200
|
+
<a href="#ports-instance_method" title="#ports (instance method)">#<strong>ports</strong> ⇒ Object </a>
|
201
201
|
|
202
202
|
|
203
203
|
|
@@ -216,16 +216,34 @@
|
|
216
216
|
|
217
217
|
|
218
218
|
|
219
|
-
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute
|
219
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute ports.</p>
|
220
220
|
</div></span>
|
221
221
|
|
222
222
|
</li>
|
223
223
|
|
224
224
|
|
225
|
-
|
225
|
+
</ul>
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
232
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span>, <span class='object_link'><a href="Resource.html#params-instance_method" title="Helium::Resource#params (method)">#params</a></span>, <span class='object_link'><a href="Resource.html#type-instance_method" title="Helium::Resource#type (method)">#type</a></span></p>
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
<h2>
|
237
|
+
Class Method Summary
|
238
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
239
|
+
</h2>
|
240
|
+
|
241
|
+
<ul class="summary">
|
242
|
+
|
243
|
+
<li class="public ">
|
226
244
|
<span class="summary_signature">
|
227
245
|
|
228
|
-
<a href="#
|
246
|
+
<a href="#all_path-class_method" title="all_path (class method)">.<strong>all_path</strong> ⇒ Object </a>
|
229
247
|
|
230
248
|
|
231
249
|
|
@@ -233,10 +251,36 @@
|
|
233
251
|
|
234
252
|
|
235
253
|
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
261
|
+
|
262
|
+
</li>
|
263
|
+
|
264
|
+
|
265
|
+
</ul>
|
266
|
+
|
267
|
+
<h2>
|
268
|
+
Instance Method Summary
|
269
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
270
|
+
</h2>
|
271
|
+
|
272
|
+
<ul class="summary">
|
273
|
+
|
274
|
+
<li class="public ">
|
275
|
+
<span class="summary_signature">
|
236
276
|
|
237
|
-
<
|
277
|
+
<a href="#as_json-instance_method" title="#as_json (instance method)">#<strong>as_json</strong> ⇒ Object </a>
|
238
278
|
|
279
|
+
|
239
280
|
|
281
|
+
</span>
|
282
|
+
|
283
|
+
|
240
284
|
|
241
285
|
|
242
286
|
|
@@ -244,34 +288,38 @@
|
|
244
288
|
|
245
289
|
|
246
290
|
|
247
|
-
<span class="summary_desc"><div class='inline'><p>
|
291
|
+
<span class="summary_desc"><div class='inline'><p>TODO can probably generalize this a bit more.</p>
|
248
292
|
</div></span>
|
249
293
|
|
250
294
|
</li>
|
251
295
|
|
296
|
+
|
297
|
+
<li class="public ">
|
298
|
+
<span class="summary_signature">
|
299
|
+
|
300
|
+
<a href="#device_configuration-instance_method" title="#device_configuration (instance method)">#<strong>device_configuration</strong> ⇒ Object </a>
|
252
301
|
|
253
|
-
</ul>
|
254
|
-
|
255
|
-
|
256
302
|
|
303
|
+
|
304
|
+
</span>
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
|
257
310
|
|
258
311
|
|
259
|
-
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
260
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span>, <span class='object_link'><a href="Resource.html#type-instance_method" title="Helium::Resource#type (method)">#type</a></span></p>
|
261
|
-
|
262
312
|
|
263
313
|
|
264
|
-
<
|
265
|
-
|
266
|
-
|
267
|
-
</h2>
|
314
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
315
|
+
|
316
|
+
</li>
|
268
317
|
|
269
|
-
<ul class="summary">
|
270
318
|
|
271
319
|
<li class="public ">
|
272
320
|
<span class="summary_signature">
|
273
321
|
|
274
|
-
<a href="#
|
322
|
+
<a href="#element-instance_method" title="#element (instance method)">#<strong>element</strong> ⇒ Object </a>
|
275
323
|
|
276
324
|
|
277
325
|
|
@@ -285,8 +333,7 @@
|
|
285
333
|
|
286
334
|
|
287
335
|
|
288
|
-
<span class="summary_desc"><div class='inline'
|
289
|
-
</div></span>
|
336
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
290
337
|
|
291
338
|
</li>
|
292
339
|
|
@@ -313,6 +360,28 @@
|
|
313
360
|
<span class="summary_desc"><div class='inline'><p>A new instance of Sensor.</p>
|
314
361
|
</div></span>
|
315
362
|
|
363
|
+
</li>
|
364
|
+
|
365
|
+
|
366
|
+
<li class="public ">
|
367
|
+
<span class="summary_signature">
|
368
|
+
|
369
|
+
<a href="#labels-instance_method" title="#labels (instance method)">#<strong>labels</strong> ⇒ Object </a>
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
</span>
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
384
|
+
|
316
385
|
</li>
|
317
386
|
|
318
387
|
|
@@ -333,6 +402,28 @@
|
|
333
402
|
|
334
403
|
|
335
404
|
|
405
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
406
|
+
|
407
|
+
</li>
|
408
|
+
|
409
|
+
|
410
|
+
<li class="public ">
|
411
|
+
<span class="summary_signature">
|
412
|
+
|
413
|
+
<a href="#virtual%3F-instance_method" title="#virtual? (instance method)">#<strong>virtual?</strong> ⇒ Boolean </a>
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
</span>
|
418
|
+
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
|
336
427
|
<span class="summary_desc"><div class='inline'></div></span>
|
337
428
|
|
338
429
|
</li>
|
@@ -351,7 +442,18 @@
|
|
351
442
|
|
352
443
|
|
353
444
|
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Resource.html" title="Helium::Resource (class)">Resource</a></span></h3>
|
354
|
-
<p class="inherited"><span class='object_link'><a href="Resource.html#%3D%3D-instance_method" title="Helium::Resource#== (method)">#==</a></span>, <span class='object_link'><a href="Resource.html#all-class_method" title="Helium::Resource.all (method)">all</a></span>, <span class='object_link'><a href="Resource.html#create-class_method" title="Helium::Resource.create (method)">create</a></span>, <span class='object_link'><a href="Resource.html#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</a></span>, <span class='object_link'><a href="Resource.html#destroy-instance_method" title="Helium::Resource#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Resource.html#eql%3F-instance_method" title="Helium::Resource#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Resource.html#find-class_method" title="Helium::Resource.find (method)">find</a></span>, <span class='object_link'><a href="Resource.html#hash-instance_method" title="Helium::Resource#hash (method)">#hash</a></span>, <span class='object_link'><a href="Resource.html#to_json-instance_method" title="Helium::Resource#to_json (method)">#to_json</a></span>, <span class='object_link'><a href="Resource.html#update-instance_method" title="Helium::Resource#update (method)">#update</a></span>, <span class='object_link'><a href="Resource.html#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span></p>
|
445
|
+
<p class="inherited"><span class='object_link'><a href="Resource.html#%3D%3D-instance_method" title="Helium::Resource#== (method)">#==</a></span>, <span class='object_link'><a href="Resource.html#all-class_method" title="Helium::Resource.all (method)">all</a></span>, <span class='object_link'><a href="Resource.html#create-class_method" title="Helium::Resource.create (method)">create</a></span>, <span class='object_link'><a href="Resource.html#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</a></span>, <span class='object_link'><a href="Resource.html#destroy-instance_method" title="Helium::Resource#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Resource.html#eql%3F-instance_method" title="Helium::Resource#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="Resource.html#find-class_method" title="Helium::Resource.find (method)">find</a></span>, <span class='object_link'><a href="Resource.html#hash-instance_method" title="Helium::Resource#hash (method)">#hash</a></span>, <span class='object_link'><a href="Resource.html#initialize_from_path-class_method" title="Helium::Resource.initialize_from_path (method)">initialize_from_path</a></span>, <span class='object_link'><a href="Resource.html#metadata-instance_method" title="Helium::Resource#metadata (method)">#metadata</a></span>, <span class='object_link'><a href="Resource.html#resource_name-class_method" title="Helium::Resource.resource_name (method)">resource_name</a></span>, <span class='object_link'><a href="Resource.html#resource_name-instance_method" title="Helium::Resource#resource_name (method)">#resource_name</a></span>, <span class='object_link'><a href="Resource.html#resource_path-instance_method" title="Helium::Resource#resource_path (method)">#resource_path</a></span>, <span class='object_link'><a href="Resource.html#singleton-class_method" title="Helium::Resource.singleton (method)">singleton</a></span>, <span class='object_link'><a href="Resource.html#to_json-instance_method" title="Helium::Resource#to_json (method)">#to_json</a></span>, <span class='object_link'><a href="Resource.html#update-instance_method" title="Helium::Resource#update (method)">#update</a></span>, <span class='object_link'><a href="Resource.html#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span></p>
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
|
453
|
+
|
454
|
+
|
455
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Helium::Utils (module)">Utils</a></span></h3>
|
456
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">#datetime_to_iso</a></span>, <span class='object_link'><a href="Utils.html#kebab_case-instance_method" title="Helium::Utils#kebab_case (method)">#kebab_case</a></span></p>
|
355
457
|
<div id="constructor_details" class="method_details_list">
|
356
458
|
<h2>Constructor Details</h2>
|
357
459
|
|
@@ -387,9 +489,7 @@
|
|
387
489
|
9
|
388
490
|
10
|
389
491
|
11
|
390
|
-
12
|
391
|
-
13
|
392
|
-
14</pre>
|
492
|
+
12</pre>
|
393
493
|
</td>
|
394
494
|
<td>
|
395
495
|
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 5</span>
|
@@ -401,8 +501,6 @@
|
|
401
501
|
<span class='ivar'>@mac</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mac</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
402
502
|
<span class='ivar'>@ports</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ports</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
403
503
|
<span class='ivar'>@last_seen</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>last-seen</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
404
|
-
<span class='ivar'>@firmware</span> <span class='op'>=</span> <span class='ivar'>@params</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>meta</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>versions</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>sensor</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
405
|
-
|
406
504
|
<span class='kw'>end</span></pre>
|
407
505
|
</td>
|
408
506
|
</tr>
|
@@ -417,49 +515,7 @@
|
|
417
515
|
|
418
516
|
<span id=""></span>
|
419
517
|
<div class="method_details first">
|
420
|
-
<h3 class="signature first" id="
|
421
|
-
|
422
|
-
#<strong>firmware</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
</h3><div class="docstring">
|
429
|
-
<div class="discussion">
|
430
|
-
<p>Returns the value of attribute firmware</p>
|
431
|
-
|
432
|
-
|
433
|
-
</div>
|
434
|
-
</div>
|
435
|
-
<div class="tags">
|
436
|
-
|
437
|
-
|
438
|
-
</div><table class="source_code">
|
439
|
-
<tr>
|
440
|
-
<td>
|
441
|
-
<pre class="lines">
|
442
|
-
|
443
|
-
|
444
|
-
3
|
445
|
-
4
|
446
|
-
5</pre>
|
447
|
-
</td>
|
448
|
-
<td>
|
449
|
-
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
450
|
-
|
451
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_firmware'>firmware</span>
|
452
|
-
<span class='ivar'>@firmware</span>
|
453
|
-
<span class='kw'>end</span></pre>
|
454
|
-
</td>
|
455
|
-
</tr>
|
456
|
-
</table>
|
457
|
-
</div>
|
458
|
-
|
459
|
-
|
460
|
-
<span id=""></span>
|
461
|
-
<div class="method_details ">
|
462
|
-
<h3 class="signature " id="last_seen-instance_method">
|
518
|
+
<h3 class="signature first" id="last_seen-instance_method">
|
463
519
|
|
464
520
|
#<strong>last_seen</strong> ⇒ <tt>DateTime</tt><sup>?</sup> <span class="extras">(readonly)</span>
|
465
521
|
|
@@ -500,12 +556,12 @@
|
|
500
556
|
<pre class="lines">
|
501
557
|
|
502
558
|
|
503
|
-
|
504
|
-
|
505
|
-
|
559
|
+
53
|
560
|
+
54
|
561
|
+
55</pre>
|
506
562
|
</td>
|
507
563
|
<td>
|
508
|
-
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line
|
564
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 53</span>
|
509
565
|
|
510
566
|
<span class='kw'>def</span> <span class='id identifier rubyid_last_seen'>last_seen</span>
|
511
567
|
<span class='ivar'>@last_seen</span>
|
@@ -644,6 +700,42 @@
|
|
644
700
|
</div>
|
645
701
|
|
646
702
|
|
703
|
+
<div id="class_method_details" class="method_details_list">
|
704
|
+
<h2>Class Method Details</h2>
|
705
|
+
|
706
|
+
|
707
|
+
<div class="method_details first">
|
708
|
+
<h3 class="signature first" id="all_path-class_method">
|
709
|
+
|
710
|
+
.<strong>all_path</strong> ⇒ <tt>Object</tt>
|
711
|
+
|
712
|
+
|
713
|
+
|
714
|
+
|
715
|
+
|
716
|
+
</h3><table class="source_code">
|
717
|
+
<tr>
|
718
|
+
<td>
|
719
|
+
<pre class="lines">
|
720
|
+
|
721
|
+
|
722
|
+
18
|
723
|
+
19
|
724
|
+
20</pre>
|
725
|
+
</td>
|
726
|
+
<td>
|
727
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 18</span>
|
728
|
+
|
729
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all_path'>all_path</span>
|
730
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor?include=label</span><span class='tstring_end'>"</span></span>
|
731
|
+
<span class='kw'>end</span></pre>
|
732
|
+
</td>
|
733
|
+
</tr>
|
734
|
+
</table>
|
735
|
+
</div>
|
736
|
+
|
737
|
+
</div>
|
738
|
+
|
647
739
|
<div id="instance_method_details" class="method_details_list">
|
648
740
|
<h2>Instance Method Details</h2>
|
649
741
|
|
@@ -673,18 +765,18 @@
|
|
673
765
|
<pre class="lines">
|
674
766
|
|
675
767
|
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
768
|
+
59
|
769
|
+
60
|
770
|
+
61
|
771
|
+
62
|
772
|
+
63
|
773
|
+
64
|
774
|
+
65
|
775
|
+
66
|
776
|
+
67</pre>
|
685
777
|
</td>
|
686
778
|
<td>
|
687
|
-
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line
|
779
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 59</span>
|
688
780
|
|
689
781
|
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span>
|
690
782
|
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
@@ -692,7 +784,7 @@
|
|
692
784
|
<span class='label'>mac:</span> <span class='id identifier rubyid_mac'>mac</span><span class='comma'>,</span>
|
693
785
|
<span class='label'>ports:</span> <span class='id identifier rubyid_ports'>ports</span><span class='comma'>,</span>
|
694
786
|
<span class='label'>last_seen:</span> <span class='id identifier rubyid_last_seen'>last_seen</span><span class='comma'>,</span>
|
695
|
-
<span class='label'>
|
787
|
+
<span class='label'>virtual:</span> <span class='id identifier rubyid_virtual?'>virtual?</span>
|
696
788
|
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
697
789
|
<span class='kw'>end</span></pre>
|
698
790
|
</td>
|
@@ -701,9 +793,9 @@
|
|
701
793
|
</div>
|
702
794
|
|
703
795
|
<div class="method_details ">
|
704
|
-
<h3 class="signature " id="
|
796
|
+
<h3 class="signature " id="device_configuration-instance_method">
|
705
797
|
|
706
|
-
#<strong>
|
798
|
+
#<strong>device_configuration</strong> ⇒ <tt>Object</tt>
|
707
799
|
|
708
800
|
|
709
801
|
|
@@ -715,26 +807,116 @@
|
|
715
807
|
<pre class="lines">
|
716
808
|
|
717
809
|
|
718
|
-
16
|
719
|
-
17
|
720
|
-
18
|
721
|
-
19
|
722
|
-
20
|
723
|
-
21
|
724
|
-
22
|
725
|
-
23
|
726
|
-
24
|
727
|
-
25
|
728
810
|
26
|
729
811
|
27
|
730
|
-
28
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
812
|
+
28</pre>
|
813
|
+
</td>
|
814
|
+
<td>
|
815
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 26</span>
|
816
|
+
|
817
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_device_configuration'>device_configuration</span>
|
818
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_sensor_device_configuration'>sensor_device_configuration</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
819
|
+
<span class='kw'>end</span></pre>
|
820
|
+
</td>
|
821
|
+
</tr>
|
822
|
+
</table>
|
823
|
+
</div>
|
824
|
+
|
825
|
+
<div class="method_details ">
|
826
|
+
<h3 class="signature " id="element-instance_method">
|
827
|
+
|
828
|
+
#<strong>element</strong> ⇒ <tt>Object</tt>
|
829
|
+
|
830
|
+
|
831
|
+
|
832
|
+
|
833
|
+
|
834
|
+
</h3><table class="source_code">
|
835
|
+
<tr>
|
836
|
+
<td>
|
837
|
+
<pre class="lines">
|
838
|
+
|
839
|
+
|
840
|
+
14
|
841
|
+
15
|
842
|
+
16</pre>
|
843
|
+
</td>
|
844
|
+
<td>
|
845
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 14</span>
|
846
|
+
|
847
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_element'>element</span>
|
848
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_sensor_element'>sensor_element</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
849
|
+
<span class='kw'>end</span></pre>
|
850
|
+
</td>
|
851
|
+
</tr>
|
852
|
+
</table>
|
853
|
+
</div>
|
854
|
+
|
855
|
+
<div class="method_details ">
|
856
|
+
<h3 class="signature " id="labels-instance_method">
|
857
|
+
|
858
|
+
#<strong>labels</strong> ⇒ <tt>Object</tt>
|
859
|
+
|
860
|
+
|
861
|
+
|
862
|
+
|
863
|
+
|
864
|
+
</h3><table class="source_code">
|
865
|
+
<tr>
|
866
|
+
<td>
|
867
|
+
<pre class="lines">
|
868
|
+
|
869
|
+
|
870
|
+
22
|
871
|
+
23
|
872
|
+
24</pre>
|
873
|
+
</td>
|
874
|
+
<td>
|
875
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 22</span>
|
876
|
+
|
877
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_labels'>labels</span>
|
878
|
+
<span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>klass:</span> <span class='const'>Label</span><span class='comma'>,</span> <span class='label'>client:</span> <span class='ivar'>@client</span><span class='comma'>,</span> <span class='label'>belongs_to:</span> <span class='kw'>self</span><span class='rparen'>)</span>
|
879
|
+
<span class='kw'>end</span></pre>
|
880
|
+
</td>
|
881
|
+
</tr>
|
882
|
+
</table>
|
883
|
+
</div>
|
884
|
+
|
885
|
+
<div class="method_details ">
|
886
|
+
<h3 class="signature " id="timeseries-instance_method">
|
887
|
+
|
888
|
+
#<strong>timeseries</strong>(opts = {}) ⇒ <tt>Object</tt>
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
|
893
|
+
|
894
|
+
</h3><table class="source_code">
|
895
|
+
<tr>
|
896
|
+
<td>
|
897
|
+
<pre class="lines">
|
898
|
+
|
899
|
+
|
900
|
+
34
|
901
|
+
35
|
902
|
+
36
|
903
|
+
37
|
904
|
+
38
|
905
|
+
39
|
906
|
+
40
|
907
|
+
41
|
908
|
+
42
|
909
|
+
43
|
910
|
+
44
|
911
|
+
45
|
912
|
+
46
|
913
|
+
47
|
914
|
+
48
|
915
|
+
49
|
916
|
+
50</pre>
|
735
917
|
</td>
|
736
918
|
<td>
|
737
|
-
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line
|
919
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 34</span>
|
738
920
|
|
739
921
|
<span class='kw'>def</span> <span class='id identifier rubyid_timeseries'>timeseries</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
740
922
|
<span class='id identifier rubyid_size'>size</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:size</span><span class='comma'>,</span> <span class='int'>1000</span><span class='rparen'>)</span>
|
@@ -756,6 +938,58 @@
|
|
756
938
|
</td>
|
757
939
|
</tr>
|
758
940
|
</table>
|
941
|
+
</div>
|
942
|
+
|
943
|
+
<div class="method_details ">
|
944
|
+
<h3 class="signature " id="virtual?-instance_method">
|
945
|
+
|
946
|
+
#<strong>virtual?</strong> ⇒ <tt>Boolean</tt>
|
947
|
+
|
948
|
+
|
949
|
+
|
950
|
+
|
951
|
+
|
952
|
+
</h3><div class="docstring">
|
953
|
+
<div class="discussion">
|
954
|
+
|
955
|
+
|
956
|
+
</div>
|
957
|
+
</div>
|
958
|
+
<div class="tags">
|
959
|
+
|
960
|
+
<p class="tag_title">Returns:</p>
|
961
|
+
<ul class="return">
|
962
|
+
|
963
|
+
<li>
|
964
|
+
|
965
|
+
|
966
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
967
|
+
|
968
|
+
|
969
|
+
|
970
|
+
</li>
|
971
|
+
|
972
|
+
</ul>
|
973
|
+
|
974
|
+
</div><table class="source_code">
|
975
|
+
<tr>
|
976
|
+
<td>
|
977
|
+
<pre class="lines">
|
978
|
+
|
979
|
+
|
980
|
+
30
|
981
|
+
31
|
982
|
+
32</pre>
|
983
|
+
</td>
|
984
|
+
<td>
|
985
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 30</span>
|
986
|
+
|
987
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_virtual?'>virtual?</span>
|
988
|
+
<span class='id identifier rubyid_mac'>mac</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
989
|
+
<span class='kw'>end</span></pre>
|
990
|
+
</td>
|
991
|
+
</tr>
|
992
|
+
</table>
|
759
993
|
</div>
|
760
994
|
|
761
995
|
</div>
|
@@ -763,9 +997,9 @@
|
|
763
997
|
</div>
|
764
998
|
|
765
999
|
<div id="footer">
|
766
|
-
Generated on Thu
|
1000
|
+
Generated on Thu Jan 12 15:58:34 2017 by
|
767
1001
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
768
|
-
0.9.
|
1002
|
+
0.9.5 (ruby-2.3.1).
|
769
1003
|
</div>
|
770
1004
|
|
771
1005
|
</div>
|