growatt 0.1.3 → 0.2.0

data/lib/growatt/client.rb

@@ -1,158 +1,160 @@
-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
+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_limit(serial_number,enable,value=nil)
+      if ExportLimit::DISABLE.eql? enable
+        params = [0]
+      else
+        raise ArgumentError, "exportlimitation enable should be ExportLimit::WATT or ExportLimit::PERCENTAGE" unless [ExportLimit::WATT,ExportLimit::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) do |request|
+          request.headers['Accept'] = "application/#{format}"
+        end
+      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,26 +1,29 @@
-
-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
+
+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"
+  end
+
+  class ExportLimit
+    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.3'
-end
+# frozen_string_literal: true
+
+module Growatt
+  VERSION = '0.2.0'
+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

data/test/auth_test.rb

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,69 @@
+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
+    # get data
+    data = @client.inverter_data(inverter.deviceSn,Growatt::Timespan::DAY,Time.now)
+    assert data, "Get day data by hour"
+    data = @client.inverter_data(inverter.deviceSn,Growatt::Timespan::MONTH,Time.now)
+    assert data, "Get month data by day"
+    data = @client.inverter_data(inverter.deviceSn,Growatt::Timespan::YEAR,Time.now)
+    assert data, "Get year data by month"
+puts "\n* Inverter data:"
+puts data.to_json
+
+    # 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
+  it "#3 export limitation parameters" do
+
+    assert_raises ArgumentError do
+      @client.export_limit('xxxx', 4)
+      flunk( 'ArgumentError expected, invalid limtation' )
+    end
+    assert_raises ArgumentError do
+      @client.export_limit('xxxx', Growatt::ExportLimit::WATT)
+      flunk( 'ArgumentError expected, no value given for WATTs' )
+    end
+    assert_raises ArgumentError do
+      @client.export_limit('xxxx',Growatt::ExportLimit::PERCENTAGE)
+      flunk( 'ArgumentError expected, no value given for PERCENTAGEs' )
+    end
+  end
+end