Floppy-currentcost 0.0.2

data/COPYING

@@ -0,0 +1,19 @@
+Copyright (c) 2008 James Smith (james@floppy.org.uk)
+
+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

@@ -0,0 +1,30 @@
+== CurrentCost-Ruby
+
+A gem to provide a Ruby interface to the CurrentCost energy meter 
+(http://www.currentcost.com)
+
+Licensed under the MIT license (See COPYING file for details)
+
+Author: James Smith (james@floppy.org.uk / http://www.floppy.org.uk)
+
+Homepage: http://github.com/Floppy/currentcost-ruby
+
+== INSTALLATION
+
+1) Enable gems from github, if you haven't already done so (rubygems >= 1.2): 
+    > sudo gem sources -a http://gems.github.com
+
+2) Install gem
+    > sudo gem install Floppy-currentcost
+
+== REQUIREMENTS
+
+ruby-serialport >= 0.7.0
+ - You will need to get the source from http://github.com/aaronp/ruby-serialport,
+   build the gem using "rake gem", and install it before using this gem.
+
+== STATUS
+
+This software is in very early development. There is currently no direct access
+to the meter via serial port, but you can use CurrentCost::Reading.from_xml to 
+parse XML which you have got from the meter another way.

data/lib/currentcost.rb

@@ -0,0 +1,6 @@
+require 'rexml/document'
+
+require 'currentcost/version'
+require 'currentcost/exceptions'
+require 'currentcost/meter'
+require 'currentcost/reading'

data/lib/currentcost/exceptions.rb

@@ -0,0 +1,6 @@
+module CurrentCost
+  
+  class ParseError < Exception
+  end
+
+end

data/lib/currentcost/meter.rb

@@ -0,0 +1,15 @@
+module CurrentCost
+  
+  class Meter
+    
+    def initialize
+      
+    end
+    
+    def latest_reading
+      Reading.new
+    end
+    
+  end
+  
+end

data/lib/currentcost/reading.rb

@@ -0,0 +1,64 @@
+module CurrentCost
+  
+  class Reading
+    
+    def self.from_xml(xml)
+      # Parse XML
+      doc = REXML::Document.new(xml)
+      # Create reading object
+      r = Reading.new
+      # Extract basic data
+      r.days_since_birth = REXML::XPath.first(doc, "/msg/date/dsb").text.to_i
+      r.hour = REXML::XPath.first(doc, "/msg/date/hr").text.to_i
+      r.minute = REXML::XPath.first(doc, "/msg/date/min").text.to_i
+      r.second = REXML::XPath.first(doc, "/msg/date/sec").text.to_i
+      r.name = REXML::XPath.first(doc, "/msg/src/name").text
+      r.id = REXML::XPath.first(doc, "/msg/src/id").text
+      r.type = REXML::XPath.first(doc, "/msg/src/type").text
+      r.software_version = REXML::XPath.first(doc, "/msg/src/sver").text
+      r.temperature = REXML::XPath.first(doc, "/msg/tmpr").text.to_f
+      r.channels = []
+      REXML::XPath.each(doc, "/msg/*/watts") do |node|
+        r.channels << { :watts => node.text.to_i }
+      end
+      # Extract history data
+      if REXML::XPath.first(doc, "/msg/hist")
+        r.history = {}
+        r.history[:hours] = []
+        REXML::XPath.each(doc, "/msg/hist/hrs/*") do |node|
+          r.history[:hours][node.name.slice(1,2).to_i] = node.text.to_f
+        end
+        r.history[:days] = []
+        REXML::XPath.each(doc, "/msg/hist/days/*") do |node|
+          r.history[:days][node.name.slice(1,2).to_i] = node.text.to_i
+        end
+        r.history[:months] = []
+        REXML::XPath.each(doc, "/msg/hist/mths/*") do |node|
+          r.history[:months][node.name.slice(1,2).to_i] = node.text.to_i
+        end
+        r.history[:years] = []
+        REXML::XPath.each(doc, "/msg/hist/yrs/*") do |node|
+          r.history[:years][node.name.slice(1,2).to_i] = node.text.to_i
+        end
+      end
+      # Done
+      return r
+    rescue 
+      raise CurrentCost::ParseError.new("Couldn't parse XML data.")
+    end
+    
+    attr_accessor :days_since_birth
+    attr_accessor :hour
+    attr_accessor :minute
+    attr_accessor :second
+    attr_accessor :name
+    attr_accessor :id
+    attr_accessor :type
+    attr_accessor :software_version
+    attr_accessor :channels
+    attr_accessor :temperature
+    attr_accessor :history
+    
+  end
+  
+end

data/lib/currentcost/version.rb

@@ -0,0 +1,10 @@
+module CurrentCost
+  
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: Floppy-currentcost
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: james@floppy.org.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- COPYING
+- lib/currentcost.rb
+- lib/currentcost/meter.rb
+- lib/currentcost/reading.rb
+- lib/currentcost/version.rb
+- lib/currentcost/exceptions.rb
+has_rdoc: false
+homepage: http://github.com/Floppy/currentcost-ruby
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby interface to the CurrentCost energy meter
+test_files: []
+