solaredge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa7343187ab4b5ba7127ceaed020c9e25cc5ea56
+  data.tar.gz: 196ec1eb598270e502e773f2f8cff18f6839355f
+SHA512:
+  metadata.gz: bc78b99da9a1b489fd1fb0b8e250d6adaefec23fe7504a9bae8b358d9f94cc216d24c04ce25a83ac3de63b1117205ac38246cfd5fc3b7609d0845f6655096a24
+  data.tar.gz: 2129a85b70b5148106a6b4f13c8649a219930793083e5904fb641c2f22a0a2b520e82cd9854521db34ff73c027eefba18d77f18d23668597ab9734c4f77704c5

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'The Energy Detective'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+task :default => :rdoc

data/lib/solar_edge/client.rb

@@ -0,0 +1,71 @@
+require 'json'
+require 'net/http'
+
+require 'openssl'
+
+require 'solar_edge/sites'
+
+module SolarEdge
+  class Client
+    def initialize(api_key)
+      @api_key = api_key
+      @host = URI.parse('https://monitoringapi.solaredge.com/')
+      @http = Net::HTTP.new(@host.host, @host.port)
+      @http.use_ssl = (@host.scheme == 'https')
+      @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+
+    def sites(search_text: nil, sort_by: nil, sort_order: nil)
+      raise ArgumentError, "invalid sort_by" if sort_by && !VALID_SORT_PROPERTIES.include?(sort_by)
+      raise ArgumentError, "sort_order must be specific with sort_by" if sort_order && !sort_by
+      raise ArgumentError, "sort_order must be :asc or :desc" if sort_order && !%i{asc desc}.include?(sort_order)
+
+      params = {}
+      params[:search_text] = search_text if search_text
+      params[:sort_property] = sort_by if sort_by
+      params[:sort_order] = sort_order if sort_order
+
+      # we cache the "all sites" query
+      if params.empty?
+        @sites ||= Sites.new(self, params)
+      else
+        Sites.new(self, params)
+      end
+    end
+
+    private
+
+    VALID_SORT_PROPERTIES = %i{
+      Name
+      Country
+      State
+      City
+      Address
+      Zip
+      Status
+      PeakPower
+      InstallationDate
+      Amount
+      MaxSeverity
+      CreationTime
+    }.freeze
+    private_constant :VALID_SORT_PROPERTIES
+
+    def query(path, params = {})
+      params = params.merge(api_key: @api_key)
+
+      uri = @host.merge(path)
+      uri.query = self.class.hash_to_query(params)
+
+      puts uri
+      get = Net::HTTP::Get.new(uri)
+      response = @http.request(get)
+      response.body
+      JSON.load(response.body)
+    end
+
+    def self.hash_to_query(hash)
+      hash.map{|k,v| "#{k}=#{v}" }.join("&")
+    end
+  end
+end

data/lib/solar_edge/inverter.rb

@@ -0,0 +1,32 @@
+module SolarEdge
+  class Inverter
+    attr_reader :name, :manufacturer, :model, :serial_number
+
+    def initialize(site, name, manufacturer, model, serial_number)
+      @site, @name, @manufacturer, @model, @serial_number = site, name, manufacturer, model, serial_number
+    end
+
+    def data(start_time: @site.time_zone.now.beginning_of_day, end_time: @site.time_zone.now)
+      params = {}
+      params[:startTime] = start_time.in_time_zone(@site.time_zone).strftime('%Y-%m-%d %H:%M:%S')
+      params[:endTime] = end_time.in_time_zone(@site.time_zone).strftime('%Y-%m-%d %H:%M:%S')
+
+      @site.instance_variable_get(:@client).send(:query,
+        "/equipment/#{@site.id}/#{serial_number}/data", params)['data']['telemetries'].map do |value|
+        {
+            timestamp: @site.time_zone.parse(value['date']),
+            total_active_power: value['totalActivePower'],
+            dc_voltage: value['dcVoltage'],
+            ground_fault_resistance: value['groundFaultResistance'],
+            total_energy: value['totalEnergy'],
+            temperature: value['temperature'],
+            inverter_mode: value['inverterMode'].to_sym
+        }
+      end
+    end
+
+    def inspect
+      "#<SolarEdge::Inverter:#{serial_number} #{manufacturer} #{model} - #{name}>"
+    end
+  end
+end

data/lib/solar_edge/site.rb

@@ -0,0 +1,71 @@
+require 'active_support/time'
+
+require 'solar_edge/inverter'
+
+module SolarEdge
+  class Site
+    attr_reader :id
+
+    def initialize(client, id_or_details)
+      @client = client
+      if id_or_details.is_a?(Hash)
+        @details = id_or_details
+        @id = @details['id']
+      else
+        @id = id
+      end
+    end
+
+    def time_zone
+      @time_zone ||= ActiveSupport::TimeZone.new(details['location']['timeZone'])
+    end
+
+    def data_period
+      response = @client.send(:query, "/site/#{id}/dataPeriod")['dataPeriod']
+      time_zone.parse(response['startDate'])..time_zone.parse(response['endDate'])
+    end
+
+    def energy(resolution: :quarter_of_an_hour, start_date: time_zone.now, end_date: time_zone.now)
+      raise ArgumentError, "invalid resolution" unless %i{quarter_of_an_hour hour day week month year}.include?(resolution)
+      params = {}
+      params[:timeUnit] = resolution.to_s.upcase
+      params[:startDate] = start_date.to_date
+      params[:endDate] = end_date.to_date
+
+      @client.send(:query, "/site/#{id}/energy", params)['energy']['values'].map do |value|
+        {
+          timestamp: time_zone.parse(value['date']),
+          value: value['value']
+        }
+      end
+    end
+
+    def power(start_time: time_zone.now.beginning_of_day, end_time: time_zone.now)
+      params = {}
+      params[:startTime] = start_time.in_time_zone(time_zone).strftime('%Y-%m-%d %H:%M:%S')
+      params[:endTime] = end_time.in_time_zone(time_zone).strftime('%Y-%m-%d %H:%M:%S')
+
+      @client.send(:query, "/site/#{id}/power", params)['power']['values'].map do |value|
+        {
+            timestamp: time_zone.parse(value['date']),
+            value: value['value']
+        }
+      end
+    end
+
+    def inverters
+      @inverters ||= @client.send(:query, "/equipment/#{id}/list")['reporters']['list'].map do |inverter|
+        Inverter.new(self,
+                     inverter['name'],
+                     inverter['manufacturer'],
+                     inverter['model'],
+                     inverter['serialNumber'])
+      end
+    end
+    private
+
+    def details
+      @details ||= @client.send(:query, "/site/#{id}/details")
+    end
+  end
+end

data/lib/solar_edge/sites.rb

@@ -0,0 +1,36 @@
+require 'solar_edge/site'
+
+module SolarEdge
+  class Sites
+    include Enumerable
+
+    def initialize(client, params)
+      @client, @params = client, params
+    end
+
+    def find(id)
+      Site.new(client, id)
+    end
+
+    def size
+      params = @params.dup
+      params[:size] = 1
+      @client.send(:query, '/sites/list', params)['sites']['count']
+    end
+
+    def each
+      params = @params.dup
+      params[:size] = 100
+      params[:startIndex] = 0
+      while true
+        sites = @client.send(:query, '/sites/list', params)['sites']
+        sites['site'].each do |site|
+          yield Site.new(@client, site)
+        end
+        break if sites['site'].length < params[:size] ||
+            params[:startIndex] + sites['site'].length == sites['count']
+        params[:startIndex] += sites['site'].length
+      end
+    end
+  end
+end

data/lib/solar_edge/version.rb

@@ -0,0 +1,3 @@
+module SolarEdge
+  VERSION = "0.1.0"
+end

data/lib/solaredge.rb

@@ -0,0 +1 @@
+require 'solar_edge/client'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: solaredge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: 
+email:
+- cody@cutrer.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/solar_edge/client.rb
+- lib/solar_edge/inverter.rb
+- lib/solar_edge/site.rb
+- lib/solar_edge/sites.rb
+- lib/solar_edge/version.rb
+- lib/solaredge.rb
+homepage: http://www.solaredge.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Client library for talking to the SolarEdge monitoring API
+test_files: []