saj_collector 0.5.3 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d32f08b2a5d39a7d59128ae0c811a3ee31d4be8e0924d059d4de4c27aaa74a24
-  data.tar.gz: 90c7d852b9e8a60acec43f742005b0a71d33bd82d0b5eb52be8e3ae05bd54090
+  metadata.gz: a0e32b86391108e73fe14c279167f59b95a62b212ebd26ba385009b6f6910c6a
+  data.tar.gz: fdb0b4bcfa18d5f3643811db8c5638f65f08718b7a6a69ba6447239a74878eb2
 SHA512:
-  metadata.gz: 6c0abb66a28888bf1b0da98e83501e339782948bb8c9932757b7f6a6c0e494bea509ba9e2f34c74d04c104c46f7f8e8e76e740541369832a7ee96a0e6e48dc59
-  data.tar.gz: 51b42f49c3836c7485433a65aa6dd0181b7aeb8f1203680b061b60bc8e006975be3fe6f501db04a72aaec776db00044f6b40759df6759e2d1c6137de6f9bc02d
+  metadata.gz: f575fb51be5d5d9c8f24630d90799fc6062e8be9313c0a31a2c35906bfc30c1004d0c5c8a4b03cebc5fb392e5b2a270f597aeaae36d14e4050cb843f2504dcc3
+  data.tar.gz: '06391f6189aeea508e877614541fc82f44308f0ef35be781a7c2edfb600ba909b7c8413a9ec2ee0a2f41faca01c5e36e65f86101e9ce52bdcdefca1b845ac897'

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: jwillemsen

data/.github/workflows/ruby.yml

@@ -1,18 +1,39 @@
 name: Ruby
 
-on: [push]
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron: '0 7 * * SUN'
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
+    strategy:
+      matrix:
+        name: [
+          Ruby24,
+          Ruby25,
+          Ruby26,
+          Ruby27
+        ]
+        include:
+          - name: Ruby24
+            RubyVersion: 2.4
+          - name: Ruby25
+            RubyVersion: 2.5
+          - name: Ruby26
+            RubyVersion: 2.6
+          - name: Ruby27
+            RubyVersion: 2.7
     steps:
     - uses: actions/checkout@v1
     - name: Set up Ruby 2.6
       uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: ${{ matrix.RubyVersion }}
     - name: Build and test with Rake
       run: |
         gem install bundler

data/.travis.yml

@@ -8,6 +8,7 @@ rvm:
 - 2.4
 - 2.5
 - 2.6
+- 2.7
 - ruby-head
 gemfile:
 - Gemfile
@@ -24,11 +25,3 @@ addons:
     repo_token: 2b46019558c79326fc3cc87f2e4261610256aee236063c4b62b8ed8d2c2ce21d
 after_success:
 - bundle exec codeclimate-test-reporter
-deploy:
-  provider: rubygems
-  api_key:
-    secure: YnibTFYFBn8XvyocId6wfKm3qCrVOprorIkKHEok4g8AOo3VHea9YxChmp2E/yvVqDdT9G7yKg3hn+JwuolYOIyGVSlS7AXOHguzHLcOI7iYwAd+RWFXDmn1MMFIX/tVV0oeRu8mNGbxNIbofI6DtExH0RHRHN0FTIqxPzH8Se0TbkHzznKkouwu55CU8ss7kh/CYPeFJOEyfCxZ+NNm1cdWocNkMbhPxT2FgsXGRlIMsABc/UpTMUR2mtmGqFUiwnIKvxkhI9qUEePfqHYU/IVGubwUjSE5LJRvOtAOdglj4QH4UZKlI2TJI6kq4a/1q7lZuAnONyqdlROrmBIjm9K9g9l0XvCBeReNpZoXRxIS+78F0H1GSCvxajaRfJYk0Po4RZ6JE2N8hhxSpqyMRHy2mVQiu5fBMXaZXcH7buIgiPY7KH+JFBgyGUqFR8a+8d0kKuX0Fz/sM1YmO2iATtP+CXqSotDWmU4nn8dMoEyvzvHlG5O49ZIlhG+ze6SlryWOlgiewEk8Gf+Nn3q5En1jgxAZTSPy5eyzQdT4RR4dysMy8p1BGCxIXyaKDDZVtk3n+00kG4VMLmrLehfrjalNY6NDAkOEO5Fc1OrQEYXKT/CHlA3R7iaZDqsblRgfpEDYTsXAffMobyggnrrWZRxrJppvITGCFOb6FFvYjKI=
-  gemspec: saj_collector.gemspec
-  on:
-    tags: true
-    repo: jwillemsen/saj_collector

