senec 0.7.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eabf3cf6c200b6e167e68ba309a8a0365f1ad3c388bc6e6797460606ba81d13e
-  data.tar.gz: e7d1742ca594b43bb8a1636e3faea98784a468efc1a4fc86b96052a9b613f26b
+  metadata.gz: c99082ac76970b9dd8c23b3d847c329bae0a1499108cb4da23cc6890db0799c1
+  data.tar.gz: 2a7b3fd24ec219b64ad3345745d3dbe783293327849bf225356d63b3b02a1ca8
 SHA512:
-  metadata.gz: 9a7ac30d46616071e3d0a6d57151ff21f3c2a219e347aceda27423f82fefa9c5b7dddbcdcbeff840573f4b35c82fff575e2d3bbbc3caa526822b147a82b705b5
-  data.tar.gz: 511506136b9baf3839e92aa9ca66fb7a9354e7a924c6290e0a24ba9ce47d2d64d1f501bcc8caba0f58def09d620b57f9021781ce06f3bff5d76094a17cdeb150
+  metadata.gz: 046047abcc8df94341e6da4e1209bd828045a93c0d64f4970b49fdffa41afd88c815194b64372ceee09cacf30dbdacdd12be36a6d6d0bdf40a6b5a8f04a367c7
+  data.tar.gz: 4620d56810a324f10a9a14607afb35f198e6275c77eea18d41aa5ee1339ce0f97e207ba82a5f9d12636bcaacef8709e273dcd8dc1f524bf9b0ea2825b8a06421

data/lib/senec/constants.rb

@@ -2,11 +2,8 @@ module Senec
   # For a full list of available vars, see http://[IP-of-your-SENEC]/vars.html
   # Comments taken from https://gist.github.com/smashnet/82ad0b9d7f0ba2e5098e6649ba08f88a
   BASIC_REQUEST = {
-    STATISTIC: {
-      CURRENT_STATE: '',                # Current state of the system (int, see SYSTEM_STATE_NAME)
-      MEASURE_TIME: ''                  # Unix timestamp for above values (ms)
-    },
     ENERGY: {
+      STAT_STATE: '',                   # Current state of the system (int, see SYSTEM_STATE_NAME)
       GUI_BAT_DATA_CURRENT: '',         # Battery charge current: negative if discharging, positiv if charging (A)
       GUI_BAT_DATA_FUEL_CHARGE: '',     # Remaining battery (percent)
       GUI_BAT_DATA_POWER: '',           # Battery charge power: negative if discharging, positiv if charging (W)
@@ -16,6 +13,10 @@ module Senec
       GUI_INVERTER_POWER: '',           # PV production (W)
       STAT_HOURS_OF_OPERATION: ''       # Appliance hours of operation
     },
+    RTC: {
+      UTC_OFFSET: '',
+      WEB_TIME: ''
+    },
     PV1: {
       MPP_POWER: ''                     # List: MPP power (W)
     },

data/lib/senec/request.rb

@@ -4,11 +4,14 @@ require 'senec/constants'
 
 module Senec
   class Request
-    def initialize(host:, state_names: nil)
+    def initialize(host:, schema: 'http', state_names: nil)
       @host = host
+      @schema = schema
       @state_names = state_names
     end
 
+    attr_reader :host, :schema, :state_names
+
     def house_power
       get('ENERGY', 'GUI_HOUSE_POW')
     end
@@ -50,17 +53,20 @@ module Senec
     end
 
     def current_state
-      get('STATISTIC', 'CURRENT_STATE')
+      get('ENERGY', 'STAT_STATE')
     end
 
     def current_state_name
-      throw RuntimeError, 'No state names provided!' unless @state_names
+      throw RuntimeError, 'No state names provided!' unless state_names
 
-      @state_names[current_state]
+      state_names[current_state]
     end
 
     def measure_time
-      get('STATISTIC', 'MEASURE_TIME')
+      web_time = get('RTC', 'WEB_TIME')
+      utc_offset = get('RTC', 'UTC_OFFSET')
+
+      web_time - (utc_offset * 60)
     end
 
     private
@@ -72,9 +78,13 @@ module Senec
         value.map do |v|
           Senec::Value.new(v).decoded
         end
-      else
+      elsif value
         Senec::Value.new(value).decoded
+      else
+        raise Senec::Error, "Value missing for #{keys.join('.')}"
       end
+    rescue DecodingError => e
+      raise Senec::Error, "Decoding failed for #{keys.join('.')}: #{e.message}"
     end
 
     def response
@@ -84,7 +94,8 @@ module Senec
           body: JSON.generate(Senec::BASIC_REQUEST),
           headers: {
             'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8'
-          }
+          },
+          verify: false
         )
         raise Senec::Error, res.message.to_s unless res.success?
 
@@ -93,7 +104,7 @@ module Senec
     end
 
     def url
-      "http://#{@host}/lala.cgi"
+      "#{schema}://#{host}/lala.cgi"
     end
   end
 end

data/lib/senec/state.rb

@@ -2,11 +2,12 @@ require 'httparty'
 
 module Senec
   class State
-    def initialize(host:)
+    def initialize(host:, schema: 'http')
       @host = host
+      @schema = schema
     end
 
-    attr_reader :host
+    attr_reader :host, :schema
 
     # Extract state names from JavaScript file, which is formatted like this:
     #
@@ -31,7 +32,7 @@ module Senec
 
     def response
       @response ||= begin
-        res = HTTParty.get url
+        res = HTTParty.get url, verify: false
         raise Senec::Error, res.message unless res.success?
 
         res.body
@@ -40,7 +41,7 @@ module Senec
 
     # Use the JavaScript file with German names from the SENEC web interface
     def url
-      "http://#{host}/js/DE-de.js"
+      "#{schema}://#{host}/js/DE-de.js"
     end
   end
 end

data/lib/senec/value.rb

@@ -1,14 +1,17 @@
 module Senec
   class Value
-    def initialize(data)
-      @data = data
+    def initialize(raw)
+      @raw = raw
+      @prefix, @value = raw&.split('_')
     end
 
-    def decoded
-      parts  = @data.split('_')
-      prefix = parts[0]
-      value  = parts[1]
+    attr_reader :prefix, :value, :raw
+
+    def valid?
+      prefix && PREFIXES.include?(prefix)
+    end
 
+    def decoded
       case prefix
       when 'fl'
         decoded_float(value)
@@ -18,7 +21,7 @@ module Senec
         value
       # TODO: There are some more prefixes to handle
       else
-        raise ArgumentError, "#{@data} has unknown prefix!"
+        raise Senec::DecodingError, "Unknown value '#{@raw}'"
       end
     end
 
@@ -28,6 +31,9 @@ module Senec
 
     private
 
+    PREFIXES = %w[fl i3 u1 u3 u6 u8 st].freeze
+    private_constant :PREFIXES
+
     def decoded_float(hex)
       ["0x#{hex}".to_i(16)].pack('L').unpack1('F').round(1)
     end

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.7.2'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/lib/senec.rb

@@ -4,4 +4,5 @@ require 'senec/request'
 
 module Senec
   class Error < StandardError; end
+  class DecodingError < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-23 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home