Floppy-currentcostd 1.1

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,33 @@
+== currentcostd
+
+A system daemon for monitoring and publishing data from a 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-daemon
+
+== 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-currentcostd
+
+== REQUIREMENTS
+
+Floppy-currentcost >= 0.2.4
+Floppy-eeml >= 0.1.0
+daemons >= 1.0.10
+builder >= 2.1.2
+
+== USAGE
+
+1) Copy config/currentcostd.example.yml to /etc/currentcost.yml
+
+2) Edit the settings in your new currentcostd.yml
+
+3) Run "sudo currentcostd start" to start the daemon.

data/bin/currentcostd

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2008 James Smith (www.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.
+#
+# http://www.opensource.org/licenses/mit-license.php
+
+require 'rubygems'
+require 'daemons'
+require 'currentcost/meter'
+
+# Load config
+config  = nil
+config_files = [
+  "/etc/currentcostd.yml",
+  File.join(File.dirname(__FILE__), '/../config/currentcostd.yml')
+]
+config_files.each do |c|
+  if File.exists?(c)
+    config = YAML.load_file(c)
+    break
+  end
+end
+if config.nil?
+  puts "Couldn't load configuration from " + config_files.join(" or ")
+  exit
+end
+
+# Require all available publishers
+Dir.glob(File.join(File.dirname(__FILE__), '/../lib/currentcostd/publishers/*.rb')).each { |f| require f }
+
+Daemons.run_proc('currentcostd', :dir_mode => :system) do
+
+  # Create meter object
+  meter = CurrentCost::Meter.new config['currentcost']['port']
+
+  # Register publishers with meter if their configuration sections are defined
+  CurrentCostDaemon::Publishers.constants.each do |publisher|
+    pub_class = CurrentCostDaemon::Publishers.const_get(publisher)
+    if config[pub_class.config_section] && config[pub_class.config_section]['enabled'] == true
+      meter.add_observer(pub_class.new(config))
+    end
+  end
+
+  # Just let it run
+  while (true)
+    sleep(30)
+  end
+
+end

data/config/currentcostd.example.yml

@@ -0,0 +1,20 @@
+# Copy this file to /etc/currentcostd.yml OR ./currentcostd.yml and add your
+# own settings.
+
+currentcost:
+  port: /dev/ttyS0
+
+# Enable this to dump meter data to standard output
+debug:
+  enabled: true
+
+# Enable this to publish to a feed on www.pachube.com
+pachube:
+  enabled: false
+  feed_id: your_pachube_feed_id_goes_here (e.g. 123)
+  api_key: your_pachube_api_key_goes_here
+
+# Enable this to run a web server which you can look at in a browser
+http:
+  enabled: false
+  port: 3500

data/lib/currentcostd/publishers/debug.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2008 James Smith (www.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.
+#
+# http://www.opensource.org/licenses/mit-license.php
+
+module CurrentCostDaemon
+
+  module Publishers
+
+    class Debug
+    
+      def self.config_section
+        'debug'
+      end
+    
+      def initialize(config)
+      end
+
+      def update(reading)
+        # Print out measurement
+        puts "New reading received: #{reading.total_watts} W"
+      end
+    
+    end  
+
+  end
+
+end

data/lib/currentcostd/publishers/http.rb

@@ -0,0 +1,112 @@
+# Copyright (c) 2008 James Smith (www.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.
+#
+# http://www.opensource.org/licenses/mit-license.php
+
+require 'webrick'
+
+module CurrentCostDaemon
+
+  module Publishers
+
+    class Http
+    
+      def self.config_section
+        'http'
+      end
+    
+      class Servlet < WEBrick::HTTPServlet::AbstractServlet
+        def do_GET(request, response)
+          if request.query['format'].nil? || request.query['format'] == "html"
+            response.status = 200
+            response['Content-Type'] = "text/html"
+            response.body = "
+<html>
+  <body>
+    <div style='float:right'>
+      <a title='EEML' href='/?format=eeml'><span style='border:1px solid;border-color:#9C9 #030 #030 #696;padding:0 3px;font:bold 10px verdana,sans-serif;color:#FFF;background:#090;text-decoration:none;margin:0;'>EEML</span></a>
+      <a title='XML' href='/?format=xml'><span style='border:1px solid;border-color:#FC9 #630 #330 #F96;padding:0 3px;font:bold 10px verdana,sans-serif;color:#FFF;background:#F60;text-decoration:none;margin:0;'>XML</span></a>
+    </div>
+    <h1>Current Total</h1>
+    <p>#{@@total} Watts</p>
+    <h1>History</h1>
+    <h2>Hourly</h2>
+    <img src='http://chart.apis.google.com/chart?cht=lc&chs=400x125&chd=t:#{@@history[:hours].reverse.delete_if{|x|x.nil?}.join(',')}&chds=0,#{@@history[:hours].delete_if{|x|x.nil?}.max}'/>
+    <h2>Daily</h2>
+    <img src='http://chart.apis.google.com/chart?cht=lc&chs=400x125&chd=t:#{@@history[:days].reverse.map{|x| x.nil? ? 0 : x}.join(',')}&chds=0,#{@@history[:days].delete_if{|x|x.nil?}.max}'/>
+    <h2>Monthly</h2>
+    <img src='http://chart.apis.google.com/chart?cht=lc&chs=400x125&chd=t:#{@@history[:months].reverse.map{|x| x.nil? ? 0 : x}.join(',')}&chds=0,#{@@history[:months].delete_if{|x|x.nil?}.max}'/>
+    <h2>Yearly</h2>
+    <img src='http://chart.apis.google.com/chart?cht=lc&chs=400x125&chd=t:#{@@history[:years].reverse.map{|x| x.nil? ? 0 : x}.join(',')}&chds=0,#{@@history[:years].delete_if{|x|x.nil?}.max}'/>
+  </body>
+</html>"
+          elsif request.query['format'] == "eeml"
+            # Create EEML document
+            eeml = EEML::Environment.new
+            # Create data object
+            data = EEML::Data.new(0)
+            data.unit = EEML::Unit.new("Watts", :symbol => 'W', :type => :derivedSI)
+            eeml << data
+            eeml[0].value = @@total
+            eeml.updated_at = @@updated_at
+            response.status = 200
+            response['Content-Type'] = "text/xml"
+            response.body = eeml.to_eeml
+          elsif request.query['format'] == "xml"
+            response.status = 200
+            response['Content-Type'] = "text/xml"
+            # Create XML
+            xml = Builder::XmlMarkup.new
+            xml.instruct!
+            response.body = xml.currentcost { xml.watts @@total }
+          else
+            response.status = 400
+          end
+        end
+        def self.update(reading)
+          @@reading = reading
+          @@updated_at = Time.now
+          # Add all channels to get real total
+          @@total = @@reading.total_watts
+          # Store history if available
+          @@history = @@reading.history if @@reading.history
+        end
+      end
+
+      def initialize(config)
+        # Initialise storage
+        @watts = 0
+        # Create WEBrick server
+        @server = WEBrick::HTTPServer.new(:Port => config['http']['port'] )
+        # Create a simple webrick servlet for HTML output
+        @server.mount("/", Servlet)
+        trap("INT") {@server.shutdown}
+        Thread.new{@server.start}
+      end
+
+      def update(reading)
+        Servlet.update(reading)
+      end
+    
+    end  
+
+  end
+
+end

data/lib/currentcostd/publishers/pachube.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2008 James Smith (www.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.
+#
+# http://www.opensource.org/licenses/mit-license.php
+
+require 'eeml'
+require 'net/http'
+
+module CurrentCostDaemon
+
+  module Publishers
+
+    class Pachube
+      
+      def self.config_section
+        'pachube'
+      end
+
+      def initialize(config)
+        @feed = config['pachube']['feed_id']
+        @api_key = config['pachube']['api_key']
+        @http = Net::HTTP.new('www.pachube.com')
+        @http.start
+      end
+      
+      def update(reading)
+        # Create EEML document
+        eeml = EEML::Environment.new
+        # Create data object
+        data = EEML::Data.new(0)
+        data.unit = EEML::Unit.new("Watts", :symbol => 'W', :type => :derivedSI)
+        eeml << data
+        eeml[0].value = reading.total_watts
+        eeml.set_updated!
+        # Put data
+        put = Net::HTTP::Put.new("/feeds/#{@feed}.xml")
+        put.body = eeml.to_eeml
+        put['X-PachubeApiKey'] = @api_key
+        @http.request(put)
+      end
+    
+    end  
+
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: Floppy-currentcostd
+version: !ruby/object:Gem::Version 
+  version: "1.1"
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-26 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: Floppy-currentcost
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: Floppy-eeml
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+description: 
+email: james@floppy.org.uk
+executables: 
+- currentcostd
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- COPYING
+- lib/currentcostd/publishers/debug.rb
+- lib/currentcostd/publishers/pachube.rb
+- lib/currentcostd/publishers/http.rb
+- config/currentcostd.example.yml
+- bin/currentcostd
+has_rdoc: false
+homepage: http://github.com/Floppy/currentcost-daemon
+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: A system daemon for monitoring and publishing currentcost data
+test_files: []
+