purple_air_api 0.1.0 → 0.1.1
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/.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,979 @@
|
|
|
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::GetSensors
|
|
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::GetSensors";
|
|
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 (G)</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">GetSensors</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::GetSensors
|
|
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::GetSensors</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/sensors/get_sensors.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Class for requesting sensor data. This will return different response formats from the API.</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="DEFAULT_FIELDS-constant" class="">DEFAULT_FIELDS =
|
|
123
|
+
<div class="docstring">
|
|
124
|
+
<div class="discussion">
|
|
125
|
+
|
|
126
|
+
<p>The default value for fields that will be returned by PurpleAir</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tags">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</dt>
|
|
136
|
+
<dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>icon</span><span class='words_sep'> </span><span class='tstring_content'>name</span><span class='words_sep'> </span><span class='tstring_content'>latitude</span><span class='words_sep'> </span><span class='tstring_content'>longitude</span><span class='words_sep'> </span><span class='tstring_content'>altitude</span><span class='words_sep'> </span><span class='tstring_content'>pm2.5</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
137
|
+
|
|
138
|
+
<dt id="DEFAULT_LOCATION_TYPE-constant" class="">DEFAULT_LOCATION_TYPE =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<p>The default location type for the sensor</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</dt>
|
|
152
|
+
<dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>outside</span><span class='words_sep'> </span><span class='tstring_content'>inside</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
153
|
+
|
|
154
|
+
<dt id="URL-constant" class="">URL =
|
|
155
|
+
<div class="docstring">
|
|
156
|
+
<div class="discussion">
|
|
157
|
+
|
|
158
|
+
<p>The endpoint URL</p>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
</div>
|
|
163
|
+
<div class="tags">
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</div>
|
|
167
|
+
</dt>
|
|
168
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.purpleair.com/v1/sensors</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
169
|
+
|
|
170
|
+
</dl>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
177
|
+
<ul class="summary">
|
|
178
|
+
|
|
179
|
+
<li class="public ">
|
|
180
|
+
<span class="summary_signature">
|
|
181
|
+
|
|
182
|
+
<a href="#http_client-instance_method" title="#http_client (instance method)">#<strong>http_client</strong> ⇒ Object </a>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</span>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="note title readonly">readonly</span>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<span class="summary_desc"><div class='inline'>
|
|
202
|
+
<p>Returns the value of attribute http_client.</p>
|
|
203
|
+
</div></span>
|
|
204
|
+
|
|
205
|
+
</li>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<li class="public ">
|
|
209
|
+
<span class="summary_signature">
|
|
210
|
+
|
|
211
|
+
<a href="#http_response-instance_method" title="#http_response (instance method)">#<strong>http_response</strong> ⇒ Object </a>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</span>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<span class="summary_desc"><div class='inline'>
|
|
229
|
+
<p>Returns the value of attribute http_response.</p>
|
|
230
|
+
</div></span>
|
|
231
|
+
|
|
232
|
+
</li>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<li class="public ">
|
|
236
|
+
<span class="summary_signature">
|
|
237
|
+
|
|
238
|
+
<a href="#parsed_response-instance_method" title="#parsed_response (instance method)">#<strong>parsed_response</strong> ⇒ Hash </a>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
</span>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<span class="summary_desc"><div class='inline'>
|
|
256
|
+
<p>Takes the raw response from PurpleAir and generates a hash indexed by sensor index.</p>
|
|
257
|
+
</div></span>
|
|
258
|
+
|
|
259
|
+
</li>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<li class="public ">
|
|
263
|
+
<span class="summary_signature">
|
|
264
|
+
|
|
265
|
+
<a href="#request_options-instance_method" title="#request_options (instance method)">#<strong>request_options</strong> ⇒ Object </a>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</span>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<span class="summary_desc"><div class='inline'>
|
|
283
|
+
<p>Returns the value of attribute request_options.</p>
|
|
284
|
+
</div></span>
|
|
285
|
+
|
|
286
|
+
</li>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
</ul>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<h2>
|
|
296
|
+
Class Method Summary
|
|
297
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
298
|
+
</h2>
|
|
299
|
+
|
|
300
|
+
<ul class="summary">
|
|
301
|
+
|
|
302
|
+
<li class="public ">
|
|
303
|
+
<span class="summary_signature">
|
|
304
|
+
|
|
305
|
+
<a href="#call-class_method" title="call (class method)">.<strong>call</strong> ⇒ Object </a>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
<span class="summary_desc"><div class='inline'>
|
|
320
|
+
<p>Calls initializes the class and requests the data from PurpleAir.</p>
|
|
321
|
+
</div></span>
|
|
322
|
+
|
|
323
|
+
</li>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
</ul>
|
|
327
|
+
|
|
328
|
+
<h2>
|
|
329
|
+
Instance Method Summary
|
|
330
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
331
|
+
</h2>
|
|
332
|
+
|
|
333
|
+
<ul class="summary">
|
|
334
|
+
|
|
335
|
+
<li class="public ">
|
|
336
|
+
<span class="summary_signature">
|
|
337
|
+
|
|
338
|
+
<a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(...) ⇒ Object </a>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
</span>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
<span class="summary_desc"><div class='inline'>
|
|
353
|
+
<p>Calls initializes the class and requests the data from PurpleAir.</p>
|
|
354
|
+
</div></span>
|
|
355
|
+
|
|
356
|
+
</li>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<li class="public ">
|
|
360
|
+
<span class="summary_signature">
|
|
361
|
+
|
|
362
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client: , **options) ⇒ GetSensors </a>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
</span>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
<span class="note title constructor">constructor</span>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
<span class="summary_desc"><div class='inline'>
|
|
379
|
+
<p>Creates a HTTP friendly options hash depending on your inputs.</p>
|
|
380
|
+
</div></span>
|
|
381
|
+
|
|
382
|
+
</li>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<li class="public ">
|
|
386
|
+
<span class="summary_signature">
|
|
387
|
+
|
|
388
|
+
<a href="#json_response-instance_method" title="#json_response (instance method)">#<strong>json_response</strong> ⇒ Hash </a>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</span>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
<span class="summary_desc"><div class='inline'>
|
|
403
|
+
<p>Takes the raw response from PurpleAir and parses the JSON into a Hash.</p>
|
|
404
|
+
</div></span>
|
|
405
|
+
|
|
406
|
+
</li>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<li class="public ">
|
|
410
|
+
<span class="summary_signature">
|
|
411
|
+
|
|
412
|
+
<a href="#request-instance_method" title="#request (instance method)">#<strong>request</strong> ⇒ PurpleAirApi::V1::GetSensors </a>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
</span>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<span class="summary_desc"><div class='inline'>
|
|
427
|
+
<p>Makes a get request to the PurpleAir Get Sensors Data endpoint <a href="https://api.purpleair.com/v1/sensors">api.purpleair.com/v1/sensors</a>.</p>
|
|
428
|
+
</div></span>
|
|
429
|
+
|
|
430
|
+
</li>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
</ul>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<div id="constructor_details" class="method_details_list">
|
|
437
|
+
<h2>Constructor Details</h2>
|
|
438
|
+
|
|
439
|
+
<div class="method_details first">
|
|
440
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
441
|
+
|
|
442
|
+
#<strong>initialize</strong>(client: , **options) ⇒ <tt><span class='object_link'><a href="" title="PurpleAirApi::V1::GetSensors (class)">GetSensors</a></span></tt>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
</h3><div class="docstring">
|
|
449
|
+
<div class="discussion">
|
|
450
|
+
|
|
451
|
+
<p>Creates a HTTP friendly options hash depending on your inputs</p>
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
</div>
|
|
455
|
+
</div>
|
|
456
|
+
<div class="tags">
|
|
457
|
+
<p class="tag_title">Parameters:</p>
|
|
458
|
+
<ul class="param">
|
|
459
|
+
|
|
460
|
+
<li>
|
|
461
|
+
|
|
462
|
+
<span class='name'>client</span>
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<em class="default">(defaults to: <tt></tt>)</em>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
—
|
|
472
|
+
<div class='inline'>
|
|
473
|
+
<p>Your HTTP client initialized in Client</p>
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
</li>
|
|
477
|
+
|
|
478
|
+
<li>
|
|
479
|
+
|
|
480
|
+
<span class='name'>options</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
—
|
|
488
|
+
<div class='inline'>
|
|
489
|
+
<p>Your HTTP options for the request.</p>
|
|
490
|
+
</div>
|
|
491
|
+
|
|
492
|
+
</li>
|
|
493
|
+
|
|
494
|
+
</ul>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</div><table class="source_code">
|
|
498
|
+
<tr>
|
|
499
|
+
<td>
|
|
500
|
+
<pre class="lines">
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
32
|
|
504
|
+
33
|
|
505
|
+
34
|
|
506
|
+
35
|
|
507
|
+
36</pre>
|
|
508
|
+
</td>
|
|
509
|
+
<td>
|
|
510
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 32</span>
|
|
511
|
+
|
|
512
|
+
<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='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
513
|
+
<span class='ivar'>@http_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
514
|
+
<span class='ivar'>@request_options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
515
|
+
<span class='id identifier rubyid_create_options_hash'>create_options_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
516
|
+
<span class='kw'>end</span></pre>
|
|
517
|
+
</td>
|
|
518
|
+
</tr>
|
|
519
|
+
</table>
|
|
520
|
+
</div>
|
|
521
|
+
|
|
522
|
+
</div>
|
|
523
|
+
|
|
524
|
+
<div id="instance_attr_details" class="attr_details">
|
|
525
|
+
<h2>Instance Attribute Details</h2>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
<span id=""></span>
|
|
529
|
+
<div class="method_details first">
|
|
530
|
+
<h3 class="signature first" id="http_client-instance_method">
|
|
531
|
+
|
|
532
|
+
#<strong>http_client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
</h3><div class="docstring">
|
|
539
|
+
<div class="discussion">
|
|
540
|
+
|
|
541
|
+
<p>Returns the value of attribute http_client.</p>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
</div>
|
|
545
|
+
</div>
|
|
546
|
+
<div class="tags">
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div><table class="source_code">
|
|
550
|
+
<tr>
|
|
551
|
+
<td>
|
|
552
|
+
<pre class="lines">
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
8
|
|
556
|
+
9
|
|
557
|
+
10</pre>
|
|
558
|
+
</td>
|
|
559
|
+
<td>
|
|
560
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 8</span>
|
|
561
|
+
|
|
562
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_http_client'>http_client</span>
|
|
563
|
+
<span class='ivar'>@http_client</span>
|
|
564
|
+
<span class='kw'>end</span></pre>
|
|
565
|
+
</td>
|
|
566
|
+
</tr>
|
|
567
|
+
</table>
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<span id="http_response=-instance_method"></span>
|
|
572
|
+
<div class="method_details ">
|
|
573
|
+
<h3 class="signature " id="http_response-instance_method">
|
|
574
|
+
|
|
575
|
+
#<strong>http_response</strong> ⇒ <tt>Object</tt>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</h3><div class="docstring">
|
|
582
|
+
<div class="discussion">
|
|
583
|
+
|
|
584
|
+
<p>Returns the value of attribute http_response.</p>
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
</div>
|
|
588
|
+
</div>
|
|
589
|
+
<div class="tags">
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
</div><table class="source_code">
|
|
593
|
+
<tr>
|
|
594
|
+
<td>
|
|
595
|
+
<pre class="lines">
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
7
|
|
599
|
+
8
|
|
600
|
+
9</pre>
|
|
601
|
+
</td>
|
|
602
|
+
<td>
|
|
603
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 7</span>
|
|
604
|
+
|
|
605
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_http_response'>http_response</span>
|
|
606
|
+
<span class='ivar'>@http_response</span>
|
|
607
|
+
<span class='kw'>end</span></pre>
|
|
608
|
+
</td>
|
|
609
|
+
</tr>
|
|
610
|
+
</table>
|
|
611
|
+
</div>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
<span id="parsed_response=-instance_method"></span>
|
|
615
|
+
<div class="method_details ">
|
|
616
|
+
<h3 class="signature " id="parsed_response-instance_method">
|
|
617
|
+
|
|
618
|
+
#<strong>parsed_response</strong> ⇒ <tt>Hash</tt>
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
</h3><div class="docstring">
|
|
625
|
+
<div class="discussion">
|
|
626
|
+
|
|
627
|
+
<p>Takes the raw response from PurpleAir and generates a hash indexed by sensor index. You can use this response like a normal hash object. This <a href=":47">GetSensorsClass.parsed_response</a> would return a hash of data for sensor 47 with each hash key labelling the associated data.</p>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
</div>
|
|
631
|
+
</div>
|
|
632
|
+
<div class="tags">
|
|
633
|
+
|
|
634
|
+
<div class="examples">
|
|
635
|
+
<p class="tag_title">Examples:</p>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
<p class="example_title"><div class='inline'>
|
|
639
|
+
<p>parsed_response example</p>
|
|
640
|
+
</div></p>
|
|
641
|
+
|
|
642
|
+
<pre class="example code"><code><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_parsed_response'>parsed_response</span>
|
|
643
|
+
<span class='lbrace'>{</span>
|
|
644
|
+
<span class='symbol'>:fields</span><span class='op'>=></span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor_index</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='comma'>,</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'>latitude</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>longitude</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>altitude</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>pm2.5</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
645
|
+
<span class='symbol'>:api_version</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>V1.0.6-0.0.9</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
646
|
+
<span class='symbol'>:time_stamp</span><span class='op'>=></span><span class='int'>1614787814</span><span class='comma'>,</span>
|
|
647
|
+
<span class='symbol'>:data_time_stamp</span><span class='op'>=></span><span class='kw'>nil</span><span class='comma'>,</span>
|
|
648
|
+
<span class='symbol'>:max_age</span><span class='op'>=></span><span class='int'>3600</span><span class='comma'>,</span>
|
|
649
|
+
<span class='symbol'>:data</span><span class='op'>=></span>
|
|
650
|
+
<span class='lbrace'>{</span>
|
|
651
|
+
<span class='int'>20</span><span class='op'>=></span><span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor_index</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='int'>20</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='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Oakdale</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>icon</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>latitude</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='float'>40.6031</span><span class='comma'>,</span>
|
|
652
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>longitude</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='op'>-</span><span class='float'>111.8361</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>altitude</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='int'>4636</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>pm2.5</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='float'>0.0</span><span class='rbrace'>}</span><span class='comma'>,</span>
|
|
653
|
+
<span class='int'>47</span><span class='op'>=></span><span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor_index</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='int'>47</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='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>OZONE TEST</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>icon</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>latitude</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='float'>40.4762</span><span class='comma'>,</span>
|
|
654
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>longitude</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='op'>-</span><span class='float'>111.8826</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>altitude</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='kw'>nil</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>pm2.5</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='kw'>nil</span><span class='rbrace'>}</span>
|
|
655
|
+
<span class='rbrace'>}</span>
|
|
656
|
+
<span class='rbrace'>}</span></code></pre>
|
|
657
|
+
|
|
658
|
+
</div>
|
|
659
|
+
|
|
660
|
+
<p class="tag_title">Returns:</p>
|
|
661
|
+
<ul class="return">
|
|
662
|
+
|
|
663
|
+
<li>
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
</li>
|
|
671
|
+
|
|
672
|
+
</ul>
|
|
673
|
+
|
|
674
|
+
</div><table class="source_code">
|
|
675
|
+
<tr>
|
|
676
|
+
<td>
|
|
677
|
+
<pre class="lines">
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
69
|
|
681
|
+
70
|
|
682
|
+
71</pre>
|
|
683
|
+
</td>
|
|
684
|
+
<td>
|
|
685
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 69</span>
|
|
686
|
+
|
|
687
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parsed_response'>parsed_response</span>
|
|
688
|
+
<span class='ivar'>@parsed_response</span> <span class='op'>||=</span> <span class='id identifier rubyid_parse_response'>parse_response</span>
|
|
689
|
+
<span class='kw'>end</span></pre>
|
|
690
|
+
</td>
|
|
691
|
+
</tr>
|
|
692
|
+
</table>
|
|
693
|
+
</div>
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
<span id="request_options=-instance_method"></span>
|
|
697
|
+
<div class="method_details ">
|
|
698
|
+
<h3 class="signature " id="request_options-instance_method">
|
|
699
|
+
|
|
700
|
+
#<strong>request_options</strong> ⇒ <tt>Object</tt>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
</h3><div class="docstring">
|
|
707
|
+
<div class="discussion">
|
|
708
|
+
|
|
709
|
+
<p>Returns the value of attribute request_options.</p>
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
</div>
|
|
713
|
+
</div>
|
|
714
|
+
<div class="tags">
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
</div><table class="source_code">
|
|
718
|
+
<tr>
|
|
719
|
+
<td>
|
|
720
|
+
<pre class="lines">
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
7
|
|
724
|
+
8
|
|
725
|
+
9</pre>
|
|
726
|
+
</td>
|
|
727
|
+
<td>
|
|
728
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 7</span>
|
|
729
|
+
|
|
730
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_request_options'>request_options</span>
|
|
731
|
+
<span class='ivar'>@request_options</span>
|
|
732
|
+
<span class='kw'>end</span></pre>
|
|
733
|
+
</td>
|
|
734
|
+
</tr>
|
|
735
|
+
</table>
|
|
736
|
+
</div>
|
|
737
|
+
|
|
738
|
+
</div>
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
<div id="class_method_details" class="method_details_list">
|
|
742
|
+
<h2>Class Method Details</h2>
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
<div class="method_details first">
|
|
746
|
+
<h3 class="signature first" id="call-class_method">
|
|
747
|
+
|
|
748
|
+
.<strong>call</strong> ⇒ <tt>Object</tt>
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
</h3><div class="docstring">
|
|
755
|
+
<div class="discussion">
|
|
756
|
+
|
|
757
|
+
<p>Calls initializes the class and requests the data from PurpleAir.</p>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
</div>
|
|
761
|
+
</div>
|
|
762
|
+
<div class="tags">
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
</div><table class="source_code">
|
|
766
|
+
<tr>
|
|
767
|
+
<td>
|
|
768
|
+
<pre class="lines">
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
23
|
|
772
|
+
24
|
|
773
|
+
25</pre>
|
|
774
|
+
</td>
|
|
775
|
+
<td>
|
|
776
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 23</span>
|
|
777
|
+
|
|
778
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span>
|
|
779
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span>
|
|
780
|
+
<span class='kw'>end</span></pre>
|
|
781
|
+
</td>
|
|
782
|
+
</tr>
|
|
783
|
+
</table>
|
|
784
|
+
</div>
|
|
785
|
+
|
|
786
|
+
</div>
|
|
787
|
+
|
|
788
|
+
<div id="instance_method_details" class="method_details_list">
|
|
789
|
+
<h2>Instance Method Details</h2>
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<div class="method_details first">
|
|
793
|
+
<h3 class="signature first" id="call-instance_method">
|
|
794
|
+
|
|
795
|
+
#<strong>call</strong>(...) ⇒ <tt>Object</tt>
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
</h3><div class="docstring">
|
|
802
|
+
<div class="discussion">
|
|
803
|
+
|
|
804
|
+
<p>Calls initializes the class and requests the data from PurpleAir.</p>
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
</div>
|
|
808
|
+
</div>
|
|
809
|
+
<div class="tags">
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</div><table class="source_code">
|
|
813
|
+
<tr>
|
|
814
|
+
<td>
|
|
815
|
+
<pre class="lines">
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
23
|
|
819
|
+
24
|
|
820
|
+
25</pre>
|
|
821
|
+
</td>
|
|
822
|
+
<td>
|
|
823
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 23</span>
|
|
824
|
+
|
|
825
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span>
|
|
826
|
+
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span>
|
|
827
|
+
<span class='kw'>end</span></pre>
|
|
828
|
+
</td>
|
|
829
|
+
</tr>
|
|
830
|
+
</table>
|
|
831
|
+
</div>
|
|
832
|
+
|
|
833
|
+
<div class="method_details ">
|
|
834
|
+
<h3 class="signature " id="json_response-instance_method">
|
|
835
|
+
|
|
836
|
+
#<strong>json_response</strong> ⇒ <tt>Hash</tt>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</h3><div class="docstring">
|
|
843
|
+
<div class="discussion">
|
|
844
|
+
|
|
845
|
+
<p>Takes the raw response from PurpleAir and parses the JSON into a Hash.</p>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
</div>
|
|
849
|
+
</div>
|
|
850
|
+
<div class="tags">
|
|
851
|
+
|
|
852
|
+
<div class="examples">
|
|
853
|
+
<p class="tag_title">Examples:</p>
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
<p class="example_title"><div class='inline'>
|
|
857
|
+
<p>json_response example</p>
|
|
858
|
+
</div></p>
|
|
859
|
+
|
|
860
|
+
<pre class="example code"><code><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_json_response'>json_response</span>
|
|
861
|
+
<span class='lbrace'>{</span>
|
|
862
|
+
<span class='symbol'>:api_version</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>V1.0.6-0.0.9</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
863
|
+
<span class='symbol'>:time_stamp</span><span class='op'>=></span><span class='int'>1614787814</span><span class='comma'>,</span>
|
|
864
|
+
<span class='symbol'>:data_time_stamp</span><span class='op'>=></span><span class='int'>1614787807</span><span class='comma'>,</span>
|
|
865
|
+
<span class='symbol'>:location_type</span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span>
|
|
866
|
+
<span class='symbol'>:max_age</span><span class='op'>=></span><span class='int'>3600</span><span class='comma'>,</span>
|
|
867
|
+
<span class='symbol'>:fields</span><span class='op'>=></span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sensor_index</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='comma'>,</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'>latitude</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>longitude</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>altitude</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>pm2.5</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
868
|
+
<span class='symbol'>:data</span><span class='op'>=></span><span class='lbracket'>[</span>
|
|
869
|
+
<span class='lbracket'>[</span><span class='int'>20</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Oakdale</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='float'>40.6031</span><span class='comma'>,</span> <span class='op'>-</span><span class='float'>111.8361</span><span class='comma'>,</span> <span class='int'>4636</span><span class='comma'>,</span> <span class='float'>0.0</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
870
|
+
<span class='lbracket'>[</span><span class='int'>47</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>OZONE TEST</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='float'>40.4762</span><span class='comma'>,</span> <span class='op'>-</span><span class='float'>111.8826</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
|
|
871
|
+
<span class='rbracket'>]</span>
|
|
872
|
+
<span class='rbrace'>}</span></code></pre>
|
|
873
|
+
|
|
874
|
+
</div>
|
|
875
|
+
|
|
876
|
+
<p class="tag_title">Returns:</p>
|
|
877
|
+
<ul class="return">
|
|
878
|
+
|
|
879
|
+
<li>
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
</li>
|
|
887
|
+
|
|
888
|
+
</ul>
|
|
889
|
+
|
|
890
|
+
</div><table class="source_code">
|
|
891
|
+
<tr>
|
|
892
|
+
<td>
|
|
893
|
+
<pre class="lines">
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
91
|
|
897
|
+
92
|
|
898
|
+
93</pre>
|
|
899
|
+
</td>
|
|
900
|
+
<td>
|
|
901
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 91</span>
|
|
902
|
+
|
|
903
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_json_response'>json_response</span>
|
|
904
|
+
<span class='ivar'>@json_response</span> <span class='op'>||=</span> <span class='const'>FastJsonparser</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_http_response'>http_response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
905
|
+
<span class='kw'>end</span></pre>
|
|
906
|
+
</td>
|
|
907
|
+
</tr>
|
|
908
|
+
</table>
|
|
909
|
+
</div>
|
|
910
|
+
|
|
911
|
+
<div class="method_details ">
|
|
912
|
+
<h3 class="signature " id="request-instance_method">
|
|
913
|
+
|
|
914
|
+
#<strong>request</strong> ⇒ <tt><span class='object_link'><a href="" title="PurpleAirApi::V1::GetSensors (class)">PurpleAirApi::V1::GetSensors</a></span></tt>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
</h3><div class="docstring">
|
|
921
|
+
<div class="discussion">
|
|
922
|
+
|
|
923
|
+
<p>Makes a get request to the PurpleAir Get Sensors Data endpoint <a href="https://api.purpleair.com/v1/sensors">api.purpleair.com/v1/sensors</a>.</p>
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
</div>
|
|
927
|
+
</div>
|
|
928
|
+
<div class="tags">
|
|
929
|
+
|
|
930
|
+
<p class="tag_title">Returns:</p>
|
|
931
|
+
<ul class="return">
|
|
932
|
+
|
|
933
|
+
<li>
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="PurpleAirApi::V1::GetSensors (class)">PurpleAirApi::V1::GetSensors</a></span></tt>)</span>
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
</li>
|
|
941
|
+
|
|
942
|
+
</ul>
|
|
943
|
+
|
|
944
|
+
</div><table class="source_code">
|
|
945
|
+
<tr>
|
|
946
|
+
<td>
|
|
947
|
+
<pre class="lines">
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
42
|
|
951
|
+
43
|
|
952
|
+
44
|
|
953
|
+
45</pre>
|
|
954
|
+
</td>
|
|
955
|
+
<td>
|
|
956
|
+
<pre class="code"><span class="info file"># File 'lib/purple_air_api/V1/sensors/get_sensors.rb', line 42</span>
|
|
957
|
+
|
|
958
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span>
|
|
959
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_http_response'>http_response</span> <span class='op'>=</span> <span class='id identifier rubyid_http_client'>http_client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#URL-constant" title="PurpleAirApi::V1::GetSensors::URL (constant)">URL</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_request_options'>request_options</span><span class='rparen'>)</span>
|
|
960
|
+
<span class='kw'>self</span>
|
|
961
|
+
<span class='kw'>end</span></pre>
|
|
962
|
+
</td>
|
|
963
|
+
</tr>
|
|
964
|
+
</table>
|
|
965
|
+
</div>
|
|
966
|
+
|
|
967
|
+
</div>
|
|
968
|
+
|
|
969
|
+
</div>
|
|
970
|
+
|
|
971
|
+
<div id="footer">
|
|
972
|
+
Generated on Fri Mar 12 10:06:11 2021 by
|
|
973
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
974
|
+
0.9.26 (ruby-3.0.0).
|
|
975
|
+
</div>
|
|
976
|
+
|
|
977
|
+
</div>
|
|
978
|
+
</body>
|
|
979
|
+
</html>
|