data/README.md

@@ -1,7 +1,6 @@
 # SAJ Collector
 
 [![Build Status](https://travis-ci.org/jwillemsen/saj_collector.png)](https://travis-ci.org/jwillemsen/saj_collector)
-[![Code Climate](https://codeclimate.com/github/jwillemsen/saj_collector/badges/gpa.png)](https://codeclimate.com/github/jwillemsen/saj_collector)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/fdb313b9a4b24614867b91e45a5505f9)](https://www.codacy.com/app/jwillemsen/saj_collector?utm_source=github.com&utm_medium=referral&utm_content=jwillemsen/saj_collector&utm_campaign=badger)
 [![Gem Version](https://badge.fury.io/rb/saj_collector.svg)](http://badge.fury.io/rb/saj_collector)
 
@@ -10,45 +9,50 @@ ruby gem is based on https://github.com/johnf/jfy_collector
 
 ## Installation
 
-Install it:
+First install [ruby](https://www.ruby-lang.org) on your system through your favorite package manager. On Windows download and install ruby from [Rubyinstaller](http://www.rubyinstaller.org).
 
-    $ gem install saj_collector
+Install it by running the following command from a linux shell or windows command prompt
+
+    gem install saj_collector
 
 ## Usage
 
 Create a config file for PVOutput in ```saj_collector.yaml```.
 This should contain the IP address of your SAJ Solar Invertor (```saj```), your
-PVOutput system id (```system_id```) and API key (```api_key```).
+PVOutput system id (```system_id```) and PVOutput API key (```api_key```). These PVOutput
+system id and API key can be found on your
+[PVOutput account page](https://pvoutput.org/account.jsp).
+
+Some SAJ Solar Inverters provide the generation of each day with a granularity of 0.1kWh and some with
+a granularity of 0.01kWh. In case of the last you have to change the ```day_trend_multiplication_factor```
+within your ```saj_collector.yaml``` to 10. An incorrect ```day_trend_multiplication_factor``` triggers
+a `Bad Post` exception when running the `saj_output_collector` script.
 
 ``` yaml
----
 :saj: a.b.c.d
 :system_id: 123456
 :api_key: fb6a2e3
 :day_trend_multiplication_factor: 100
 ```
 
-Run the SAJ Collector in a screen or via init of some sort
+Run the SAJ Collector from the command prompt or shell
 
-    $ saj_collector
+    saj_collector
 
 This will run the current power generation frm the SAJ Collector and push the
-data once to PVOutput. You can add
-``saj_collector`` to your crontab or a custom script to let it automatically push with
-a certain frequency.
+data once to PVOutput.
 
 The SAJ Output Collector will retrieve the generation of each day of the current month and
 push the data once to PVOutput.
-Run the SAJ Output Collector in a screen or via init of some sort
 
-    $ saj_output_collector
+Run the SAJ Output Collector from the command prompt or shell
 
-You can add ``saj_output_collector`` to your crontab or a custom script to let it automatically push with
-a certain frequency.
+    saj_output_collector
 
-Some SAJ Solar Inverters provide the generation of each day with a granularity of 0.1kWh and some with
-a granularity of 0.01kWh. In case of the last you have to change the ```day_trend_multiplication_factor```
-within your ```saj_collector.yaml``` to 10.
+## Scheduling the collecor
+
+On Linux you can add ``saj_collector`` and ``saj_output_collector`` to your crontab to let it automatically push with
+a certain frequency.
 
 At the moment you add any of these to your crontab you have to make sure
 that the ``saj_collector.yaml`` file can be found. For example when you put the ``saj_collector.yaml`` file
@@ -57,13 +61,16 @@ add to your crontab
 
     */5 6-21 * * * cd /usr/local/bin && ruby /usr/local/bin/saj_collector
 
+On Windows you can create a task using the Task Scheduler. Make sure that for the Action you specific the path
+of the ``saj_collector.yaml`` file as ``Start in``.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
 
 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
+in `lib/saj_collector/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).
 

data/exe/saj_collector

@@ -4,14 +4,24 @@ require 'rexml/document'
 require 'net/http'
 require 'pvoutput/client'
 require 'yaml'
+require 'ipaddress'
+
+yaml_file = 'saj_collector.yaml'
 
 # Load the configuration from the yaml file
-sajcollector_config = YAML.load_file('saj_collector.yaml')
+sajcollector_config = YAML.load_file(yaml_file)
 
 # Create a pvoutput with the configured system_id and api_key which both
 # can be obtained from the pvoutput website
 pvoutput = PVOutput::Client.new(sajcollector_config[:system_id], sajcollector_config[:api_key])
 
+unless IPAddress.valid?(sajcollector_config[:saj])
+  raise ("[#{sajcollector_config[:saj]}] is not a valid IP address, please correct your #{yaml_file} file")
+end
+
+# Get the current realtime data from the SAJ device
+c = Net::HTTP.get(sajcollector_config[:saj], '/real_time_data.xml')
+
 options = {
   'temperature'      => 0, # Temperature in celcius
   'energy_generated' => 0, # Energy generation in watt hours
@@ -24,9 +34,6 @@ options = {
   'runtime_all_time' => 0
 }
 
-# Get the current realtime data from the SAJ device
-c = Net::HTTP.get(sajcollector_config[:saj], '/real_time_data.xml')
-
 # Let REXML parse the XML site
 doc = REXML::Document.new c
 
@@ -50,10 +57,14 @@ doc.elements.each('real_time_data/i-grid') do |e|
   options[:amperage] = e.text
 end
 
-# Get the voltage
+# Get the voltage for a 1 phase inverter
 doc.elements.each('real_time_data/v-grid') do |e|
   options[:voltage] = e.text
 end
+# Get the voltage for a 3 phase inverter
+doc.elements.each('real_time_data/Vac_l1') do |e|
+  options[:voltage] = e.text
+end
 doc.elements.each('real_time_data/e-today') do |e|
   options[:power_today] = e.text
 end

data/exe/saj_output_collector

@@ -4,14 +4,21 @@ require 'rexml/document'
 require 'net/http'
 require 'pvoutput/client'
 require 'yaml'
+require 'ipaddress'
+
+yaml_file = 'saj_collector.yaml'
 
 # Load the configuration from the yaml file
-sajcollector_config = YAML.load_file('saj_collector.yaml')
+sajcollector_config = YAML.load_file(yaml_file)
 
 # Create a pvoutput with the configured system_id and api_key which both
 # can be obtained from the pvoutput website
 pvoutput = PVOutput::Client.new(sajcollector_config[:system_id], sajcollector_config[:api_key])
 
+unless IPAddress.valid?(sajcollector_config[:saj])
+  raise ("[#{sajcollector_config[:saj]}] is not a valid IP address, please correct your #{yaml_file} file")
+end
+
 # Get the current day trend data from the SAJ device
 c = Net::HTTP.get(sajcollector_config[:saj], '/day_trend.xml')
 
@@ -52,7 +59,8 @@ while counter < days
 end
 
 options.each do |date, values|
-  puts "Energy generated #{date}: #{values[:energy_generated]} Wh"
+  energy_generated = values[:energy_generated].to_i/1000.0
+  puts "Energy generated #{date}: #{energy_generated} kWh"
 end
 
 pvoutput.add_batch_output(options)

data/lib/saj_collector/version.rb

@@ -1,3 +1,3 @@
 module SAJCollector
-  VERSION = '0.5.3'.freeze
+  VERSION = '0.5.8'.freeze
 end

data/saj_collector.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'saj_collector/version'
 
@@ -17,11 +17,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
+  spec.add_dependency 'ipaddress'
   spec.add_dependency 'pvoutput', '~> 0.4.0'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop', '~> 0.49.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52.0'
   spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: saj_collector
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.8
 platform: ruby
 authors:
 - Johnny Willemsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ipaddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pvoutput
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.52.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.52.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/ruby.yml"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -137,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Pull stats from SAJ Solar Inverter and push them to PVOutput