senec 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2393be5a611f5e463679c73cea88426b38797d16a1678864d794164ebf4b2186
-  data.tar.gz: d10a2d220bd8594fc8f22721c97290a0d1e1390e3f6a06621ad1a5f8965433da
+  metadata.gz: adfa786a844f0a43a8e3a87763249da55e2e6165e80600ada958fe7aed674d32
+  data.tar.gz: ff9d52cc6e3fd5be19d49d474ee145526cbe0930438859b05423c92163b95274
 SHA512:
-  metadata.gz: 909689c326e6dcd09bc46f43e24c9e0019279af93b6b665ba9b859b62592010ccea49d3a6a5603d4970df799e7fb57908ad7c8b69b457f00452ea6ffe9c52153
-  data.tar.gz: 82101ee5a0f8e982cfeb7cc3ad576dfe74febd229b483157d21aaa1b4fe08d5e6708c8bb4a705fcbad10885361a91f75e530de095138f4972bc8aa2151414795
+  metadata.gz: c7b507db12c1b6712da5ba93b2780ac34b31c0ff5c108714d0b540f1e43a270ee30f4f4de234c5948e29a1b2d28f872aed1590f87945b6ac56e7e32b80ee7d43
+  data.tar.gz: c2739c6d4ef96c3d359e1d0a1398a5ce07363517db15c6032fb339aadbe802758751149af0f4d4d1b58e3d9a649367ed82667905a68259b7bce0ae3fc373f29a

data/.env.test

@@ -0,0 +1,3 @@
+SENEC_USERNAME=mail@example.com
+SENEC_PASSWORD=topsecret
+SENEC_SYSTEM_ID=123456

data/.github/workflows/push.yml

@@ -11,9 +11,12 @@ jobs:
       matrix:
         ruby: ['3.2']
 
+    env:
+      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+
     steps:
       - name: Checkout the code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -25,4 +28,10 @@ jobs:
         run: bundle exec rubocop
 
       - name: Run tests
-        run: bundle exec rake
+        run: bundle exec dotenv -f ".env.test" rspec
+
+      - name: Send test coverage to CodeClimate
+        uses: paambaati/codeclimate-action@v5.0.0
+        if: ${{ env.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: true

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -2,6 +2,7 @@ require:
   - rubocop-performance
   - rubocop-rspec
   - rubocop-rake
+  - rubocop-thread_safety
 
 AllCops:
   TargetRubyVersion: 3.2
@@ -13,8 +14,20 @@ Style/Documentation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/IfUnlessModifier:
+  Enabled: false
+
 Metrics/MethodLength:
   Max: 15
 
 Layout/LineLength:
   AllowedPatterns: ['\A#'] # Allow long comments
+
+RSpec/ExampleLength:
+  Max: 15
+
+RSpec/NestedGroups:
+  Max: 4

data/.vscode/settings.json

@@ -12,7 +12,7 @@
   },
 
   "[ruby]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
     "editor.formatOnSave": true
   }
 }

data/Gemfile

@@ -21,5 +21,17 @@ gem 'rubocop-rspec'
 # A RuboCop plugin for Rake (https://github.com/rubocop/rubocop-rake)
 gem 'rubocop-rake'
 
-# Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests. (https://relishapp.com/vcr/vcr/docs)
+# Thread-safety checks via static analysis (https://github.com/rubocop/rubocop-thread_safety)
+gem 'rubocop-thread_safety', require: false
+
+# Loads environment variables from `.env`. (https://github.com/bkeepers/dotenv)
+gem 'dotenv'
+
+# Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests. (https://benoittgt.github.io/vcr)
 gem 'vcr'
+
+# Code coverage for Ruby (https://github.com/simplecov-ruby/simplecov)
+gem 'simplecov'
+
+# Library for stubbing HTTP requests in Ruby. (https://github.com/bblimke/webmock)
+gem 'webmock'

data/README.md

