huawei_solar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e86d39ee331eb59ce2496335ab7c766dc19b3f2d37825c99fd798f30ea2b868
+  data.tar.gz: 3169ec089f148789c1ded10c3e5f3afb5a862c40821cd88039b2896ea5dbe102
+SHA512:
+  metadata.gz: 76b42e417c4436caa6da377bc6912413f16beeb08a0dce86ec5db331763f369c437809aa7160fcdcd34e34b4f4e3f322bcd24c84910aff46cc20307e3b106899
+  data.tar.gz: 0f6e8b7fabe17a1851265337ea28ae15ed07facdd0f8763dadb109767d59a7a78ddcaf8eb7d8d24a0dbbdafc31e510f1576102db62ad3d40745f5dc1c73aca63

data/.editorconfig

@@ -0,0 +1,12 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.pryrc

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Pry.config.prompt_name = "[huawei_solar]"

data/.rubocop.yml

@@ -0,0 +1,54 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+    - Prefixes
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - "**/bin/**/*"
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/ModuleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.0.1] - 2022-12-07
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest", "~> 0.19"
+gem "rubocop-rake", "~> 0.6"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    huawei_solar (0.0.1)
+      rmodbus (~> 1.3.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rmodbus (1.3.3)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.19.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  huawei_solar!
+  minitest (~> 5.0)
+  pry (~> 0.14)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-minitest (~> 0.19)
+  rubocop-rake (~> 0.6)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Javier Aranda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# Huawei Solar
+
+![CI](https://github.com/javierav/huawei_solar/workflows/CI/badge.svg)
+
+A Ruby library for connect to Huawei Solar inverters using Modbus TCP.
+
+## Example
+
+```ruby
+require "huawei_solar"
+
+hs = HuaweiSolar.new("192.168.0.110", 502)
+
+hs.read(:inverter_model) # => "SUN2000-3.68KTL-L1"
+hs.read(:inverter_input_power) # => 234.0
+hs.read(:inverter_input_power, with_unit: true) # => "234.0 W"
+
+hs.read(%i[inverter_output_power inverter_daily_energy meter_grid_power])
+# => [225.0, 5.82, -339.0]
+
+hs.read(%i[inverter_output_power inverter_daily_energy meter_grid_power], with_unit: true)
+# => ["225.0 W", "5.82 kWh", "-339.0 W"]
+```
+
+## License
+
+Copyright © 2022 Javier Aranda. Released under the terms of the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+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]

data/data/registers.yml

@@ -0,0 +1,167 @@
+#
+## INVERTER
+#
+
+# Modelo del inversor
+inverter_model:
+  type: string
+  address: 30000
+  quantity: 15
+
+# Número de serie del inversor
+inverter_serial_number:
+  type: string
+  address: 30015
+  quantity: 10
+
+# Número de strings del inversor
+inverter_pv_strings:
+  type: u16
+  address: 30071
+  quantity: 1
+
+# Voltaje de entrada CC en el String 1 del inversor
+inverter_pv1_voltage:
+  type: i16
+  address: 32016
+  quantity: 1
+  unit: V
+  gain: 10
+
+# Intensidad de entrada CC en el String 1 del inversor
+inverter_pv1_current:
+  type: i16
+  address: 32017
+  quantity: 1
+  unit: A
+  gain: 100
+
+# Voltaje de entrada CC en el String 2 del inversor
+inverter_pv2_voltage:
+  type: i16
+  address: 32018
+  quantity: 1
+  unit: V
+  gain: 10
+
+# Intensidad de entrada CC en el String 2 del inversor
+inverter_pv2_current:
+  type: i16
+  address: 32019
+  quantity: 1
+  unit: A
+  gain: 100
+
+# Potencia de entrada CC en el inversor
+inverter_input_power:
+  type: i32
+  address: 32064
+  quantity: 2
+  unit: W
+  gain: 1
+
+# Voltaje de salida AC del inversor
+inverter_output_voltage:
+  type: u16
+  address: 32066
+  quantity: 1
+  unit: V
+  gain: 10
+
+# Intensidad de salida AC del inversor
+inverter_output_current:
+  type: i32
+  address: 32072
+  quantity: 2
+  unit: A
+  gain: 1000
+
+# Potencia de salida AC del inversor
+inverter_output_power:
+  type: i32
+  address: 32080
+  quantity: 2
+  unit: W
+  gain: 1
+
+# Factor de potencia del inversor
+inverter_power_factor:
+  type: i16
+  address: 32084
+  quantity: 1
+  gain: 1000
+
+# Eficiencia del inversor
+inverter_efficiency:
+  type: u16
+  address: 32086
+  quantity: 1
+  unit: "%"
+  gain: 100
+
+# Temperatura del inversor
+inverter_temperature:
+  type: i16
+  address: 32087
+  quantity: 1
+  unit: "ºC"
+  gain: 10
+
+# Producción diaria de energía
+inverter_daily_energy:
+  type: u32
+  address: 32114
+  quantity: 2
+  unit: kWh
+  gain: 100
+
+# Frecuencia de red del inversor
+inverter_grid_frequency:
+  type: u16
+  address: 32085
+  quantity: 1
+  unit: Hz
+  gain: 100
+
+#
+## METER
+#
+
+# Voltage de red
+meter_grid_voltage:
+  type: i32
+  address: 37101
+  quantity: 2
+  unit: V
+  gain: 10
+
+# Intensidad de red. > 0 vertiendo a red, < 0 obteniendo de red
+meter_grid_current:
+  type: i32
+  address: 37107
+  quantity: 2
+  unit: A
+  gain: 100
+
+# Potencia de red. > 0 vertiendo a red, < 0 obteniendo de red
+meter_grid_power:
+  type: i32
+  address: 37113
+  quantity: 2
+  unit: W
+  gain: 1
+
+# Factor de potencia de red.
+meter_power_factor:
+  type: i16
+  address: 37117
+  quantity: 1
+  gain: 1000
+
+# Frecuencia de red.
+meter_grid_frequency:
+  type: i16
+  address: 37118
+  quantity: 1
+  unit: Hz
+  gain: 100

data/lib/huawei_solar/array_ext.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# https://github.com/rmodbus/rmodbus/issues/57
+class Array
+  def to_32u
+    raise "Array requires an even number of elements to pack to 32bits: was #{size}" unless size.even?
+
+    each_slice(2).map { |(msb, lsb)| [msb, lsb].pack("n*").unpack1("N") }
+  end
+
+  # Given an array of 16bit Fixnum, we turn it into 32bit unsigned int in little-endian order, halving the size
+  def to_32u_le
+    raise "Array requires an even number of elements to pack to 32bits: was #{size}" unless size.even?
+
+    each_slice(2).map { |(lsb, msb)| [msb, lsb].pack("n*").unpack1("N") }
+  end
+
+  def to_signed32(number)
+    number >= 2_147_483_648 ? number - 4_294_967_296 : number
+  end
+
+  # Given an array of 16bit Fixnum, we turn it into 32bit signed int in big-endian order, halving the size
+  def to_32i
+    raise "Array requires an even number of elements to pack to 32bits: was #{size}" unless size.even?
+
+    to_32u.map { |n| to_signed32(n) }
+  end
+
+  # Given an array of 16bit Fixnum, we turn it into 32bit signed int in little-endian order, halving the size
+  def to_32i_le
+    raise "Array requires an even number of elements to pack to 32bits: was #{size}" unless size.even?
+
+    to_32u_le.map { |n| to_signed32(n) }
+  end
+end

data/lib/huawei_solar/i16.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class HuaweiSolar::I16
+  def self.call(value)
+    value
+  end
+end

data/lib/huawei_solar/i32.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class HuaweiSolar::I32
+  def self.call(value)
+    value.to_32i.first
+  end
+end

data/lib/huawei_solar/string.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class HuaweiSolar::String
+  def self.call(value)
+    value.map(&:to_word).join.strip
+  end
+end

data/lib/huawei_solar/u16.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class HuaweiSolar::U16
+  def self.call(value)
+    value
+  end
+end

data/lib/huawei_solar/u32.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class HuaweiSolar::U32
+  def self.call(value)
+    value.to_32u.first
+  end
+end

data/lib/huawei_solar/version.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class HuaweiSolar
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+
+  def self.version
+    VERSION::STRING
+  end
+
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+end

data/lib/huawei_solar.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "huawei_solar/string"
+require_relative "huawei_solar/i16"
+require_relative "huawei_solar/i32"
+require_relative "huawei_solar/u16"
+require_relative "huawei_solar/u32"
+require_relative "huawei_solar/version"
+
+require "rmodbus"
+require_relative "huawei_solar/array_ext"
+require "yaml"
+
+class HuaweiSolar
+  def initialize(host, port=502, **opts)
+    @client = ModBus::TCPClient.connect(host, port, opts)
+    @client.debug = !ENV["DEBUG"].nil?
+    @slave = @client.with_slave(1)
+    @registers = YAML.load_file(File.expand_path("../data/registers.yml", __dir__))
+  end
+
+  def read(name, with_unit: false)
+    name.is_a?(Array) ? read_multiple(name, with_unit:) : read_single(name, with_unit:)
+  end
+
+  private
+
+  def read_single(name, with_unit: false) # rubocop:disable Metrics/AbcSize
+    register = register_by_name(name)
+    type = find_type(register["type"])
+    gain = register["gain"]
+    unit = register["unit"]
+
+    value = type.call(
+      @slave.read_holding_registers(register["address"], register["quantity"])
+    )
+
+    value = value.is_a?(Array) && value.size == 1 ? value.first : value
+    value = gain ? value / (gain * 1.0) : value
+
+    with_unit && !unit.nil? ? "#{value} #{unit}" : value
+  end
+
+  def read_multiple(names, with_unit: false)
+    names.map { |name| read_single(name, with_unit:) }
+  end
+
+  def register_by_name(name)
+    @registers[name.to_s]
+  end
+
+  def find_type(type)
+    Object.const_get("HuaweiSolar::#{type.capitalize}")
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: huawei_solar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Javier Aranda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmodbus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description:
+email:
+- javier.aranda.varo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".editorconfig"
+- ".envrc"
+- ".pryrc"
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- data/registers.yml
+- lib/huawei_solar.rb
+- lib/huawei_solar/array_ext.rb
+- lib/huawei_solar/i16.rb
+- lib/huawei_solar/i32.rb
+- lib/huawei_solar/string.rb
+- lib/huawei_solar/u16.rb
+- lib/huawei_solar/u32.rb
+- lib/huawei_solar/version.rb
+homepage: https://github.com/javierav/huawei_solar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/javierav/huawei_solar
+  source_code_uri: https://github.com/javierav/huawei_solar/tree/v0.0.1
+  changelog_uri: https://github.com/javierav/huawei_solar/blob/v0.0.1/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A library for connect to Huawei Solar inverters using Modbus TCP
+test_files: []