purple_air_api 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +0 -1
- data/Gemfile.lock +1 -1
- data/README.md +143 -11
- data/Rakefile +5 -0
- data/docs/PurpleAirApi.html +488 -0
- data/docs/PurpleAirApi/V1.html +128 -0
- data/docs/PurpleAirApi/V1/ApiError.html +159 -0
- data/docs/PurpleAirApi/V1/ApiKeyError.html +159 -0
- data/docs/PurpleAirApi/V1/BaseError.html +431 -0
- data/docs/PurpleAirApi/V1/Client.html +801 -0
- data/docs/PurpleAirApi/V1/GetSensor.html +1033 -0
- data/docs/PurpleAirApi/V1/GetSensors.html +979 -0
- data/docs/PurpleAirApi/V1/MissingJsonPayloadError.html +159 -0
- data/docs/PurpleAirApi/V1/NotFoundError.html +159 -0
- data/docs/PurpleAirApi/V1/OptionsError.html +135 -0
- data/docs/PurpleAirApi/V1/RaiseHttpException.html +318 -0
- data/docs/PurpleAirApi/V1/ServerError.html +159 -0
- data/docs/_index.html +274 -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 +497 -0
- data/docs/file.README.html +247 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +247 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +315 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/purple_air_api/V1/client.rb +11 -1
- data/lib/purple_air_api/V1/sensors/get_sensor.rb +5 -4
- data/lib/purple_air_api/V1/sensors/get_sensors.rb +11 -9
- data/lib/purple_air_api/version.rb +1 -1
- data/purple_air_api.gemspec +8 -5
- metadata +37 -8
|
@@ -0,0 +1,801 @@
|
|
|
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: PurpleAirApi::V1::Client
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "PurpleAirApi::V1::Client";
|
|
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 (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../PurpleAirApi.html" title="PurpleAirApi (module)">PurpleAirApi</a></span></span> » <span class='title'><span class='object_link'><a href="../V1.html" title="PurpleAirApi::V1 (module)">V1</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Client</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: PurpleAirApi::V1::Client
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">PurpleAirApi::V1::Client</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/purple_air_api/V1/client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Client class for interfacing with the V1 PurpleAir API. Refer to the instance methods to learn more about what methods and API options are available.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
<h2>
|
|
116
|
+
Constant Summary
|
|
117
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
118
|
+
</h2>
|
|
119
|
+
|
|
120
|
+
<dl class="constants">
|
|
121
|
+
|
|
122
|
+
<dt id="API_URL-constant" class="">API_URL =
|
|
123
|
+
<div class="docstring">
|
|
124
|
+
<div class="discussion">
|
|
125
|
+
|
|
126
|
+
<p>The base URL for the PurpleAir API</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tags">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</dt>
|
|
136
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.purpleair.com/v1/</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
137
|
+
|
|
138
|
+
</dl>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
145
|
+
<ul class="summary">
|
|
146
|
+
|
|
147
|
+
<li class="public ">
|
|
148
|
+
<span class="summary_signature">
|
|
149
|
+
|
|
150
|
+
<a href="#read_client-instance_method" title="#read_client (instance method)">#<strong>read_client</strong> ⇒ Object </a>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</span>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<span class="note title readonly">readonly</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'>
|
|
170
|
+
<p>Returns the value of attribute read_client.</p>
|
|
171
|
+
</div></span>
|
|
172
|
+
|
|
173
|
+
</li>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<li class="public ">
|
|
177
|
+
<span class="summary_signature">
|
|
178
|
+
|
|
179
|
+
<a href="#write_client-instance_method" title="#write_client (instance method)">#<strong>write_client</strong> ⇒ Object </a>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<span class="note title readonly">readonly</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<span class="summary_desc"><div class='inline'>
|
|
199
|
+
<p>Returns the value of attribute write_client.</p>
|
|
200
|
+
</div></span>
|
|
201
|
+
|
|
202
|
+
</li>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</ul>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<h2>
|
|
212
|
+
Instance Method Summary
|
|
213
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
214
|
+
</h2>
|
|
215
|
+
|
|
216
|
+
<ul class="summary">
|
|
217
|
+
|
|
218
|
+
<li class="public ">
|
|
219
|
+
<span class="summary_signature">
|
|
220
|
+
|
|
221
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(read_token: , write_token: ) ⇒ Client </a>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
</span>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<span class="note title constructor">constructor</span>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<span class="summary_desc"><div class='inline'>
|
|
238
|
+
<p>Creates a read and write client to interface with the Purple Air API.</p>
|
|
239
|
+
</div></span>
|
|
240
|
+
|
|
241
|
+
</li>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<li class="public ">
|
|
245
|
+
<span class="summary_signature">
|
|
246
|
+
|
|
247
|
+
<a href="#request_sensor-instance_method" title="#request_sensor (instance method)">#<strong>request_sensor</strong>(sensor_index, read_key: nil) ⇒ PurpleAirApi::GetSensor </a>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</span>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<span class="summary_desc"><div class='inline'>
|
|
262
|
+
<p>Makes a request to the individual sensor SHOW endpoint and returns an instance of the V1::GetSensors class.</p>
|
|
263
|
+
</div></span>
|
|
264
|
+
|
|
265
|
+
</li>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<li class="public ">
|
|
269
|
+
<span class="summary_signature">
|
|
270
|
+
|
|
271
|
+
<a href="#request_sensors-instance_method" title="#request_sensors (instance method)">#<strong>request_sensors</strong>(options) ⇒ PurpleAirApi::GetSensors </a>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
</span>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<span class="summary_desc"><div class='inline'>
|
|
286
|
+
<p>Makes a request to the sensors INDEX endpoint and returns an instance of the V1::GetSensors class.</p>
|
|
287
|
+
</div></span>
|
|
288
|
+
|
|
289
|
+
</li>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</ul>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<div id="constructor_details" class="method_details_list">
|
|
296
|
+
<h2>Constructor Details</h2>
|
|
297
|
+
|
|
298
|
+
<div class="method_details first">
|
|
299
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
300
|
+
|
|
301
|
+
#<strong>initialize</strong>(read_token: , write_token: ) ⇒ <tt><span class='object_link'><a href="" title="PurpleAirApi::V1::Client (class)">Client</a></span></tt>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
</h3><div class="docstring">
|
|
308
|
+
<div class="discussion">
|
|
309
|
+
|
|
310
|
+
<p>Creates a read and write client to interface with the Purple Air API.</p>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
</div>
|
|
314
|
+
</div>
|
|
315
|
+
<div class="tags">
|
|
316
|
+
|
|
317
|
+
<div class="examples">
|
|
318
|
+
<p class="tag_title">Examples:</p>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<p class="example_title"><div class='inline'>
|
|
322
|
+
<p>generate a client instance</p>
|
|
323
|
+
</div></p>
|
|
324
|
+
|
|
325
|
+
<pre class="example code"><code><span class='const'><span class='object_link'><a href="../../PurpleAirApi.html" title="PurpleAirApi (module)">PurpleAirApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../V1.html" title="PurpleAirApi::V1 (module)">V1</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="PurpleAirApi::V1::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>read_token:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1234</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>write_token:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1234</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
326
|
+
|
|
327
|
+
</div>
|
|
328
|
+
<p class="tag_title">Parameters:</p>
|
|
329
|
+
<ul class="param">
|
|
330
|
+
|
|
331
|
+
<li>
|
|
332
|
+
|
|
333
|
+
<span class='name'>read_token</span>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<em class="default">(defaults to: <tt></tt>)</em>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
—
|
|
343
|
+
<div class='inline'>
|
|
344
|
+
<p>The read client you received from PurpleAir</p>
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
</li>
|
|
348
|
+
|
|
349
|
+
<li>
|
|
350
|
+
|
|
351
|
+
<span class='name'>write_token</span>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<em class="default">(defaults to: <tt></tt>)</em>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
—
|
|
361
|
+
<div class='inline'>
|
|
362
|
+
<p>The write client you received from PurpleAir</p>
|
|
363
|
+
</div>
|
|
364
|
+
|
|
365
|
+
</li>
|
|
366
|
+
|
|
367
|
+
</ul>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
</div><table class="source_code">
|
|
371
|
+
<tr>
|
|
372
|
+
<td>
|
|
373
|
+
<pre class="lines">
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
21
|
|
377
|
+
22
|
|
378
|
+
23
|
|
379
|
+
24</pre>
|
|
380
|
+
</td>
|
|
381
|
+
<td>
|
|
382
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/client.rb', line 21</span>
|
|
383
|
+
|
|
384
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>read_token:</span><span class='comma'>,</span> <span class='label'>write_token:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
385
|
+
<span class='ivar'>@read_client</span> <span class='op'>=</span> <span class='id identifier rubyid_create_http_client'>create_http_client</span><span class='lparen'>(</span><span class='id identifier rubyid_read_token'>read_token</span><span class='rparen'>)</span>
|
|
386
|
+
<span class='ivar'>@write_client</span> <span class='op'>=</span> <span class='id identifier rubyid_create_http_client'>create_http_client</span><span class='lparen'>(</span><span class='id identifier rubyid_write_token'>write_token</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_write_token'>write_token</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
387
|
+
<span class='kw'>end</span></pre>
|
|
388
|
+
</td>
|
|
389
|
+
</tr>
|
|
390
|
+
</table>
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
</div>
|
|
394
|
+
|
|
395
|
+
<div id="instance_attr_details" class="attr_details">
|
|
396
|
+
<h2>Instance Attribute Details</h2>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<span id=""></span>
|
|
400
|
+
<div class="method_details first">
|
|
401
|
+
<h3 class="signature first" id="read_client-instance_method">
|
|
402
|
+
|
|
403
|
+
#<strong>read_client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
</h3><div class="docstring">
|
|
410
|
+
<div class="discussion">
|
|
411
|
+
|
|
412
|
+
<p>Returns the value of attribute read_client.</p>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
</div>
|
|
416
|
+
</div>
|
|
417
|
+
<div class="tags">
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
</div><table class="source_code">
|
|
421
|
+
<tr>
|
|
422
|
+
<td>
|
|
423
|
+
<pre class="lines">
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
9
|
|
427
|
+
10
|
|
428
|
+
11</pre>
|
|
429
|
+
</td>
|
|
430
|
+
<td>
|
|
431
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/client.rb', line 9</span>
|
|
432
|
+
|
|
433
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_read_client'>read_client</span>
|
|
434
|
+
<span class='ivar'>@read_client</span>
|
|
435
|
+
<span class='kw'>end</span></pre>
|
|
436
|
+
</td>
|
|
437
|
+
</tr>
|
|
438
|
+
</table>
|
|
439
|
+
</div>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span id=""></span>
|
|
443
|
+
<div class="method_details ">
|
|
444
|
+
<h3 class="signature " id="write_client-instance_method">
|
|
445
|
+
|
|
446
|
+
#<strong>write_client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
</h3><div class="docstring">
|
|
453
|
+
<div class="discussion">
|
|
454
|
+
|
|
455
|
+
<p>Returns the value of attribute write_client.</p>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
</div>
|
|
459
|
+
</div>
|
|
460
|
+
<div class="tags">
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
</div><table class="source_code">
|
|
464
|
+
<tr>
|
|
465
|
+
<td>
|
|
466
|
+
<pre class="lines">
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
9
|
|
470
|
+
10
|
|
471
|
+
11</pre>
|
|
472
|
+
</td>
|
|
473
|
+
<td>
|
|
474
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/client.rb', line 9</span>
|
|
475
|
+
|
|
476
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_write_client'>write_client</span>
|
|
477
|
+
<span class='ivar'>@write_client</span>
|
|
478
|
+
<span class='kw'>end</span></pre>
|
|
479
|
+
</td>
|
|
480
|
+
</tr>
|
|
481
|
+
</table>
|
|
482
|
+
</div>
|
|
483
|
+
|
|
484
|
+
</div>
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
<div id="instance_method_details" class="method_details_list">
|
|
488
|
+
<h2>Instance Method Details</h2>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<div class="method_details first">
|
|
492
|
+
<h3 class="signature first" id="request_sensor-instance_method">
|
|
493
|
+
|
|
494
|
+
#<strong>request_sensor</strong>(sensor_index, read_key: nil) ⇒ <tt>PurpleAirApi::GetSensor</tt>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
</h3><div class="docstring">
|
|
501
|
+
<div class="discussion">
|
|
502
|
+
|
|
503
|
+
<p>Makes a request to the individual sensor SHOW endpoint and returns an instance of the V1::GetSensors class.</p>
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
</div>
|
|
507
|
+
</div>
|
|
508
|
+
<div class="tags">
|
|
509
|
+
|
|
510
|
+
<div class="examples">
|
|
511
|
+
<p class="tag_title">Examples:</p>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
<p class="example_title"><div class='inline'>
|
|
515
|
+
<p>request sensor data for a few sensors</p>
|
|
516
|
+
</div></p>
|
|
517
|
+
|
|
518
|
+
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../PurpleAirApi.html" title="PurpleAirApi (module)">PurpleAirApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../V1.html" title="PurpleAirApi::V1 (module)">V1</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="PurpleAirApi::V1::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="PurpleAirApi::V1::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>read_token:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1234</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
519
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request_sensor'>request_sensor</span><span class='lparen'>(</span><span class='label'>sensor_index:</span> <span class='int'>20</span><span class='rparen'>)</span>
|
|
520
|
+
<span class='id identifier rubyid_response_hash'>response_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span></code></pre>
|
|
521
|
+
|
|
522
|
+
</div>
|
|
523
|
+
<p class="tag_title">Parameters:</p>
|
|
524
|
+
<ul class="param">
|
|
525
|
+
|
|
526
|
+
<li>
|
|
527
|
+
|
|
528
|
+
<span class='name'>sensor_index</span>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
—
|
|
536
|
+
<div class='inline'>
|
|
537
|
+
<p>The sensor_index for the sensor you want to request data from.</p>
|
|
538
|
+
</div>
|
|
539
|
+
|
|
540
|
+
</li>
|
|
541
|
+
|
|
542
|
+
<li>
|
|
543
|
+
|
|
544
|
+
<span class='name'>read_key</span>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
—
|
|
554
|
+
<div class='inline'>
|
|
555
|
+
<p>The read_key for the sensor you want to request data from if it is a private sensor.</p>
|
|
556
|
+
</div>
|
|
557
|
+
|
|
558
|
+
</li>
|
|
559
|
+
|
|
560
|
+
</ul>
|
|
561
|
+
|
|
562
|
+
<p class="tag_title">Returns:</p>
|
|
563
|
+
<ul class="return">
|
|
564
|
+
|
|
565
|
+
<li>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
<span class='type'>(<tt>PurpleAirApi::GetSensor</tt>)</span>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
</li>
|
|
573
|
+
|
|
574
|
+
</ul>
|
|
575
|
+
|
|
576
|
+
</div><table class="source_code">
|
|
577
|
+
<tr>
|
|
578
|
+
<td>
|
|
579
|
+
<pre class="lines">
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
59
|
|
583
|
+
60
|
|
584
|
+
61</pre>
|
|
585
|
+
</td>
|
|
586
|
+
<td>
|
|
587
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/client.rb', line 59</span>
|
|
588
|
+
|
|
589
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_request_sensor'>request_sensor</span><span class='lparen'>(</span><span class='label'>sensor_index:</span><span class='comma'>,</span> <span class='label'>read_key:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
590
|
+
<span class='const'><span class='object_link'><a href="GetSensor.html" title="PurpleAirApi::V1::GetSensor (class)">GetSensor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="GetSensor.html#call-class_method" title="PurpleAirApi::V1::GetSensor.call (method)">call</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='id identifier rubyid_read_client'>read_client</span><span class='comma'>,</span> <span class='label'>sensor_index:</span> <span class='id identifier rubyid_sensor_index'>sensor_index</span><span class='comma'>,</span> <span class='label'>read_key:</span> <span class='id identifier rubyid_read_key'>read_key</span><span class='rparen'>)</span>
|
|
591
|
+
<span class='kw'>end</span></pre>
|
|
592
|
+
</td>
|
|
593
|
+
</tr>
|
|
594
|
+
</table>
|
|
595
|
+
</div>
|
|
596
|
+
|
|
597
|
+
<div class="method_details ">
|
|
598
|
+
<h3 class="signature " id="request_sensors-instance_method">
|
|
599
|
+
|
|
600
|
+
#<strong>request_sensors</strong>(options) ⇒ <tt>PurpleAirApi::GetSensors</tt>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</h3><div class="docstring">
|
|
607
|
+
<div class="discussion">
|
|
608
|
+
|
|
609
|
+
<p>Makes a request to the sensors INDEX endpoint and returns an instance of the V1::GetSensors class.</p>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
</div>
|
|
613
|
+
</div>
|
|
614
|
+
<div class="tags">
|
|
615
|
+
|
|
616
|
+
<div class="examples">
|
|
617
|
+
<p class="tag_title">Examples:</p>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
<pre class="example code"><code><span class='lbrace'>{</span> <span class='label'>bounding_box:</span> <span class='lbrace'>{</span> <span class='label'>nw:</span> <span class='lbracket'>[</span><span class='float'>37.7790262</span><span class='comma'>,</span> <span class='op'>-</span><span class='float'>122.4199061</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>se:</span> <span class='lbracket'>[</span><span class='float'>37.6535403</span><span class='comma'>,</span> <span class='op'>-</span><span class='float'>122.4168664</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='rbrace'>}</span></code></pre>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
<p class="example_title"><div class='inline'>
|
|
624
|
+
<p>request sensor data for a few sensors</p>
|
|
625
|
+
</div></p>
|
|
626
|
+
|
|
627
|
+
<pre class="example code"><code><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>fields:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>icon</span><span class='tstring_end'>'</span></span><span class='comma'>,</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><span class='comma'>,</span> <span class='label'>location_type:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>outside</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>show_only:</span> <span class='lbracket'>[</span><span class='int'>20</span><span class='comma'>,</span> <span class='int'>47</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>max_age:</span> <span class='int'>3600</span><span class='rbrace'>}</span>
|
|
628
|
+
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../PurpleAirApi.html" title="PurpleAirApi (module)">PurpleAirApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../V1.html" title="PurpleAirApi::V1 (module)">V1</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="PurpleAirApi::V1::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="PurpleAirApi::V1::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>read_token:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1234</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>write_token:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1234</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
629
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_request_sensors'>request_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
630
|
+
<span class='id identifier rubyid_response_hash'>response_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span></code></pre>
|
|
631
|
+
|
|
632
|
+
</div>
|
|
633
|
+
<p class="tag_title">Parameters:</p>
|
|
634
|
+
<ul class="param">
|
|
635
|
+
|
|
636
|
+
<li>
|
|
637
|
+
|
|
638
|
+
<span class='name'>options</span>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
—
|
|
646
|
+
<div class='inline'>
|
|
647
|
+
<p>A hash of options { :option_name=>value }</p>
|
|
648
|
+
</div>
|
|
649
|
+
|
|
650
|
+
</li>
|
|
651
|
+
|
|
652
|
+
</ul>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
658
|
+
<ul class="option">
|
|
659
|
+
|
|
660
|
+
<li>
|
|
661
|
+
<span class="name">:show_only</span>
|
|
662
|
+
<span class="type">(<tt>Array<Integer></tt>)</span>
|
|
663
|
+
<span class="default">
|
|
664
|
+
|
|
665
|
+
</span>
|
|
666
|
+
|
|
667
|
+
— <div class='inline'>
|
|
668
|
+
<p>An array of indexes for the sensors you want to request.</p>
|
|
669
|
+
</div>
|
|
670
|
+
|
|
671
|
+
</li>
|
|
672
|
+
|
|
673
|
+
<li>
|
|
674
|
+
<span class="name">:location_type</span>
|
|
675
|
+
<span class="type">(<tt>Array<String></tt>)</span>
|
|
676
|
+
<span class="default">
|
|
677
|
+
|
|
678
|
+
</span>
|
|
679
|
+
|
|
680
|
+
— <div class='inline'>
|
|
681
|
+
<p>An array of strings specifying sensor location.</p>
|
|
682
|
+
</div>
|
|
683
|
+
|
|
684
|
+
</li>
|
|
685
|
+
|
|
686
|
+
<li>
|
|
687
|
+
<span class="name">:fields</span>
|
|
688
|
+
<span class="type">(<tt>Array<String></tt>)</span>
|
|
689
|
+
<span class="default">
|
|
690
|
+
|
|
691
|
+
</span>
|
|
692
|
+
|
|
693
|
+
— <div class='inline'>
|
|
694
|
+
<p>An array of fields you want returned.</p>
|
|
695
|
+
</div>
|
|
696
|
+
|
|
697
|
+
</li>
|
|
698
|
+
|
|
699
|
+
<li>
|
|
700
|
+
<span class="name">:modified_since</span>
|
|
701
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
702
|
+
<span class="default">
|
|
703
|
+
|
|
704
|
+
</span>
|
|
705
|
+
|
|
706
|
+
— <div class='inline'>
|
|
707
|
+
<p>Only return sensors updated since this timestamp.</p>
|
|
708
|
+
</div>
|
|
709
|
+
|
|
710
|
+
</li>
|
|
711
|
+
|
|
712
|
+
<li>
|
|
713
|
+
<span class="name">:max_age</span>
|
|
714
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
715
|
+
<span class="default">
|
|
716
|
+
|
|
717
|
+
</span>
|
|
718
|
+
|
|
719
|
+
— <div class='inline'>
|
|
720
|
+
<p>Only return sensors updated in the last n seconds.</p>
|
|
721
|
+
</div>
|
|
722
|
+
|
|
723
|
+
</li>
|
|
724
|
+
|
|
725
|
+
<li>
|
|
726
|
+
<span class="name">:bounding_box</span>
|
|
727
|
+
<span class="type">(<tt>Hash<array></tt>)</span>
|
|
728
|
+
<span class="default">
|
|
729
|
+
|
|
730
|
+
</span>
|
|
731
|
+
|
|
732
|
+
— <div class='inline'>
|
|
733
|
+
<p>A hash with a :nw and :se array { nw: [lat,long], se: [lat,long] }.</p>
|
|
734
|
+
</div>
|
|
735
|
+
|
|
736
|
+
</li>
|
|
737
|
+
|
|
738
|
+
<li>
|
|
739
|
+
<span class="name">:read_keys</span>
|
|
740
|
+
<span class="type">(<tt>Array<String></tt>)</span>
|
|
741
|
+
<span class="default">
|
|
742
|
+
|
|
743
|
+
</span>
|
|
744
|
+
|
|
745
|
+
— <div class='inline'>
|
|
746
|
+
<p>An array of read-keys which are required for private devices.</p>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
</li>
|
|
750
|
+
|
|
751
|
+
</ul>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
<p class="tag_title">Returns:</p>
|
|
755
|
+
<ul class="return">
|
|
756
|
+
|
|
757
|
+
<li>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
<span class='type'>(<tt>PurpleAirApi::GetSensors</tt>)</span>
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
</li>
|
|
765
|
+
|
|
766
|
+
</ul>
|
|
767
|
+
|
|
768
|
+
</div><table class="source_code">
|
|
769
|
+
<tr>
|
|
770
|
+
<td>
|
|
771
|
+
<pre class="lines">
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
45
|
|
775
|
+
46
|
|
776
|
+
47</pre>
|
|
777
|
+
</td>
|
|
778
|
+
<td>
|
|
779
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/client.rb', line 45</span>
|
|
780
|
+
|
|
781
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_request_sensors'>request_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
782
|
+
<span class='const'><span class='object_link'><a href="GetSensors.html" title="PurpleAirApi::V1::GetSensors (class)">GetSensors</a></span></span><span class='period'>.</span><span class='id identifier rubyid_call'><span class='object_link'><a href="GetSensors.html#call-class_method" title="PurpleAirApi::V1::GetSensors.call (method)">call</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='id identifier rubyid_read_client'>read_client</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
783
|
+
<span class='kw'>end</span></pre>
|
|
784
|
+
</td>
|
|
785
|
+
</tr>
|
|
786
|
+
</table>
|
|
787
|
+
</div>
|
|
788
|
+
|
|
789
|
+
</div>
|
|
790
|
+
|
|
791
|
+
</div>
|
|
792
|
+
|
|
793
|
+
<div id="footer">
|
|
794
|
+
Generated on Fri Mar 12 10:06:11 2021 by
|
|
795
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
796
|
+
0.9.26 (ruby-3.0.0).
|
|
797
|
+
</div>
|
|
798
|
+
|
|
799
|
+
</div>
|
|
800
|
+
</body>
|
|
801
|
+
</html>
|