sma_api 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a9ddcb7964e241dd22e1aedeb60c4d349579c1573f40fd006cad4a25f7531a
-  data.tar.gz: 9f1d8eff6ce63d13aeb22c5036f8139906fb41f482d4db0b4116ce93f4b509da
+  metadata.gz: 0dc92d3abe35f2de18b03c9bc2e09c38b0e4807ae1f03182929b4cbf8dc89c4a
+  data.tar.gz: e03b4fdf64401d7ac504fb313487588643f36824a34ff24ae33295c3cec7cc4b
 SHA512:
-  metadata.gz: '097ece0e24a75bc31cfaa491d4c7e217ff3d0519d45ef2574183d49ddc60d22873a2fc3773a6f4031f0f17eb13df5cafeb6704c765b4ec94f92bf866db733add'
-  data.tar.gz: 1b100eb1cd43594b59876e3e724d826ece9715f8b9de67b09530e8ebf88ee645b5b08bbf9e4be7d515fba7642be45955ac853022c0a8ecb4159e4c80b846d074
+  metadata.gz: 0c914d046551021c6e8c98890a600b94bbf7452778d9e5f3ee6ce5c06b8d287b55d58ecc5a16a908c4180ce0c567fbb50c55b06bccf17497d0fea1db03c6c5b4
+  data.tar.gz: 772823374578e87813516d2a16f2988e106b68dba1bd5a9e7b6391cca0ece4538588e39ac28b670ca5f1b13d3e9264e056c0fba59701c283c23b8146da85a08f

data/README.md

@@ -2,12 +2,12 @@
 
 This gem provides an API for the web interface of SMA inverters.
 
-The gem is in early development and should not be considered stable. Everything might change.
+The gem is not under active development but I will maintain it. 
 
 ## Supported inverters
 
-This gem has been developed using a SMA Sunny Boy 3.0 (SB3.0-1AV-41 902).
-Firmware version is 3.10.18.R
+This gem has been developed using a SMA Sunny Boy 3.0 (SB3.0-1AV-41).
+Firmware version is 4.0.55.R
 
 It will probably work with other SMA products that have a recent firmware. But
 it has not been tested.
@@ -34,11 +34,11 @@ The web interface of the inverter does not allow an unlimited number of sessions
 There seems to be a limit of 4 sessions. Another attempt to login will result into
 an error message from the web interface, which is turned into a `SmaApi::Error`
 that has the `Creating session failed` message. The software in the inverter will
-free up a session after a 5 minute inactivity.
+free up a session after 5 minutes of inactivity.
 
 There are different ways of handling the session:
 - Create the `SmaApi::Client` instance just once and use it multiple times
-- Store the session id in a cache (file, Redis or another solution)
+- Create the `SmaApi::Client` instance using the session id from a cache (Redis, a file)
 - Use `client.destroy_session` to explicitly remove the session
 
 ### Create client once
@@ -55,7 +55,7 @@ while true do
 end
 ```
 
-### Cache the session id
+### Use the session id when creating the client
 
 In case the `sid` is not valid anymore, the client will try to create a new session.
 
@@ -74,7 +74,7 @@ while true do
 
   # If sid has been changed, save it to the sid file
   if client.sid != sid
-    File.open(sid_file, 'w') { |f| f.puts sid }
+    File.open(sid_file, 'w') { |f| f.puts client.sid }
   end
 
   puts "#{Time.now}\tCurrent yield: #{current_yield}"

data/lib/sma_api/client.rb

@@ -6,7 +6,7 @@ module SmaApi
     def initialize(host:, password:, sid: nil)
       @host = host
       @password = password
-      @client = Http.new(host: host, password: password, sid: sid)
+      @client = Http.new(host:, password:, sid:)
     end
 
     # The current session id. If empty, it will create a new session
@@ -28,11 +28,11 @@ module SmaApi
     # @param keys [Array<String>] List of keys
     # @return [Hash] Key-value pairs
     def get_values(keys)
-      result = @client.post('/dyn/getValues.json', { destDev: [], keys: keys })
+      result = @client.post('/dyn/getValues.json', { destDev: [], keys: })
       return nil unless result['result']
 
       keys.each_with_object({}) do |k, h|
-        h[k] = scalar_value(result['result'].first[1][k])
+        h[k] = get_value(k, result)
       end
     end
 
@@ -40,13 +40,13 @@ module SmaApi
     #
     # @return [Array] List of directories and files
     def get_fs(path)
-      result = @client.post('/dyn/getFS.json', { destDev: [], path: path })
+      result = @client.post('/dyn/getFS.json', { destDev: [], path: })
 
       result['result'].first[1][path].map do |f|
         type = f.key?('f') ? 'f' : 'd'
         {
           name: f['d'] || f['f'],
-          type: type,
+          type:,
           last_modified: Time.at(f['tm']),
           size: f['s']
         }
@@ -70,6 +70,19 @@ module SmaApi
 
     private
 
+    def get_value(requested_key, result)
+      split_by_underscore = requested_key.split('_')
+      if split_by_underscore.size == 3
+        array_value(result, split_by_underscore[0..1].join('_'), split_by_underscore[2].to_i)
+      else
+        scalar_value(result['result'].first[1][requested_key])
+      end
+    end
+
+    def array_value(result, result_key, position)
+      result['result'].first[1][result_key]['1'][position]['val']
+    end
+
     def scalar_value(value)
       value['1'].first['val']
     end

data/lib/sma_api/http.rb

@@ -88,12 +88,12 @@ module SmaApi
     end
 
     def retrieve_file(url)
-      res = http.get('/fs' + url_with_sid(url))
+      res = http.get("/fs#{url_with_sid(url)}")
 
       unless res.code == '200'
         # Try again because invalid sid does not result in a 401
         create_session
-        res = http.get('/fs' + url_with_sid(url))
+        res = http.get("/fs#{url_with_sid(url)}")
 
         raise "Error retrieving file (#{res.code} #{res.message})" unless res.code == '200'
       end

data/lib/sma_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SmaApi
-  VERSION = "0.1.3"
+  VERSION = '0.2.1'
 end

data/lib/sma_api.rb

@@ -1,7 +1,8 @@
-require "sma_api/client"
-require "sma_api/http"
-require "sma_api/version"
+# frozen_string_literal: true
 
+require 'sma_api/client'
+require 'sma_api/http'
+require 'sma_api/version'
 
 module SmaApi
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sma_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Rutger Wessels
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2024-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -31,9 +31,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,9 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,76 +58,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '1.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '1.40'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
+        version: '2.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
+        version: '2.16'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: '3.18'
 description: Extract data from a SMA Inverter web interface.
 email:
 - rutger@rutgerwessels.nl
@@ -152,7 +140,8 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/rutgerw/sma_api/blob/master/CHANGELOG.md
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,15 +149,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Extract data from a SMA Inverter web interface.
 test_files: []