ekm-omnimeter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10dccf5f6ac3dcbab08c817d8efe39f9781352d4
+  data.tar.gz: c890f15fa21dae3bee6478505dbde6f366318de0
+SHA512:
+  metadata.gz: c78895c1cb06608cd7c23f0a489866c12305bef1532ee610cb8e6e69976868a96b5a16f977e080416dc8bdde0334346eced2ab543e593b4177bc9b04e6913578
+  data.tar.gz: cee6d71ff4faaec035eaae6daa1b798063814e53363a2b1a142ce7a3c5cc189f98324edf6202c87c505f6f5eff10a273991d8564b1a2f57ca337d9c18219dd38

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ekm-meter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+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)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    log4r (1.1.10)
+    mini_portile (0.5.3)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    ox (2.1.1)
+    rake (10.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    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)
+      multi_xml (>= 0.5.2)
+      nokogiri (>= 1.5.6)
+      ox (>= 1.5.9)
+      yajl-ruby (>= 1.1.0)
+    xively-rb-connector (0.1.1)
+      bigdecimal (~> 1.2)
+      log4r (~> 1.1)
+      xively-rb (~> 0.2)
+    yajl-ruby (1.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  ekm-omnimeter!
+  rake (~> 10.2)
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jordan Duggan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+ekm-omnimeter
+=============
+
+This ruby gem provides an interface to [EKM Omnimeter Pulse meters](http://www.ekmmetering.com/ekm-metering-products/electric-meters-kwh-meters/smart-meters-read-meter-remotely-automatically/omnimeter-pulse.html)
+that are connected to a [EKM iSerial TCP/IP Ethernet to RS-485 Serial Converter](http://www.ekmmetering.com/ekm-metering-products/remote-meter-reading-solutions/ekm-iserial-v-2-tcp-ip-to-serial-converter-ethernet-connection.html).
+
+[EKM Metering](http://www.ekmmetering.com) offers a range of digital utility metering and control devices, including the
+Omnimeter Pulse Meter line of smart meters. The
+[Omnimeter Pulse Meter](http://www.ekmmetering.com/ekm-metering-products/electric-meters-kwh-meters/smart-meters-read-meter-remotely-automatically/omnimeter-pulse.html)
+contains a revenue-grade universal kWh power meter, three pulse counting inputs for
+[water](http://www.ekmmetering.com/ekm-metering-products/water-meters.html) and/or
+[gas](http://www.ekmmetering.com/ekm-metering-products/gas-meters/pulse-output-gas-meter-pgm-1-read-gas-consumption-remotely.html) metering,
+and 2 controllable 50 mA at 12 volts relay outputs that can toggle 120v circuits when connected to their [EKM Switch120 power cord](http://www.ekmmetering.com/ekm-metering-products/accessories/switch120.html).
+
+TODO:
+* Cast values to their proper type and precision
+* Add specs
+* Add daemon to monitor meter's output at regular intervals
+
+NOTE:
+## Requirements
+
+* Ruby 2.0.0 or higher
+* A [EKM Omnimeter Pulse meters](http://www.ekmmetering.com/ekm-metering-products/electric-meters-kwh-meters/smart-meters-read-meter-remotely-automatically/omnimeter-pulse.html)
+* A [EKM iSerial TCP/IP Ethernet to RS-485 Serial Converter](http://www.ekmmetering.com/ekm-metering-products/remote-meter-reading-solutions/ekm-iserial-v-2-tcp-ip-to-serial-converter-ethernet-connection.html)
+
+
+## Contact, feedback and bugs
+
+This interface was not developed or reviewed by EKM Metering. They bare no responsibility for its quality, performance, or results. Use at your own risk.
+
+Please file bugs / issues and feature requests on the [issue tracker](https://github.com/jwtd/ekm-omnimeter/issues)
+
+## Install
+
+```
+gem install ekm-omnimeter
+```
+
+## Examples
+
+```ruby
+
+require 'ekm-omnimeter'
+
+# Connect to the meter
+m = EkmOmnimeter::Meter.new(
+  :power_configuration => :single_phase_3wire,  # Valid values are  :single_phase_2wire, :single_phase_3wire, :three_phase_3wire, :three_phase_4wire
+  :meter_number=>300000001,                     # Your nine digit meter id
+  :remote_address=>'192.168.1.125',             # The IP address of your iSerial device
+  :remote_port => 50000)                        # The port on which your iSerial device is listening
+
+# Read some values
+m.remote_address            # 192.168.1.125
+m.remote_port               # 50000
+m.meter_number              # 000300000001
+m.address                   # 000300000001
+m.measurement_timestamp     # 2014-04-03 05:03:01
+m.total_active_kwh          # 00450609
+m.total_kvarh               # 00080417
+m.total_rev_kwh             # 00007590
+m.three_phase_kwh           # 002115660023898000000000
+m.three_phase_rev_kwh       # 000000000000759000000000
+m.resettable_kwh            # 00450609
+m.resettable_reverse_kwh    # 00007590
+m.volts_l1                  # 1245
+m.volts_l2                  # 1254
+m.volts_l3                  # 0000
+m.amps_l1                   # 00200
+m.amps_l2                   # 00056
+m.amps_l3                   # 00000
+m.watts_l1                  # 0002504
+m.watts_l2                  # 0000664
+m.watts_l3                  # 0000000
+m.watts_total               # 0003172
+m.cosϴ_l1                   # 100
+m.cosϴ_l2                   # 100
+m.cosϴ_l3                   # C000
+m.var_l1                    # 0000052
+m.var_l2                    # 0000000
+m.var_l3                    # 0000000
+m.var_total                 # 0000052
+m.freq                      # 6006
+m.pulse_count_1             # 00000003
+m.pulse_count_2             # 00000006
+m.pulse_count_3             # 00000000
+m.pulse_input_hilo          # 4
+m.direction_of_current      # 1
+m.outputs_onoff             # 1
+m.kwh_data_decimal_places   # 2
+
+
+```
+
+## Special Thanks
+
+* EKM Metering - for an awesome piece of hardware
+* Ian Duggan - for introducing me to ruby
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/ekm-omnimeter.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ekm-omnimeter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ekm-omnimeter"
+  spec.version       = EkmOmnimeter::VERSION::STRING
+  spec.authors       = ["Jordan Duggan"]
+  spec.email         = ["Jordan.Duggan@gmail.com"]
+  spec.description   = %q{Ruby interface to the EKM Omnimeter Pulse}
+  spec.summary       = %q{This ruby gem provides an interface to EKM Omnimeter Pulse meters that are connected to a EKM iSerial TCP/IP Ethernet to RS-485 Serial Converter. Omnimeter Pulse meters contain a revenue-grade universal kWh power meter, three pulse counting inputs for water and/or gas metering, and 2 controllable 50 mA at 12 volts relay outputs.}
+  spec.homepage      = "https://github.com/jwtd/ekm-omnimeter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.2"
+  spec.add_development_dependency "rspec", "~> 2.14"
+
+  # 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.rb

@@ -0,0 +1,8 @@
+module EkmOmnimeter
+  # Base Ekm exception class
+  class EkmOmnimeterError < ::Exception; end
+end
+
+require "ekm-omnimeter/version"
+require "ekm-omnimeter/logging"
+require "ekm-omnimeter/meter"

data/lib/ekm-omnimeter/logging.rb

@@ -0,0 +1,25 @@
+require 'log4r'
+include Log4r
+module EkmOmnimeter
+
+  module Logging
+
+    def logger
+      @logger ||= EkmOmnimeter::Logging.logger
+    end
+
+    def self.logger
+      @logger ||= self.configure_logger_for(self.class.name)
+    end
+
+    def self.configure_logger_for(classname)
+      l = Logger.new(classname)
+      l.level = ERROR
+      l.trace = false
+      l.add Log4r::Outputter.stderr
+      l
+    end
+
+  end
+
+end

data/lib/ekm-omnimeter/meter.rb

@@ -0,0 +1,359 @@
+require 'socket'
+require 'ostruct'
+
+# Convert byte array to string
+# %w(01 52 31 02 30 30 31 31 28 29 03 13 16).map{|a| a.to_i(16).chr}.join
+
+module EkmOmnimeter
+  # EKM Omnimeter Pulse v.4 - Pulse Counting, Relay Controlling, Universal Smart Electric Meter
+  # EKM Developer Portal http://www.ekmmetering.com/developer-portal
+  # PHP Client http://forum.ekmmetering.com/viewtopic.php?f=4&t=3206
+  class Meter
+
+    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
+
+    # 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,
+
+    # Request B
+    #attr_reader :t1_t2_t3_t4_kwh, :t1_t2_t3_t4_rev_kwh, :maximum_demand, :maximum_demand_time, :pulse_ratio_1, :pulse_ratio_2, :pulse_ratio_3, :ct_ratio, :auto_reset_md, :settable_imp_per_kWh_constant
+
+    # Mix in the ability to log
+    include Logging
+
+    def initialize(options)
+
+      @logger = logger || options[:logger]
+
+      # Test logging call
+      @logger.info "Initializing Meter"
+
+      # Prepend the meter number with the correct amount of leading zeros
+      @meter_number   = options[:meter_number].to_s.rjust(12, '0')
+      @remote_address = options[:remote_address] || '192.168.0.125'
+      @remote_port    = options[:remote_port] || 50000
+      @logger.debug  "meter_number: #{meter_number}"
+      @logger.debug  "remote_address: #{remote_address}"
+      @logger.debug  "remote_port: #{remote_port}"
+
+      # Collect the power configurations
+      if VALID_POWER_CONFIGURATIONS.index(options[:power_configuration])
+        power_configuration = options[:power_configuration]
+      else
+        raise EkmOmnimeterError, "Invalid power configuration #{options[:power_configuration]}. Valid values are #{VALID_POWER_CONFIGURATIONS.join(', ')}"
+      end
+
+      # Collect pulse inputs
+      #:ekm_gas_meter
+      #:ekm_water_meter
+      #@pulse_input_1_device = options[:pulse_input_1_device] || nil
+      #@pulse_input_2_device = options[:pulse_input_3_device] || nil
+      #@pulse_input_3_device = options[:pulse_input_2_device] || nil
+
+      @values = {}
+      @last_update = nil
+
+      # Get values
+      request_a()
+
+    end
+
+    # Alias request_a with read
+    def read
+      request_a()
+    end
+
+    # Formatted datetime reported by meter during last read
+    def measurement_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}"
+
+      # 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}"
+      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}"
+        @values[method_sym]
+      else
+        @logger.debug "Didn't find #{method_sym}"
+        super
+      end
+    end
+
+    # Attribute responder that delegates check of attribute existence to the values hash
+    def respond_to?(method_sym, include_private = false)
+      if @values.include? method_sym
+        true
+      else
+        super
+      end
+    end
+
+
+    ## Request A
+    #d[:meter_type]              # 2 Byte Meter Type
+    #d[:meter_firmware]          # 1 Byte Meter Firmware
+    #d[:address]                 # 12 Bytes Address
+    #d[:total_active_kwh]        # 8 Bytes total Active kWh
+    #d[:total_kvarh]             # 8 Bytes Total kVARh
+    #d[:total_rev_kwh]           # 8 Bytes Total Rev.kWh
+    #d[:three_phase_kwh]         # 24 Bytes 3 phase kWh
+    #d[:three_phase_rev_kwh]     # 24 Bytes 3 phase Rev.kWh
+    #d[:resettable_kwh]          # 8 Bytes Resettable kWh
+    #d[:resettable_reverse_kwh]  # 8 bytes Resettable Reverse kWh
+    #d[:volts_l1]                # 4 Bytes Volts L1
+    #d[:volts_l2]                # 4 Bytes Volts L2
+    #d[:volts_l3]                # 4 Bytes Volts L3
+    #d[:amps_l1]                 # 5 Bytes Amps L1
+    #d[:amps_l2]                 # 5 Bytes Amps L2
+    #d[:amps_l3]                 # 5 Bytes Amps L3
+    #d[:watts_l1]                # 7 Bytes Watts L1
+    #d[:watts_l2]                # 7 Bytes Watts L2
+    #d[:watts_l3]                # 7 Bytes Watts L3
+    #d[:watts_total]             # 7 Bytes Watts Total
+    #d[:cosϴ_l1]                 # 4 Bytes Cosϴ L1
+    #d[:cosϴ_l2]                 # 4 Bytes Cosϴ L2
+    #d[:cosϴ_l3]                 # 4 Bytes Cosϴ L3
+    #d[:var_l1]                  # 7 Bytes VAR L1
+    #d[:var_l2]                  # 7 Bytes VAR L2
+    #d[:var_l3]                  # 7 Bytes VAR L3
+    #d[:var_total]               # 7 Bytes VAR Total
+    #d[:freq]                    # 4 Bytes Freq
+    #d[:pulse_count_1]           # 8 Bytes Pulse Count 1
+    #d[:pulse_count_2]           # 8 Bytes Pulse Count 2
+    #d[:pulse_count_3]           # 8 Bytes Pulse Count 3
+    #d[:pulse_input_hilo]        # 1 Byte Pulse Input Hi/Lo
+    #d[:direction_of_current]    # 1 Bytes direction of current
+    #d[:outputs_onoff]           # 1 Byte Outputs On/Off
+    #d[:kwh_data_decimal_places] # 1 Byte kWh Data Decimal Places
+
+    ## Request B
+    #d[:t1_t2_t3_t4_kwh]               # 32 Bytes T1, T2, T3, T4 kwh
+    #d[:t1_t2_t3_t4_rev_kwh]           # 32 Bytes T1, T2, T3, T4 Rev kWh
+    #d[:maximum_demand]                # 8 Bytes Maximum Demand
+    #d[:maximum_demand_time]           # 1 Byte Maximum Demand Time
+    #d[:pulse_ratio_1]                 # 4 Bytes Pulse Ratio 1
+    #d[:pulse_ratio_2]                 # 4 Bytes Pulse Ratio 2
+    #d[:pulse_ratio_3]                 # 4 Bytes Pulse Ratio 3
+    #d[:ct_ratio]                      # 4 Bytes CT Ratio
+    #d[:auto_reset_md]                 # 1 Bytes Auto Reset MD
+    #d[:settable_imp_per_kWh_constant] # 4 Bytes Settable Imp/kWh Constant
+
+
+    # iSerial v4 Spec From http://documents.ekmmetering.com/Omnimeter-Pulse-v.4-Protocol.pdf
+    # %w(01 52 31 02 30 30 31 31 28 29 03 13 16).map{|a| a.to_i(16).chr}.join
+
+    # Returns the correct measurement for voltage, current, and power based on the corresponding power_configuration
+    def calculate_measurement(m1, m2, m3)
+      if power_configuration == :single_phase_2wire
+        volts_l1
+      elsif power_configuration == :single_phase_3wire
+        (volts_l1 + volts_l2)
+      elsif power_configuration == :three_phase_3wire
+        (volts_l1 + :volts_l3)
+      elsif power_configuration == :three_phase_4wire
+        (volts_l1 + volts_l2 + volts_l3)
+      end
+    end
+
+    #Request A:
+    def request_a
+
+      # 2F 3F 12 Bytes Address 30 30 21 0D 0A
+      # /?00000000012300! then a CRLF
+      request = "/?" + meter_number + "00!\r\n"
+      read_bytes = 255
+      logger.debug "Socket write #{request}" unless logger.nil?
+      response = get_remote_meter_data(request, read_bytes)
+      raise EkmError if response.nil?
+
+      # Split the response string into an array and prepare a hash to store the values
+      a = response.split('')
+      d = {}
+
+      # Return (255 Bytes total) :
+      a.shift(1)                               # 02
+      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[: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
+      d[:volts_l3] = a.shift(4)                # 4 Bytes Volts L3
+      d[:amps_l1] = a.shift(5)                 # 5 Bytes Amps L1
+      d[:amps_l2] = a.shift(5)                 # 5 Bytes Amps L2
+      d[:amps_l3] = a.shift(5)                 # 5 Bytes Amps L3
+      d[:watts_l1] = a.shift(7)                # 7 Bytes Watts L1
+      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[: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
+      d[:kwh_data_decimal_places] = a.shift(1) # 1 Byte kWh Data Decimal Places
+      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
+
+      # Smash arrays into strungs
+      d.each {|k,v| d[k] = v.join('')}
+
+      # Merge to values and reset time
+      @values.merge!(d)
+      @last_update = Time.now
+
+      # Calculate totals based on wiring configuration
+      @values[:measurement_timestamp] = measurement_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])
+
+      # Return the hash as an open struct
+      return d
+
+    end
+
+
+    # Request B:
+    def request_b
+
+      # 2F 3F 12 Bytes Address 30 31 21 0D 0A
+      # /?00000000012301! then a CRLF
+      request = "/?" + meter_number + "01!\r\n"
+      read_bytes = 255
+      logger.debug "Socket write #{request}" unless logger.nil?
+      response = get_remote_meter_data(request, read_bytes)
+      raise EkmError if response.nil?
+
+      # Split the response string into an array and prepare a hash to store the values
+      a = s.split('')
+      d = {}
+
+      # Return (255 Bytes total) :
+      a.shift(1)                               # 02
+      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
+      # 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
+      d[:volts_l3] = a.shift(4)                # 4 Bytes Volts L3
+      d[:amps_l1] = a.shift(5)                 # 5 Bytes Amps L1
+      d[:amps_l2] = a.shift(5)                 # 5 Bytes Amps L2
+      d[:amps_l3] = a.shift(5)                 # 5 Bytes Amps L3
+      d[:watts_l1] = a.shift(7)                # 7 Bytes Watts L1
+      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
+      # 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[: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
+      # Diff from request A end
+      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
+
+      # Smash arrays into strungs
+      d.each {|k,v| d[k] = v.join('')}
+
+      # Merge to values and reset time
+      @values.merge!(d)
+      @last_update = Time.now
+
+      # Calculate totals based on wiring configuration
+      @values[:measurement_timestamp] = measurement_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])
+
+      # Return the hash as an open struct
+      return d
+
+    end
+
+
+
+    # Gets remote EKM meter data using iSerial defaults
+    #   meter_number is the meters serial number. leading 0s not required.
+    #   remote_address is the IP address of the ethernet-RS485 converter
+    #   remote_port is the TCP port number the converter is listening to (50000 in my case)
+    # We do not check the checksum - I'm lazy.  Probably should. Running for 8 months, querying
+    # once per minute..I've encountered one or two bad results from the meter.
+    def get_remote_meter_data(request, read_bytes)
+
+      logger.debug "get_remote_meter_data #{request} from meter# #{meter_number}" unless logger.nil?
+
+      # connect to the meter and check to make sure we connected
+      begin
+
+        socket = TCPSocket.new(remote_address, remote_port)
+        logger.debug "Socket open" unless logger.nil?
+
+        # Send request to the meter
+        logger.debug "Request: #{request}" unless logger.nil?
+        socket.write(request)
+
+        # Receive a response of 255 bytes
+        response = socket.read(read_bytes)
+        logger.debug "Socket response #{response.length}" unless logger.nil?
+        logger.debug response unless logger.nil?
+
+      rescue Exception => ex
+        logger.error "Exception\n#{ex.message}\n#{ex.backtrace.join("\n")}" unless logger.nil?
+      ensure
+        # EKM Meter software sends this just before closing the connection, so we will too
+        socket.write "\x0a\x03\x32\x3d"
+        socket.close
+        logger.debug "Socket closed" unless logger.nil?
+      end
+
+      return response
+
+    end
+
+  end
+end

data/lib/ekm-omnimeter/version.rb

@@ -0,0 +1,14 @@
+module EkmOmnimeter
+
+  def self.version_string
+    "ekm-omnimeter version #{EkmOmnimeter::VERSION::STRING}"
+  end
+
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].join('.')
+  end
+end

data/spec/meter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe EkmOmnimeter::Meter do
+
+  describe "#initialize" do
+    it "should ..." do
+
+      #:meter_number
+      #:remote_address
+      #:remote_port
+
+    end
+  end
+
+  describe "#read" do
+    it "should ..." do
+    end
+  end
+
+  describe "#meter_timestamp" do
+    it "should ..." do
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+
+require 'rspec'
+require 'time'
+
+# figure out where we are being loaded from
+if $LOADED_FEATURES.grep(/spec\/spec_helper\.rb/).any?
+  begin
+    raise "foo"
+  rescue => e
+    puts <<-MSG
+  ===================================================
+  It looks like spec_helper.rb has been loaded
+  multiple times. Normalize the require to:
+
+    require "spec/spec_helper"
+
+  Things like File.join and File.expand_path will
+  cause it to be loaded multiple times.
+
+  Loaded this time from:
+
+    #{e.backtrace.join("\n    ")}
+  ===================================================
+    MSG
+  end
+end
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'ekm-omnimeter'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+
+
+
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ekm-omnimeter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Duggan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: xively-rb-connector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ekm-omnimeter.gemspec
+- lib/ekm-omnimeter.rb
+- lib/ekm-omnimeter/logging.rb
+- lib/ekm-omnimeter/meter.rb
+- lib/ekm-omnimeter/version.rb
+- spec/meter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jwtd/ekm-omnimeter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This ruby gem provides an interface to EKM Omnimeter Pulse meters that are
+  connected to a EKM iSerial TCP/IP Ethernet to RS-485 Serial Converter. Omnimeter
+  Pulse meters contain a revenue-grade universal kWh power meter, three pulse counting
+  inputs for water and/or gas metering, and 2 controllable 50 mA at 12 volts relay
+  outputs.
+test_files:
+- spec/meter_spec.rb
+- spec/spec_helper.rb