helium-ruby 0.3.0 → 0.4.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/README.md +85 -0
- data/docs/Helium.html +4 -4
- data/docs/Helium/Client.html +43 -21
- data/docs/Helium/Client/Elements.html +335 -0
- data/docs/Helium/Client/Http.html +1 -1
- data/docs/Helium/Client/Labels.html +637 -0
- data/docs/Helium/Client/Organizations.html +1 -1
- data/docs/Helium/Client/Sensors.html +1 -1
- data/docs/Helium/Client/Users.html +1 -1
- data/docs/Helium/Cursor.html +53 -1
- data/docs/Helium/DataPoint.html +152 -90
- data/docs/Helium/Element.html +589 -0
- data/docs/Helium/Label.html +658 -0
- data/docs/Helium/Organization.html +75 -203
- data/docs/Helium/Resource.html +869 -0
- data/docs/Helium/Sensor.html +102 -215
- data/docs/Helium/User.html +68 -179
- data/docs/Helium/Utils.html +1 -1
- data/docs/_index.html +63 -1
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +107 -1
- data/docs/index.html +107 -1
- data/docs/method_list.html +267 -43
- data/docs/top-level-namespace.html +1 -1
- data/lib/helium.rb +3 -0
- data/lib/helium/client.rb +4 -0
- data/lib/helium/client/elements.rb +42 -0
- data/lib/helium/client/labels.rb +105 -0
- data/lib/helium/cursor.rb +4 -0
- data/lib/helium/data_point.rb +28 -8
- data/lib/helium/element.rb +27 -0
- data/lib/helium/label.rb +44 -0
- data/lib/helium/organization.rb +12 -15
- data/lib/helium/resource.rb +58 -0
- data/lib/helium/sensor.rb +16 -17
- data/lib/helium/user.rb +11 -13
- data/lib/helium/version.rb +1 -1
- metadata +12 -2
data/docs/class_list.html
CHANGED
@@ -43,7 +43,7 @@
|
|
43
43
|
|
44
44
|
<ul id="full_list" class="class">
|
45
45
|
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
|
46
|
-
<li id='object_Helium' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Helium.html" title="Helium (module)">Helium</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Helium::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Helium/Client.html" title="Helium::Client (class)">Client</a></span> < Object<small class='search_info'>Helium</small></div><ul><li id='object_Helium::Client::Http' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Http.html" title="Helium::Client::Http (module)">Http</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Organizations' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Sensors' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Users' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Users.html" title="Helium::Client::Users (module)">Users</a></span><small class='search_info'>Helium::Client</small></div></li></ul></li><li id='object_Helium::Cursor' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Cursor.html" title="Helium::Cursor (class)">Cursor</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::DataPoint' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span> <
|
46
|
+
<li id='object_Helium' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Helium.html" title="Helium (module)">Helium</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Helium::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Helium/Client.html" title="Helium::Client (class)">Client</a></span> < Object<small class='search_info'>Helium</small></div><ul><li id='object_Helium::Client::Elements' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Elements.html" title="Helium::Client::Elements (module)">Elements</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Http' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Http.html" title="Helium::Client::Http (module)">Http</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Labels' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Labels.html" title="Helium::Client::Labels (module)">Labels</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Organizations' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Organizations.html" title="Helium::Client::Organizations (module)">Organizations</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Sensors' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Sensors.html" title="Helium::Client::Sensors (module)">Sensors</a></span><small class='search_info'>Helium::Client</small></div></li><li id='object_Helium::Client::Users' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Helium/Client/Users.html" title="Helium::Client::Users (module)">Users</a></span><small class='search_info'>Helium::Client</small></div></li></ul></li><li id='object_Helium::Cursor' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Cursor.html" title="Helium::Cursor (class)">Cursor</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::DataPoint' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/DataPoint.html" title="Helium::DataPoint (class)">DataPoint</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Element' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Element.html" title="Helium::Element (class)">Element</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Label' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Label.html" title="Helium::Label (class)">Label</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Organization' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Organization.html" title="Helium::Organization (class)">Organization</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Resource' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Resource.html" title="Helium::Resource (class)">Resource</a></span> < Object<small class='search_info'>Helium</small></div></li><li id='object_Helium::Sensor' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Sensor.html" title="Helium::Sensor (class)">Sensor</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::User' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/User.html" title="Helium::User (class)">User</a></span> < Resource<small class='search_info'>Helium</small></div></li><li id='object_Helium::Utils' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Helium/Utils.html" title="Helium::Utils (module)">Utils</a></span><small class='search_info'>Helium</small></div></li></ul></li>
|
47
47
|
|
48
48
|
</ul>
|
49
49
|
</div>
|
data/docs/file.README.html
CHANGED
@@ -131,6 +131,24 @@
|
|
131
131
|
<span class='comment'># => #<Helium::Sensor:0x007f89acdb1b58 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="Marc's Isotope", @mac="6081f9fffe00019b", @ports=["t", "b"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
132
132
|
</span></code></pre>
|
133
133
|
|
134
|
+
<h4>Create a Virtual Sensor</h4>
|
135
|
+
|
136
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_new_sensor'>new_sensor</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>A New Sensor</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
137
|
+
<span class='comment'># => #<Helium::Sensor:0x007f89acdb1b58 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="A New Sensor", @mac="6081f9fffe00019b", @ports=["t", "b"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
138
|
+
</span></code></pre>
|
139
|
+
|
140
|
+
<h4>Update a Sensor</h4>
|
141
|
+
|
142
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>An Updated Sensor</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
143
|
+
<span class='comment'># => #<Helium::Sensor:0x007f89acdb1b58 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="A New Sensor", @mac="6081f9fffe00019b", @ports=["t", "b"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
144
|
+
</span></code></pre>
|
145
|
+
|
146
|
+
<h4>Delete a Sensor</h4>
|
147
|
+
|
148
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
|
149
|
+
<span class='comment'># => true
|
150
|
+
</span></code></pre>
|
151
|
+
|
134
152
|
<h3>Timeseries</h3>
|
135
153
|
|
136
154
|
<h4>Get Timeseries data for a sensor</h4>
|
@@ -211,6 +229,94 @@
|
|
211
229
|
|
212
230
|
<p>A full list of aggregation types and sizes can be found here: <a href="https://docs.helium.com/docs/timeseries#aggregations">https://docs.helium.com/docs/timeseries#aggregations</a>.</p>
|
213
231
|
|
232
|
+
<h3>Elements</h3>
|
233
|
+
|
234
|
+
<h4>Get all Elements</h4>
|
235
|
+
|
236
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_elements'>elements</span>
|
237
|
+
<span class='comment'># => [#<Helium::Element:0x007faf732c11e8 @id="78b6a9f4-9c39-4673-9946-72a16c35a422", @name="SF Office", @mac="6081f9fffe0002a8", @created_at="2015-08-12T23:10:40.537762Z", @updated_at="2015-08-12T23:10:40.536644Z", @versions={"element"=>"3050900"}>,...]
|
238
|
+
</span></code></pre>
|
239
|
+
|
240
|
+
<h4>Get an Element by id</h4>
|
241
|
+
|
242
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_element'>element</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
243
|
+
<span class='comment'># => #<Helium::Element:0x007faf732c2548 @id="1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de", @name="SF Office", @mac="6081f9fffe00033f", @created_at="2015-08-12T23:19:34.175932Z", @updated_at="2015-08-12T23:19:34.174828Z", @versions=nil>
|
244
|
+
</span></code></pre>
|
245
|
+
|
246
|
+
<h4>Update an Element</h4>
|
247
|
+
|
248
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>A New Name</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
249
|
+
<span class='comment'># => #<Helium::Element:0x007faf732c2548 @id="1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de", @name="A New Name", @mac="6081f9fffe00033f", @created_at="2015-08-12T23:19:34.175932Z", @updated_at="2015-08-12T23:19:34.174828Z", @versions=nil>
|
250
|
+
</span></code></pre>
|
251
|
+
|
252
|
+
<h3>Labels</h3>
|
253
|
+
|
254
|
+
<p>Sensors can be grouped together under a named label.</p>
|
255
|
+
|
256
|
+
<h4>Create a Label</h4>
|
257
|
+
|
258
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_new_label'>new_label</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A New Label</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
259
|
+
<span class='comment'># => #<Helium::Label:0x007ffd80f2be28 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="A New Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">
|
260
|
+
</span></code></pre>
|
261
|
+
|
262
|
+
<h4>List all Labels</h4>
|
263
|
+
|
264
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_labels'>labels</span>
|
265
|
+
<span class='comment'># => [#<Helium::Label:0x007ffd80f2be28 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="A New Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">, ...]
|
266
|
+
</span></code></pre>
|
267
|
+
|
268
|
+
<h4>Find a Label by id</h4>
|
269
|
+
|
270
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_label'>label</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>409d9394-60d5-436a-b8cb-7160d466fc5a</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
271
|
+
<span class='comment'># => #<Helium::Label:0x007ffd80f2be28 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="A New Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">
|
272
|
+
</span></code></pre>
|
273
|
+
|
274
|
+
<h4>Update a Label</h4>
|
275
|
+
|
276
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>An Updated Label</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
277
|
+
<span class='comment'># => #<Helium::Label:0x007ffd80d41680 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="An Updated Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">
|
278
|
+
</span></code></pre>
|
279
|
+
|
280
|
+
<h4>Add Sensors to a Label</h4>
|
281
|
+
|
282
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_add_sensors'>add_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_a_sensor'>a_sensor</span><span class='rparen'>)</span>
|
283
|
+
<span class='comment'># Or
|
284
|
+
</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_add_sensors'>add_sensors</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_sensor_1'>sensor_1</span><span class='comma'>,</span> <span class='id identifier rubyid_sensor_2'>sensor_2</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
285
|
+
</code></pre>
|
286
|
+
|
287
|
+
<h4>View a Label's Sensors</h4>
|
288
|
+
|
289
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span>
|
290
|
+
<span class='comment'># => [
|
291
|
+
</span><span class='comment'># [0] #<Helium::Sensor:0x007ffd81147450 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="Marc's Isotope", @mac="6081f9fffe00019b", @ports=["b", "t"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
292
|
+
</span><span class='comment'># ]
|
293
|
+
</span></code></pre>
|
294
|
+
|
295
|
+
<h4>Remove Sensors from a Label</h4>
|
296
|
+
|
297
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_remove_sensors'>remove_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_a_sensor'>a_sensor</span><span class='rparen'>)</span>
|
298
|
+
<span class='comment'># Or
|
299
|
+
</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_remove_sensors'>remove_sensors</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_sensor_1'>sensor_1</span><span class='comma'>,</span> <span class='id identifier rubyid_sensor_2'>sensor_2</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
300
|
+
</code></pre>
|
301
|
+
|
302
|
+
<h4>Destroy a Label</h4>
|
303
|
+
|
304
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
|
305
|
+
<span class='comment'># => true
|
306
|
+
</span></code></pre>
|
307
|
+
|
308
|
+
<h3>JSON</h3>
|
309
|
+
|
310
|
+
<p>All objects and collections of objects have a JSON representation. Simply call <code>.to_json</code>:</p>
|
311
|
+
|
312
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
313
|
+
<span class='comment'># => "{\"id\":\"08bab58b-d095-4c7c-912c-1f8024d91d95\",\"created_at\":\"2015-08-06T17:28:11+00:00\",\"updated_at\":\"2016-05-30T22:36:50+00:00\",\"name\":\"Marc's Isotope\",\"mac\":\"6081f9fffe00019b\",\"ports\":[\"b\",\"t\"]}"
|
314
|
+
</span></code></pre>
|
315
|
+
|
316
|
+
<h2>Source Documentation</h2>
|
317
|
+
|
318
|
+
<p>Documentation for the gem's source can be found here: <a href="https://helium.github.io/helium-ruby/">https://helium.github.io/helium-ruby/</a></p>
|
319
|
+
|
214
320
|
<h2>Development</h2>
|
215
321
|
|
216
322
|
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
@@ -256,7 +362,7 @@
|
|
256
362
|
</div></div>
|
257
363
|
|
258
364
|
<div id="footer">
|
259
|
-
Generated on
|
365
|
+
Generated on Mon Aug 22 15:52:19 2016 by
|
260
366
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
261
367
|
0.9.3 (ruby-2.3.1).
|
262
368
|
</div>
|
data/docs/index.html
CHANGED
@@ -131,6 +131,24 @@
|
|
131
131
|
<span class='comment'># => #<Helium::Sensor:0x007f89acdb1b58 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="Marc's Isotope", @mac="6081f9fffe00019b", @ports=["t", "b"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
132
132
|
</span></code></pre>
|
133
133
|
|
134
|
+
<h4>Create a Virtual Sensor</h4>
|
135
|
+
|
136
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_new_sensor'>new_sensor</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>A New Sensor</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
137
|
+
<span class='comment'># => #<Helium::Sensor:0x007f89acdb1b58 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="A New Sensor", @mac="6081f9fffe00019b", @ports=["t", "b"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
138
|
+
</span></code></pre>
|
139
|
+
|
140
|
+
<h4>Update a Sensor</h4>
|
141
|
+
|
142
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>An Updated Sensor</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
143
|
+
<span class='comment'># => #<Helium::Sensor:0x007f89acdb1b58 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="A New Sensor", @mac="6081f9fffe00019b", @ports=["t", "b"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
144
|
+
</span></code></pre>
|
145
|
+
|
146
|
+
<h4>Delete a Sensor</h4>
|
147
|
+
|
148
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_sensor'>sensor</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
|
149
|
+
<span class='comment'># => true
|
150
|
+
</span></code></pre>
|
151
|
+
|
134
152
|
<h3>Timeseries</h3>
|
135
153
|
|
136
154
|
<h4>Get Timeseries data for a sensor</h4>
|
@@ -211,6 +229,94 @@
|
|
211
229
|
|
212
230
|
<p>A full list of aggregation types and sizes can be found here: <a href="https://docs.helium.com/docs/timeseries#aggregations">https://docs.helium.com/docs/timeseries#aggregations</a>.</p>
|
213
231
|
|
232
|
+
<h3>Elements</h3>
|
233
|
+
|
234
|
+
<h4>Get all Elements</h4>
|
235
|
+
|
236
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_elements'>elements</span>
|
237
|
+
<span class='comment'># => [#<Helium::Element:0x007faf732c11e8 @id="78b6a9f4-9c39-4673-9946-72a16c35a422", @name="SF Office", @mac="6081f9fffe0002a8", @created_at="2015-08-12T23:10:40.537762Z", @updated_at="2015-08-12T23:10:40.536644Z", @versions={"element"=>"3050900"}>,...]
|
238
|
+
</span></code></pre>
|
239
|
+
|
240
|
+
<h4>Get an Element by id</h4>
|
241
|
+
|
242
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_element'>element</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
243
|
+
<span class='comment'># => #<Helium::Element:0x007faf732c2548 @id="1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de", @name="SF Office", @mac="6081f9fffe00033f", @created_at="2015-08-12T23:19:34.175932Z", @updated_at="2015-08-12T23:19:34.174828Z", @versions=nil>
|
244
|
+
</span></code></pre>
|
245
|
+
|
246
|
+
<h4>Update an Element</h4>
|
247
|
+
|
248
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>A New Name</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
249
|
+
<span class='comment'># => #<Helium::Element:0x007faf732c2548 @id="1b686e82-bd4a-4aac-9d7b-9bdbe1e9a7de", @name="A New Name", @mac="6081f9fffe00033f", @created_at="2015-08-12T23:19:34.175932Z", @updated_at="2015-08-12T23:19:34.174828Z", @versions=nil>
|
250
|
+
</span></code></pre>
|
251
|
+
|
252
|
+
<h3>Labels</h3>
|
253
|
+
|
254
|
+
<p>Sensors can be grouped together under a named label.</p>
|
255
|
+
|
256
|
+
<h4>Create a Label</h4>
|
257
|
+
|
258
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_new_label'>new_label</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>A New Label</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
259
|
+
<span class='comment'># => #<Helium::Label:0x007ffd80f2be28 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="A New Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">
|
260
|
+
</span></code></pre>
|
261
|
+
|
262
|
+
<h4>List all Labels</h4>
|
263
|
+
|
264
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_labels'>labels</span>
|
265
|
+
<span class='comment'># => [#<Helium::Label:0x007ffd80f2be28 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="A New Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">, ...]
|
266
|
+
</span></code></pre>
|
267
|
+
|
268
|
+
<h4>Find a Label by id</h4>
|
269
|
+
|
270
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_label'>label</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>409d9394-60d5-436a-b8cb-7160d466fc5a</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
271
|
+
<span class='comment'># => #<Helium::Label:0x007ffd80f2be28 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="A New Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">
|
272
|
+
</span></code></pre>
|
273
|
+
|
274
|
+
<h4>Update a Label</h4>
|
275
|
+
|
276
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>An Updated Label</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
277
|
+
<span class='comment'># => #<Helium::Label:0x007ffd80d41680 @id="409d9394-60d5-436a-b8cb-7160d466fc5a", @name="An Updated Label", @created_at="2016-08-22T18:58:34.415862Z", @updated_at="2016-08-22T18:58:34.415862Z">
|
278
|
+
</span></code></pre>
|
279
|
+
|
280
|
+
<h4>Add Sensors to a Label</h4>
|
281
|
+
|
282
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_add_sensors'>add_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_a_sensor'>a_sensor</span><span class='rparen'>)</span>
|
283
|
+
<span class='comment'># Or
|
284
|
+
</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_add_sensors'>add_sensors</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_sensor_1'>sensor_1</span><span class='comma'>,</span> <span class='id identifier rubyid_sensor_2'>sensor_2</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
285
|
+
</code></pre>
|
286
|
+
|
287
|
+
<h4>View a Label's Sensors</h4>
|
288
|
+
|
289
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span>
|
290
|
+
<span class='comment'># => [
|
291
|
+
</span><span class='comment'># [0] #<Helium::Sensor:0x007ffd81147450 @id="08bab58b-d095-4c7c-912c-1f8024d91d95", @name="Marc's Isotope", @mac="6081f9fffe00019b", @ports=["b", "t"], @created_at="2015-08-06T17:28:11.614107Z", @updated_at="2016-05-30T22:36:50.810716Z">
|
292
|
+
</span><span class='comment'># ]
|
293
|
+
</span></code></pre>
|
294
|
+
|
295
|
+
<h4>Remove Sensors from a Label</h4>
|
296
|
+
|
297
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_remove_sensors'>remove_sensors</span><span class='lparen'>(</span><span class='id identifier rubyid_a_sensor'>a_sensor</span><span class='rparen'>)</span>
|
298
|
+
<span class='comment'># Or
|
299
|
+
</span><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_remove_sensors'>remove_sensors</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_sensor_1'>sensor_1</span><span class='comma'>,</span> <span class='id identifier rubyid_sensor_2'>sensor_2</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
300
|
+
</code></pre>
|
301
|
+
|
302
|
+
<h4>Destroy a Label</h4>
|
303
|
+
|
304
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_label'>label</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
|
305
|
+
<span class='comment'># => true
|
306
|
+
</span></code></pre>
|
307
|
+
|
308
|
+
<h3>JSON</h3>
|
309
|
+
|
310
|
+
<p>All objects and collections of objects have a JSON representation. Simply call <code>.to_json</code>:</p>
|
311
|
+
|
312
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_sensors'>sensors</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
313
|
+
<span class='comment'># => "{\"id\":\"08bab58b-d095-4c7c-912c-1f8024d91d95\",\"created_at\":\"2015-08-06T17:28:11+00:00\",\"updated_at\":\"2016-05-30T22:36:50+00:00\",\"name\":\"Marc's Isotope\",\"mac\":\"6081f9fffe00019b\",\"ports\":[\"b\",\"t\"]}"
|
314
|
+
</span></code></pre>
|
315
|
+
|
316
|
+
<h2>Source Documentation</h2>
|
317
|
+
|
318
|
+
<p>Documentation for the gem's source can be found here: <a href="https://helium.github.io/helium-ruby/">https://helium.github.io/helium-ruby/</a></p>
|
319
|
+
|
214
320
|
<h2>Development</h2>
|
215
321
|
|
216
322
|
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
@@ -256,7 +362,7 @@
|
|
256
362
|
</div></div>
|
257
363
|
|
258
364
|
<div id="footer">
|
259
|
-
Generated on
|
365
|
+
Generated on Mon Aug 22 15:52:19 2016 by
|
260
366
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
261
367
|
0.9.3 (ruby-2.3.1).
|
262
368
|
</div>
|
data/docs/method_list.html
CHANGED
@@ -46,7 +46,23 @@
|
|
46
46
|
|
47
47
|
<li class="odd ">
|
48
48
|
<div class="item">
|
49
|
-
<span class='object_link'><a href="Helium/
|
49
|
+
<span class='object_link'><a href="Helium/Resource.html#%3D%3D-instance_method" title="Helium::Resource#== (method)">#==</a></span>
|
50
|
+
<small>Helium::Resource</small>
|
51
|
+
</div>
|
52
|
+
</li>
|
53
|
+
|
54
|
+
|
55
|
+
<li class="even ">
|
56
|
+
<div class="item">
|
57
|
+
<span class='object_link'><a href="Helium/Label.html#add_sensors-instance_method" title="Helium::Label#add_sensors (method)">#add_sensors</a></span>
|
58
|
+
<small>Helium::Label</small>
|
59
|
+
</div>
|
60
|
+
</li>
|
61
|
+
|
62
|
+
|
63
|
+
<li class="odd ">
|
64
|
+
<div class="item">
|
65
|
+
<span class='object_link'><a href="Helium/DataPoint.html#aggregate%3F-instance_method" title="Helium::DataPoint#aggregate? (method)">#aggregate?</a></span>
|
50
66
|
<small>Helium::DataPoint</small>
|
51
67
|
</div>
|
52
68
|
</li>
|
@@ -62,7 +78,23 @@
|
|
62
78
|
|
63
79
|
<li class="odd ">
|
64
80
|
<div class="item">
|
65
|
-
<span class='object_link'><a href="Helium/
|
81
|
+
<span class='object_link'><a href="Helium/Organization.html#as_json-instance_method" title="Helium::Organization#as_json (method)">#as_json</a></span>
|
82
|
+
<small>Helium::Organization</small>
|
83
|
+
</div>
|
84
|
+
</li>
|
85
|
+
|
86
|
+
|
87
|
+
<li class="even ">
|
88
|
+
<div class="item">
|
89
|
+
<span class='object_link'><a href="Helium/Element.html#as_json-instance_method" title="Helium::Element#as_json (method)">#as_json</a></span>
|
90
|
+
<small>Helium::Element</small>
|
91
|
+
</div>
|
92
|
+
</li>
|
93
|
+
|
94
|
+
|
95
|
+
<li class="odd ">
|
96
|
+
<div class="item">
|
97
|
+
<span class='object_link'><a href="Helium/DataPoint.html#as_json-instance_method" title="Helium::DataPoint#as_json (method)">#as_json</a></span>
|
66
98
|
<small>Helium::DataPoint</small>
|
67
99
|
</div>
|
68
100
|
</li>
|
@@ -70,7 +102,23 @@
|
|
70
102
|
|
71
103
|
<li class="even ">
|
72
104
|
<div class="item">
|
73
|
-
<span class='object_link'><a href="Helium/
|
105
|
+
<span class='object_link'><a href="Helium/Sensor.html#as_json-instance_method" title="Helium::Sensor#as_json (method)">#as_json</a></span>
|
106
|
+
<small>Helium::Sensor</small>
|
107
|
+
</div>
|
108
|
+
</li>
|
109
|
+
|
110
|
+
|
111
|
+
<li class="odd ">
|
112
|
+
<div class="item">
|
113
|
+
<span class='object_link'><a href="Helium/Label.html#as_json-instance_method" title="Helium::Label#as_json (method)">#as_json</a></span>
|
114
|
+
<small>Helium::Label</small>
|
115
|
+
</div>
|
116
|
+
</li>
|
117
|
+
|
118
|
+
|
119
|
+
<li class="even ">
|
120
|
+
<div class="item">
|
121
|
+
<span class='object_link'><a href="Helium/User.html#as_json-instance_method" title="Helium::User#as_json (method)">#as_json</a></span>
|
74
122
|
<small>Helium::User</small>
|
75
123
|
</div>
|
76
124
|
</li>
|
@@ -78,21 +126,29 @@
|
|
78
126
|
|
79
127
|
<li class="odd ">
|
80
128
|
<div class="item">
|
81
|
-
<span class='object_link'><a href="Helium/
|
82
|
-
<small>Helium::
|
129
|
+
<span class='object_link'><a href="Helium/Resource.html#as_json-instance_method" title="Helium::Resource#as_json (method)">#as_json</a></span>
|
130
|
+
<small>Helium::Resource</small>
|
83
131
|
</div>
|
84
132
|
</li>
|
85
133
|
|
86
134
|
|
87
135
|
<li class="even ">
|
88
136
|
<div class="item">
|
89
|
-
<span class='object_link'><a href="Helium/
|
90
|
-
<small>Helium::
|
137
|
+
<span class='object_link'><a href="Helium/DataPoint.html#avg-instance_method" title="Helium::DataPoint#avg (method)">#avg</a></span>
|
138
|
+
<small>Helium::DataPoint</small>
|
91
139
|
</div>
|
92
140
|
</li>
|
93
141
|
|
94
142
|
|
95
143
|
<li class="odd ">
|
144
|
+
<div class="item">
|
145
|
+
<span class='object_link'><a href="Helium/Resource.html#created_at-instance_method" title="Helium::Resource#created_at (method)">#created_at</a></span>
|
146
|
+
<small>Helium::Resource</small>
|
147
|
+
</div>
|
148
|
+
</li>
|
149
|
+
|
150
|
+
|
151
|
+
<li class="even ">
|
96
152
|
<div class="item">
|
97
153
|
<span class='object_link'><a href="Helium/Utils.html#datetime_to_iso-instance_method" title="Helium::Utils#datetime_to_iso (method)">#datetime_to_iso</a></span>
|
98
154
|
<small>Helium::Utils</small>
|
@@ -100,7 +156,7 @@
|
|
100
156
|
</li>
|
101
157
|
|
102
158
|
|
103
|
-
<li class="
|
159
|
+
<li class="odd ">
|
104
160
|
<div class="item">
|
105
161
|
<span class='object_link'><a href="Helium/Client.html#debug%3F-instance_method" title="Helium::Client#debug? (method)">#debug?</a></span>
|
106
162
|
<small>Helium::Client</small>
|
@@ -108,7 +164,7 @@
|
|
108
164
|
</li>
|
109
165
|
|
110
166
|
|
111
|
-
<li class="
|
167
|
+
<li class="even ">
|
112
168
|
<div class="item">
|
113
169
|
<span class='object_link'><a href="Helium/Client/Http.html#delete-instance_method" title="Helium::Client::Http#delete (method)">#delete</a></span>
|
114
170
|
<small>Helium::Client::Http</small>
|
@@ -116,6 +172,14 @@
|
|
116
172
|
</li>
|
117
173
|
|
118
174
|
|
175
|
+
<li class="odd ">
|
176
|
+
<div class="item">
|
177
|
+
<span class='object_link'><a href="Helium/Client/Labels.html#delete_label-instance_method" title="Helium::Client::Labels#delete_label (method)">#delete_label</a></span>
|
178
|
+
<small>Helium::Client::Labels</small>
|
179
|
+
</div>
|
180
|
+
</li>
|
181
|
+
|
182
|
+
|
119
183
|
<li class="even ">
|
120
184
|
<div class="item">
|
121
185
|
<span class='object_link'><a href="Helium/Client/Sensors.html#delete_sensor-instance_method" title="Helium::Client::Sensors#delete_sensor (method)">#delete_sensor</a></span>
|
@@ -133,6 +197,14 @@
|
|
133
197
|
|
134
198
|
|
135
199
|
<li class="even ">
|
200
|
+
<div class="item">
|
201
|
+
<span class='object_link'><a href="Helium/Label.html#destroy-instance_method" title="Helium::Label#destroy (method)">#destroy</a></span>
|
202
|
+
<small>Helium::Label</small>
|
203
|
+
</div>
|
204
|
+
</li>
|
205
|
+
|
206
|
+
|
207
|
+
<li class="odd ">
|
136
208
|
<div class="item">
|
137
209
|
<span class='object_link'><a href="Helium/Cursor.html#each-instance_method" title="Helium::Cursor#each (method)">#each</a></span>
|
138
210
|
<small>Helium::Cursor</small>
|
@@ -140,7 +212,23 @@
|
|
140
212
|
</li>
|
141
213
|
|
142
214
|
|
215
|
+
<li class="even ">
|
216
|
+
<div class="item">
|
217
|
+
<span class='object_link'><a href="Helium/Client/Elements.html#element-instance_method" title="Helium::Client::Elements#element (method)">#element</a></span>
|
218
|
+
<small>Helium::Client::Elements</small>
|
219
|
+
</div>
|
220
|
+
</li>
|
221
|
+
|
222
|
+
|
143
223
|
<li class="odd ">
|
224
|
+
<div class="item">
|
225
|
+
<span class='object_link'><a href="Helium/Client/Elements.html#elements-instance_method" title="Helium::Client::Elements#elements (method)">#elements</a></span>
|
226
|
+
<small>Helium::Client::Elements</small>
|
227
|
+
</div>
|
228
|
+
</li>
|
229
|
+
|
230
|
+
|
231
|
+
<li class="even ">
|
144
232
|
<div class="item">
|
145
233
|
<span class='object_link'><a href="Helium/User.html#email-instance_method" title="Helium::User#email (method)">#email</a></span>
|
146
234
|
<small>Helium::User</small>
|
@@ -148,6 +236,14 @@
|
|
148
236
|
</li>
|
149
237
|
|
150
238
|
|
239
|
+
<li class="odd ">
|
240
|
+
<div class="item">
|
241
|
+
<span class='object_link'><a href="Helium/Resource.html#eql%3F-instance_method" title="Helium::Resource#eql? (method)">#eql?</a></span>
|
242
|
+
<small>Helium::Resource</small>
|
243
|
+
</div>
|
244
|
+
</li>
|
245
|
+
|
246
|
+
|
151
247
|
<li class="even ">
|
152
248
|
<div class="item">
|
153
249
|
<span class='object_link'><a href="Helium/Client/Http.html#get-instance_method" title="Helium::Client::Http#get (method)">#get</a></span>
|
@@ -158,23 +254,23 @@
|
|
158
254
|
|
159
255
|
<li class="odd ">
|
160
256
|
<div class="item">
|
161
|
-
<span class='object_link'><a href="Helium/
|
162
|
-
<small>Helium::
|
257
|
+
<span class='object_link'><a href="Helium/Resource.html#hash-instance_method" title="Helium::Resource#hash (method)">#hash</a></span>
|
258
|
+
<small>Helium::Resource</small>
|
163
259
|
</div>
|
164
260
|
</li>
|
165
261
|
|
166
262
|
|
167
263
|
<li class="even ">
|
168
264
|
<div class="item">
|
169
|
-
<span class='object_link'><a href="Helium/
|
170
|
-
<small>Helium::
|
265
|
+
<span class='object_link'><a href="Helium/Resource.html#id-instance_method" title="Helium::Resource#id (method)">#id</a></span>
|
266
|
+
<small>Helium::Resource</small>
|
171
267
|
</div>
|
172
268
|
</li>
|
173
269
|
|
174
270
|
|
175
271
|
<li class="odd ">
|
176
272
|
<div class="item">
|
177
|
-
<span class='object_link'><a href="Helium/DataPoint.html#
|
273
|
+
<span class='object_link'><a href="Helium/DataPoint.html#initialize-instance_method" title="Helium::DataPoint#initialize (method)">#initialize</a></span>
|
178
274
|
<small>Helium::DataPoint</small>
|
179
275
|
</div>
|
180
276
|
</li>
|
@@ -182,21 +278,29 @@
|
|
182
278
|
|
183
279
|
<li class="even ">
|
184
280
|
<div class="item">
|
185
|
-
<span class='object_link'><a href="Helium/
|
186
|
-
<small>Helium::
|
281
|
+
<span class='object_link'><a href="Helium/User.html#initialize-instance_method" title="Helium::User#initialize (method)">#initialize</a></span>
|
282
|
+
<small>Helium::User</small>
|
187
283
|
</div>
|
188
284
|
</li>
|
189
285
|
|
190
286
|
|
191
287
|
<li class="odd ">
|
192
288
|
<div class="item">
|
193
|
-
<span class='object_link'><a href="Helium/
|
194
|
-
<small>Helium::
|
289
|
+
<span class='object_link'><a href="Helium/Label.html#initialize-instance_method" title="Helium::Label#initialize (method)">#initialize</a></span>
|
290
|
+
<small>Helium::Label</small>
|
195
291
|
</div>
|
196
292
|
</li>
|
197
293
|
|
198
294
|
|
199
295
|
<li class="even ">
|
296
|
+
<div class="item">
|
297
|
+
<span class='object_link'><a href="Helium/Cursor.html#initialize-instance_method" title="Helium::Cursor#initialize (method)">#initialize</a></span>
|
298
|
+
<small>Helium::Cursor</small>
|
299
|
+
</div>
|
300
|
+
</li>
|
301
|
+
|
302
|
+
|
303
|
+
<li class="odd ">
|
200
304
|
<div class="item">
|
201
305
|
<span class='object_link'><a href="Helium/Sensor.html#initialize-instance_method" title="Helium::Sensor#initialize (method)">#initialize</a></span>
|
202
306
|
<small>Helium::Sensor</small>
|
@@ -204,15 +308,31 @@
|
|
204
308
|
</li>
|
205
309
|
|
206
310
|
|
311
|
+
<li class="even ">
|
312
|
+
<div class="item">
|
313
|
+
<span class='object_link'><a href="Helium/Client.html#initialize-instance_method" title="Helium::Client#initialize (method)">#initialize</a></span>
|
314
|
+
<small>Helium::Client</small>
|
315
|
+
</div>
|
316
|
+
</li>
|
317
|
+
|
318
|
+
|
207
319
|
<li class="odd ">
|
208
320
|
<div class="item">
|
209
|
-
<span class='object_link'><a href="Helium/
|
210
|
-
<small>Helium::
|
321
|
+
<span class='object_link'><a href="Helium/Element.html#initialize-instance_method" title="Helium::Element#initialize (method)">#initialize</a></span>
|
322
|
+
<small>Helium::Element</small>
|
211
323
|
</div>
|
212
324
|
</li>
|
213
325
|
|
214
326
|
|
215
327
|
<li class="even ">
|
328
|
+
<div class="item">
|
329
|
+
<span class='object_link'><a href="Helium/Resource.html#initialize-instance_method" title="Helium::Resource#initialize (method)">#initialize</a></span>
|
330
|
+
<small>Helium::Resource</small>
|
331
|
+
</div>
|
332
|
+
</li>
|
333
|
+
|
334
|
+
|
335
|
+
<li class="odd ">
|
216
336
|
<div class="item">
|
217
337
|
<span class='object_link'><a href="Helium/Organization.html#initialize-instance_method" title="Helium::Organization#initialize (method)">#initialize</a></span>
|
218
338
|
<small>Helium::Organization</small>
|
@@ -220,31 +340,47 @@
|
|
220
340
|
</li>
|
221
341
|
|
222
342
|
|
343
|
+
<li class="even ">
|
344
|
+
<div class="item">
|
345
|
+
<span class='object_link'><a href="Helium/Client.html#inspect-instance_method" title="Helium::Client#inspect (method)">#inspect</a></span>
|
346
|
+
<small>Helium::Client</small>
|
347
|
+
</div>
|
348
|
+
</li>
|
349
|
+
|
350
|
+
|
223
351
|
<li class="odd ">
|
224
352
|
<div class="item">
|
225
|
-
<span class='object_link'><a href="Helium/
|
226
|
-
<small>Helium::
|
353
|
+
<span class='object_link'><a href="Helium/Client/Labels.html#label-instance_method" title="Helium::Client::Labels#label (method)">#label</a></span>
|
354
|
+
<small>Helium::Client::Labels</small>
|
227
355
|
</div>
|
228
356
|
</li>
|
229
357
|
|
230
358
|
|
231
359
|
<li class="even ">
|
232
360
|
<div class="item">
|
233
|
-
<span class='object_link'><a href="Helium/
|
234
|
-
<small>Helium::
|
361
|
+
<span class='object_link'><a href="Helium/Client/Labels.html#label_sensors-instance_method" title="Helium::Client::Labels#label_sensors (method)">#label_sensors</a></span>
|
362
|
+
<small>Helium::Client::Labels</small>
|
235
363
|
</div>
|
236
364
|
</li>
|
237
365
|
|
238
366
|
|
239
367
|
<li class="odd ">
|
240
368
|
<div class="item">
|
241
|
-
<span class='object_link'><a href="Helium/Client.html#
|
242
|
-
<small>Helium::Client</small>
|
369
|
+
<span class='object_link'><a href="Helium/Client/Labels.html#labels-instance_method" title="Helium::Client::Labels#labels (method)">#labels</a></span>
|
370
|
+
<small>Helium::Client::Labels</small>
|
243
371
|
</div>
|
244
372
|
</li>
|
245
373
|
|
246
374
|
|
247
375
|
<li class="even ">
|
376
|
+
<div class="item">
|
377
|
+
<span class='object_link'><a href="Helium/Element.html#mac-instance_method" title="Helium::Element#mac (method)">#mac</a></span>
|
378
|
+
<small>Helium::Element</small>
|
379
|
+
</div>
|
380
|
+
</li>
|
381
|
+
|
382
|
+
|
383
|
+
<li class="odd ">
|
248
384
|
<div class="item">
|
249
385
|
<span class='object_link'><a href="Helium/Sensor.html#mac-instance_method" title="Helium::Sensor#mac (method)">#mac</a></span>
|
250
386
|
<small>Helium::Sensor</small>
|
@@ -252,7 +388,7 @@
|
|
252
388
|
</li>
|
253
389
|
|
254
390
|
|
255
|
-
<li class="
|
391
|
+
<li class="even ">
|
256
392
|
<div class="item">
|
257
393
|
<span class='object_link'><a href="Helium/DataPoint.html#max-instance_method" title="Helium::DataPoint#max (method)">#max</a></span>
|
258
394
|
<small>Helium::DataPoint</small>
|
@@ -260,7 +396,7 @@
|
|
260
396
|
</li>
|
261
397
|
|
262
398
|
|
263
|
-
<li class="
|
399
|
+
<li class="odd ">
|
264
400
|
<div class="item">
|
265
401
|
<span class='object_link'><a href="Helium/DataPoint.html#min-instance_method" title="Helium::DataPoint#min (method)">#min</a></span>
|
266
402
|
<small>Helium::DataPoint</small>
|
@@ -268,15 +404,31 @@
|
|
268
404
|
</li>
|
269
405
|
|
270
406
|
|
407
|
+
<li class="even ">
|
408
|
+
<div class="item">
|
409
|
+
<span class='object_link'><a href="Helium/Organization.html#name-instance_method" title="Helium::Organization#name (method)">#name</a></span>
|
410
|
+
<small>Helium::Organization</small>
|
411
|
+
</div>
|
412
|
+
</li>
|
413
|
+
|
414
|
+
|
271
415
|
<li class="odd ">
|
272
416
|
<div class="item">
|
273
|
-
<span class='object_link'><a href="Helium/
|
274
|
-
<small>Helium::
|
417
|
+
<span class='object_link'><a href="Helium/Element.html#name-instance_method" title="Helium::Element#name (method)">#name</a></span>
|
418
|
+
<small>Helium::Element</small>
|
275
419
|
</div>
|
276
420
|
</li>
|
277
421
|
|
278
422
|
|
279
423
|
<li class="even ">
|
424
|
+
<div class="item">
|
425
|
+
<span class='object_link'><a href="Helium/Label.html#name-instance_method" title="Helium::Label#name (method)">#name</a></span>
|
426
|
+
<small>Helium::Label</small>
|
427
|
+
</div>
|
428
|
+
</li>
|
429
|
+
|
430
|
+
|
431
|
+
<li class="odd ">
|
280
432
|
<div class="item">
|
281
433
|
<span class='object_link'><a href="Helium/Sensor.html#name-instance_method" title="Helium::Sensor#name (method)">#name</a></span>
|
282
434
|
<small>Helium::Sensor</small>
|
@@ -284,10 +436,18 @@
|
|
284
436
|
</li>
|
285
437
|
|
286
438
|
|
439
|
+
<li class="even ">
|
440
|
+
<div class="item">
|
441
|
+
<span class='object_link'><a href="Helium/User.html#name-instance_method" title="Helium::User#name (method)">#name</a></span>
|
442
|
+
<small>Helium::User</small>
|
443
|
+
</div>
|
444
|
+
</li>
|
445
|
+
|
446
|
+
|
287
447
|
<li class="odd ">
|
288
448
|
<div class="item">
|
289
|
-
<span class='object_link'><a href="Helium/
|
290
|
-
<small>Helium::
|
449
|
+
<span class='object_link'><a href="Helium/Client/Labels.html#new_label-instance_method" title="Helium::Client::Labels#new_label (method)">#new_label</a></span>
|
450
|
+
<small>Helium::Client::Labels</small>
|
291
451
|
</div>
|
292
452
|
</li>
|
293
453
|
|
@@ -357,6 +517,14 @@
|
|
357
517
|
|
358
518
|
|
359
519
|
<li class="even ">
|
520
|
+
<div class="item">
|
521
|
+
<span class='object_link'><a href="Helium/Label.html#remove_sensors-instance_method" title="Helium::Label#remove_sensors (method)">#remove_sensors</a></span>
|
522
|
+
<small>Helium::Label</small>
|
523
|
+
</div>
|
524
|
+
</li>
|
525
|
+
|
526
|
+
|
527
|
+
<li class="odd ">
|
360
528
|
<div class="item">
|
361
529
|
<span class='object_link'><a href="Helium/Client/Sensors.html#sensor-instance_method" title="Helium::Client::Sensors#sensor (method)">#sensor</a></span>
|
362
530
|
<small>Helium::Client::Sensors</small>
|
@@ -364,7 +532,7 @@
|
|
364
532
|
</li>
|
365
533
|
|
366
534
|
|
367
|
-
<li class="
|
535
|
+
<li class="even ">
|
368
536
|
<div class="item">
|
369
537
|
<span class='object_link'><a href="Helium/Client/Sensors.html#sensor_timeseries-instance_method" title="Helium::Client::Sensors#sensor_timeseries (method)">#sensor_timeseries</a></span>
|
370
538
|
<small>Helium::Client::Sensors</small>
|
@@ -372,6 +540,14 @@
|
|
372
540
|
</li>
|
373
541
|
|
374
542
|
|
543
|
+
<li class="odd ">
|
544
|
+
<div class="item">
|
545
|
+
<span class='object_link'><a href="Helium/Label.html#sensors-instance_method" title="Helium::Label#sensors (method)">#sensors</a></span>
|
546
|
+
<small>Helium::Label</small>
|
547
|
+
</div>
|
548
|
+
</li>
|
549
|
+
|
550
|
+
|
375
551
|
<li class="even ">
|
376
552
|
<div class="item">
|
377
553
|
<span class='object_link'><a href="Helium/Client/Sensors.html#sensors-instance_method" title="Helium::Client::Sensors#sensors (method)">#sensors</a></span>
|
@@ -404,6 +580,38 @@
|
|
404
580
|
</li>
|
405
581
|
|
406
582
|
|
583
|
+
<li class="even ">
|
584
|
+
<div class="item">
|
585
|
+
<span class='object_link'><a href="Helium/Cursor.html#to_json-instance_method" title="Helium::Cursor#to_json (method)">#to_json</a></span>
|
586
|
+
<small>Helium::Cursor</small>
|
587
|
+
</div>
|
588
|
+
</li>
|
589
|
+
|
590
|
+
|
591
|
+
<li class="odd ">
|
592
|
+
<div class="item">
|
593
|
+
<span class='object_link'><a href="Helium/Resource.html#to_json-instance_method" title="Helium::Resource#to_json (method)">#to_json</a></span>
|
594
|
+
<small>Helium::Resource</small>
|
595
|
+
</div>
|
596
|
+
</li>
|
597
|
+
|
598
|
+
|
599
|
+
<li class="even ">
|
600
|
+
<div class="item">
|
601
|
+
<span class='object_link'><a href="Helium/Label.html#update-instance_method" title="Helium::Label#update (method)">#update</a></span>
|
602
|
+
<small>Helium::Label</small>
|
603
|
+
</div>
|
604
|
+
</li>
|
605
|
+
|
606
|
+
|
607
|
+
<li class="odd ">
|
608
|
+
<div class="item">
|
609
|
+
<span class='object_link'><a href="Helium/Element.html#update-instance_method" title="Helium::Element#update (method)">#update</a></span>
|
610
|
+
<small>Helium::Element</small>
|
611
|
+
</div>
|
612
|
+
</li>
|
613
|
+
|
614
|
+
|
407
615
|
<li class="even ">
|
408
616
|
<div class="item">
|
409
617
|
<span class='object_link'><a href="Helium/Sensor.html#update-instance_method" title="Helium::Sensor#update (method)">#update</a></span>
|
@@ -414,37 +622,45 @@
|
|
414
622
|
|
415
623
|
<li class="odd ">
|
416
624
|
<div class="item">
|
417
|
-
<span class='object_link'><a href="Helium/Client/
|
418
|
-
<small>Helium::Client::
|
625
|
+
<span class='object_link'><a href="Helium/Client/Elements.html#update_element-instance_method" title="Helium::Client::Elements#update_element (method)">#update_element</a></span>
|
626
|
+
<small>Helium::Client::Elements</small>
|
419
627
|
</div>
|
420
628
|
</li>
|
421
629
|
|
422
630
|
|
423
631
|
<li class="even ">
|
424
632
|
<div class="item">
|
425
|
-
<span class='object_link'><a href="Helium/
|
426
|
-
<small>Helium::
|
633
|
+
<span class='object_link'><a href="Helium/Client/Labels.html#update_label-instance_method" title="Helium::Client::Labels#update_label (method)">#update_label</a></span>
|
634
|
+
<small>Helium::Client::Labels</small>
|
427
635
|
</div>
|
428
636
|
</li>
|
429
637
|
|
430
638
|
|
431
639
|
<li class="odd ">
|
432
640
|
<div class="item">
|
433
|
-
<span class='object_link'><a href="Helium/
|
434
|
-
<small>Helium::
|
641
|
+
<span class='object_link'><a href="Helium/Client/Labels.html#update_label_sensors-instance_method" title="Helium::Client::Labels#update_label_sensors (method)">#update_label_sensors</a></span>
|
642
|
+
<small>Helium::Client::Labels</small>
|
435
643
|
</div>
|
436
644
|
</li>
|
437
645
|
|
438
646
|
|
439
647
|
<li class="even ">
|
440
648
|
<div class="item">
|
441
|
-
<span class='object_link'><a href="Helium/
|
442
|
-
<small>Helium::
|
649
|
+
<span class='object_link'><a href="Helium/Client/Sensors.html#update_sensor-instance_method" title="Helium::Client::Sensors#update_sensor (method)">#update_sensor</a></span>
|
650
|
+
<small>Helium::Client::Sensors</small>
|
443
651
|
</div>
|
444
652
|
</li>
|
445
653
|
|
446
654
|
|
447
655
|
<li class="odd ">
|
656
|
+
<div class="item">
|
657
|
+
<span class='object_link'><a href="Helium/Resource.html#updated_at-instance_method" title="Helium::Resource#updated_at (method)">#updated_at</a></span>
|
658
|
+
<small>Helium::Resource</small>
|
659
|
+
</div>
|
660
|
+
</li>
|
661
|
+
|
662
|
+
|
663
|
+
<li class="even ">
|
448
664
|
<div class="item">
|
449
665
|
<span class='object_link'><a href="Helium/Client/Users.html#user-instance_method" title="Helium::Client::Users#user (method)">#user</a></span>
|
450
666
|
<small>Helium::Client::Users</small>
|
@@ -452,7 +668,7 @@
|
|
452
668
|
</li>
|
453
669
|
|
454
670
|
|
455
|
-
<li class="
|
671
|
+
<li class="odd ">
|
456
672
|
<div class="item">
|
457
673
|
<span class='object_link'><a href="Helium/Organization.html#users-instance_method" title="Helium::Organization#users (method)">#users</a></span>
|
458
674
|
<small>Helium::Organization</small>
|
@@ -460,7 +676,7 @@
|
|
460
676
|
</li>
|
461
677
|
|
462
678
|
|
463
|
-
<li class="
|
679
|
+
<li class="even ">
|
464
680
|
<div class="item">
|
465
681
|
<span class='object_link'><a href="Helium/DataPoint.html#value-instance_method" title="Helium::DataPoint#value (method)">#value</a></span>
|
466
682
|
<small>Helium::DataPoint</small>
|
@@ -468,6 +684,14 @@
|
|
468
684
|
</li>
|
469
685
|
|
470
686
|
|
687
|
+
<li class="odd ">
|
688
|
+
<div class="item">
|
689
|
+
<span class='object_link'><a href="Helium/Element.html#versions-instance_method" title="Helium::Element#versions (method)">#versions</a></span>
|
690
|
+
<small>Helium::Element</small>
|
691
|
+
</div>
|
692
|
+
</li>
|
693
|
+
|
694
|
+
|
471
695
|
|
472
696
|
</ul>
|
473
697
|
</div>
|