helium-ruby 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.codeclimate.yml +31 -0
- data/.csslintrc +2 -0
- data/.eslintignore +1 -0
- data/.eslintrc +213 -0
- data/.gitignore +0 -1
- data/.rubocop.yml +1156 -0
- data/CONTRIBUTING.md +33 -0
- data/LICENSE.txt +23 -17
- data/README.md +58 -47
- data/Rakefile +14 -0
- data/bin/console +8 -0
- data/docs/Helium.html +131 -0
- data/docs/Helium/Client.html +493 -0
- data/docs/Helium/Client/Http.html +428 -0
- data/docs/Helium/Client/Organizations.html +251 -0
- data/docs/Helium/Client/Sensors.html +543 -0
- data/docs/Helium/Client/Users.html +185 -0
- data/docs/Helium/Cursor.html +305 -0
- data/docs/Helium/DataPoint.html +707 -0
- data/docs/Helium/Organization.html +632 -0
- data/docs/Helium/Sensor.html +820 -0
- data/docs/Helium/User.html +563 -0
- data/docs/Helium/Utils.html +183 -0
- data/docs/_index.html +226 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +474 -0
- data/docs/file.README.html +266 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +266 -0
- data/docs/js/app.js +243 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +475 -0
- data/docs/top-level-namespace.html +112 -0
- data/helium-ruby.gemspec +2 -0
- data/lib/helium.rb +1 -1
- data/lib/helium/client.rb +0 -16
- data/lib/helium/client/http.rb +50 -9
- data/lib/helium/client/sensors.rb +51 -28
- data/lib/helium/cursor.rb +54 -0
- data/lib/helium/data_point.rb +3 -3
- data/lib/helium/sensor.rb +9 -0
- data/lib/helium/version.rb +1 -1
- metadata +63 -3
- data/lib/helium/timeseries.rb +0 -35
|
@@ -0,0 +1,820 @@
|
|
|
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: Helium::Sensor
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.3
|
|
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 = "Helium::Sensor";
|
|
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"></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 (S)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Helium.html" title="Helium (module)">Helium</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Sensor</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
|
+
<iframe id="search_frame" src="../class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Helium::Sensor
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Helium::Sensor</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/helium/sensor.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
109
|
+
<ul class="summary">
|
|
110
|
+
|
|
111
|
+
<li class="public ">
|
|
112
|
+
<span class="summary_signature">
|
|
113
|
+
|
|
114
|
+
<a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> ⇒ Object </a>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</span>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute created_at.</p>
|
|
132
|
+
</div></span>
|
|
133
|
+
|
|
134
|
+
</li>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
<li class="public ">
|
|
138
|
+
<span class="summary_signature">
|
|
139
|
+
|
|
140
|
+
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ Object </a>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
</span>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute id.</p>
|
|
158
|
+
</div></span>
|
|
159
|
+
|
|
160
|
+
</li>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<li class="public ">
|
|
164
|
+
<span class="summary_signature">
|
|
165
|
+
|
|
166
|
+
<a href="#mac-instance_method" title="#mac (instance method)">#<strong>mac</strong> ⇒ Object </a>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</span>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute mac.</p>
|
|
184
|
+
</div></span>
|
|
185
|
+
|
|
186
|
+
</li>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<li class="public ">
|
|
190
|
+
<span class="summary_signature">
|
|
191
|
+
|
|
192
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ Object </a>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</span>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute name.</p>
|
|
210
|
+
</div></span>
|
|
211
|
+
|
|
212
|
+
</li>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<li class="public ">
|
|
216
|
+
<span class="summary_signature">
|
|
217
|
+
|
|
218
|
+
<a href="#ports-instance_method" title="#ports (instance method)">#<strong>ports</strong> ⇒ Object </a>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
</span>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute ports.</p>
|
|
236
|
+
</div></span>
|
|
237
|
+
|
|
238
|
+
</li>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<li class="public ">
|
|
242
|
+
<span class="summary_signature">
|
|
243
|
+
|
|
244
|
+
<a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> ⇒ Object </a>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
</span>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute updated_at.</p>
|
|
262
|
+
</div></span>
|
|
263
|
+
|
|
264
|
+
</li>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</ul>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<h2>
|
|
274
|
+
Instance Method Summary
|
|
275
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
276
|
+
</h2>
|
|
277
|
+
|
|
278
|
+
<ul class="summary">
|
|
279
|
+
|
|
280
|
+
<li class="public ">
|
|
281
|
+
<span class="summary_signature">
|
|
282
|
+
|
|
283
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">#<strong>destroy</strong> ⇒ Object </a>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</span>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
298
|
+
|
|
299
|
+
</li>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<li class="public ">
|
|
303
|
+
<span class="summary_signature">
|
|
304
|
+
|
|
305
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, params:) ⇒ Sensor </a>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<span class="note title constructor">constructor</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Sensor.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#timeseries-instance_method" title="#timeseries (instance method)">#<strong>timeseries</strong>(size: 1000, port: nil, start_time: nil, end_time: nil, aggtype: nil, aggsize: nil) ⇒ Object </a>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
345
|
+
|
|
346
|
+
</li>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<li class="public ">
|
|
350
|
+
<span class="summary_signature">
|
|
351
|
+
|
|
352
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(name:) ⇒ Object </a>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</span>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<span class="summary_desc"><div class='inline'><p>TODO these kinds of methods should be generalized into a Resource object.</p>
|
|
367
|
+
</div></span>
|
|
368
|
+
|
|
369
|
+
</li>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
</ul>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<div id="constructor_details" class="method_details_list">
|
|
376
|
+
<h2>Constructor Details</h2>
|
|
377
|
+
|
|
378
|
+
<div class="method_details first">
|
|
379
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
380
|
+
|
|
381
|
+
#<strong>initialize</strong>(client:, params:) ⇒ <tt><span class='object_link'><a href="" title="Helium::Sensor (class)">Sensor</a></span></tt>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
</h3><div class="docstring">
|
|
388
|
+
<div class="discussion">
|
|
389
|
+
<p>Returns a new instance of Sensor</p>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</div>
|
|
393
|
+
</div>
|
|
394
|
+
<div class="tags">
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
</div><table class="source_code">
|
|
398
|
+
<tr>
|
|
399
|
+
<td>
|
|
400
|
+
<pre class="lines">
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
5
|
|
404
|
+
6
|
|
405
|
+
7
|
|
406
|
+
8
|
|
407
|
+
9
|
|
408
|
+
10
|
|
409
|
+
11
|
|
410
|
+
12
|
|
411
|
+
13</pre>
|
|
412
|
+
</td>
|
|
413
|
+
<td>
|
|
414
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 5</span>
|
|
415
|
+
|
|
416
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>params:</span><span class='rparen'>)</span>
|
|
417
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
418
|
+
<span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>id</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
419
|
+
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>attributes</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>name</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
420
|
+
<span class='ivar'>@mac</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>meta</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>mac</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
421
|
+
<span class='ivar'>@ports</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>meta</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ports</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
422
|
+
<span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>meta</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>created</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
423
|
+
<span class='ivar'>@updated_at</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>meta</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>updated</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
424
|
+
<span class='kw'>end</span></pre>
|
|
425
|
+
</td>
|
|
426
|
+
</tr>
|
|
427
|
+
</table>
|
|
428
|
+
</div>
|
|
429
|
+
|
|
430
|
+
</div>
|
|
431
|
+
|
|
432
|
+
<div id="instance_attr_details" class="attr_details">
|
|
433
|
+
<h2>Instance Attribute Details</h2>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<span id="created_at=-instance_method"></span>
|
|
437
|
+
<div class="method_details first">
|
|
438
|
+
<h3 class="signature first" id="created_at-instance_method">
|
|
439
|
+
|
|
440
|
+
#<strong>created_at</strong> ⇒ <tt>Object</tt>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</h3><div class="docstring">
|
|
447
|
+
<div class="discussion">
|
|
448
|
+
<p>Returns the value of attribute created_at</p>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</div>
|
|
452
|
+
</div>
|
|
453
|
+
<div class="tags">
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</div><table class="source_code">
|
|
457
|
+
<tr>
|
|
458
|
+
<td>
|
|
459
|
+
<pre class="lines">
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
3
|
|
463
|
+
4
|
|
464
|
+
5</pre>
|
|
465
|
+
</td>
|
|
466
|
+
<td>
|
|
467
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
|
468
|
+
|
|
469
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
|
470
|
+
<span class='ivar'>@created_at</span>
|
|
471
|
+
<span class='kw'>end</span></pre>
|
|
472
|
+
</td>
|
|
473
|
+
</tr>
|
|
474
|
+
</table>
|
|
475
|
+
</div>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
<span id="id=-instance_method"></span>
|
|
479
|
+
<div class="method_details ">
|
|
480
|
+
<h3 class="signature " id="id-instance_method">
|
|
481
|
+
|
|
482
|
+
#<strong>id</strong> ⇒ <tt>Object</tt>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
</h3><div class="docstring">
|
|
489
|
+
<div class="discussion">
|
|
490
|
+
<p>Returns the value of attribute id</p>
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</div>
|
|
494
|
+
</div>
|
|
495
|
+
<div class="tags">
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
</div><table class="source_code">
|
|
499
|
+
<tr>
|
|
500
|
+
<td>
|
|
501
|
+
<pre class="lines">
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
3
|
|
505
|
+
4
|
|
506
|
+
5</pre>
|
|
507
|
+
</td>
|
|
508
|
+
<td>
|
|
509
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
|
510
|
+
|
|
511
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
|
|
512
|
+
<span class='ivar'>@id</span>
|
|
513
|
+
<span class='kw'>end</span></pre>
|
|
514
|
+
</td>
|
|
515
|
+
</tr>
|
|
516
|
+
</table>
|
|
517
|
+
</div>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
<span id="mac=-instance_method"></span>
|
|
521
|
+
<div class="method_details ">
|
|
522
|
+
<h3 class="signature " id="mac-instance_method">
|
|
523
|
+
|
|
524
|
+
#<strong>mac</strong> ⇒ <tt>Object</tt>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
</h3><div class="docstring">
|
|
531
|
+
<div class="discussion">
|
|
532
|
+
<p>Returns the value of attribute mac</p>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
</div>
|
|
536
|
+
</div>
|
|
537
|
+
<div class="tags">
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
</div><table class="source_code">
|
|
541
|
+
<tr>
|
|
542
|
+
<td>
|
|
543
|
+
<pre class="lines">
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
3
|
|
547
|
+
4
|
|
548
|
+
5</pre>
|
|
549
|
+
</td>
|
|
550
|
+
<td>
|
|
551
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
|
552
|
+
|
|
553
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_mac'>mac</span>
|
|
554
|
+
<span class='ivar'>@mac</span>
|
|
555
|
+
<span class='kw'>end</span></pre>
|
|
556
|
+
</td>
|
|
557
|
+
</tr>
|
|
558
|
+
</table>
|
|
559
|
+
</div>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
<span id="name=-instance_method"></span>
|
|
563
|
+
<div class="method_details ">
|
|
564
|
+
<h3 class="signature " id="name-instance_method">
|
|
565
|
+
|
|
566
|
+
#<strong>name</strong> ⇒ <tt>Object</tt>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
</h3><div class="docstring">
|
|
573
|
+
<div class="discussion">
|
|
574
|
+
<p>Returns the value of attribute name</p>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
</div>
|
|
578
|
+
</div>
|
|
579
|
+
<div class="tags">
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</div><table class="source_code">
|
|
583
|
+
<tr>
|
|
584
|
+
<td>
|
|
585
|
+
<pre class="lines">
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
3
|
|
589
|
+
4
|
|
590
|
+
5</pre>
|
|
591
|
+
</td>
|
|
592
|
+
<td>
|
|
593
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
|
594
|
+
|
|
595
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
|
596
|
+
<span class='ivar'>@name</span>
|
|
597
|
+
<span class='kw'>end</span></pre>
|
|
598
|
+
</td>
|
|
599
|
+
</tr>
|
|
600
|
+
</table>
|
|
601
|
+
</div>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
<span id="ports=-instance_method"></span>
|
|
605
|
+
<div class="method_details ">
|
|
606
|
+
<h3 class="signature " id="ports-instance_method">
|
|
607
|
+
|
|
608
|
+
#<strong>ports</strong> ⇒ <tt>Object</tt>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
</h3><div class="docstring">
|
|
615
|
+
<div class="discussion">
|
|
616
|
+
<p>Returns the value of attribute ports</p>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
</div>
|
|
620
|
+
</div>
|
|
621
|
+
<div class="tags">
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
</div><table class="source_code">
|
|
625
|
+
<tr>
|
|
626
|
+
<td>
|
|
627
|
+
<pre class="lines">
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
3
|
|
631
|
+
4
|
|
632
|
+
5</pre>
|
|
633
|
+
</td>
|
|
634
|
+
<td>
|
|
635
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
|
636
|
+
|
|
637
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ports'>ports</span>
|
|
638
|
+
<span class='ivar'>@ports</span>
|
|
639
|
+
<span class='kw'>end</span></pre>
|
|
640
|
+
</td>
|
|
641
|
+
</tr>
|
|
642
|
+
</table>
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
<span id="updated_at=-instance_method"></span>
|
|
647
|
+
<div class="method_details ">
|
|
648
|
+
<h3 class="signature " id="updated_at-instance_method">
|
|
649
|
+
|
|
650
|
+
#<strong>updated_at</strong> ⇒ <tt>Object</tt>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</h3><div class="docstring">
|
|
657
|
+
<div class="discussion">
|
|
658
|
+
<p>Returns the value of attribute updated_at</p>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
</div>
|
|
662
|
+
</div>
|
|
663
|
+
<div class="tags">
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
</div><table class="source_code">
|
|
667
|
+
<tr>
|
|
668
|
+
<td>
|
|
669
|
+
<pre class="lines">
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
3
|
|
673
|
+
4
|
|
674
|
+
5</pre>
|
|
675
|
+
</td>
|
|
676
|
+
<td>
|
|
677
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 3</span>
|
|
678
|
+
|
|
679
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
|
|
680
|
+
<span class='ivar'>@updated_at</span>
|
|
681
|
+
<span class='kw'>end</span></pre>
|
|
682
|
+
</td>
|
|
683
|
+
</tr>
|
|
684
|
+
</table>
|
|
685
|
+
</div>
|
|
686
|
+
|
|
687
|
+
</div>
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
<div id="instance_method_details" class="method_details_list">
|
|
691
|
+
<h2>Instance Method Details</h2>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
<div class="method_details first">
|
|
695
|
+
<h3 class="signature first" id="destroy-instance_method">
|
|
696
|
+
|
|
697
|
+
#<strong>destroy</strong> ⇒ <tt>Object</tt>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
</h3><table class="source_code">
|
|
704
|
+
<tr>
|
|
705
|
+
<td>
|
|
706
|
+
<pre class="lines">
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
39
|
|
710
|
+
40
|
|
711
|
+
41</pre>
|
|
712
|
+
</td>
|
|
713
|
+
<td>
|
|
714
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 39</span>
|
|
715
|
+
|
|
716
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
|
|
717
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_sensor'>delete_sensor</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
|
718
|
+
<span class='kw'>end</span></pre>
|
|
719
|
+
</td>
|
|
720
|
+
</tr>
|
|
721
|
+
</table>
|
|
722
|
+
</div>
|
|
723
|
+
|
|
724
|
+
<div class="method_details ">
|
|
725
|
+
<h3 class="signature " id="timeseries-instance_method">
|
|
726
|
+
|
|
727
|
+
#<strong>timeseries</strong>(size: 1000, port: nil, start_time: nil, end_time: nil, aggtype: nil, aggsize: nil) ⇒ <tt>Object</tt>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
</h3><table class="source_code">
|
|
734
|
+
<tr>
|
|
735
|
+
<td>
|
|
736
|
+
<pre class="lines">
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
23
|
|
740
|
+
24
|
|
741
|
+
25
|
|
742
|
+
26
|
|
743
|
+
27
|
|
744
|
+
28
|
|
745
|
+
29
|
|
746
|
+
30
|
|
747
|
+
31
|
|
748
|
+
32</pre>
|
|
749
|
+
</td>
|
|
750
|
+
<td>
|
|
751
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 23</span>
|
|
752
|
+
|
|
753
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_timeseries'>timeseries</span><span class='lparen'>(</span><span class='label'>size:</span> <span class='int'>1000</span><span class='comma'>,</span> <span class='label'>port:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>start_time:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>end_time:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>aggtype:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>aggsize:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
754
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_sensor_timeseries'>sensor_timeseries</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span>
|
|
755
|
+
<span class='label'>size:</span> <span class='id identifier rubyid_size'>size</span><span class='comma'>,</span>
|
|
756
|
+
<span class='label'>port:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
|
|
757
|
+
<span class='label'>start_time:</span> <span class='id identifier rubyid_start_time'>start_time</span><span class='comma'>,</span>
|
|
758
|
+
<span class='label'>end_time:</span> <span class='id identifier rubyid_end_time'>end_time</span><span class='comma'>,</span>
|
|
759
|
+
<span class='label'>aggtype:</span> <span class='id identifier rubyid_aggtype'>aggtype</span><span class='comma'>,</span>
|
|
760
|
+
<span class='label'>aggsize:</span> <span class='id identifier rubyid_aggsize'>aggsize</span>
|
|
761
|
+
<span class='rparen'>)</span>
|
|
762
|
+
<span class='kw'>end</span></pre>
|
|
763
|
+
</td>
|
|
764
|
+
</tr>
|
|
765
|
+
</table>
|
|
766
|
+
</div>
|
|
767
|
+
|
|
768
|
+
<div class="method_details ">
|
|
769
|
+
<h3 class="signature " id="update-instance_method">
|
|
770
|
+
|
|
771
|
+
#<strong>update</strong>(name:) ⇒ <tt>Object</tt>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
</h3><div class="docstring">
|
|
778
|
+
<div class="discussion">
|
|
779
|
+
<p>TODO these kinds of methods should be generalized into a Resource object</p>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
</div>
|
|
783
|
+
</div>
|
|
784
|
+
<div class="tags">
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</div><table class="source_code">
|
|
788
|
+
<tr>
|
|
789
|
+
<td>
|
|
790
|
+
<pre class="lines">
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
35
|
|
794
|
+
36
|
|
795
|
+
37</pre>
|
|
796
|
+
</td>
|
|
797
|
+
<td>
|
|
798
|
+
<pre class="code"><span class="info file"># File 'lib/helium/sensor.rb', line 35</span>
|
|
799
|
+
|
|
800
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span><span class='rparen'>)</span>
|
|
801
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update_sensor'>update_sensor</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
|
802
|
+
<span class='kw'>end</span></pre>
|
|
803
|
+
</td>
|
|
804
|
+
</tr>
|
|
805
|
+
</table>
|
|
806
|
+
</div>
|
|
807
|
+
|
|
808
|
+
</div>
|
|
809
|
+
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
<div id="footer">
|
|
813
|
+
Generated on Thu Aug 18 10:50:33 2016 by
|
|
814
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
815
|
+
0.9.3 (ruby-2.3.1).
|
|
816
|
+
</div>
|
|
817
|
+
|
|
818
|
+
</div>
|
|
819
|
+
</body>
|
|
820
|
+
</html>
|