growatt 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 901c3b86599ff30ac6afa1514954736acd92800cc7c969ab0bb185ed1285472a
-  data.tar.gz: a3a2d6a8ed6dcde5a5187b8133a05d15e003b38495afa456de28bb6be556f46f
+  metadata.gz: c4ad3dfd2cb69b9089ded3f89572c129c6681e927ffbbf85c3b95e5257758db3
+  data.tar.gz: 266c26a95fa3835e52a3783a669ac10084420be4748d0942ee7af8d3f0ecf19e
 SHA512:
-  metadata.gz: 84fd0f8eab0c9a2bd1f325a04b8d514140e81ccebcb20749b9bdb11161f78ff13a5f40ad871f47f01eb277d2345d3945b086567c61476de5ac4207e72ad3aee1
-  data.tar.gz: e00dfb6ac885c733d24be4d8170727f2cb5ae87693fbf9bb19e2f12deedcb1e2a9872c194a1f0598f8644aca294e094d187f443c12e898a53309416059641e5f
+  metadata.gz: ca2a1abfd1d5df708ae36b60abe0b6d5312ba345431672d92a091db417336421cd004a549ac48c1cc900f4bfcfb3a657978a54d34e68877ebe9ebbc54d125aa9
+  data.tar.gz: 8a46f8d312bb5bcd46e27e15c290b31bf8c8270d7583b159d57e0aea0fc5770f194cc36f3a69495fe4a25df34f05d1872b572d4c43fab1c178945de91ba2f177

data/.env.template

@@ -1,4 +1,4 @@
-# demo token used
-GROWATT_USERNAME=username
-GROWATT_PASSWORD=password
-
+# demo token used
+GROWATT_USERNAME=username
+GROWATT_PASSWORD=password
+

data/.gitignore

@@ -1,47 +1,47 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-/data/
-*.log
-*.txt
-*.json
-*.yml
-.DS_Store
-__pycache__
-*.py
-
-# Used by dotenv library to load environment variables.
-.env
-
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
-Gemfile.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/data/
+*.log
+*.txt
+*.json
+*.yml
+.DS_Store
+__pycache__
+*.py
+
+# Used by dotenv library to load environment variables.
+.env
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/CHANGELOG.md

@@ -1,8 +1,10 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-05-28
-- Initial release
-## [0.1.1] - 2024-05-28
-- remove unused require
-## [0.1.2] - 2024-05-29
-- add missing dependency
+## [Unreleased]
+
+## [0.1.0] - 2024-05-28
+- Initial release
+## [0.1.1] - 2024-05-28
+- remove unused require
+## [0.1.2] - 2024-05-29
+- add missing dependency
+## [0.1.3] - 2024-05-30
+- fix api issues to get inverter data

data/Gemfile

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in growatt.gemspec
-gemspec
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in growatt.gemspec
+gemspec

data/README.md

