ekm-omnimeter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10dccf5f6ac3dcbab08c817d8efe39f9781352d4
-  data.tar.gz: c890f15fa21dae3bee6478505dbde6f366318de0
+  metadata.gz: 758e496aeac9d9f1cf799c3beaee919f2f322060
+  data.tar.gz: f703b60257dd10c354d4777ce804908cca9ed7dc
 SHA512:
-  metadata.gz: c78895c1cb06608cd7c23f0a489866c12305bef1532ee610cb8e6e69976868a96b5a16f977e080416dc8bdde0334346eced2ab543e593b4177bc9b04e6913578
-  data.tar.gz: cee6d71ff4faaec035eaae6daa1b798063814e53363a2b1a142ce7a3c5cc189f98324edf6202c87c505f6f5eff10a273991d8564b1a2f57ca337d9c18219dd38
+  metadata.gz: cd0305137f9ec0e3f4bf6c2cb3da5286210ba4d267c93f89ca1a71500c952bf67c6821d6f40fd99bf33f576c50d99dffcbee2e7e2cd33bb23a520f38773fc59f
+  data.tar.gz: 6edc0ed3de4baefb7e57d72083aff3ea3b92cc0954480d9b39c4ff99d6c2be28a504a797c58e19bfe025ac1e7fb47903f48860f2bca14508e94d8a8227011c27

data/Gemfile.lock

@@ -2,17 +2,13 @@ PATH
   remote: .
   specs:
     ekm-omnimeter (0.1.0)
-      bigdecimal
-      daemons
       log4r (~> 1.1)
