sunscout 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 932d2d5473a423b5839198dde6179124b13c5090
+  data.tar.gz: ea0ca9ec4af624858f71f976a50b3abf6e63a7de
+SHA512:
+  metadata.gz: 88afb8ab77d532ddc8cca0344259904d32856c33c4f836d282b831b59c6aefebc6703a08e83c1b0478a451621ccb253d013d0c1f1f1c094ba78b12a39c487823
+  data.tar.gz: a7f2a597d77e64702d9dc997e7602b62b0b499db5c8828ba27733d1557a1b6a17978eefd09544306c15c462d2eb88d9c6798200efd5672f5a37a258ee9603637

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Michael Senn
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,41 @@
+# Sunscout
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sunscout`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sunscout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sunscout
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sunscout.
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache-2.0 License](http://opensource.org/licenses/Apache-2.0).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sunscout"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sunscout.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+require_relative 'sunscout/solar_log'
+
+module Sunscout
+  # Your code goes here...
+end

data/lib/sunscout/solar_log.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+require_relative 'solar_log/client'
+require_relative 'solar_log/solar_log'
+
+module Sunscout
+  # Classes to interact with SolarLog HTTP API. 
+  # 
+  # - {SolarLog::Client} Low-Level client which returns API data directly, remapped to human-readable keys
+  # - {SolarLog::SolarLog} High-level client, which offers various convenience functions.
+  # @example
+  #   #!/usr/bin/env ruby
+  #   # coding: utf-8
+  #   
+  #   require 'sunscout'
+  #   
+  #   puts 'Querying data from SolarLog API'
+  #   solar_log = Sunscout::SolarLog::SolarLog.new('http://10.0.0.10')
+  #   
+  #   puts "Data from: #{ solar_log.time.iso8601 }"
+  #   puts "AC Power: #{ solar_log.power_ac }W (DC Power: #{ solar_log.power_dc }W, #{ (solar_log.efficiency*100).round(0) }% efficiency, #{ solar_log.alternator_loss }W loss)"
+  #   
+  #   puts "Current usage: #{ solar_log.consumption_ac }W (#{ (solar_log.usage*100).round(0) }%)"
+  module SolarLog
+  end
+end

data/lib/sunscout/solar_log/client.rb

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+REQUEST_QUERY = 'getjp'
+REQUEST_PAYLOAD = { 801 => { 170 => nil } }
+
+module Sunscout
+  module SolarLog
+    # Low-level binding to the SolarLog HTTP API
+    # @example Basic usage
+    #   require 'sunscout'
+    #   c = Sunscout::SolarLog::Client.new('http://10.60.1.10')
+    #   data = c.get_data()
+    #   puts "Current power output: #{ data[:power_ac] }W"
+    class Client
+      # Initialize a new instance of the class.
+      # @param host [String] URI of the SolarLog web interface. 
+      def initialize(host)
+        @host = host
+      end
+
+      # Retrieve data from the HTTP API.
+      # @return [Hash<Symbol, String|Integer>] Hash containing retrieved data
+      def get_data
+        uri = build_uri
+        req = build_request(uri)
+        data = send_request(req, uri)
+
+        data
+      end
+
+      private
+      # Create URI of HTTP endpoint
+      def build_uri
+        URI("#{ @host }/#{ REQUEST_QUERY }")
+      end 
+
+      # Build HTTP POST request
+      # @param uri [URI] URI of HTTP endpoint
+      def build_request(uri)
+        req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+        req.body = JSON.dump(REQUEST_PAYLOAD)
+
+        req
+      end
+
+      # Send HTTP request to URI
+      # @param req [Net::HTTP::Post] HTTP request
+      # @param uri [URI] URI of HTTP endpoint
+      # @return [Hash] Raw data retrieved by HTTP API
+      def send_request(req, uri)
+        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(req)
+        end
+
+        # Todo: Exception handling:
+        #   - catching in case of failure (DNS, timeout, ...)
+        #   - throwing in case of API failure
+        case res
+        when Net::HTTPSuccess
+          data = parse_data(JSON.parse(res.body))
+        else
+          data = {}
+        end
+
+        data
+      end
+
+      # Remap raw API data to human-readable data.
+      # @param data [Hash] Raw API data
+      # @return [Hash] Human-readable data
+      def parse_data(data)
+        data = data.fetch('801').fetch('170')
+
+        out = {
+          time:                  data.fetch('100'),
+          power_ac:              data.fetch('101'),
+          power_dc:              data.fetch('102'),
+          voltage_ac:            data.fetch('103'),
+          voltage_dc:            data.fetch('104'),
+          yield_day:             data.fetch('105'),
+          yield_yesterday:       data.fetch('106'),
+          yield_month:           data.fetch('107'),
+          yield_year:            data.fetch('108'),
+          yield_total:           data.fetch('109'),
+          consumption_ac:        data.fetch('110'),
+          consumption_day:       data.fetch('111'),
+          consumption_yesterday: data.fetch('112'),
+          consumption_month:     data.fetch('113'),
+          consumption_year:      data.fetch('114'),
+          consumption_total:     data.fetch('115'),
+          power_total:           data.fetch('116'),
+        }
+      end
+    end
+  end
+end

data/lib/sunscout/solar_log/solar_log.rb

@@ -0,0 +1,172 @@
+# coding: utf-8
+
+require 'date'
+
+module Sunscout
+  module SolarLog
+    # High-level binding to the SolarLog HTTP API
+    # @example Basic usage
+    #   require 'sunscout'
+    #   sl = Sunscout::SolarLog::SolarLog.new('http://10.60.1.10')
+    #   puts "AC power: #{ sl.power_ac }W (DC: #{ sl.power_dc }W, Efficiency #{ (sl.efficiency*100).round(0) }%)"
+    #   puts "Remaining power: #{ sl.power_available }W"
+    class SolarLog
+      # Timestamp of the data.
+      # @return [DateTime]
+      attr_reader :time
+
+      # AC power in W
+      # @return [Fixnum]
+      attr_reader :power_ac
+      # DC power in W
+      # @return [Fixnum]
+      attr_reader :power_dc
+      # Maximum DC power in W
+      # @return [Fixnum]
+      attr_reader :power_total
+
+      # AC voltage in V
+      # @return [Fixnum]
+      attr_reader :voltage_ac
+      # DC voltage in V
+      # @return [Fixnum]
+      attr_reader :voltage_dc
+
+      # Today's yield in Wh
+      # @return [Fixnum]
+      attr_reader :yield_day
+      # Yesterday's yield in WH
+      # @return [Fixnum]
+      attr_reader :yield_yesterday 
+      # This month's yield in Wh
+      # @return [Fixnum]
+      attr_reader :yield_month 
+      # This year's yield in Wh
+      # @return [Fixnum]
+      attr_reader :yield_year
+      # Total yield in Wh
+      # @return [Fixnum]
+      attr_reader :yield_total
+
+      # Current consumption in W
+      # @return [Fixnum]
+      attr_reader :consumption_ac
+      # Today's consumption in Wh
+      # @return [Fixnum]
+      attr_reader :consumption_day 
+      # Yesterday's consumption in Wh
+      # @return [Fixnum]
+      attr_reader :consumption_yesterday 
+      # This month's consumption in Wh
+      # @return [Fixnum]
+      attr_reader :consumption_month 
+      # This year's consumption in Wh
+      # @return [Fixnum]
+      attr_reader :consumption_year 
+      # Total consumption in Wh
+      # @return [Fixnum]
+      attr_reader :consumption_total
+
+      # Initialize a new instance of the class.
+      # 
+      # This also immediately queries data from the SolarLog API.
+      #
+      # @param host [String] URI of the SolarLog web interface
+      def initialize(host)
+        client = Sunscout::SolarLog::Client.new(host)
+        data = client.get_data
+
+        @time = DateTime.strptime(data.fetch(:time), '%d.%m.%y %H:%M:%s')
+
+        @power_ac    = data.fetch :power_ac
+        @power_dc    = data.fetch :power_dc
+        @power_total = data.fetch :power_total
+
+        @voltage_ac = data.fetch :voltage_ac
+        @voltage_dc = data.fetch :voltage_dc
+
+        @yield_day       = data.fetch :yield_day
+        @yield_yesterday = data.fetch :yield_yesterday
+        @yield_month     = data.fetch :yield_month
+        @yield_year      = data.fetch :yield_year
+        @yield_total     = data.fetch :yield_total
+
+        @consumption_ac        = data.fetch :consumption_ac
+        @consumption_day       = data.fetch :consumption_day
+        @consumption_yesterday = data.fetch :consumption_yesterday
+        @consumption_month     = data.fetch :consumption_month
+        @consumption_year      = data.fetch :consumption_year
+        @consumption_total     = data.fetch :consumption_total
+      end
+
+      # Efficiency of DC to AC conversion.
+      # @return [Float] Efficiency as percentage between 0 and 1.
+      #
+      # @example
+      #   solar_log.power_ac #=> 94
+      #   solar_log.power_dc #=> 100
+      #   solar_log.efficiency #=> 0.94
+      def efficiency
+        return 0 if @power_dc == 0
+        power_ac.to_f / power_dc
+      end
+
+      # Loss of DC to AC conversion.
+      # @return [Fixnum] Loss of alternator in Watt.
+      #
+      # @example
+      #   solar_log.power_ac #=> 94
+      #   solar_log.power_dc #=> 100
+      #   solar_log.alternator_loss #=> 6
+      def alternator_loss
+        power_dc - power_ac
+      end
+
+      # Usage of AC power.
+      # @return [Float] Usage of AC power as percentage. >1 if more power consumed than generated.
+      #
+      # @example Usage <100%
+      #   solar_log.consumption_ac #=> 50
+      #   solar_log.power_ac #=> 100
+      #   solar_log.usage #=> 0.5
+      #
+      # @example Usage >100%
+      #   solar_log.consumption_ac #=> 200
+      #   solar_log.power_ac #=> 100
+      #   solar_log.usage #=> 2
+      def usage
+        return 0 if @power_ac == 0
+        consumption_ac.to_f / power_ac
+      end
+
+      # Surplus AC power.
+      # @return [Fixnum] Surplus AC power in Watt. Negative if more power consumed than generated.
+      #
+      # @example Usage <100%
+      #   solar_log.consumption_ac #=> 50
+      #   solar_log.power_ac #=> 100
+      #   solar_log.power_available #=> 50
+      #
+      # @example Usage >100%
+      #   solar_log.consumption_ac #=> 200
+      #   solar_log.power_ac #=> 100
+      #   solar_log.power_available #=> -100
+      def power_available
+        power_ac - consumption_ac
+      end
+
+      # Capacity of peak power generation.
+      # @return [Float] Percentage of peak power generation.
+      #
+      # @example
+      #   solar_log.power_dc #=> 8000
+      #   solar_log.power_total #=> 10000
+      #   solar_log.capacity #=> 0.8
+      def capacity
+        return 0 if power_total == 0
+        power_dc / power_total
+      end
+    end
+  end
+end
+

data/sunscout.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "sunscout"
+  spec.version       = '0.1'
+  spec.authors       = ["Michael Senn"]
+  spec.email         = ["michael@morrolan.ch"]
+
+  spec.summary       = %q{Binding to Solarlog HTTP API}
+  # spec.description   = %q{}
+  # spec.homepage      = ""
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sunscout
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Michael Senn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- michael@morrolan.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sunscout.rb
+- lib/sunscout/solar_log.rb
+- lib/sunscout/solar_log/client.rb
+- lib/sunscout/solar_log/solar_log.rb
+- sunscout.gemspec
+homepage: 
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Binding to Solarlog HTTP API
+test_files: []