@@ -1,83 +1,83 @@
-# Growatt API
-[![Version](https://img.shields.io/gem/v/growatt.svg)](https://rubygems.org/gems/growatt)
-
-This is a wrapper for the Growatt rest API. Main objective is to turn inverter on/off. This has been testen with MOD-9000TL-X.
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'growatt'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install growatt
-
-## Usage
-
-Before you start making the requests to API provide the endpoint and api key using the configuration wrapping.
-
-```ruby
-require 'growatt'
-require 'logger'
-
-# use do block
-Growatt.configure do |config|
-  config.username = ENV['GROWATT_USERNAME']
-  config.password = ENV['GROWATT_PASSWORD']
-  config.logger = Logger.new(TEST_LOGGER)
-end
-
-# or configure with options hash
-client = Growatt.client
-client.login
-
-```
-
-## Resources
-### Authentication
-```ruby
-# setup
-#
-begin
-  client = Growatt.client
-  client.login
-  # turn invertor off
-  client.turn_inverter('<serial_no>', false)
-rescue Growatt::AuthenticationError => e
-  puts "Error logging in growatt api"
-  puts e
-end
-```
-
-
-
-## Publishing
-
-1. Update version in [version.rb](lib/growatt/version.rb).
-2. Add release to [CHANGELOG.md](CHANGELOG.md)
-3. Commit.
-4. Test build.
-```
-> rake build
-
-```
-5. Release
-```
-> rake release
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/growatt.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-"# growatt"
+# Growatt API
+[![Version](https://img.shields.io/gem/v/growatt.svg)](https://rubygems.org/gems/growatt)
+
+This is a wrapper for the Growatt rest API. Main objective is to turn inverter on/off. This has been testen with MOD-9000TL-X.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'growatt'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install growatt
+
+## Usage
+
+Before you start making the requests to API provide the endpoint and api key using the configuration wrapping.
+
+```ruby
+require 'growatt'
+require 'logger'
+
+# use do block
+Growatt.configure do |config|
+  config.username = ENV['GROWATT_USERNAME']
+  config.password = ENV['GROWATT_PASSWORD']
+  config.logger = Logger.new(TEST_LOGGER)
+end
+
+# or configure with options hash
+client = Growatt.client
+client.login
+
+```
+
+## Resources
+### Authentication
+```ruby
+# setup
+#
+begin
+  client = Growatt.client
+  client.login
+  # turn invertor off
+  client.turn_inverter('<serial_no>', false)
+rescue Growatt::AuthenticationError => e
+  puts "Error logging in growatt api"
+  puts e
+end
+```
+
+
+
+## Publishing
+
+1. Update version in [version.rb](lib/growatt/version.rb).
+2. Add release to [CHANGELOG.md](CHANGELOG.md)
+3. Commit.
+4. Test build.
+```
+> rake build
+
+```
+5. Release
+```
+> rake release
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/growatt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+"# growatt"

data/Rakefile

@@ -1,19 +1,19 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'dotenv'
-require 'rake/testtask'
-
-Dotenv.load
-
-#system './bin/cc-test-reporter before-build'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-task default: %i[test rubocop]
-#system './bin/cc-test-reporter after-build'
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'dotenv'
+require 'rake/testtask'
+
+Dotenv.load
+
+#system './bin/cc-test-reporter before-build'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+task default: %i[test rubocop]
+#system './bin/cc-test-reporter after-build'

data/growatt.gemspec

@@ -1,37 +1,37 @@
-# frozen_string_literal: true
-
-require_relative 'lib/growatt/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'growatt'
-  s.version     = Growatt::VERSION
-  s.authors     = ['Janco Tanis']
-  s.email       = 'gems@jancology.com'
-  s.license     = 'MIT'
-
-  s.summary     = 'A Ruby wrapper for the Growatt APIs (readonly)'
-  s.homepage    = 'https://rubygems.org/gems/growatt'
-
-  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
-
-  s.metadata['homepage_uri'] = s.homepage
-  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/growatt'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  s.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
-  end
-  s.bindir        = 'exe'
-  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.platform = Gem::Platform::RUBY
-  s.add_runtime_dependency 'wrapi', ">= 0.3.0"
-  s.add_runtime_dependency 'faraday-cookie_jar'
-  s.add_development_dependency 'dotenv'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'rubocop'
-end
+# frozen_string_literal: true
+
+require_relative 'lib/growatt/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'growatt'
+  s.version     = Growatt::VERSION
+  s.authors     = ['Janco Tanis']
+  s.email       = 'gems@jancology.com'
+  s.license     = 'MIT'
+
+  s.summary     = 'A Ruby wrapper for the Growatt APIs (readonly)'
+  s.homepage    = 'https://rubygems.org/gems/growatt'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/jancotanis/growatt'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.platform = Gem::Platform::RUBY
+  s.add_runtime_dependency 'wrapi', ">= 0.3.0"
+  s.add_runtime_dependency 'faraday-cookie_jar'
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop'
+end

data/lib/growatt/api.rb

@@ -1,35 +1,35 @@
-require "wrapi"
-require File.expand_path('authorization', __dir__)
-require File.expand_path('connection', __dir__)
-
-module Growatt
-  # @private
-  class API
-
-    # @private
-    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
-
-    # Creates a new API and copies settings from singleton
-    def initialize(options = {})
-      options = Growatt.options.merge(options)
-      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
-        send("#{key}=", options[key])
-      end
-    end
-
-    def config
-      conf = {}
-      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
-        conf[key] = send key
-      end
-      conf
-    end
-
-    include WrAPI::Connection
-    include Connection
-    include WrAPI::Request
-    include WrAPI::Authentication
-    include Authentication
-
-  end
-end
+require "wrapi"
+require File.expand_path('authorization', __dir__)
+require File.expand_path('connection', __dir__)
+
+module Growatt
+  # @private
+  class API
+
+    # @private
+    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API and copies settings from singleton
+    def initialize(options = {})
+      options = Growatt.options.merge(options)
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      WrAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include WrAPI::Connection
+    include Connection
+    include WrAPI::Request
+    include WrAPI::Authentication
+    include Authentication
+
+  end
+end

data/lib/growatt/authorization.rb

@@ -1,36 +1,36 @@
-require 'digest'
-require File.expand_path('error', __dir__)
-
-module Growatt
-  # Deals with authentication flow and stores it within global configuration
-  module Authentication
-
-    # Authorize to the Growatt portal
-    def login()
-      raise ConfigurationError, "Username/password not set" unless username || password
-      _password = hash_password(self.password) #unless is_password_hashed
-
-      _format = self.format
-      self.format = 'x-www-form-urlencoded'
-      response = post('newTwoLoginAPI.do', {'userName': self.username, 'password': _password})
-      self.format = _format
-      data = response.body['back']
-      if data && data['success']
-        @login_data = data
-        data
-      else
-        raise AuthenticationError.new(data['error'])
-      end
-    end
-  private
-    def hash_password(password)
-      password_md5 = Digest::MD5.hexdigest(password.encode('utf-8'))
-      (0...password_md5.length).step(2) do |i|
-        if password_md5[i] == '0'
-          password_md5[i] = 'c'
-        end
-      end
-      password_md5
-    end
-  end
-end
+require 'digest'
+require File.expand_path('error', __dir__)
+
+module Growatt
+  # Deals with authentication flow and stores it within global configuration
+  module Authentication
+
+    # Authorize to the Growatt portal
+    def login()
+      raise ConfigurationError, "Username/password not set" unless username || password
+      _password = hash_password(self.password) #unless is_password_hashed
+
+      _format = self.format
+      self.format = 'x-www-form-urlencoded'
+      response = post('newTwoLoginAPI.do', {'userName': self.username, 'password': _password})
+      self.format = _format
+      data = response.body['back']
+      if data && data['success']
+        @login_data = data
+        data
+      else
+        raise AuthenticationError.new(data['error'])
+      end
+    end
+  private
+    def hash_password(password)
+      password_md5 = Digest::MD5.hexdigest(password.encode('utf-8'))
+      (0...password_md5.length).step(2) do |i|
+        if password_md5[i] == '0'
+          password_md5[i] = 'c'
+        end
+      end
+      password_md5
+    end
+  end
+end

data/lib/growatt/client.rb

@@ -1,136 +1,158 @@
-require File.expand_path('api', __dir__)
-require File.expand_path('const', __dir__)
-require File.expand_path('error', __dir__)
-
-module Growatt
-  # Wrapper for the Growatt REST API
-  #
-  # @see no API documentation, reverse engineered
-  class Client < API
-
-    def initialize(options = {})
-      super(options)
-    end
-
-    # access data returned from login
-    def login_info
-      @login_data
-    end
-    def plant_list(user_id=nil)
-      user_id = login_info['user']['id'] unless user_id
-      _plant_list({'userId':user_id})
-    end
-    def plant_detail(plant_id,type=Timespan::DAY,date=Time.now)
-      _plant_detail( {
-        'plantId': plant_id,
-        'type': type,
-        'date': timespan_date(type,date)
-      })
-    end
-    def plant_info(plant_id)
-      _plant_info({
-        'op': 'getAllDeviceList',
-        'plantId': plant_id,
-        'pageNum': 1,
-        'pageSize': 1
-      })
-    end
-    def device_list(plant_id)
-      plant_info(plant_id).deviceList
-    end
-
-    def inverter_list(plant_id)
-      devices = device_list(plant_id)
-      devices.select { |device| 'inverter'.eql? device.deviceType  }
-    end
-
-    # get data for invertor control
-    def inverter_control_data(inverter_id)
-      _inverter_api({
-        'op': 'getMaxSetData',
-        'serialNum': inverter_id
-      }).obj.maxSetBean
-    end
-
-    def update_inverter_setting(serial_number,command,setting_type,parameters)
-      command_parameters = {
-        'op': command,
-        'serialNum': serial_number,
-        'type': setting_type
-      }
-      # repeated values to hash { param1: value1 }
-
-      parameters = parameters.map.with_index { |value, index| ["param#{index + 1}", value] }.to_h if parameters.is_a? Array
-      self.format = 'x-www-form-urlencoded'
-      data = JSON.parse(post('newTcpsetAPI.do',command_parameters.merge(parameters)).body)
-      self.format = :json
-      data['success']
-    end
-
-    # turn invertor on of off
-    def turn_inverter(serial_number,on=true)
-      onoff = (on ? Inverter::ON : Inverter::OFF )
-      update_inverter_setting(serial_number,'maxSetApi',nil,{'paramId':'max_cmd_on_off','param1':onoff})
-    end
-
-    # check if invertor is turned on
-    def inverter_on?(serial_number)
-      status = inverter_control_data(serial_number)
-      Inverter::ON.eql? status.max_cmd_on_off
-    end
-
-    # utility function to get date accordign timespan month/day
-    def timespan_date(timespan=Timespan::DAY,date=Time.now)
-      if Timespan::MONTH.eql? timespan
-        date.strftime("%Y-%m")
-      else
-        date.strftime("%Y-%m-%d")
-      end
-    end
-
-    #
-    # functions below are copied from python example code but not sure if these work with MOD9000 inverters
-    #
-    def inverter_data(inverter_id,type=Timespan::DAY,date=Time.now)
-      _inverter_api({
-        'op': 'getInverterData',
-        'inverterId': inverter_id,
-        'type': type,
-        'date': timespan_date(type,date)
-      })
-    end
-    def inverter_detail(inverter_id)
-      _inverter_api({
-        'op': 'getInverterDetailData',
-        'inverterId': inverter_id
-      })
-    end
-    def inverter_detail_two(inverter_id)
-      _inverter_api({
-        'op': 'getInverterDetailData_two',
-        'inverterId': inverter_id
-      })
-    end
-    def update_mix_inverter_setting(serial_number, setting_type, parameters)
-      update_inverter_setting(serial_number,'mixSetApiNew',setting_type,parameters)
-    end
-    def update_ac_inverter_setting(serial_number, setting_type, parameters)
-      update_inverter_setting(serial_number,'spaSetApi',setting_type,parameters)
-    end
-
-
-  private
-    def self.api_endpoint(method,path)
-      # all records
-      self.send(:define_method, method) do |params = {}|
-        # return data result
-        get(path,params)
-      end
-    end
-    api_endpoint :_plant_list, 'PlantListAPI.do'
-    api_endpoint :_plant_detail, 'PlantDetailAPI.do'
-    api_endpoint :_inverter_api, 'newInverterAPI.do'
-    api_endpoint :_plant_info, 'newTwoPlantAPI.do'
-
-  end
-end
+require File.expand_path('api', __dir__)
+require File.expand_path('const', __dir__)
+require File.expand_path('error', __dir__)
+
+module Growatt
+  # Wrapper for the Growatt REST API
+  #
+  # @see no API documentation, reverse engineered
+  class Client < API
+
+    def initialize(options = {})
+      super(options)
+    end
+
+    # access data returned from login
+    def login_info
+      @login_data
+    end
+    def plant_list(user_id=nil)
+      user_id = login_info['user']['id'] unless user_id
+      _plant_list({'userId':user_id})
+    end
+    def plant_detail(plant_id,type=Timespan::DAY,date=Time.now)
+      _plant_detail( {
+        'plantId': plant_id,
+        'type': type,
+        'date': timespan_date(type,date)
+      })
+    end
+    def plant_info(plant_id)
+      _plant_info({
+        'op': 'getAllDeviceList',
+        'plantId': plant_id,
+        'pageNum': 1,
+        'pageSize': 1
+      })
+    end
+    def device_list(plant_id)
+      plant_info(plant_id).deviceList
+    end
+
+    def inverter_list(plant_id)
+      devices = device_list(plant_id)
+      devices.select { |device| 'inverter'.eql? device.deviceType  }
+    end
+
+    # get data for invertor control
+    def inverter_control_data(inverter_id)
+      _inverter_api({
+        'op': 'getMaxSetData',
+        'serialNum': inverter_id
+      }).obj.maxSetBean
+    end
+
+    def update_inverter_setting(serial_number,command,param_id,parameters)
+      command_parameters = {
+        'op': command,
+        'serialNum': serial_number,
+        'paramId': param_id
+      }
+      # repeated values to hash { param1: value1 }
+
+      parameters = parameters.map.with_index { |value, index| ["param#{index + 1}", value] }.to_h if parameters.is_a? Array
+      self.format = 'x-www-form-urlencoded'
+      data = JSON.parse(post('newTcpsetAPI.do',command_parameters.merge(parameters)).body)
+      self.format = :json
+      data['success']
+    end
+
+    # turn invertor on of off
+    def turn_inverter(serial_number,on=true)
+      onoff = (on ? Inverter::ON : Inverter::OFF )
+      update_inverter_setting(serial_number,'maxSetApi','max_cmd_on_off',[onoff])
+    end
+
+    # check if invertor is turned on
+    def inverter_on?(serial_number)
+      status = inverter_control_data(serial_number)
+      Inverter::ON.eql? status.max_cmd_on_off
+    end
+
+    def export_limitation(serial_number,enable,value=nil)
+      if Inverter::DISABLE.eql? enable
+        params = [0]
+      else
+        raise ArgumentError, "exportlimitation enable should be Inverter::WATT or Inverter::PERCENTAGE" unless [Inverter::WATT,Inverter::PERCENTAGE].include? enable
+        raise ArgumentError, "Value should be set for export limitation" unless value
+        params = [1, value, enable]
+      end
+      update_inverter_setting(serial_number,'maxSetApi','backflow_setting',params)
+    end
+
+    # utility function to get date accordign timespan month/day
+    def timespan_date(timespan=Timespan::DAY,date=Time.now)
+      if Timespan::YEAR.eql? timespan
+        date.strftime("%Y")
+      elsif Timespan::MONTH.eql? timespan
+        date.strftime("%Y-%m")
+      elsif Timespan::DAY.eql? timespan
+        date.strftime("%Y-%m-%d")
+      end
+    end
+
+    #
+    # functions below are copied from python example code but not sure if these work with MOD9000 inverters
+    #
+    def inverter_data(inverter_id,type=Timespan::DAY,date=Time.now)
+      if Timespan::DAY.eql? type
+        operator = 'getInverterData_max'
+      elsif Timespan::MONTH.eql? type
+        operator = 'getMaxMonthPac'
+      elsif Timespan::YEAR.eql? type
+        operator = 'getMaxYearPac'
+      end
+      _inverter_api({
+        'op': operator,
+        'id': inverter_id,
+        'type': 1,
+        'date': timespan_date(type,date)
+      })
+    end
+=begin
+    def inverter_detail(inverter_id)
+      _inverter_api({
+        'op': 'getInverterDetailData',
+        'inverterId': inverter_id
+      })
+    end
+    def inverter_detail_two(inverter_id)
+      _inverter_api({
+        'op': 'getInverterDetailData_two',
+        'inverterId': inverter_id
+      })
+    end
+=end
+    def update_mix_inverter_setting(serial_number, setting_type, parameters)
+      update_inverter_setting(serial_number,'mixSetApiNew',setting_type,parameters)
+    end
+    def update_ac_inverter_setting(serial_number, setting_type, parameters)
+      update_inverter_setting(serial_number,'spaSetApi',setting_type,parameters)
+    end
+
+
+  private
+    def self.api_endpoint(method,path)
+      # all records
+      self.send(:define_method, method) do |params = {}|
+        # return data result
+        get(path,params)
+      end
+    end
+    api_endpoint :_plant_list, 'PlantListAPI.do'
+    api_endpoint :_plant_detail, 'PlantDetailAPI.do'
+    api_endpoint :_inverter_api, 'newInverterAPI.do'
+    api_endpoint :_plant_info, 'newTwoPlantAPI.do'
+
+  end
+end

data/lib/growatt/connection.rb

@@ -1,26 +1,26 @@
-require 'faraday'
-require 'faraday-cookie_jar'
-
-module Growatt
-  # Create connection and use cookies for authentication tokens
-  module Connection
-    def connection
-      raise ConfigurationError, "Option for endpoint is not defined" unless endpoint
-
-      options = setup_options
-      @connection ||= Faraday::Connection.new(options) do |connection|
-        connection.use :cookie_jar
-
-        connection.use Faraday::Response::RaiseError
-        connection.adapter Faraday.default_adapter
-        setup_authorization(connection)
-        setup_headers(connection)
-        connection.response :json, content_type: /\bjson$/
-        connection.use Faraday::Request::UrlEncoded
-
-        setup_logger_filtering(connection, logger) if logger
-      end
-    end
-
-  end
-end
+require 'faraday'
+require 'faraday-cookie_jar'
+
+module Growatt
+  # Create connection and use cookies for authentication tokens
+  module Connection
+    def connection
+      raise ConfigurationError, "Option for endpoint is not defined" unless endpoint
+
+      options = setup_options
+      @connection ||= Faraday::Connection.new(options) do |connection|
+        connection.use :cookie_jar
+
+        connection.use Faraday::Response::RaiseError
+        connection.adapter Faraday.default_adapter
+        setup_authorization(connection)
+        setup_headers(connection)
+        connection.response :json, content_type: /\bjson$/
+        connection.use Faraday::Request::UrlEncoded
+
+        setup_logger_filtering(connection, logger) if logger
+      end
+    end
+
+  end
+end

data/lib/growatt/const.rb

@@ -1,19 +1,26 @@
-
-module Growatt
-  class Enum
-      def self.enum(array)
-        array.each do |c|
-          const_set c,c
-        end
-      end
-  end
-  class Timespan
-    HOUR = 0
-    DAY = 1
-    MONTH = 2
-  end
-  class Inverter
-    ON = "0101"
-    OFF = "0000"
-  end
-end
+
+module Growatt
+  class Enum
+      def self.enum(array)
+        array.each do |c|
+          const_set c,c
+        end
+      end
+  end
+
+  class Timespan
+    HOUR = 0
+    DAY = 1
+    MONTH = 2
+    YEAR = 3
+  end
+
+  class Inverter
+    ON = "0101"
+    OFF = "0000"
+    DISABLE = -1
+    WATT = 1
+    PERCENTAGE = 0
+  end
+
+end

data/lib/growatt/error.rb

@@ -1,12 +1,12 @@
-module Growatt
-
-  # Generic error to be able to rescue all Hudu errors
-  class GrowattError < StandardError; end
-
-  # Configuration returns error
-  class ConfigurationError < GrowattError; end
-
-  # Issue authenticting
-  class AuthenticationError < GrowattError; end
-
-end
+module Growatt
+
+  # Generic error to be able to rescue all Hudu errors
+  class GrowattError < StandardError; end
+
+  # Configuration returns error
+  class ConfigurationError < GrowattError; end
+
+  # Issue authenticting
+  class AuthenticationError < GrowattError; end
+
+end

data/lib/growatt/pagination.rb

@@ -1,26 +1,26 @@
-require 'uri'
-require 'json'
-
-module Growatt
-
-  # Defines HTTP request methods
-  module RequestPagination
-
-    class DataPager < WrAPI::RequestPagination::DefaultPager
-
-      def self.data(body)
-        # data is at 'back'
-        if body.is_a? Hash
-          if body['back']
-            body['back']
-          else
-            body
-          end
-        else
-          # in some cases wrong contenttype is returned instead of app/json
-          JSON.parse(body)
-        end
-      end
-    end
-  end
-end
+require 'uri'
+require 'json'
+
+module Growatt
+
+  # Defines HTTP request methods
+  module RequestPagination
+
+    class DataPager < WrAPI::RequestPagination::DefaultPager
+
+      def self.data(body)
+        # data is at 'back'
+        if body.is_a? Hash
+          if body['back']
+            body['back']
+          else
+            body
+          end
+        else
+          # in some cases wrong contenttype is returned instead of app/json
+          JSON.parse(body)
+        end
+      end
+    end
+  end
+end

data/lib/growatt/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module Growatt
-  VERSION = '0.1.2'
-end
+# frozen_string_literal: true
+
+module Growatt
+  VERSION = '0.1.3'
+end

data/lib/growatt.rb

@@ -1,27 +1,27 @@
-require "wrapi"
-require File.expand_path('growatt/client', __dir__)
-require File.expand_path('growatt/version', __dir__)
-require File.expand_path('growatt/pagination', __dir__)
-
-module Growatt
-  extend WrAPI::Configuration
-  extend WrAPI::RespondTo
-
-  DEFAULT_UA = "Ruby Growatt API client #{Growatt::VERSION}".freeze
-  # https://openapi.growatt.com/ is an option but does not work with my account
-  DEFAULT_ENDPOINT = 'https://server.growatt.com/'.freeze
-  DEFAULT_PAGINATION = RequestPagination::DataPager
-  #
-  # @return [Growatt::Client]
-  def self.client(options = {})
-    Growatt::Client.new({ user_agent: DEFAULT_UA, endpoint: DEFAULT_ENDPOINT, pagination_class: DEFAULT_PAGINATION }.merge(options))
-  end
-
-  def self.reset
-    super
-    self.endpoint   = nil
-    self.user_agent = DEFAULT_UA
-    self.endpoint   = DEFAULT_ENDPOINT
-    self.pagination_class = DEFAULT_PAGINATION
-  end
-end
+require "wrapi"
+require File.expand_path('growatt/client', __dir__)
+require File.expand_path('growatt/version', __dir__)
+require File.expand_path('growatt/pagination', __dir__)
+
+module Growatt
+  extend WrAPI::Configuration
+  extend WrAPI::RespondTo
+
+  DEFAULT_UA = "Ruby Growatt API client #{Growatt::VERSION}".freeze
+  # https://openapi.growatt.com/ is an option but does not work with my account
+  DEFAULT_ENDPOINT = 'https://server.growatt.com/'.freeze
+  DEFAULT_PAGINATION = RequestPagination::DataPager
+  #
+  # @return [Growatt::Client]
+  def self.client(options = {})
+    Growatt::Client.new({ user_agent: DEFAULT_UA, endpoint: DEFAULT_ENDPOINT, pagination_class: DEFAULT_PAGINATION }.merge(options))
+  end
+
+  def self.reset
+    super
+    self.endpoint   = nil
+    self.user_agent = DEFAULT_UA
+    self.endpoint   = DEFAULT_ENDPOINT
+    self.pagination_class = DEFAULT_PAGINATION
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: growatt
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Janco Tanis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wrapi
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: gems@jancology.com
 executables: []
 extensions: []
@@ -116,16 +116,13 @@ files:
 - lib/growatt/error.rb
 - lib/growatt/pagination.rb
 - lib/growatt/version.rb
-- test/auth_test.rb
-- test/client_test.rb
-- test/test_helper.rb
 homepage: https://rubygems.org/gems/growatt
 licenses:
 - MIT
 metadata:
   homepage_uri: https://rubygems.org/gems/growatt
   source_code_uri: https://github.com/jancotanis/growatt
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,11 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Growatt APIs (readonly)
-test_files:
-- test/auth_test.rb
-- test/client_test.rb
-- test/test_helper.rb
+test_files: []

data/test/auth_test.rb

@@ -1,20 +0,0 @@
-require 'dotenv'
-require 'logger'
-require 'test_helper'
-
-
-describe 'authentication' do
-
-  it '#1 use wrong username/password' do
-    assert_raises Growatt::AuthenticationError do
-      client = Growatt.client( { username: "xxx"+Growatt.username, password: Growatt.password } )
-      client.login
-      flunk( 'AuthenticationError expected' )
-    end
-  end
-  it '#2 use correct username/password' do
-    client = Growatt.client( { username: Growatt.username, password:Growatt.password } )
-    client.login
-  end
-
-end

data/test/client_test.rb

@@ -1,44 +0,0 @@
-require 'dotenv'
-require 'logger'
-require 'test_helper'
-
-def p m, o
-#  puts "#{m}: #{o.inspect}"
-end
-
-describe 'client' do
-  before do
-    @client = Growatt.client
-    @client.login
-  end
-
-  it '#1 GET info' do
-
-  end
-
-  it "#2 plant/device list" do
-    plants = @client.plant_list
-
-p "\n* plants", plants
-    plant_id = plants.data.first.plantId
-    assert plant_id, "plant_id should not be nil"
-
-    detail = @client.plant_detail(plant_id)
-p "\n* plant detail", detail
-    assert value(detail.plantData.plantId).must_equal(plant_id), 'correct plantId/structure'
-
-    plant_info = @client.plant_info(plant_id)
-p "\n* plant info:", plant_info
-
-    devices = @client.device_list(plant_id)
-p "\n* devices:", plant_info.deviceList
-    inverter = devices.first
-    # turn device on
-    result = @client.turn_inverter(inverter.deviceSn,true)
-p "\n* turnon result:", result
-    is_on = @client.inverter_on?(inverter.deviceSn)
-
-    assert is_on, "Inverter should be on"
-    assert result, "inverter on should be success"
-  end
-end

data/test/test_helper.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-require 'simplecov'
-SimpleCov.start
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require 'minitest/autorun'
-require 'minitest/spec'
-
-require 'dotenv'
-require 'growatt'
-
-Dotenv.load
-
-TEST_LOGGER = 'test.log'
-
-File.delete(TEST_LOGGER) if File.exist?(TEST_LOGGER)
-
-Growatt.reset
-Growatt.configure do |config|
-  config.username = ENV['GROWATT_USERNAME']
-  config.password = ENV['GROWATT_PASSWORD']
-  config.logger = Logger.new(TEST_LOGGER)
-end