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,543 @@
|
|
|
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
|
+
Module: Helium::Client::Sensors
|
|
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::Client::Sensors";
|
|
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> » <span class='title'><span class='object_link'><a href="../Client.html" title="Helium::Client (class)">Client</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Sensors</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>Module: Helium::Client::Sensors
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<dl>
|
|
80
|
+
<dt>Included in:</dt>
|
|
81
|
+
<dd><span class='object_link'><a href="../Client.html" title="Helium::Client (class)">Helium::Client</a></span></dd>
|
|
82
|
+
</dl>
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
<dl>
|
|
87
|
+
<dt>Defined in:</dt>
|
|
88
|
+
<dd>lib/helium/client/sensors.rb</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
<h2>
|
|
102
|
+
Instance Method Summary
|
|
103
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
104
|
+
</h2>
|
|
105
|
+
|
|
106
|
+
<ul class="summary">
|
|
107
|
+
|
|
108
|
+
<li class="public ">
|
|
109
|
+
<span class="summary_signature">
|
|
110
|
+
|
|
111
|
+
<a href="#delete_sensor-instance_method" title="#delete_sensor (instance method)">#<strong>delete_sensor</strong>(sensor) ⇒ Object </a>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</span>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
126
|
+
|
|
127
|
+
</li>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
<li class="public ">
|
|
131
|
+
<span class="summary_signature">
|
|
132
|
+
|
|
133
|
+
<a href="#new_sensor-instance_method" title="#new_sensor (instance method)">#<strong>new_sensor</strong>(name:) ⇒ Object </a>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</span>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
148
|
+
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#sensor-instance_method" title="#sensor (instance method)">#<strong>sensor</strong>(id) ⇒ Object </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
170
|
+
|
|
171
|
+
</li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<li class="public ">
|
|
175
|
+
<span class="summary_signature">
|
|
176
|
+
|
|
177
|
+
<a href="#sensor_timeseries-instance_method" title="#sensor_timeseries (instance method)">#<strong>sensor_timeseries</strong>(sensor, opts = {}) ⇒ Object </a>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</span>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
192
|
+
|
|
193
|
+
</li>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<li class="public ">
|
|
197
|
+
<span class="summary_signature">
|
|
198
|
+
|
|
199
|
+
<a href="#sensors-instance_method" title="#sensors (instance method)">#<strong>sensors</strong> ⇒ Object </a>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<li class="public ">
|
|
219
|
+
<span class="summary_signature">
|
|
220
|
+
|
|
221
|
+
<a href="#update_sensor-instance_method" title="#update_sensor (instance method)">#<strong>update_sensor</strong>(sensor, name:) ⇒ Object </a>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
</span>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
236
|
+
|
|
237
|
+
</li>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
</ul>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<div id="instance_method_details" class="method_details_list">
|
|
246
|
+
<h2>Instance Method Details</h2>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<div class="method_details first">
|
|
250
|
+
<h3 class="signature first" id="delete_sensor-instance_method">
|
|
251
|
+
|
|
252
|
+
#<strong>delete_sensor</strong>(sensor) ⇒ <tt>Object</tt>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</h3><table class="source_code">
|
|
259
|
+
<tr>
|
|
260
|
+
<td>
|
|
261
|
+
<pre class="lines">
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
74
|
|
265
|
+
75
|
|
266
|
+
76
|
|
267
|
+
77</pre>
|
|
268
|
+
</td>
|
|
269
|
+
<td>
|
|
270
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 74</span>
|
|
271
|
+
|
|
272
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_sensor'>delete_sensor</span><span class='lparen'>(</span><span class='id identifier rubyid_sensor'>sensor</span><span class='rparen'>)</span>
|
|
273
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
274
|
+
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
275
|
+
<span class='kw'>end</span></pre>
|
|
276
|
+
</td>
|
|
277
|
+
</tr>
|
|
278
|
+
</table>
|
|
279
|
+
</div>
|
|
280
|
+
|
|
281
|
+
<div class="method_details ">
|
|
282
|
+
<h3 class="signature " id="new_sensor-instance_method">
|
|
283
|
+
|
|
284
|
+
#<strong>new_sensor</strong>(name:) ⇒ <tt>Object</tt>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
</h3><table class="source_code">
|
|
291
|
+
<tr>
|
|
292
|
+
<td>
|
|
293
|
+
<pre class="lines">
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
37
|
|
297
|
+
38
|
|
298
|
+
39
|
|
299
|
+
40
|
|
300
|
+
41
|
|
301
|
+
42
|
|
302
|
+
43
|
|
303
|
+
44
|
|
304
|
+
45
|
|
305
|
+
46
|
|
306
|
+
47
|
|
307
|
+
48
|
|
308
|
+
49
|
|
309
|
+
50
|
|
310
|
+
51
|
|
311
|
+
52
|
|
312
|
+
53</pre>
|
|
313
|
+
</td>
|
|
314
|
+
<td>
|
|
315
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 37</span>
|
|
316
|
+
|
|
317
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_new_sensor'>new_sensor</span><span class='lparen'>(</span><span class='label'>name:</span><span class='rparen'>)</span>
|
|
318
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor</span><span class='tstring_end'>"</span></span>
|
|
319
|
+
|
|
320
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
321
|
+
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
|
322
|
+
<span class='label'>attributes:</span> <span class='lbrace'>{</span>
|
|
323
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span>
|
|
324
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
325
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor</span><span class='tstring_end'>"</span></span>
|
|
326
|
+
<span class='rbrace'>}</span>
|
|
327
|
+
<span class='rbrace'>}</span>
|
|
328
|
+
|
|
329
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
330
|
+
<span class='id identifier rubyid_sensor_data'>sensor_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
331
|
+
|
|
332
|
+
<span class='kw'>return</span> <span class='const'>Sensor</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
|
333
|
+
<span class='kw'>end</span></pre>
|
|
334
|
+
</td>
|
|
335
|
+
</tr>
|
|
336
|
+
</table>
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
<div class="method_details ">
|
|
340
|
+
<h3 class="signature " id="sensor-instance_method">
|
|
341
|
+
|
|
342
|
+
#<strong>sensor</strong>(id) ⇒ <tt>Object</tt>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
</h3><table class="source_code">
|
|
349
|
+
<tr>
|
|
350
|
+
<td>
|
|
351
|
+
<pre class="lines">
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
15
|
|
355
|
+
16
|
|
356
|
+
17
|
|
357
|
+
18
|
|
358
|
+
19
|
|
359
|
+
20</pre>
|
|
360
|
+
</td>
|
|
361
|
+
<td>
|
|
362
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 15</span>
|
|
363
|
+
|
|
364
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sensor'>sensor</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
|
|
365
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
366
|
+
<span class='id identifier rubyid_sensor_data'>sensor_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
367
|
+
|
|
368
|
+
<span class='kw'>return</span> <span class='const'>Sensor</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
|
369
|
+
<span class='kw'>end</span></pre>
|
|
370
|
+
</td>
|
|
371
|
+
</tr>
|
|
372
|
+
</table>
|
|
373
|
+
</div>
|
|
374
|
+
|
|
375
|
+
<div class="method_details ">
|
|
376
|
+
<h3 class="signature " id="sensor_timeseries-instance_method">
|
|
377
|
+
|
|
378
|
+
#<strong>sensor_timeseries</strong>(sensor, opts = {}) ⇒ <tt>Object</tt>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</h3><table class="source_code">
|
|
385
|
+
<tr>
|
|
386
|
+
<td>
|
|
387
|
+
<pre class="lines">
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
22
|
|
391
|
+
23
|
|
392
|
+
24
|
|
393
|
+
25
|
|
394
|
+
26
|
|
395
|
+
27
|
|
396
|
+
28
|
|
397
|
+
29
|
|
398
|
+
30
|
|
399
|
+
31
|
|
400
|
+
32
|
|
401
|
+
33
|
|
402
|
+
34
|
|
403
|
+
35</pre>
|
|
404
|
+
</td>
|
|
405
|
+
<td>
|
|
406
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 22</span>
|
|
407
|
+
|
|
408
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sensor_timeseries'>sensor_timeseries</span><span class='lparen'>(</span><span class='id identifier rubyid_sensor'>sensor</span><span class='comma'>,</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>
|
|
409
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/timeseries</span><span class='tstring_end'>"</span></span>
|
|
410
|
+
|
|
411
|
+
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
412
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>page[size]</span><span class='tstring_end'>"</span></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='kw'>nil</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
413
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter[port]</span><span class='tstring_end'>"</span></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'>:port</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
414
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter[start]</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_datetime_to_iso'>datetime_to_iso</span><span class='lparen'>(</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'>:start_time</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
415
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>filter[end]</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_datetime_to_iso'>datetime_to_iso</span><span class='lparen'>(</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'>:end_time</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
416
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>agg[type]</span><span class='tstring_end'>"</span></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'>:aggtype</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
417
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>agg[size]</span><span class='tstring_end'>"</span></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'>:aggsize</span><span class='rparen'>)</span>
|
|
418
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='rbrace'>}</span>
|
|
419
|
+
|
|
420
|
+
<span class='id identifier rubyid_paginated_get'>paginated_get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>klass:</span> <span class='const'>Helium</span><span class='op'>::</span><span class='const'>DataPoint</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
421
|
+
<span class='kw'>end</span></pre>
|
|
422
|
+
</td>
|
|
423
|
+
</tr>
|
|
424
|
+
</table>
|
|
425
|
+
</div>
|
|
426
|
+
|
|
427
|
+
<div class="method_details ">
|
|
428
|
+
<h3 class="signature " id="sensors-instance_method">
|
|
429
|
+
|
|
430
|
+
#<strong>sensors</strong> ⇒ <tt>Object</tt>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
</h3><table class="source_code">
|
|
437
|
+
<tr>
|
|
438
|
+
<td>
|
|
439
|
+
<pre class="lines">
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
4
|
|
443
|
+
5
|
|
444
|
+
6
|
|
445
|
+
7
|
|
446
|
+
8
|
|
447
|
+
9
|
|
448
|
+
10
|
|
449
|
+
11
|
|
450
|
+
12
|
|
451
|
+
13</pre>
|
|
452
|
+
</td>
|
|
453
|
+
<td>
|
|
454
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 4</span>
|
|
455
|
+
|
|
456
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sensors'>sensors</span>
|
|
457
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</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>
|
|
458
|
+
<span class='id identifier rubyid_sensors_data'>sensors_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
459
|
+
|
|
460
|
+
<span class='id identifier rubyid_sensors'>sensors</span> <span class='op'>=</span> <span class='id identifier rubyid_sensors_data'>sensors_data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sensor_data'>sensor_data</span><span class='op'>|</span>
|
|
461
|
+
<span class='const'>Sensor</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
|
462
|
+
<span class='kw'>end</span>
|
|
463
|
+
|
|
464
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_sensors'>sensors</span>
|
|
465
|
+
<span class='kw'>end</span></pre>
|
|
466
|
+
</td>
|
|
467
|
+
</tr>
|
|
468
|
+
</table>
|
|
469
|
+
</div>
|
|
470
|
+
|
|
471
|
+
<div class="method_details ">
|
|
472
|
+
<h3 class="signature " id="update_sensor-instance_method">
|
|
473
|
+
|
|
474
|
+
#<strong>update_sensor</strong>(sensor, name:) ⇒ <tt>Object</tt>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
</h3><table class="source_code">
|
|
481
|
+
<tr>
|
|
482
|
+
<td>
|
|
483
|
+
<pre class="lines">
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
55
|
|
487
|
+
56
|
|
488
|
+
57
|
|
489
|
+
58
|
|
490
|
+
59
|
|
491
|
+
60
|
|
492
|
+
61
|
|
493
|
+
62
|
|
494
|
+
63
|
|
495
|
+
64
|
|
496
|
+
65
|
|
497
|
+
66
|
|
498
|
+
67
|
|
499
|
+
68
|
|
500
|
+
69
|
|
501
|
+
70
|
|
502
|
+
71
|
|
503
|
+
72</pre>
|
|
504
|
+
</td>
|
|
505
|
+
<td>
|
|
506
|
+
<pre class="code"><span class="info file"># File 'lib/helium/client/sensors.rb', line 55</span>
|
|
507
|
+
|
|
508
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_sensor'>update_sensor</span><span class='lparen'>(</span><span class='id identifier rubyid_sensor'>sensor</span><span class='comma'>,</span> <span class='label'>name:</span><span class='rparen'>)</span>
|
|
509
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/sensor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
510
|
+
|
|
511
|
+
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
512
|
+
<span class='label'>data:</span> <span class='lbrace'>{</span>
|
|
513
|
+
<span class='label'>attributes:</span> <span class='lbrace'>{</span>
|
|
514
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span>
|
|
515
|
+
<span class='rbrace'>}</span><span class='comma'>,</span>
|
|
516
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
517
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor</span><span class='tstring_end'>"</span></span>
|
|
518
|
+
<span class='rbrace'>}</span>
|
|
519
|
+
<span class='rbrace'>}</span>
|
|
520
|
+
|
|
521
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>body:</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
522
|
+
<span class='id identifier rubyid_sensor_data'>sensor_data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>data</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
523
|
+
|
|
524
|
+
<span class='kw'>return</span> <span class='const'>Sensor</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_sensor_data'>sensor_data</span><span class='rparen'>)</span>
|
|
525
|
+
<span class='kw'>end</span></pre>
|
|
526
|
+
</td>
|
|
527
|
+
</tr>
|
|
528
|
+
</table>
|
|
529
|
+
</div>
|
|
530
|
+
|
|
531
|
+
</div>
|
|
532
|
+
|
|
533
|
+
</div>
|
|
534
|
+
|
|
535
|
+
<div id="footer">
|
|
536
|
+
Generated on Thu Aug 18 10:50:33 2016 by
|
|
537
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
538
|
+
0.9.3 (ruby-2.3.1).
|
|
539
|
+
</div>
|
|
540
|
+
|
|
541
|
+
</div>
|
|
542
|
+
</body>
|
|
543
|
+
</html>
|