@@ -1,9 +1,11 @@
 [![Continuous integration](https://github.com/solectrus/senec/actions/workflows/push.yml/badge.svg)](https://github.com/solectrus/senec/actions/workflows/push.yml)
 [![wakatime](https://wakatime.com/badge/user/697af4f5-617a-446d-ba58-407e7f3e0243/project/84ac7dc2-9288-497c-bb20-9c6123d3de66.svg)](https://wakatime.com/badge/user/697af4f5-617a-446d-ba58-407e7f3e0243/project/84ac7dc2-9288-497c-bb20-9c6123d3de66)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7f87c569e806d4f19368/maintainability)](https://codeclimate.com/github/solectrus/senec/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7f87c569e806d4f19368/test_coverage)](https://codeclimate.com/github/solectrus/senec/test_coverage)
 
 # Unofficial Ruby Client for SENEC Home
 
-Access your local SENEC Solar Battery Storage System
+Access your local SENEC Solar Battery Storage System or the SENEC Cloud from Ruby.
 
 **WARNING:** I'm not affiliated in any way with the SENEC company.
 
@@ -11,6 +13,7 @@ Inspired by:
 
 - https://github.com/mchwalisz/pysenec
 - https://gist.github.com/smashnet/82ad0b9d7f0ba2e5098e6649ba08f88a
+- https://documenter.getpostman.com/view/932140/2s9YXib2td
 
 ## Installation
 
@@ -20,11 +23,61 @@ $ gem install senec
 
 ## Usage
 
+### Cloud access (V2.1, V3 and V4)
+
+```ruby
+require 'senec'
+
+# Login to the SENEC cloud
+connection = Senec::Cloud::Connection.new(username: 'me@example.com', password: 'my-secret-senec-password')
+
+# List all available systems
+puts connection.systems
+
+# => [{"id"=>"123456", "steuereinheitnummer"=>"S123XXX", "gehaeusenummer"=>"DE-V3-XXXX", "strasse"=>"Musterstraße", "hausnummer"=>"27a", "postleitzahl"=>"99999", "ort"=>"Musterort", "laendercode"=>"DE", "zeitzone"=>"Europe/Berlin", "wallboxIds"=>["1"], "systemType"=>"V3"}]
+
+# Get the data of first systems (without knowing the ID):
+puts Senec::Cloud::Dashboard[connection].first.data
+
+# => {"aktuell"=>
+#   {"stromerzeugung"=>{"wert"=>0.01, "einheit"=>"W"},
+#    "stromverbrauch"=>{"wert"=>860.0, "einheit"=>"W"},
+#    "netzeinspeisung"=>{"wert"=>0.01, "einheit"=>"W"},
+#    "netzbezug"=>{"wert"=>852.6270000000001, "einheit"=>"W"},
+#    "speicherbeladung"=>{"wert"=>0.01, "einheit"=>"W"},
+#    "speicherentnahme"=>{"wert"=>11.68, "einheit"=>"W"},
+#    "speicherfuellstand"=>{"wert"=>1.0e-05, "einheit"=>"%"},
+#    "autarkie"=>{"wert"=>1.35, "einheit"=>"%"},
+#    "wallbox"=>{"wert"=>0.01, "einheit"=>"W"}},
+#  "heute"=>
+#   {"stromerzeugung"=>{"wert"=>3339.84375, "einheit"=>"Wh"},
+#    "stromverbrauch"=>{"wert"=>21000.0, "einheit"=>"Wh"},
+#    "netzeinspeisung"=>{"wert"=>13.671875, "einheit"=>"Wh"},
+#    "netzbezug"=>{"wert"=>17546.38671875, "einheit"=>"Wh"},
+#    "speicherbeladung"=>{"wert"=>119.140625, "einheit"=>"Wh"},
+#    "speicherentnahme"=>{"wert"=>254.39453125, "einheit"=>"Wh"},
+#    "speicherfuellstand"=>{"wert"=>0.0, "einheit"=>"%"},
+#    "autarkie"=>{"wert"=>16.47, "einheit"=>"%"},
+#    "wallbox"=>{"wert"=>0.0, "einheit"=>"Wh"}},
+#  "zeitstempel"=>"2023-11-26T18:45:23Z",
+#  "electricVehicleConnected"=>false}
+
+
+# Get the data of a specific system (by ID):
+puts Senc::Cloud::Dashboard[connection].find("123456").data
+
+# => {"aktuell"=>
+#   {"stromerzeugung"=>{"wert"=>0.01, "einheit"=>"W"},
+# ....
+```
+
+### Local access (V2.1 and V3 only)
+
 ```ruby
 require 'senec'
 
-connection = Senec::Connection.new(host: '192.168.178.123', schema: 'https')
-request = Senec::Request.new(connection:)
+connection = Senec::Local::Connection.new(host: '192.168.178.123', schema: 'https')
+request = Senec::Local::Request.new(connection:)
 
 puts "PV production: #{request.inverter_power} W"
 puts "House power consumption: #{request.house_power} W"

data/lib/senec/cloud/connection.rb

@@ -0,0 +1,72 @@
+module Senec
+  module Cloud
+    class Connection
+      def initialize(username:, password:)
+        @username = username
+        @password = password
+      end
+
+      attr_reader :username, :password
+
+      def authenticated?
+        !token.nil?
+      end
+
+      def systems
+        get('/v1/senec/systems')
+      end
+
+      def default_system_id
+        raise Error.new('No systems found!', :not_found) if systems.nil?
+
+        systems[0]['id']
+      end
+
+      def get(path, params: nil)
+        return_body do
+          connection.get(path, params, { authorization: token })
+        end
+      end
+
+      def post(path, data)
+        return_body do
+          connection.post(path, data)
+        end
+      end
+
+      private
+
+      def token
+        @token ||= login['token']
+      end
+
+      def login
+        post('/v1/senec/login', { username:, password: })
+      end
+
+      def connection
+        @connection ||=
+          Faraday.new(url: 'https://app-gateway.prod.senec.dev') do |f|
+            f.request :json
+            f.response :json
+
+            f.adapter :net_http_persistent, pool_size: 5 do |http|
+              # :nocov:
+              http.idle_timeout = 120
+              # :nocov:
+            end
+          end
+      end
+
+      def return_body(&)
+        response = yield
+
+        unless response.success?
+          raise Error.new("Error #{response.status}", response.status)
+        end
+
+        response.body
+      end
+    end
+  end
+end

data/lib/senec/cloud/dashboard.rb

@@ -0,0 +1,69 @@
+require_relative 'connection'
+
+# Model for the Senec dashboard data.
+#
+# Example use:
+#
+# connection = Senec::Cloud::Connection.new(username: '...', password: '...')
+#
+# # Get the data of a specific system:
+# Dashboard[connection].find('123456')
+#
+# # Get the data of the default system:
+# Dashboard[connection].first
+#
+module Senec
+  module Cloud
+    class Dashboard
+      class Finder
+        def initialize(connection)
+          @connection = connection
+        end
+        attr_reader :connection
+
+        def find(system_id)
+          Dashboard.new(connection:, system_id:).tap(&:load_data)
+        end
+
+        def first
+          find(connection.default_system_id)
+        end
+      end
+
+      def self.[](connection)
+        Finder.new(connection)
+      end
+
+      def initialize(connection: nil, system_id: nil, data: nil)
+        raise ArgumentError unless connection.nil? ^ data.nil?
+
+        @connection = connection
+        @system_id = system_id
+
+        # Useful for testing only
+        @data = data
+      end
+
+      def load_data
+        raise 'Data already present!' if @data
+
+        @system_id ||= connection.default_system_id
+        @data = fetch_data
+      end
+
+      attr_reader :system_id, :data
+
+      private
+
+      def get(path, params: nil)
+        @connection.get(path, params:)
+      end
+
+      def fetch_data
+        return unless system_id
+
+        get("/v1/senec/systems/#{system_id}/dashboard")
+      end
+    end
+  end
+end

data/lib/senec/cloud/error.rb

@@ -0,0 +1,12 @@
+module Senec
+  module Cloud
+    class Error < StandardError
+      attr_reader :status
+
+      def initialize(message, status)
+        super(message)
+        @status = status
+      end
+    end
+  end
+end

data/lib/senec/local/connection.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'faraday/net_http_persistent'
+require 'faraday-request-timer'
+require 'forwardable'
+
+module Senec
+  module Local
+    class Connection
+      def initialize(host:, schema: 'http')
+        @url = "#{schema}://#{host}"
+      end
+
+      attr_reader :url
+
+      extend Forwardable
+      def_delegators :faraday, :get, :post
+
+      private
+
+      def faraday
+        @faraday ||= Faraday.new @url,
+                                 ssl: { verify: false },
+                                 headers: {
+                                   'Connection' => 'keep-alive'
+                                 } do |f|
+          f.request :timer
+          f.adapter :net_http_persistent, pool_size: 5 do |http|
+            http.idle_timeout = 30
+          end
+        end
+      end
+    end
+  end
+end

data/lib/senec/local/constants.rb

@@ -0,0 +1,58 @@
+module Senec
+  module Local
+    # For a full list of available vars, see https://[IP-of-your-SENEC]//Vars.html
+    # Comments taken from https://gist.github.com/smashnet/82ad0b9d7f0ba2e5098e6649ba08f88a
+    BASIC_REQUEST = {
+      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)
+        GUI_BAT_DATA_VOLTAGE: '',         # Battery voltage (V)
+        GUI_GRID_POW: '',                 # Grid power: negative if exporting, positiv if importing (W)
+        GUI_HOUSE_POW: '',                # House power consumption (W)
+        GUI_INVERTER_POWER: '',           # PV production (W)
+        STAT_HOURS_OF_OPERATION: ''       # Appliance hours of operation
+      },
+      WIZARD: {
+        APPLICATION_VERSION: ''
+      },
+      RTC: {
+        UTC_OFFSET: '',
+        WEB_TIME: ''
+      },
+      PV1: {
+        MPP_POWER: '',                    # List: MPP power (W)
+        POWER_RATIO: ''                   # Grid export limit (percent)
+      },
+      TEMPMEASURE: {
+        CASE_TEMP: ''
+      },
+      WALLBOX: {
+        APPARENT_CHARGING_POWER: ''
+      }
+    }.freeze
+
+    SAFETY_CHARGE = {
+      ENERGY: {
+        SAFE_CHARGE_FORCE: 'u8_01',
+        SAFE_CHARGE_PROHIBIT: '',
+        SAFE_CHARGE_RUNNING: '',
+        LI_STORAGE_MODE_START: '',
+        LI_STORAGE_MODE_STOP: '',
+        LI_STORAGE_MODE_RUNNING: ''
+      }
+    }.freeze
+
+    ALLOW_DISCHARGE = {
+      ENERGY: {
+        SAFE_CHARGE_FORCE: '',
+        SAFE_CHARGE_PROHIBIT: 'u8_01',
+        SAFE_CHARGE_RUNNING: '',
+        LI_STORAGE_MODE_START: '',
+        LI_STORAGE_MODE_STOP: '',
+        LI_STORAGE_MODE_RUNNING: ''
+      }
+    }.freeze
+  end
+end

data/lib/senec/local/error.rb

@@ -0,0 +1,6 @@
+module Senec
+  module Local
+    class Error < StandardError; end
+    class DecodingError < StandardError; end
+  end
+end

data/lib/senec/local/request.rb

@@ -0,0 +1,138 @@
+require_relative 'value'
+require_relative 'constants'
+
+module Senec
+  module Local
+    class Request
+      def initialize(connection:, body: BASIC_REQUEST, state_names: nil)
+        @connection = connection
+        @body = body
+        @state_names = state_names
+      end
+
+      attr_reader :connection, :body, :state_names
+
+      def perform!
+        parsed_response
+        true
+      end
+
+      def house_power
+        get('ENERGY', 'GUI_HOUSE_POW')
+      end
+
+      def inverter_power
+        get('ENERGY', 'GUI_INVERTER_POWER')
+      end
+
+      def mpp_power
+        get('PV1', 'MPP_POWER')
+      end
+
+      def power_ratio
+        get('PV1', 'POWER_RATIO')
+      end
+
+      def bat_power
+        get('ENERGY', 'GUI_BAT_DATA_POWER')
+      end
+
+      def bat_fuel_charge
+        get('ENERGY', 'GUI_BAT_DATA_FUEL_CHARGE')
+      end
+
+      def bat_charge_current
+        get('ENERGY', 'GUI_BAT_DATA_CURRENT')
+      end
+
+      def bat_voltage
+        get('ENERGY', 'GUI_BAT_DATA_VOLTAGE')
+      end
+
+      def grid_power
+        get('ENERGY', 'GUI_GRID_POW')
+      end
+
+      def wallbox_charge_power
+        get('WALLBOX', 'APPARENT_CHARGING_POWER')
+      end
+
+      def case_temp
+        get('TEMPMEASURE', 'CASE_TEMP')
+      end
+
+      def application_version
+        get('WIZARD', 'APPLICATION_VERSION')
+      end
+
+      def current_state_code
+        get('ENERGY', 'STAT_STATE')
+      end
+
+      def current_state_name
+        throw RuntimeError, 'No state names provided!' unless state_names
+
+        state_names[current_state_code]
+      end
+
+      def measure_time
+        web_time = get('RTC', 'WEB_TIME')
+        utc_offset = get('RTC', 'UTC_OFFSET')
+
+        web_time - (utc_offset * 60)
+      end
+
+      def response_duration
+        raw_response.env[:duration]
+      end
+
+      def get(*keys)
+        return unless parsed_response
+
+        value = parsed_response.dig(*keys)
+
+        if value.is_a?(Array)
+          value.map do |v|
+            Value.new(v).decoded
+          end
+        elsif value
+          Value.new(value).decoded
+        else
+          raise Error, "Value missing for #{keys.join('.')}"
+        end
+      rescue Senec::Local::DecodingError => e
+        raise Error, "Decoding failed for #{keys.join('.')}: #{e.message}"
+      end
+
+      def path
+        '/lala.cgi'
+      end
+
+      private
+
+      def parsed_response
+        @parsed_response ||= JSON.parse(raw_response.body)
+      end
+
+      def raw_response
+        @raw_response ||= begin
+          response = connection.post(path, request_body, request_header)
+          raise Error, response.status unless response.success?
+
+          response
+        end
+      end
+
+      def request_body
+        JSON.generate(body)
+      end
+
+      def request_header
+        {
+          'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8',
+          'Accept' => 'application/json, text/javascript, */*; q=0.01'
+        }
+      end
+    end
+  end
+end

data/lib/senec/local/state.rb

@@ -0,0 +1,53 @@
+module Senec
+  module Local
+    class State
+      def initialize(connection:)
+        @connection = connection
+      end
+
+      attr_reader :connection
+
+      # Extract state names from JavaScript file, which is formatted like this:
+      #
+      # var system_state_name = {
+      #   0: "FIRST STATE",
+      #   1: "SECOND STATE",
+      #   ...
+      #  };
+      def names(language: :de)
+        response(language:).match(FILE_REGEX)[0].split("\n").each_with_object({}) do |line, hash|
+          key, value = line.match(LINE_REGEX)&.captures
+          next unless key && value
+
+          hash[key.to_i] = value
+        end
+      end
+
+      private
+
+      FILE_REGEX = /var system_state_name = \{(.*?)\};/m
+      LINE_REGEX = /(\d+)\s*:\s*"(.*)"/
+
+      def response(language:)
+        res = connection.get url(language:)
+        raise Error, res.message unless res.success?
+
+        res.body
+      end
+
+      # Use the JavaScript file containing English/German/Italian names from the SENEC web interface
+      def url(language:)
+        case language
+        when :en
+          '/js/EN-en.js'
+        when :de
+          '/js/DE-de.js'
+        when :it
+          '/js/IT-it.js'
+        else
+          raise Error, "Language #{language} not supported"
+        end
+      end
+    end
+  end
+end

data/lib/senec/local/value.rb

@@ -0,0 +1,43 @@
+module Senec
+  module Local
+    class Value
+      def initialize(raw)
+        @raw = raw
+        @prefix, @value = raw&.split('_')
+      end
+
+      attr_reader :prefix, :value, :raw
+
+      def decoded
+        case prefix
+        when 'fl'
+          decoded_float(value)
+        when 'i3', 'u1', 'u3', 'u6', 'u8'
+          decoded_int(value)
+        when 'st'
+          value
+        # TODO: There are some more prefixes to handle
+        else
+          raise DecodingError, "Unknown value '#{@raw}'"
+        end
+      end
+
+      alias to_i decoded
+      alias to_f decoded
+      alias to_s decoded
+
+      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
+
+      def decoded_int(hex)
+        "0x#{hex}".to_i(16)
+      end
+    end
+  end
+end

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

data/lib/senec.rb

@@ -1,9 +1,8 @@
 require 'senec/version'
-require 'senec/connection'
-require 'senec/state'
-require 'senec/request'
+require 'senec/local/connection'
+require 'senec/local/state'
+require 'senec/local/request'
+require 'senec/local/error'
 
-module Senec
-  class Error < StandardError; end
-  class DecodingError < StandardError; end
-end
+require 'senec/cloud/dashboard'
+require 'senec/cloud/error'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.test"
 - ".github/workflows/push.yml"
 - ".gitignore"
 - ".rspec"
@@ -72,11 +73,15 @@ files:
 - bin/console
 - bin/setup
 - lib/senec.rb
-- lib/senec/connection.rb
-- lib/senec/constants.rb
-- lib/senec/request.rb
-- lib/senec/state.rb
-- lib/senec/value.rb
+- lib/senec/cloud/connection.rb
+- lib/senec/cloud/dashboard.rb
+- lib/senec/cloud/error.rb
+- lib/senec/local/connection.rb
+- lib/senec/local/constants.rb
+- lib/senec/local/error.rb
+- lib/senec/local/request.rb
+- lib/senec/local/state.rb
+- lib/senec/local/value.rb
 - lib/senec/version.rb
 - senec.gemspec
 homepage: https://github.com/solectrus/senec
@@ -102,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home

data/lib/senec/connection.rb

@@ -1,30 +0,0 @@
-require 'faraday'
-require 'faraday/net_http_persistent'
-require 'faraday-request-timer'
-require 'forwardable'
-
-module Senec
-  class Connection
-    def initialize(host:, schema: 'http')
-      @url = "#{schema}://#{host}"
-    end
-
-    extend Forwardable
-    def_delegators :faraday, :get, :post
-
-    private
-
-    def faraday
-      @faraday ||= Faraday.new @url,
-                               ssl: { verify: false },
-                               headers: {
-                                 'Connection' => 'keep-alive'
-                               } do |f|
-        f.request :timer
-        f.adapter :net_http_persistent, pool_size: 5 do |http|
-          http.idle_timeout = 30
-        end
-      end
-    end
-  end
-end

data/lib/senec/constants.rb

@@ -1,34 +0,0 @@
-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 = {
-    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)
-      GUI_BAT_DATA_VOLTAGE: '',         # Battery voltage (V)
-      GUI_GRID_POW: '',                 # Grid power: negative if exporting, positiv if importing (W)
-      GUI_HOUSE_POW: '',                # House power consumption (W)
-      GUI_INVERTER_POWER: '',           # PV production (W)
-      STAT_HOURS_OF_OPERATION: ''       # Appliance hours of operation
-    },
-    WIZARD: {
-      APPLICATION_VERSION: ''
-    },
-    RTC: {
-      UTC_OFFSET: '',
-      WEB_TIME: ''
-    },
-    PV1: {
-      MPP_POWER: '',                    # List: MPP power (W)
-      POWER_RATIO: ''                   # Grid export limit (percent)
-    },
-    TEMPMEASURE: {
-      CASE_TEMP: ''
-    },
-    WALLBOX: {
-      APPARENT_CHARGING_POWER: ''
-    }
-  }.freeze
-end

data/lib/senec/request.rb

@@ -1,130 +0,0 @@
-require 'senec/value'
-require 'senec/constants'
-
-module Senec
-  class Request
-    def initialize(connection:, state_names: nil)
-      @connection = connection
-      @state_names = state_names
-    end
-
-    attr_reader :connection, :state_names
-
-    def house_power
-      get('ENERGY', 'GUI_HOUSE_POW')
-    end
-
-    def inverter_power
-      get('ENERGY', 'GUI_INVERTER_POWER')
-    end
-
-    def mpp_power
-      get('PV1', 'MPP_POWER')
-    end
-
-    def power_ratio
-      get('PV1', 'POWER_RATIO')
-    end
-
-    def bat_power
-      get('ENERGY', 'GUI_BAT_DATA_POWER')
-    end
-
-    def bat_fuel_charge
-      get('ENERGY', 'GUI_BAT_DATA_FUEL_CHARGE')
-    end
-
-    def bat_charge_current
-      get('ENERGY', 'GUI_BAT_DATA_CURRENT')
-    end
-
-    def bat_voltage
-      get('ENERGY', 'GUI_BAT_DATA_VOLTAGE')
-    end
-
-    def grid_power
-      get('ENERGY', 'GUI_GRID_POW')
-    end
-
-    def wallbox_charge_power
-      get('WALLBOX', 'APPARENT_CHARGING_POWER')
-    end
-
-    def case_temp
-      get('TEMPMEASURE', 'CASE_TEMP')
-    end
-
-    def application_version
-      get('WIZARD', 'APPLICATION_VERSION')
-    end
-
-    def current_state_code
-      get('ENERGY', 'STAT_STATE')
-    end
-
-    def current_state_name
-      throw RuntimeError, 'No state names provided!' unless state_names
-
-      state_names[current_state_code]
-    end
-
-    def measure_time
-      web_time = get('RTC', 'WEB_TIME')
-      utc_offset = get('RTC', 'UTC_OFFSET')
-
-      web_time - (utc_offset * 60)
-    end
-
-    def response_duration
-      raw_response.env[:duration]
-    end
-
-    private
-
-    def get(*keys)
-      return unless parsed_response
-
-      value = parsed_response.dig(*keys)
-
-      if value.is_a?(Array)
-        value.map do |v|
-          Senec::Value.new(v).decoded
-        end
-      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 parsed_response
-      @parsed_response ||= JSON.parse(raw_response.body)
-    end
-
-    def raw_response
-      @raw_response ||= begin
-        response = connection.post(url, request_body, request_header)
-        raise Senec::Error, response.status unless response.success?
-
-        response
-      end
-    end
-
-    def url
-      '/lala.cgi'
-    end
-
-    def request_body
-      JSON.generate(Senec::BASIC_REQUEST)
-    end
-
-    def request_header
-      {
-        'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8',
-        'Accept' => 'application/json, text/javascript, */*; q=0.01'
-      }
-    end
-  end
-end

data/lib/senec/state.rb

@@ -1,51 +0,0 @@
-module Senec
-  class State
-    def initialize(connection:)
-      @connection = connection
-    end
-
-    attr_reader :connection
-
-    # Extract state names from JavaScript file, which is formatted like this:
-    #
-    # var system_state_name = {
-    #   0: "FIRST STATE",
-    #   1: "SECOND STATE",
-    #   ...
-    #  };
-    def names(language: :de)
-      response(language:).match(FILE_REGEX)[0].split("\n").each_with_object({}) do |line, hash|
-        key, value = line.match(LINE_REGEX)&.captures
-        next unless key && value
-
-        hash[key.to_i] = value
-      end
-    end
-
-    private
-
-    FILE_REGEX = /var system_state_name = \{(.*?)\};/m
-    LINE_REGEX = /(\d+)\s*:\s*"(.*)"/
-
-    def response(language:)
-      res = connection.get url(language:)
-      raise Senec::Error, res.message unless res.success?
-
-      res.body
-    end
-
-    # Use the JavaScript file containing English/German/Italian names from the SENEC web interface
-    def url(language:)
-      case language
-      when :en
-        '/js/EN-en.js'
-      when :de
-        '/js/DE-de.js'
-      when :it
-        '/js/IT-it.js'
-      else
-        raise Senec::Error, "Language #{language} not supported"
-      end
-    end
-  end
-end

data/lib/senec/value.rb

@@ -1,45 +0,0 @@
-module Senec
-  class Value
-    def initialize(raw)
-      @raw = raw
-      @prefix, @value = raw&.split('_')
-    end
-
-    attr_reader :prefix, :value, :raw
-
-    def valid?
-      prefix && PREFIXES.include?(prefix)
-    end
-
-    def decoded
-      case prefix
-      when 'fl'
-        decoded_float(value)
-      when 'i3', 'u1', 'u3', 'u6', 'u8'
-        decoded_int(value)
-      when 'st'
-        value
-      # TODO: There are some more prefixes to handle
-      else
-        raise Senec::DecodingError, "Unknown value '#{@raw}'"
-      end
-    end
-
-    alias to_i decoded
-    alias to_f decoded
-    alias to_s decoded
-
-    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
-
-    def decoded_int(hex)
-      "0x#{hex}".to_i(16)
-    end
-  end
-end