huawei_solar 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b47314ec2256d36828e0f6f6d25348541b63442d3adad41b59b13342cbab4793
-  data.tar.gz: 6330c438d6176a7788ce1bb834df51eccf45e06d7927623c6f214945ff4252f5
+  metadata.gz: bb059d5db290300b5ff49e9685ca5fe6bc18620f9b63f48fa30ea5679b45e8d8
+  data.tar.gz: f8421e69233715364fe19aa6152f81fabaceb7b503f94911acc5a7e5abe48573
 SHA512:
-  metadata.gz: 695249d55a711971fc5226a98e40d3e0e767361052cc1aaea462e2fa9aa3b6c4ed43471d18afb510e53730e496fe3901511ba664b2a20b1ece895afe67d2be05
-  data.tar.gz: a94b7da5ae772209ba9ff38b7fb429b6f5f43cbc055c7e89f0258e9f0c739ccc99cb1829d703ec956dffafa4bfa2ce502e1c501c9c6866fed08a32a9a59e7033
+  metadata.gz: f5ae6f6af83de404b20adf8e5b7573fd9b028d1db7b4b031f8ae068ce9cd9506abb8fb0cc222157ea0753817888920d31a2c51f2ca2ce9603f4aed028bb60a5e
+  data.tar.gz: e75ebfb14c92943a5be81265dc4771bbfad7a1eb3dc29758512c2d350259bdd975e377c65075e036526308412f249802e48c37a2b683d2d3642cf7685c5412db

data/.irbrc

@@ -0,0 +1 @@
+IRB.conf[:IRB_NAME] = "[huawei_solar]"

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.2
+ruby 3.2.2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.0.5] - 2023-08-05
+- Add `read_all` method
+- Change `with_unit` option to `units` or `unit` option.
+- Add `keys` option for return hash instead of array when retrieve multiple keys
+- Change development console from pry to irb
+
+## [0.0.4] - 2023-01-25
+- Add more meter metrics
+
 ## [0.0.3] - 2022-12-16
 - Add close method
 

data/Gemfile

@@ -5,7 +5,6 @@ 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"

data/Gemfile.lock

@@ -1,22 +1,17 @@
 PATH
   remote: .
   specs:
-    huawei_solar (0.0.3)
+    huawei_solar (0.0.5)
       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)
@@ -42,12 +37,12 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
   huawei_solar!
   minitest (~> 5.0)
-  pry (~> 0.14)
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-minitest (~> 0.19)

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Javier Aranda
+Copyright (c) 2023 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

data/README.md

@@ -4,6 +4,12 @@
 
 A Ruby library for connect to Huawei Solar inverters using Modbus TCP.
 
+## Status
+
+> :warning: **This project is still experimental, use with caution!**
+
+PR are welcome to increase the property list in [data/registers.yml](data/registers.yml)
+
 ## Example
 
 ```ruby
@@ -13,17 +19,29 @@ 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(:inverter_input_power, 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)
+hs.read(%i[inverter_output_power inverter_daily_energy meter_grid_power], units: true)
 # => ["225.0 W", "5.82 kWh", "-339.0 W"]
 
+hs.read(%i[inverter_output_power inverter_daily_energy meter_grid_power], units: true, keys: true)
+# => {:inverter_output_power=>"606.0 W", :inverter_daily_energy=>"15.15 kWh", :meter_grid_power=>"353.0 W"}
+
+hs.read_all
+# => ["SUN2000-3.68KTL-L1", "XXXXXXXX", 2, 224.8, 3.08, ..]
+
+hs.read_all(units: true)
+# => ["SUN2000-3.68KTL-L1", "XXXXXXXX", 2, "224.8 V", "3.08 A", ..]
+
+hs.read_all(keys: true)
+# => { "inverter_model"=>"SUN2000-3.68KTL-L1", "inverter_serial_number"=>"XXXXXXXX", "inverter_pv_strings"=>2, ... }
+
 hs.close
 ```
 
 ## License
 
-Copyright © 2022 Javier Aranda. Released under the terms of the [MIT license](LICENSE).
+Copyright © 2023 Javier Aranda. Released under the terms of the [MIT license](LICENSE).

data/data/registers.yml

@@ -165,3 +165,19 @@ meter_grid_frequency:
   quantity: 1
   unit: Hz
   gain: 100
+
+# Energia vertida a red
+meter_positive_active_electricity:
+  type: i32
+  address: 37119
+  quantity: 2
+  unit: kWh
+  gain: 100
+
+# Energia consumida de la red
+meter_reverse_active_power:
+  type: i32
+  address: 37121
+  quantity: 2
+  unit: kWh
+  gain: 100

data/lib/huawei_solar/version.rb

@@ -4,7 +4,7 @@ class HuaweiSolar
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 3
+    TINY  = 5
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/huawei_solar.rb

@@ -12,8 +12,12 @@ class HuaweiSolar
     @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:)
+  def read(name, **options)
+    name.is_a?(Array) ? read_multiple(name, **options) : read_single(name, **options)
+  end
+
+  def read_all(**options)
+    read_multiple(@registers.keys, **options)
   end
 
   def close
@@ -22,7 +26,7 @@ class HuaweiSolar
 
   private
 
-  def read_single(name, with_unit: false) # rubocop:disable Metrics/AbcSize
+  def read_single(name, **options) # rubocop:disable Metrics/AbcSize
     register = register_by_name(name)
     type = find_type(register["type"])
     gain = register["gain"]
@@ -35,11 +39,15 @@ class HuaweiSolar
     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
+    (options[:units] || options[:unit]) && !unit.nil? ? "#{value} #{unit}" : value
   end
 
-  def read_multiple(names, with_unit: false)
-    names.map { |name| read_single(name, with_unit:) }
+  def read_multiple(names, **options)
+    if options[:keys]
+      names.to_h { |name| [name, read_single(name, **options)] }
+    else
+      names.map { |name| read_single(name, **options) }
+    end
   end
 
   def register_by_name(name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huawei_solar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Javier Aranda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2023-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmodbus
@@ -26,7 +26,7 @@ dependencies:
         version: 1.3.3
 description:
 email:
-- javier.aranda.varo@gmail.com
+- aranda@hey.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -35,7 +35,7 @@ extra_rdoc_files:
 files:
 - ".editorconfig"
 - ".envrc"
-- ".pryrc"
+- ".irbrc"
 - ".rubocop.yml"
 - ".tool-versions"
 - CHANGELOG.md
@@ -58,8 +58,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/javierav/huawei_solar
-  source_code_uri: https://github.com/javierav/huawei_solar/tree/v0.0.3
-  changelog_uri: https://github.com/javierav/huawei_solar/blob/v0.0.3/CHANGELOG.md
+  source_code_uri: https://github.com/javierav/huawei_solar/tree/v0.0.5
+  changelog_uri: https://github.com/javierav/huawei_solar/blob/v0.0.5/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options:
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A library for connect to Huawei Solar inverters using Modbus TCP

data/.pryrc

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