-      trollop
       xively-rb-connector (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bigdecimal (1.2.5)
-    daemons (1.1.9)
     diff-lcs (1.2.5)
     httparty (0.13.0)
       json (~> 1.8)
@@ -34,7 +30,6 @@ GEM
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
-    trollop (2.0)
     xively-rb (0.2.10)
       httparty (>= 0.10.0)
       multi_json (>= 1.3.6)
@@ -42,7 +37,7 @@ GEM
       nokogiri (>= 1.5.6)
       ox (>= 1.5.9)
       yajl-ruby (>= 1.1.0)
-    xively-rb-connector (0.1.1)
+    xively-rb-connector (0.1.3)
       bigdecimal (~> 1.2)
       log4r (~> 1.1)
       xively-rb (~> 0.2)
@@ -55,4 +50,4 @@ DEPENDENCIES
   bundler (~> 1.3)
   ekm-omnimeter!
   rake (~> 10.2)
-  rspec
+  rspec (~> 2.14)

data/README.md

@@ -17,7 +17,6 @@ TODO:
 * Add specs
 * Add daemon to monitor meter's output at regular intervals
 
-NOTE:
 ## Requirements
 
 * Ruby 2.0.0 or higher

data/ekm-omnimeter.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   # Runtime dependencies
   spec.add_runtime_dependency "log4r", "~> 1.1"
   spec.add_runtime_dependency "xively-rb-connector", "~> 0.1"
-  spec.add_runtime_dependency "bigdecimal", "~> 1.2"
 
 
 end

data/lib/ekm-omnimeter/configuration.rb

@@ -0,0 +1,23 @@
+module EkmOmnimeter
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :sockets
+  end
+
+end

data/lib/ekm-omnimeter/meter.rb

@@ -13,7 +13,7 @@ module EkmOmnimeter
     VALID_POWER_CONFIGURATIONS = [:single_phase_2wire, :single_phase_3wire, :three_phase_3wire, :three_phase_4wire]
 
     # Initialization attributes
-    attr_reader :meter_number, :remote_address, :remote_port, :power_configuration
+    attr_reader :meter_number, :remote_address, :remote_port, :power_configuration, :last_read_timestamp
 
     # Request A
     #attr_reader :meter_type, :meter_firmware, :address, :total_active_kwh, :total_kvarh, :total_rev_kwh, :three_phase_kwh, :three_phase_rev_kwh, :resettable_kwh, :resettable_reverse_kwh, :volts_l1, :volts_l2, :volts_l3, :amps_l1, :amps_l2, :amps_l3, :watts_l1, :watts_l2, :watts_l3, :watts_total, :cosϴ_l1, :cosϴ_l2, :cosϴ_l3, :var_l1, :var_l2, :var_l3, :var_total, :freq, :pulse_count_1, :pulse_count_2, :pulse_count_3, :pulse_input_hilo, :direction_of_current, :outputs_onoff, :kwh_data_decimal_places,
@@ -54,41 +54,43 @@ module EkmOmnimeter
       #@pulse_input_3_device = options[:pulse_input_2_device] || nil
 
       @values = {}
-      @last_update = nil
+      @last_read_timestamp = nil
 
       # Get values
-      request_a()
+      read()
 
     end
 
-    # Alias request_a with read
+    # A complete read spans two protocol requests
     def read
       request_a()
+      request_b()
+      @values
     end
 
     # Formatted datetime reported by meter during last read
-    def measurement_timestamp
+    def meter_timestamp
       "20#{current_time[0,2]}-#{current_time[2,2]}-#{current_time[4,2]} #{current_time[6,2]}:#{current_time[ 8,2]}:#{current_time[10,2]}"
     end
 
     # Attribute handler that delegates attribute reads to the values hash
     def method_missing(method_sym, *arguments, &block)
 
-      @logger.debug "method_missing #{method_sym.inspect}"
+      #@logger.debug "method_missing #{method_sym.inspect}"
 
       # Only refresh data if its more than 0.25 seconds old
-      et = @last_update.nil? ? 0 : (Time.now - @last_update)
-      @logger.debug "Elapsed time since last read #{et}"
+      et = @last_read_timestamp.nil? ? 0 : (Time.now - @last_read_timestamp)
+      #logger.debug "Elapsed time since last read #{et}"
       if et > 250
         @logger.info "More than 250 milliseconds have passed, updating data"
         read()
       end
 
       if @values.include? method_sym
-        @logger.debug "Found #{method_sym}"
+        #logger.debug "Found #{method_sym}"
         @values[method_sym]
       else
-        @logger.debug "Didn't find #{method_sym}"
+        #logger.debug "Didn't find #{method_sym}"
         super
       end
     end
@@ -169,7 +171,100 @@ module EkmOmnimeter
       end
     end
 
-    #Request A:
+    def to_kwh_float(s)
+      to_f_with_decimal_places(s, @values[:kwh_data_decimal_places])
+    end
+
+    def to_f_with_decimal_places(s, p=1)
+      unless s.nil?
+        v = (s.to_f / (10 ** p))
+        logger.debug "Casting #{s.inspect}  ->  #{v.inspect}"
+        v
+      else
+        logger.error "Could not cast #{s} to #{p} decimal places"
+      end
+    end
+
+    def cast_response_to_correct_types(d)
+
+      # Integers
+      [:kwh_data_decimal_places,
+       :watts_l1,
+       :watts_l2,
+       :watts_l3,
+       :watts_total,
+       :maximum_demand,
+       :ct_ratio,
+       :pulse_1_count,
+       :pulse_1_ratio,
+       :pulse_2_count,
+       :pulse_2_ratio,
+       :pulse_3_count,
+       :pulse_3_ratio,
+       :reactive_power_1,
+       :reactive_power_2,
+       :reactive_power_3,
+       :total_reactive_power,
+       :settable_pulse_per_kwh_ratio
+      ].each do |k|
+        logger.debug "Casting #{k} = #{d[k].inspect}  ->  #{d[k].to_i}"
+        d[k] = d[k].to_i if d.has_key?(k)
+      end
+
+      # Floats with precision 1
+      [:volts_l1,
+       :volts_l2,
+       :volts_l3,
+       :amps_l1,
+       :amps_l2,
+       :amps_l3
+      ].each do |k|
+        logger.debug "Casting #{k}"
+        d[k] = to_f_with_decimal_places(d[k], 1) if d.has_key?(k)
+      end
+
+      # Floats with precision 2
+      [:power_factor_1,
+       :power_factor_2,
+       :power_factor_3,
+       :frequency
+      ].each do |k|
+        logger.debug "Casting #{k}"
+        d[k] = to_f_with_decimal_places(d[k], 2) if d.has_key?(k)
+      end
+
+      # Floats with precision set by kwh_data_decimal_places
+      [:total_kwh,
+       :reactive_kwh_kvarh,
+       :total_forward_kwh,
+       :total_reverse_kwh,
+       :net_kwh,
+       :total_kwh_l1,
+       :total_kwh_l2,
+       :total_kwh_l3,
+       :reverse_kwh_l1,
+       :reverse_kwh_l2,
+       :reverse_kwh_l3,
+       :resettable_total_kwh,
+       :resettable_reverse_kwh,
+       :total_kwh_t1,
+       :total_kwh_t2,
+       :total_kwh_t3,
+       :total_kwh_t4,
+       :reverse_kwh_t1,
+       :reverse_kwh_t2,
+       :reverse_kwh_t3,
+       :reverse_kwh_t4
+      ].each do |k|
+        logger.debug "Casting #{k}"
+        d[k] = to_kwh_float(d[k]) if d.has_key?(k)
+      end
+
+    end
+
+
+    # Request A
+    # TODO: Instead of pre-parsing and casting everything, refactor this so that only the response string gets saved, and  parse out values that are accessed.
     def request_a
 
       # 2F 3F 12 Bytes Address 30 30 21 0D 0A
@@ -178,7 +273,11 @@ module EkmOmnimeter
       read_bytes = 255
       logger.debug "Socket write #{request}" unless logger.nil?
       response = get_remote_meter_data(request, read_bytes)
-      raise EkmError if response.nil?
+
+      if response.nil?
+        log.error "No response to request_a from meter #{address}"
+        raise EkmOmnimeter, "No response from meter."
+      end
 
       # Split the response string into an array and prepare a hash to store the values
       a = response.split('')
@@ -189,12 +288,20 @@ module EkmOmnimeter
       d[:meter_type] = a.shift(2)              # 2 Byte Meter Type
       d[:meter_firmware] = a.shift(1)          # 1 Byte Meter Firmware
       d[:address] = a.shift(12)                # 12 Bytes Address
-      d[:total_active_kwh] = a.shift(8)        # 8 Bytes total Active kWh
-      d[:total_kvarh] = a.shift(8)             # 8 Bytes Total kVARh
-      d[:total_rev_kwh] = a.shift(8)           # 8 Bytes Total Rev.kWh
-      d[:three_phase_kwh] = a.shift(24)        # 24 Bytes 3 phase kWh
-      d[:three_phase_rev_kwh] = a.shift(24)    # 24 Bytes 3 phase Rev.kWh
-      d[:resettable_kwh] = a.shift(8)          # 8 Bytes Resettable kWh
+      d[:total_kwh] = a.shift(8)               # 8 Bytes total Active kWh
+      d[:reactive_kwh_kvarh] = a.shift(8)      # 8 Bytes Total kVARh
+      d[:total_reverse_kwh] = a.shift(8)       # 8 Bytes Total Rev.kWh
+
+      # 24 Bytes 3 phase kWh
+      d[:total_kwh_l1] = a.shift(8)
+      d[:total_kwh_l2] = a.shift(8)
+      d[:total_kwh_l3] = a.shift(8)
+      # 24 Bytes 3 phase Rev.kWh
+      d[:reverse_kwh_l1] = a.shift(8)
+      d[:reverse_kwh_l2] = a.shift(8)
+      d[:reverse_kwh_l3] = a.shift(8)
+
+      d[:resettable_total_kwh] = a.shift(8)    # 8 Bytes Resettable kWh
       d[:resettable_reverse_kwh] = a.shift(8)  # 8 bytes Resettable Reverse kWh
       d[:volts_l1] = a.shift(4)                # 4 Bytes Volts L1
       d[:volts_l2] = a.shift(4)                # 4 Bytes Volts L2
@@ -206,17 +313,17 @@ module EkmOmnimeter
       d[:watts_l2] = a.shift(7)                # 7 Bytes Watts L2
       d[:watts_l3] = a.shift(7)                # 7 Bytes Watts L3
       d[:watts_total] = a.shift(7)             # 7 Bytes Watts Total
-      d[:cosϴ_l1] = a.shift(4)                 # 4 Bytes Cosϴ L1
-      d[:cosϴ_l2] = a.shift(4)                 # 4 Bytes Cosϴ L2
-      d[:cosϴ_l3] = a.shift(4)                 # 4 Bytes Cosϴ L3
-      d[:var_l1] = a.shift(7)                  # 7 Bytes VAR L1
-      d[:var_l2] = a.shift(7)                  # 7 Bytes VAR L2
-      d[:var_l3] = a.shift(7)                  # 7 Bytes VAR L3
-      d[:var_total] = a.shift(7)               # 7 Bytes VAR Total
-      d[:freq] = a.shift(4)                    # 4 Bytes Freq
-      d[:pulse_count_1] = a.shift(8)           # 8 Bytes Pulse Count 1
-      d[:pulse_count_2] = a.shift(8)           # 8 Bytes Pulse Count 2
-      d[:pulse_count_3] = a.shift(8)           # 8 Bytes Pulse Count 3
+      d[:power_factor_1] = a.shift(4)          # 4 Bytes Cosϴ L1
+      d[:power_factor_2] = a.shift(4)          # 4 Bytes Cosϴ L2
+      d[:power_factor_3] = a.shift(4)          # 4 Bytes Cosϴ L3
+      d[:reactive_power_1] = a.shift(7)        # 7 Bytes VAR L1
+      d[:reactive_power_2] = a.shift(7)        # 7 Bytes VAR L2
+      d[:reactive_power_3] = a.shift(7)        # 7 Bytes VAR L3
+      d[:total_reactive_power] = a.shift(7)    # 7 Bytes VAR Total
+      d[:frequency] = a.shift(4)               # 4 Bytes Freq
+      d[:pulse_1_count] = a.shift(8)           # 8 Bytes Pulse Count 1
+      d[:pulse_2_count] = a.shift(8)           # 8 Bytes Pulse Count 2
+      d[:pulse_3_count] = a.shift(8)           # 8 Bytes Pulse Count 3
       d[:pulse_input_hilo] = a.shift(1)        # 1 Byte Pulse Input Hi/Lo
       d[:direction_of_current] = a.shift(1)    # 1 Bytes direction of current
       d[:outputs_onoff] = a.shift(1)           # 1 Byte Outputs On/Off
@@ -224,20 +331,26 @@ module EkmOmnimeter
       a.shift(2)                               # 2 Bytes Reserved
       d[:current_time] = a.shift(14)           # 14 Bytes Current Time
       a.shift(6)                               # 30 30 21 0D 0A 03
-      #d[] = a.shift(2)                         # 2 Bytes CRC16
+      d[:CRC16] = a.shift(2)                   # 2 Bytes CRC16
 
       # Smash arrays into strungs
       d.each {|k,v| d[k] = v.join('')}
 
+      # Cast types
+      @values[:kwh_data_decimal_places] = d[:kwh_data_decimal_places].to_i
+      cast_response_to_correct_types(d)
+
       # Merge to values and reset time
       @values.merge!(d)
-      @last_update = Time.now
+      @last_read_timestamp = Time.now
 
       # Calculate totals based on wiring configuration
-      @values[:measurement_timestamp] = measurement_timestamp
+      @values[:meter_timestamp] = meter_timestamp
       @values[:volts] = calculate_measurement(d[:volts_l1], d[:volts_l2], d[:volts_l3])
       @values[:amps]  = calculate_measurement(d[:amps_l1], d[:amps_l2], d[:amps_l3])
       @values[:watts] = calculate_measurement(d[:watts_l1], d[:watts_l2], d[:watts_l3])
+      @values[:total_forward_kwh] = total_kwh - total_reverse_kwh
+      @values[:net_kwh] = total_forward_kwh - total_reverse_kwh
 
       # Return the hash as an open struct
       return d
@@ -245,7 +358,8 @@ module EkmOmnimeter
     end
 
 
-    # Request B:
+    # Request B
+    # TODO: Instead of pre-parsing and casting everything, refactor this so that only the response string gets saved, and  parse out values that are accessed.
     def request_b
 
       # 2F 3F 12 Bytes Address 30 31 21 0D 0A
@@ -254,10 +368,13 @@ module EkmOmnimeter
       read_bytes = 255
       logger.debug "Socket write #{request}" unless logger.nil?
       response = get_remote_meter_data(request, read_bytes)
-      raise EkmError if response.nil?
+      if response.nil?
+        log.error "No response to request_a from meter #{address}"
+        raise EkmOmnimeter, "No response from meter."
+      end
 
       # Split the response string into an array and prepare a hash to store the values
-      a = s.split('')
+      a = response.split('')
       d = {}
 
       # Return (255 Bytes total) :
@@ -265,9 +382,20 @@ module EkmOmnimeter
       d[:meter_type] = a.shift(2)              # 2 Byte Meter Type
       d[:meter_firmware] = a.shift(1)          # 1 Byte Meter Firmware
       d[:address] = a.shift(12)                # 12 Bytes Address
+
       # Diff from request A start
-      d[:t1_t2_t3_t4_kwh] = a.shift(32)              # 32 Bytes T1, T2, T3, T4 kwh
-      d[:t1_t2_t3_t4_rev_kwh] = a.shift(32)          # 32 Bytes T1, T2, T3, T4 Rev kWh
+      #d[:t1_t2_t3_t4_kwh] = a.shift(32)        # 32 Bytes T1, T2, T3, T4 kwh
+      d[:total_kwh_t1] = a.shift(8)
+      d[:total_kwh_t2] = a.shift(8)
+      d[:total_kwh_t3] = a.shift(8)
+      d[:total_kwh_t4] = a.shift(8)
+
+      #d[:t1_t2_t3_t4_rev_kwh] = a.shift(32)    # 32 Bytes T1, T2, T3, T4 Rev kWh
+      d[:reverse_kwh_t1] = a.shift(8)
+      d[:reverse_kwh_t2] = a.shift(8)
+      d[:reverse_kwh_t3] = a.shift(8)
+      d[:reverse_kwh_t4] = a.shift(8)
+
       # Diff from request A end
       d[:volts_l1] = a.shift(4)                # 4 Bytes Volts L1
       d[:volts_l2] = a.shift(4)                # 4 Bytes Volts L2
@@ -279,33 +407,36 @@ module EkmOmnimeter
       d[:watts_l2] = a.shift(7)                # 7 Bytes Watts L2
       d[:watts_l3] = a.shift(7)                # 7 Bytes Watts L3
       d[:watts_total] = a.shift(7)             # 7 Bytes Watts Total
-      d[:cosϴ_l1] = a.shift(4)                 # 4 Bytes Cosϴ L1
-      d[:cosϴ_l2] = a.shift(4)                 # 4 Bytes Cosϴ L2
-      d[:cosϴ_l3] = a.shift(4)                 # 4 Bytes Cosϴ L3
+      d[:power_factor_1] = a.shift(4)          # 4 Bytes Cosϴ L1
+      d[:power_factor_2] = a.shift(4)          # 4 Bytes Cosϴ L2
+      d[:power_factor_3] = a.shift(4)          # 4 Bytes Cosϴ L3
       # Diff from request A start
       d[:maximum_demand] = a.shift(8)                # 8 Bytes Maximum Demand
-      d[:maximum_demand_time] = a.shift(1)           # 1 Byte Maximum Demand Time
-      d[:pulse_ratio_1] = a.shift(4)                 # 4 Bytes Pulse Ratio 1
-      d[:pulse_ratio_2] = a.shift(4)                 # 4 Bytes Pulse Ratio 2
-      d[:pulse_ratio_3] = a.shift(4)                 # 4 Bytes Pulse Ratio 3
+      d[:maximum_demand_period] = a.shift(1)         # 1 Byte Maximum Demand Time
+      d[:pulse_1_ratio] = a.shift(4)                 # 4 Bytes Pulse Ratio 1
+      d[:pulse_2_ratio] = a.shift(4)                 # 4 Bytes Pulse Ratio 2
+      d[:pulse_3_ratio] = a.shift(4)                 # 4 Bytes Pulse Ratio 3
       d[:ct_ratio] = a.shift(4)                      # 4 Bytes CT Ratio
-      d[:auto_reset_md] = a.shift(1)                 # 1 Bytes Auto Reset MD
-      d[:settable_imp_per_kWh_constant] = a.shift(4) # 4 Bytes Settable Imp/kWh Constant
+      d[:auto_reset_max_demand] = a.shift(1)         # 1 Bytes Auto Reset MD
+      d[:settable_pulse_per_kwh_ratio] = a.shift(4)  # 4 Bytes Settable Imp/kWh Constant
       # Diff from request A end
-      a.shift(56)                               # 56 Bytes Reserved
+      a.shift(56)                              # 56 Bytes Reserved
       d[:current_time] = a.shift(14)           # 14 Bytes Current Time
       a.shift(6)                               # 30 30 21 0D 0A 03
-      d[] = a.shift(2)                         # 2 Bytes CRC16
+      d[:checksum] = a.shift(2)                # 2 Bytes CRC16
 
       # Smash arrays into strungs
       d.each {|k,v| d[k] = v.join('')}
 
+      # Cast types
+      cast_response_to_correct_types(d)
+
       # Merge to values and reset time
       @values.merge!(d)
-      @last_update = Time.now
+      @last_read_timestamp = Time.now
 
       # Calculate totals based on wiring configuration
-      @values[:measurement_timestamp] = measurement_timestamp
+      @values[:meter_timestamp] = meter_timestamp
       @values[:volts] = calculate_measurement(d[:volts_l1], d[:volts_l2], d[:volts_l3])
       @values[:amps]  = calculate_measurement(d[:amps_l1], d[:amps_l2], d[:amps_l3])
       @values[:watts] = calculate_measurement(d[:watts_l1], d[:watts_l2], d[:watts_l3])

data/lib/ekm-omnimeter/version.rb

@@ -6,7 +6,7 @@ module EkmOmnimeter
 
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ekm-omnimeter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jordan Duggan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +80,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: bigdecimal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
 description: Ruby interface to the EKM Omnimeter Pulse
 email:
 - Jordan.Duggan@gmail.com
@@ -109,6 +95,7 @@ files:
 - Rakefile
 - ekm-omnimeter.gemspec
 - lib/ekm-omnimeter.rb
+- lib/ekm-omnimeter/configuration.rb
 - lib/ekm-omnimeter/logging.rb
 - lib/ekm-omnimeter/meter.rb
 - lib/ekm-omnimeter/version.rb