solarium 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0c5c4f5db3d02c348ed02e9b9ba42629372c598
+  data.tar.gz: 437ee53bb835aa18834057fc8ca2f0ba72ed52bd
+SHA512:
+  metadata.gz: 8ca7ba6a541d4ee16612e006ef10f4df1f047bf93bf74761042b5ca738891c3821d07732aba4d85d35fc93b48943ac58e285170f48fadabb2d4e42123179ff6f
+  data.tar.gz: 7f4d02d5ed1658045d82cadbf07b20efcbf3c3c27810e31b046b07479075fbaee2c9c730ade15517c2a83f0c409285bc30e45eb1894e906d4684e0aeca42584a

data/bin/solarium-collect

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# Solarium (C) 2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+
+APP_ROOT = File.dirname __dir__
+if Dir.exist? "#{APP_ROOT}/.git"
+	$LOAD_PATH.unshift "#{APP_ROOT}/lib"
+end
+
+%w(solarium trollop).each do |lib|
+	begin
+		require lib
+	rescue ::Exception => error
+		STDERR.puts "A fatal error was encountered whilst loading #{lib}:"
+		STDERR.puts "#{error.class}: #{error.message}"
+		exit 1
+	end
+end
+
+APP_NAME = File.basename $PROGRAM_NAME
+options = Trollop::options do
+	banner "Usage: #{APP_NAME} [OPTIONS]"
+	version Solarium::VERSION
+
+	opt :database_url, 'The URL for connecting to the SQL database', default: 'sqlite://production.sq3'
+	opt :envoy_url, 'The URL of the Envoy web interface', default: 'http://192.168.1.200/'
+	opt :print_stats, 'Print generation statistics after collection', default: false	
+end
+
+Trollop::die :database_url, 'is not a valid URL' unless options[:database_url] =~ /^#{URI.regexp}$/
+Trollop::die :envoy_url, 'is not a valid URL' unless options[:envoy_url] =~ /^#{URI.regexp}$/
+
+collector = Solarium::Collector.new options[:envoy_url]
+unless collector.error.nil?
+	STDERR.puts "A fatal error was encountered whilst collecting data:"
+	STDERR.puts "#{collector.error.class}: #{collector.error.message}"
+	exit 1
+end
+
+if options[:print_stats]
+	puts <<~STATISTICS
+		== Generation Statistics ==
+		Currently: #{collector.now} watts
+		Today: #{collector.today} watt hours
+		Past Week: #{collector.week} watt hours
+		Since Installation: #{collector.lifetime} watt hours
+	STATISTICS
+end
+
+database = Solarium::Database.new options[:database_url]
+unless database.error.nil?
+	STDERR.puts "A fatal error was encountered whilst connecting to the database:"
+	STDERR.puts "#{database.error.class}: #{database.error.message}"
+	exit 1
+end
+database.insert collector

data/lib/solarium/collector.rb

@@ -0,0 +1,48 @@
+# Solarium (C) 2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+
+module Solarium
+
+	# Public: Collects generation information from the Envoy API.
+	class Collector
+
+		# Public: Either an exception that was thrown during collection or nil.
+		attr_reader :error
+
+		# Public: The number of watt hours which have been generated since the system was installed.
+		attr_reader :lifetime
+
+		# Public: The number of watts currently being generated.
+		attr_reader :now
+
+		# Public: The number of watt hours which have been generated today.
+		attr_reader :today
+
+		# Public: The number of watt hours which have been generated in the last week.
+		attr_reader :week
+
+		# Public: Initializes a new instance of the Solarium::Collector class.
+		#
+		# url - The URL of the Envoy web interface.
+		def initialize url
+			collect url
+		rescue ::Exception => error
+			@error = error
+		end
+
+		# Internal: Collects generation information from the Envoy API.
+		#
+		# url - The URL of the Envoy web interface.
+		private def collect url
+			uri = URI.parse url
+			uri.path = '/api/v1/production'
+
+			body = open(uri).read
+			json = JSON.parse body
+
+			@now      = json['wattsNow']
+			@today    = json['wattHoursToday']
+			@week     = json['wattHoursSevenDays']
+			@lifetime = json['wattHoursLifetime']
+		end
+	end
+end

data/lib/solarium/database.rb

@@ -0,0 +1,49 @@
+# Solarium (C) 2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+
+module Solarium
+
+	# Public: Implements logic for interacting with the Solarium database.
+	class Database
+
+		# Public: Either an exception that was thrown during database connection or nil.
+		attr_reader :error
+
+		# Public: Initializes a new instance of the Solarium::Database class.
+		#
+		# url - The URL for connecting to the SQL database.
+		def initialize url
+			connect url
+		rescue ::Exception => error
+			@error = error
+		end
+
+		# Public: Stores the information provided by a Solarium::Collector in the database.
+		#
+		# collector - An instance of the Solarium::Collector class containing information to store.
+		def insert collector
+			row = {
+				time: DateTime.now,
+				now: collector.now,
+				today: collector.today,
+				week: collector.week,
+				lifetime: collector.lifetime
+			}
+			@connection[:solarium].insert row
+		end
+
+		# Internal: Connects to the database and creates the table if required.
+		#
+		# url - The URL for connecting to the SQL database.
+		private def connect url
+			@connection = Sequel.connect url
+			@connection.create_table? :solarium do
+				column :time, DateTime, primary_key: true
+				column :now, Integer, null: false
+				column :today, Integer, null: false
+				column :week, Integer, null: false
+				column :lifetime, Integer, null: false
+			end
+		end
+
+	end
+end

data/lib/solarium/version.rb

@@ -0,0 +1,23 @@
+# Solarium (C) 2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+
+module Solarium
+
+	# Public: The version number which is incremented when compatibility is broken.
+	VERSION_MAJOR = 0
+
+	# Public: The version number which is incremented when new features are added.
+	VERSION_MINOR = 1
+
+	# Public: The version number which is incremented when bugs are fixed.
+	VERSION_PATCH = 0
+
+	# Public: The version label which describes the status of the build.
+	VERSION_LABEL = nil
+
+	# Public: A string which contains the current version.
+	VERSION = if VERSION_LABEL.nil?
+		"#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
+	else
+		"#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}-#{VERSION_LABEL}"
+	end
+end

data/lib/solarium.rb

@@ -0,0 +1,10 @@
+# Solarium (C) 2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+
+require 'json'
+require 'open-uri'
+require 'sequel'
+require 'uri'
+
+require_relative 'solarium/collector'
+require_relative 'solarium/database'
+require_relative 'solarium/version'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: solarium
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter "SaberUK" Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: tomdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+description: A tool for working with generation data collected from the Enphase Envoy
+  solar panel management system.
+email: petpow@saberuk.com
+executables:
+- solarium-collect
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/solarium-collect
+- lib/solarium.rb
+- lib/solarium/collector.rb
+- lib/solarium/database.rb
+- lib/solarium/version.rb
+homepage: https://github.com/SaberUK/solarium
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Enphase Envoy generation data manipulation tool.
+test_files: []