pvoutput 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c675f86a314a18eff21610c99ab24c182b0e17a4
-  data.tar.gz: a19c6c6e50ed4772bd2e8246e8dfb052047e97b0
+  metadata.gz: 8eb79d223db909c8c4ecc34f018b3a8d952b5ebb
+  data.tar.gz: 975583f464c918aca3e9d61fe1992a3012d5e404
 SHA512:
-  metadata.gz: 52c869a01e3d2b121137433db0c3c1bba8fdde9c4f03e7ac29a4c7b54cfec56560730fdddde34cb18f4963bdf7cf753ab81bcb8bf189b9b05aa3680bd3e9bd60
-  data.tar.gz: be043beee3755051fdfbcc5be663f5befd333b5be520d7e8add364ca0670ce6e7f13b84e9d8e032940fef9b20edf9dc7a9293246e88b397a2101fa57cb840c3c
+  metadata.gz: db4f626c4f3851d09020c247beccd74e634d0b77a9ebb4d0c3b59f740047efe26d07a9d00cfebcf8fa5995d4113ba42c5f272e4347fe408d1faab82586430127
+  data.tar.gz: f0c80ce60a15525463babc44727a3dc2732216831787f1d3efcab134160a290ee55354a18a1fa108bb6b5536b29db8e9bf41df25d1c21e1d631cf7f4c0346b64

data/CHANGELOG.md

@@ -1,7 +1,16 @@
+# Changelog
+
+# 0.2.0 (20160227)
+
+* Fix typo in temperature (@jwillemsen)
+* Add usage documentation (@jwillemsen)
+* Add the add_ouput method for end of day reporting (@jwillemsen)
+* Use latest bundler in CircleCI (@johnf)
+
 # 0.1.1 (20151122)
 
-* Convert the system id to a string
+* Convert the system id to a string (@johnf)
 
 # 0.1.0 (20151122)
 
-* Initial Release
+* Initial Release (@johnf)

data/README.md

@@ -23,7 +23,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+In order to use pvoutput in your application you need to use
+
+```ruby
+require 'pvoutput/client'
+```
+
+First step is to create a PVOutput client using your PVOutput assigned system_id and api_key
+
+```ruby
+pvoutput = PVOutput::Client.new(system_id, api_key)
+```
+
+Now you can report your status to PVOutput using
+
+```ruby
+pvoutput.add_status(
+  options
+)
+```
+
+The add_status operation accepts the following options
+
+| Option           | PVOutput Parameter |
+| ---------------- | ------------------ |
+| energy_generated |v1 |
+| power_generated  | v2 |
+| energy_consumed  | v3 |
+| power_consumed   | v4 |
+| temperature      | v5 |
+| voltage          | v6 |
+| cumulative       | c1 |
+| net              | n |
+
+As example
+
+```ruby
+client.add_status(
+  :energy_generated => 100,
+  :power_generated  => 50,
+  :temperature      => 30,
+  :voltage          => 200,
+)
+```
 
 ## Development
 
@@ -33,7 +75,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/johnf/pvoutput. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnf/pvoutput. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/circle.yml

@@ -4,3 +4,6 @@ test:
 machine:
   ruby:
     version: 2.2.3
+dependencies:
+  pre:
+    - gem install bundler --pre

data/lib/pvoutput/client.rb

@@ -26,7 +26,7 @@ module PVOutput
       params[:v2] = options[:power_generated] if options[:power_generated]
       params[:v3] = options[:energy_consumed] if options[:energy_consumed]
       params[:v4] = options[:power_consumed] if options[:power_consumed]
-      params[:v5] = options[:temperature] if options[:temparature]
+      params[:v5] = options[:temperature] if options[:temperature]
       params[:v6] = options[:voltage] if options[:voltage]
       params[:c1] = 1 if options[:cumulative] == true
       params[:n]  = 1 if options[:net] == true
@@ -36,5 +36,25 @@ module PVOutput
       fail('Bad Post') unless response.code == 200
     end
     # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def add_output(options)
+      params = {
+      }
+
+      params[:d] = options[:output_date]
+      params[:g] = options[:energy_generated] if options[:energy_generated]
+      params[:pp] = options[:peak_power] if options[:peak_power]
+      params[:pt] = options[:peak_time] if options[:peak_time]
+      params[:cd] = options[:condition] if options[:condition]
+      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]
+
+      response = self.class.post('/service/r2/addoutput.jsp', :body => params)
+
+      fail('Bad Post') unless response.code == 200
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   end
 end

data/lib/pvoutput/version.rb

@@ -1,3 +1,3 @@
 module PVOutput
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

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