pvoutput 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8eb79d223db909c8c4ecc34f018b3a8d952b5ebb
-  data.tar.gz: 975583f464c918aca3e9d61fe1992a3012d5e404
+  metadata.gz: aabffd834f87c5ca43ed5d0c04c952fe4969b99c
+  data.tar.gz: d52c7cb268ad9608ce3c6503dd2e3b5cb38ff244
 SHA512:
-  metadata.gz: db4f626c4f3851d09020c247beccd74e634d0b77a9ebb4d0c3b59f740047efe26d07a9d00cfebcf8fa5995d4113ba42c5f272e4347fe408d1faab82586430127
-  data.tar.gz: f0c80ce60a15525463babc44727a3dc2732216831787f1d3efcab134160a290ee55354a18a1fa108bb6b5536b29db8e9bf41df25d1c21e1d631cf7f4c0346b64
+  metadata.gz: 25b9b1b49b10ca564cb9d23233a16505a17d7703d40a01ca0c48d25f1f0cd8f5328aeff11273aa777b358d20bf453ceaf0f5b91bee36063f7ef46fb820c1d411
+  data.tar.gz: 0a8fa6e7d7841d52a0657489d5ac5b9aedcd4b2105201f63fd5cebef3dfcc92b8664a52b19a8cc129dcf3a7213b26754c77817dfa0eca6596d6987289e814a33

data/.rubocop.yml

@@ -9,9 +9,12 @@ Style/Documentation:
 Style/Lambda:
   Enabled: false
 
-Style/TrailingComma:
+Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: comma
 
+Metrics/MethodLength:
+  Max: 20
+
 Metrics/LineLength:
   Max: 120
 

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+# 0.3.0 (20160229)
+
+* Add donation mode (@jwillemsen)
+* Add batch_output support (@jwillemsen)
+
 # 0.2.0 (20160227)
 
 * Fix typo in temperature (@jwillemsen)

data/README.md

@@ -35,7 +35,13 @@ First step is to create a PVOutput client using your PVOutput assigned system_id
 pvoutput = PVOutput::Client.new(system_id, api_key)
 ```
 
-Now you can report your status to PVOutput using
+At the moment you [donate](http://pvoutput.org/donate.jsp) to PVOutput you can enable the donation mode by creating a PVOutput client using
+
+```ruby
+pvoutput = PVOutput::Client.new(system_id, api_key, true)
+```
+
+Now you can report your real time status to PVOutput using
 
 ```ruby
 pvoutput.add_status(
@@ -47,7 +53,7 @@ The add_status operation accepts the following options
 
 | Option           | PVOutput Parameter |
 | ---------------- | ------------------ |
-| energy_generated |v1 |
+| energy_generated | v1 |
 | power_generated  | v2 |
 | energy_consumed  | v3 |
 | power_consumed   | v4 |
@@ -67,6 +73,80 @@ client.add_status(
 )
 ```
 
+You can report your daily output to PVOutput using
+
+```ruby
+pvoutput.add_output(
+  options
+)
+```
+
+The add_output operation accepts the following options
+
+| Option                | PVOutput Parameter |
+| --------------------- | ------------------ |
+| output_date           | d |
+| energy_generated      | g |
+| peak_power            | pp |
+| peak_time             | pt |
+| condition             | cd |
+| min_temp              | tm |
+| max_temp              | tx |
+| comments              | cm |
+| import_peak           | ip |
+| import_off_peak       | io |
+| import_shoulder       | is |
+| import_high_shoulder  | ih |
+| consumption           | c |
+
+As example
+
+```ruby
+client.add_output(
+  :output_date      => '20160228'
+  :energy_generated  => 15000,
+  :max_temp      => 30
+)
+```
+
+You can report also a batch of daily output values to PVOutput using
+
+```ruby
+pvoutput.add_batch_output(
+  options
+)
+```
+
+The add_batch_output operation accepts a hash with the date as key and within that the following options
+
+| Option                | PVOutput Parameter |
+| --------------------- | ------------------ |
+| energy_generated      | g |
+| peak_power            | pp |
+| peak_time             | pt |
+| condition             | cd |
+| min_temp              | tm |
+| max_temp              | tx |
+| comments              | cm |
+| import_peak           | ip |
+| import_off_peak       | io |
+| import_shoulder       | is |
+| import_high_shoulder  | ih |
+| consumption           | c |
+
+As example
+
+```ruby
+client.add_output(
+  :'20150101' => {
+    :energy_generated => 1239, },
+  :'20150102' => {
+    :energy_generated => 1523 },
+  :'20150103' => {
+    :energy_generated => 2190 },
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pvoutput/client.rb

@@ -6,14 +6,18 @@ module PVOutput
     base_uri 'pvoutput.org'
     # debug_output $stdout
 
-    def initialize(system_id, api_key)
+    def initialize(system_id, api_key, donation_mode = false)
       @system_id = system_id.to_s
       @api_key = api_key.to_s
+      # The batch operations have default limit of 30 sets of data in one request, when you
+      # are using the donation mode the limit is 100 sets
+      @batch_size = 30
+      @batch_size = 100 if donation_mode
 
       self.class.headers 'X-Pvoutput-Apikey' => @api_key, 'X-Pvoutput-SystemId' => @system_id
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def add_status(options)
       time = options[:when] || Time.now
 
@@ -33,11 +37,11 @@ module PVOutput
 
       response = self.class.post('/service/r2/addstatus.jsp', :body => params)
 
-      fail('Bad Post') unless response.code == 200
+      raise('Bad Post') unless response.code == 200
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def add_output(options)
       params = {
       }
@@ -50,11 +54,41 @@ module PVOutput
       params[:tm] = options[:min_temp] if options[:min_temp]
       params[:tx] = options[:max_temp] if options[:max_temp]
       params[:cm] = options[:comments] if options[:comments]
+      params[:ip] = options[:import_peak] if options[:import_peak]
+      params[:io] = options[:import_off_peak] if options[:import_off_peak]
+      params[:is] = options[:import_shoulder] if options[:import_shoulder]
+      params[:ih] = options[:import_high_shoulder] if options[:import_high_shoulder]
+      params[:c] = options[:consumption] if options[:consumption]
 
       response = self.class.post('/service/r2/addoutput.jsp', :body => params)
 
-      fail('Bad Post') unless response.code == 200
+      raise('Bad Post') unless response.code == 200
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    # rubocop:disable Metrics/AbcSize
+    def add_batch_output(options)
+      keys = %i(energy_generated energy_export energy_used)
+      keys += %i(peak_power peak_time condition min_temp)
+      keys += %i(max_temp comments import_peak import_off_peak)
+      keys += %i(import_shoulder)
+
+      options.to_a.each_slice(@batch_size) do |slice|
+        data = ''
+        slice.each do |entry|
+          date, values = entry
+          data += "#{date}," + keys.map { |key| values[key] }.join(',') + ';'
+        end
+
+        params = {
+          :data => data.chop,
+        }
+
+        response = self.class.post('/service/r2/addbatchoutput.jsp', :body => params)
+
+        raise('Bad Post') unless response.code == 200
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/pvoutput/version.rb

@@ -1,3 +1,3 @@
 module PVOutput
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pvoutput
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - John Ferlito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty