sma_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e76c957bc8c28c065e5d09ae6af7f19da1fdfbf37750a4717142caf0995cb00
-  data.tar.gz: 7eb2af1e6cb5e5c5cafb1347a48e062db2031bee1f627fbefa77a538afa6b857
+  metadata.gz: 0dc92d3abe35f2de18b03c9bc2e09c38b0e4807ae1f03182929b4cbf8dc89c4a
+  data.tar.gz: e03b4fdf64401d7ac504fb313487588643f36824a34ff24ae33295c3cec7cc4b
 SHA512:
-  metadata.gz: 9615bf3a31e8010b649dafc7da9ecf63aaeef714b6aae91155c7a2fd8da20fdf3be3069b04f61c6cce5d0e092f0282940322cc793359fefedf611bdf8272807f
-  data.tar.gz: b45b79f2e061d98c85ecbaa1b3904f968db56664b38558a051dce4b00e44bcaadb75c818784afe45d8e2ac6ff9759a2059bf433641d9509e87e6381201a1b72b
+  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

@@ -32,7 +32,7 @@ module SmaApi
       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
 
@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sma_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Rutger Wessels
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2024-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler