egauge 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,8 @@
-== 1.0.0 / 2012-03-02
+== 1.0.1 / 2012-10-09
+
+* Update each_with_timestamp to more useful each_row that includes step size the row represents in seconds
+* Clarify code and docs that serial is the configuration serial number not the device serial number
+
+== 1.0.0 / 2012-10-09
 
 * Initial revision

data/README.rdoc

@@ -12,7 +12,7 @@ A set of classes to enable parsing and using data from eGauge meters as native R
 
 This gem facilitates interpreting incoming monitoring data and converting it into Ruby objects for easier
 manipulation.  It handles parsing the xml data posted by eGauge devices, converting them into Ruby objects
-that can be manipulated with ease!
+that can be manipulated more easily.
 
 To use:
 
@@ -23,7 +23,7 @@ To use:
     # the data posted to your server from the eGauge device
     >> data = EGauge::Data.parse(request.body.read)
 
-    # Which device sent this data?
+    # What's the configuration serial number?
     >> data.serial
     => '0x37cdd096'
     
@@ -35,15 +35,15 @@ To use:
     >> data.row_count
     => 3
 
-    # Check out a register
+    # Inspect one of the registers
     >> reg = data.registers.first
     >> reg.label
     => 'Solar'
     >> reg.type_code
     => 'P'
     
-    # Get the data points from a given register, with timestamps
-    >> reg.each_with_timestamp do |val, ts|
+    # Get the data points from a given register, with timestamps and seconds the value represents
+    >> reg.each_row do |ts, val, seconds|
     >>   puts "#{ts}: #{val}"
     >> end
     2012-10-09 13:50:00 -0400: 51140761685

data/Version.txt

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/egauge/data.rb

@@ -3,7 +3,7 @@ require 'nokogiri'
 module EGauge
   class Data
     # Attributes
-    attr_reader :serial, :registers, :timestamp
+    attr_reader :config_serial, :registers, :timestamp
     
     # Parse XML and return an EGauge::Data object containing the data.
     # This will be the primary entry point for most uses of this gem.
@@ -18,7 +18,7 @@ module EGauge
     def initialize(xml)
       # Store off Nokogiri xml tree
       @xml = xml
-      @serial = @xml.group['serial']
+      @config_serial = @xml.group['serial']
       
       # Get first data segment, which sets the register info for all data segments
       data = @xml.group.data
@@ -51,7 +51,7 @@ module EGauge
     end
     
     # Run each value in this register
-    def each_with_timestamp
+    def each_row
       @xml.group.elements.each do |chunk|
         # Set up for running this data chunk - prep timestamp and increment step from source xml
         ts = EGauge::parse_time(chunk['time_stamp'])
@@ -60,17 +60,17 @@ module EGauge
         # Run each row in the chunk, and yield our results
         (chunk / './r').each do |row|
           vals = (row / './c').collect {|c| c.text.to_i}
-          yield ts, vals
+          yield ts, vals, step
           ts += step
         end
       end
     end
     
-    # Return results as a 2D array, like so: [ [timestamp1, [val1, val2...]], [timestamp2, [val1, val2,...], ... ]
+    # Return results as a 2D array, like so: [ [timestamp1, [val1, val2...], seconds1], [timestamp2, [val1, val2,...], seconds2], ... ]
     def to_a
       res = []
-      each_with_timestamp do |ts, vals|
-        res << [ts, vals]
+      each_row do |ts, vals, step|
+        res << [ts, vals, step]
       end
       res
     end

data/lib/egauge/register.rb

@@ -14,7 +14,7 @@ module EGauge
     end
     
     # Run each value in this register, yielding |timestamp, value| for each
-    def each_with_timestamp
+    def each_row
       @data.xml.group.elements.each do |chunk|
         # Set up for running this data chunk - prep timestamp and increment step from source xml
         ts = EGauge::parse_time(chunk['time_stamp'])
@@ -23,17 +23,17 @@ module EGauge
         # Run each row in the chunk, and yield our results
         (chunk / './r').each do |row|
           val = (row / './c')[@index].text.to_i
-          yield ts, val
+          yield ts, val, step
           ts += step
         end
       end
     end
     
-    # Return results as a 2D array, like so: [ [timestamp1, val1], [timestamp2, val2], ... ]
+    # Return results as a 2D array, like so: [ [timestamp1, val1, seconds1], [timestamp2, val2, seconds2], ... ]
     def to_a
       res = []
-      each_with_timestamp do |ts, val|
-        res << [ts, val]
+      each_row do |ts, val, step|
+        res << [ts, val, step]
       end
       res
     end

data/spec/egauge/data_spec.rb

@@ -12,8 +12,8 @@ describe EGauge::Data do
     group.should_not be_nil
   end
   
-  it 'should provide the serial number' do
-    @data1.serial.should == '0x37cdd096'
+  it 'should provide the configuration serial number' do
+    @data1.config_serial.should == '0x37cdd096'
   end
   
   it 'should provide the timestamp' do
@@ -35,10 +35,11 @@ describe EGauge::Data do
   end
   
   it 'should allow access to full row data' do
-    @data1.each_with_timestamp do |ts, values|
+    @data1.each_row do |ts, values, step|
       ts.should be_a(Time)
       values.should be_a(Array)
       values.count.should == 3
+      step.should == 60
     end
   end
 

data/spec/egauge/register_spec.rb

@@ -24,9 +24,10 @@ describe EGauge::Register do
   
   it 'should allow iterating over values with timestamps' do
     counter = 0
-    @reg.each_with_timestamp do |ts, val|
+    @reg.each_row do |ts, val, step|
       val.should be_a(Integer)
       ts.should be_a(Time)
+      step.should == 60
       counter += 1
     end
     counter.should == 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: egauge
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: