senec 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 877e39b91e6ff1f4709131aaf96394db590396faad43d8648c88ab90cce1ca3a
-  data.tar.gz: bffeb00945d5a22ab11936299ec8d716283aa5c8283250c2ec337534f10af690
+  metadata.gz: f3914b7ea67325757972bb42f497370f9195ba55222d5e5fc87c03af9ff7c825
+  data.tar.gz: dca80a11290b1ea0f2b791090b83ba4a169ade0ec528f36ec92463ccb945f5dc
 SHA512:
-  metadata.gz: 966c843b9dfe626d753cf7ceafa1c030479a59c8bd076009e8406252147d09f11f239225b86c628a537eb87b538d5893503c6206579cf0c769d235e442035100
-  data.tar.gz: ca2fc0dfe72ce5934bc0ebeae1b2ac453f188031dbd0a2c515f135c892bc1d971fec9d81f9b7ccde604affdd0a6d312ee9dabfa349f00bd9df2ec97039e22734
+  metadata.gz: d19c80369fad7f4f066e0916e26c4280eb8d2a708e149cf9fb11071f29cee49be6fdebd7b225bb1368796771d3cc73682132e22056410db03ec98bea4dbd07e8
+  data.tar.gz: 9ca1fa435012bbe331924b1fd2173358fd700fbe3cb5fa2cbd75a9e2a59f9017c6ff575aee089df918bdfe9318dcd34c2b543ae3bd43207617af5bc96a2d79f0

data/.github/workflows/push.yml

@@ -6,6 +6,11 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.0', '3.1', '3.2']
+
     steps:
       - name: Checkout the code
         uses: actions/checkout@v3
@@ -14,7 +19,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '3.1'
+          ruby-version: ${{ matrix.ruby }}
 
       - name: Lint with RuboCop
         run: bundle exec rubocop

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   NewCops: enable
 
 Style/Documentation:

data/LICENSE.txt

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

@@ -1,3 +1,6 @@
+[![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)
+
 # Unofficial Ruby Client for SENEC Home
 
 Access your local SENEC Solar Battery Storage System
@@ -20,7 +23,8 @@ $ gem install senec
 ```ruby
 require 'senec'
 
-request = Senec::Request.new host: '10.0.1.99'
+senec_ip = '10.0.1.99'
+request = Senec::Request.new host: senec_ip
 
 puts "PV production: #{request.inverter_power} W"
 puts "House power consumption: #{request.house_power} W"
@@ -53,10 +57,22 @@ puts "Measure time: #{Time.at request.measure_time}"
 # Wallbox charge power: [ 8680, 0, 0, 0 ] W
 #
 # Grid power: 315 W
-# Current state of the system: CHARGE
+# Current state of the system: 14
 # Measure time: 2021-10-06 17:50:22 +0200
 ```
 
+To get the state name (in German) instead of just the number:
+
+```ruby
+state_names = Senec::State.new(host: senec_ip).names
+request = Senec::Request.new host: senec_ip, state_names: state_names
+
+puts request.current_state_name
+# => "LADEN"
+```
+
+The state names are extracted on-the-fly from the JavaScript source code returned by the SENEC web interface.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -71,6 +87,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/solect
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+Copyright (c) 2020,2023 Georg Ledermann
+
 ## Code of Conduct
 
 Everyone interacting in this project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/solectrus/senec/blob/master/CODE_OF_CONDUCT.md).

data/lib/senec/constants.rb

@@ -1,100 +1,4 @@
-module Senec # rubocop:disable Metrics/ModuleLength
-  # Taken from https://github.com/mchwalisz/pysenec
-  STATE_NAMES = {
-    0 => 'INITIAL STATE',
-    1 => 'ERROR INVERTER COMMUNICATION',
-    2 => 'ERROR ELECTRICY METER',
-    3 => 'RIPPLE CONTROL RECEIVER',
-    4 => 'INITIAL CHARGE',
-    5 => 'MAINTENANCE CHARGE',
-    6 => 'MAINTENANCE READY',
-    7 => 'MAINTENANCE REQUIRED',
-    8 => 'MAN. SAFETY CHARGE',
-    9 => 'SAFETY CHARGE READY',
-    10 => 'FULL CHARGE',
-    11 => 'EQUALIZATION: CHARGE',
-    12 => 'DESULFATATION: CHARGE',
-    13 => 'BATTERY FULL',
-    14 => 'CHARGE',
-    15 => 'BATTERY EMPTY',
-    16 => 'DISCHARGE',
-    17 => 'PV + DISCHARGE',
-    18 => 'GRID + DISCHARGE',
-    19 => 'PASSIVE',
-    20 => 'OFF',
-    21 => 'OWN CONSUMPTION',
-    22 => 'RESTART',
-    23 => 'MAN. EQUALIZATION: CHARGE',
-    24 => 'MAN. DESULFATATION: CHARGE',
-    25 => 'SAFETY CHARGE',
-    26 => 'BATTERY PROTECTION MODE',
-    27 => 'EG ERROR',
-    28 => 'EG CHARGE',
-    29 => 'EG DISCHARGE',
-    30 => 'EG PASSIVE',
-    31 => 'EG PROHIBIT CHARGE',
-    32 => 'EG PROHIBIT DISCHARGE',
-    33 => 'EMERGANCY CHARGE',
-    34 => 'SOFTWARE UPDATE',
-    35 => 'NSP ERROR',
-    36 => 'NSP ERROR: GRID',
-    37 => 'NSP ERROR: HARDWRE',
-    38 => 'NO SERVER CONNECTION',
-    39 => 'BMS ERROR',
-    40 => 'MAINTENANCE: FILTER',
-    41 => 'SLEEPING MODE',
-    42 => 'WAITING EXCESS',
-    43 => 'CAPACITY TEST: CHARGE',
-    44 => 'CAPACITY TEST: DISCHARGE',
-    45 => 'MAN. DESULFATATION: WAIT',
-    46 => 'MAN. DESULFATATION: READY',
-    47 => 'MAN. DESULFATATION: ERROR',
-    48 => 'EQUALIZATION: WAIT',
-    49 => 'EMERGANCY CHARGE: ERROR',
-    50 => 'MAN. EQUALIZATION: WAIT',
-    51 => 'MAN. EQUALIZATION: ERROR',
-    52 => 'MAN: EQUALIZATION: READY',
-    53 => 'AUTO. DESULFATATION: WAIT',
-    54 => 'ABSORPTION PHASE',
-    55 => 'DC-SWITCH OFF',
-    56 => 'PEAK-SHAVING: WAIT',
-    57 => 'ERROR BATTERY INVERTER',
-    58 => 'NPU-ERROR',
-    59 => 'BMS OFFLINE',
-    60 => 'MAINTENANCE CHARGE ERROR',
-    61 => 'MAN. SAFETY CHARGE ERROR',
-    62 => 'SAFETY CHARGE ERROR',
-    63 => 'NO CONNECTION TO MASTER',
-    64 => 'LITHIUM SAFE MODE ACTIVE',
-    65 => 'LITHIUM SAFE MODE DONE',
-    66 => 'BATTERY VOLTAGE ERROR',
-    67 => 'BMS DC SWITCHED OFF',
-    68 => 'GRID INITIALIZATION',
-    69 => 'GRID STABILIZATION',
-    70 => 'REMOTE SHUTDOWN',
-    71 => 'OFFPEAK-CHARGE',
-    72 => 'ERROR HALFBRIDGE',
-    73 => 'BMS: ERROR OPERATING TEMPERATURE',
-    74 => 'FACOTRY SETTINGS NOT FOUND',
-    75 => 'BACKUP POWER MODE - ACTIVE',
-    76 => 'BACKUP POWER MODE - BATTERY EMPTY',
-    77 => 'BACKUP POWER MODE ERROR',
-    78 => 'INITIALISING',
-    79 => 'INSTALLATION MODE',
-    80 => 'GRID OFFLINE',
-    81 => 'BMS UPDATE NEEDED',
-    82 => 'BMS CONFIGURATION NEEDED',
-    83 => 'INSULATION TEST',
-    84 => 'SELFTEST',
-    85 => 'EXTERNAL CONTROL',
-    86 => 'ERROR: TEMPERATURESENSOR',
-    87 => 'GRID OPERATOR: CHARGE PROHIBITED',
-    88 => 'GRID OPERATOR: DISCHARGE PROHIBITED',
-    89 => 'SPARE CAPACITY',
-    90 => 'SELFTEST ERROR',
-    91 => 'EARTH FAULT'
-  }.freeze
-
+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 = {

data/lib/senec/request.rb

@@ -5,8 +5,9 @@ require 'senec/constants'
 
 module Senec
   class Request
-    def initialize(host:)
+    def initialize(host:, state_names: nil)
       @host = host
+      @state_names = state_names
     end
 
     def house_power
@@ -46,9 +47,13 @@ module Senec
     end
 
     def current_state
-      state = get('STATISTIC', 'CURRENT_STATE')
+      get('STATISTIC', 'CURRENT_STATE')
+    end
+
+    def current_state_name
+      throw RuntimeError, 'No state names provided!' unless @state_names
 
-      STATE_NAMES[state]
+      @state_names[current_state]
     end
 
     def measure_time

data/lib/senec/state.rb

@@ -0,0 +1,46 @@
+require 'http'
+
+module Senec
+  class State
+    def initialize(host:)
+      @host = host
+    end
+
+    attr_reader :host
+
+    # Extract state names from JavaScript file, which is formatted like this:
+    #
+    # var system_state_name = {
+    #   0: "FIRST STATE",
+    #   1: "SECOND STATE",
+    #   ...
+    #  };
+    def names
+      response.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
+      @response ||= begin
+        res = HTTP.get uri
+        raise Senec::Error, res.status.to_s unless res.status.success?
+
+        res.body.to_s
+      end
+    end
+
+    # Use the JavaScript file with German names from the SENEC web interface
+    def uri
+      URI.parse("http://#{host}/js/DE-de.js")
+    end
+  end
+end

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.6.2'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/lib/senec.rb

@@ -1,4 +1,5 @@
 require 'senec/version'
+require 'senec/state'
 require 'senec/request'
 
 module Senec

data/senec.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Access your local SENEC Solar Battery Storage System'
   spec.homepage      = 'https://github.com/solectrus/senec'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
   spec.add_runtime_dependency 'http', '~> 5'
 
   spec.metadata['homepage_uri'] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 2023-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -46,6 +46,7 @@ files:
 - lib/senec.rb
 - lib/senec/constants.rb
 - lib/senec/request.rb
+- lib/senec/state.rb
 - lib/senec/value.rb
 - lib/senec/version.rb
 - senec.gemspec
@@ -65,14 +66,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home