senec 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc66f87a694b567a5d255e80aeca2ce5bd6bc31bbdce717f991c0f4a4bb6cae
-  data.tar.gz: 6c2def742896e62ee42d475983b4285ecb3e7a0a0315d6fc5317f959831d4401
+  metadata.gz: 37a0113a0636d99436244e2e69122dba3d8e978c74c63858f2cc35774a3eb6b5
+  data.tar.gz: bffc7d07e16369e04b518034ab87feedc07ecdc97091e8694caf7b113ff8e95e
 SHA512:
-  metadata.gz: c1006a948b5e0932fd9c1e675dbaec90f11e5c6a54b5899c239db0854f7e8623c03030dff72f4162acd716e60ae256526ceea2e883bf7b8f3ac8220ad93fb049
-  data.tar.gz: 3004661d438142e41e30c758d41e9f0b7ecf3e2f74f5533387689c215aa92e11346806651f413c7b76cb686a575a8f0188f9e03829c38ae1ca36496f074f20f0
+  metadata.gz: 2a10a927e07bf216f44e0fc7bd6770d61d851c6523b72fb040800667b65d5e0d4421352929091df67129b7dd1fa16111cc408be93da0398e94ffde0cf99c81f5
+  data.tar.gz: c0fa250c00fecf7f6a4a8ac2efc0e04740a3de1d6dfef469cf84e8ff63851e32a85835854edc47858f98109515f8c411d82c4a548a7886f7384a3915307bead5

data/.github/workflows/push.yml

@@ -8,13 +8,13 @@ jobs:
 
     steps:
       - name: Checkout the code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: '3.0'
+          ruby-version: '3.1'
 
       - name: Lint with RuboCop
         run: bundle exec rubocop

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
 
 Style/Documentation:
@@ -15,3 +15,6 @@ Style/FrozenStringLiteralComment:
 
 Metrics/MethodLength:
   Max: 15
+
+Layout/LineLength:
+  AllowedPatterns: ['\A#'] # Allow long comments

data/.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.tabSize": 2,
+
+  "files.trimTrailingWhitespace": true,
+
+  "ruby.lint": {
+    "rubocop": {
+      "forceExclusion": true
+    }
+  },
+
+  "[ruby]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  }
+}

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 # Rake is a Make-like program implemented in Ruby (https://github.com/ruby/rake)
 gem 'rake'
 
-# rspec-3.10.0 (http://github.com/rspec)
+# rspec-3.12.0 (http://github.com/rspec)
 gem 'rspec'
 
 # Automatic Ruby code style checking tool. (https://github.com/rubocop/rubocop)
@@ -20,3 +20,12 @@ gem 'rubocop-rspec'
 
 # A RuboCop plugin for Rake (https://github.com/rubocop/rubocop-rake)
 gem 'rubocop-rake'
+
+# HTTP should be easy (https://github.com/httprb/http)
+gem 'http'
+
+# 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)
+gem 'vcr'
+
+# Library for stubbing HTTP requests in Ruby. (https://github.com/bblimke/webmock)
+gem 'webmock'

data/LICENSE.txt

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

@@ -2,13 +2,12 @@
 
 Access your local SENEC Solar Battery Storage System
 
-**WARNING:** This project was coded in a few hours just for fun after the photovoltaic stuff was installed in my house. I'm not affiliated in any way with the SENEC company.
+**WARNING:** I'm not affiliated in any way with the SENEC company.
 
 Inspired by:
 
-* https://github.com/mchwalisz/pysenec
-* https://gist.github.com/smashnet/82ad0b9d7f0ba2e5098e6649ba08f88a
-
+- https://github.com/mchwalisz/pysenec
+- https://gist.github.com/smashnet/82ad0b9d7f0ba2e5098e6649ba08f88a
 
 ## Installation
 
@@ -31,6 +30,8 @@ puts "Battery fuel charge: #{request.bat_fuel_charge} %"
 puts "Battery charge current: #{request.bat_charge_current} A"
 puts "Battery voltage: #{request.bat_voltage} V"
 puts "\n"
+puts "Case temperature: #{request.case_temp} °C"
+puts "\n"
 puts "Wallbox charge power: [ #{request.wallbox_charge_power.join(',')} ] W"
 puts "\n"
 puts "Grid power: #{request.grid_power} W"
@@ -47,6 +48,8 @@ puts "Measure time: #{Time.at request.measure_time}"
 # Battery charge current: 19.8 A
 # Battery voltage: 49.2 V
 #
+# Case temperature: 31.3 °C
+#
 # Wallbox charge power: [ 8680, 0, 0, 0 ] W
 #
 # Grid power: 315 W
@@ -64,7 +67,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/solectrus/senec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/solectrus/senec/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/senec/constants.rb

@@ -95,16 +95,11 @@ module Senec # rubocop:disable Metrics/ModuleLength
     91 => 'EARTH FAULT'
   }.freeze
 
-  # Taken from https://gist.github.com/smashnet/82ad0b9d7f0ba2e5098e6649ba08f88a
+  # 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)
-      LIVE_BAT_CHARGE_MASTER: '',       # Battery charge amount since installation (kWh)
-      LIVE_BAT_DISCHARGE_MASTER: '',    # Battery discharge amount since installation (kWh)
-      LIVE_GRID_EXPORT: '',             # Grid export amount since installation (kWh)
-      LIVE_GRID_IMPORT: '',             # Grid import amount since installation (kWh)
-      LIVE_HOUSE_CONS: '',              # House consumption since installation (kWh)
-      LIVE_PV_GEN: '',                  # PV generated power since installation (kWh)
       MEASURE_TIME: ''                  # Unix timestamp for above values (ms)
     },
     ENERGY: {
@@ -117,14 +112,8 @@ module Senec # rubocop:disable Metrics/ModuleLength
       GUI_INVERTER_POWER: '',           # PV production (W)
       STAT_HOURS_OF_OPERATION: ''       # Appliance hours of operation
     },
-    BMS: {
-      CHARGED_ENERGY: '',               # List: Charged energy per battery
-      DISCHARGED_ENERGY: '',            # List: Discharged energy per battery
-      CYCLES: ''                        # List: Cycles per battery
-    },
-    PV1: {
-      POWER_RATIO: '',                  # Grid export limit (percent)
-      P_TOTAL: ''                       # ?
+    TEMPMEASURE: {
+      CASE_TEMP: ''
     },
     WALLBOX: {
       APPARENT_CHARGING_POWER: ''

data/lib/senec/request.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+require 'http'
 require 'json'
 require 'senec/value'
 require 'senec/constants'
@@ -10,66 +10,70 @@ module Senec
     end
 
     def house_power
-      value = response.dig('ENERGY', 'GUI_HOUSE_POW')
-      Senec::Value.new(value).to_i
+      get('ENERGY', 'GUI_HOUSE_POW')
     end
 
     def inverter_power
-      value = response.dig('ENERGY', 'GUI_INVERTER_POWER')
-      Senec::Value.new(value).to_i
+      get('ENERGY', 'GUI_INVERTER_POWER')
     end
 
     def bat_power
-      value = response.dig('ENERGY', 'GUI_BAT_DATA_POWER')
-      Senec::Value.new(value).to_i
+      get('ENERGY', 'GUI_BAT_DATA_POWER')
     end
 
     def bat_fuel_charge
-      value = response.dig('ENERGY', 'GUI_BAT_DATA_FUEL_CHARGE')
-      Senec::Value.new(value).to_f
+      get('ENERGY', 'GUI_BAT_DATA_FUEL_CHARGE')
     end
 
     def bat_charge_current
-      value = response.dig('ENERGY', 'GUI_BAT_DATA_CURRENT')
-      Senec::Value.new(value).to_f
+      get('ENERGY', 'GUI_BAT_DATA_CURRENT')
     end
 
     def bat_voltage
-      value = response.dig('ENERGY', 'GUI_BAT_DATA_VOLTAGE')
-      Senec::Value.new(value).to_f
+      get('ENERGY', 'GUI_BAT_DATA_VOLTAGE')
     end
 
     def grid_power
-      value = response.dig('ENERGY', 'GUI_GRID_POW')
-      Senec::Value.new(value).to_i
+      get('ENERGY', 'GUI_GRID_POW')
     end
 
     def wallbox_charge_power
-      response.dig('WALLBOX', 'APPARENT_CHARGING_POWER').map do |value|
-        Senec::Value.new(value).to_i
-      end
+      get('WALLBOX', 'APPARENT_CHARGING_POWER')
+    end
+
+    def case_temp
+      get('TEMPMEASURE', 'CASE_TEMP')
     end
 
     def current_state
-      value = response.dig('STATISTIC', 'CURRENT_STATE')
-      state = Senec::Value.new(value).to_i
+      state = get('STATISTIC', 'CURRENT_STATE')
 
       STATE_NAMES[state]
     end
 
     def measure_time
-      value = response.dig('STATISTIC', 'MEASURE_TIME')
-      Senec::Value.new(value).to_i
+      get('STATISTIC', 'MEASURE_TIME')
     end
 
     private
 
+    def get(*keys)
+      value = response.dig(*keys)
+
+      if value.is_a?(Array)
+        value.map do |v|
+          Senec::Value.new(v).decoded
+        end
+      else
+        Senec::Value.new(value).decoded
+      end
+    end
+
     def response
       @response ||= begin
-        res = Net::HTTP.post uri, Senec::BASIC_REQUEST.to_json
+        res = HTTP.post uri, json: Senec::BASIC_REQUEST
 
-        case res
-        when Net::HTTPOK
+        if res.status.success?
           JSON.parse(res.body)
         else
           throw "Failure: #{res.value}"

data/lib/senec/value.rb

@@ -4,37 +4,35 @@ module Senec
       @data = data
     end
 
-    def to_f
-      decoded_value
-    end
-
-    def to_i
-      decoded_value.round
-    end
-
-    private
-
-    def decoded_value
+    def decoded
       parts  = @data.split('_')
       prefix = parts[0]
       value  = parts[1]
 
       case prefix
       when 'fl'
-        hex2float(value)
-      when 'i3', 'u1', 'u3'
-        hex2int(value)
+        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 ArgumentError, "#{@data} cannot be decoded!"
+        raise ArgumentError, "#{@data} has unknown prefix!"
       end
     end
 
-    def hex2float(hex)
+    alias to_i decoded
+    alias to_f decoded
+    alias to_s decoded
+
+    private
+
+    def decoded_float(hex)
       ["0x#{hex}".to_i(16)].pack('L').unpack1('F').round(1)
     end
 
-    def hex2int(hex)
+    def decoded_int(hex)
       "0x#{hex}".to_i(16)
     end
   end

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/senec.gemspec

@@ -10,11 +10,12 @@ 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.6.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/solectrus/senec'
   spec.metadata['changelog_uri'] = 'https://github.com/solectrus/senec/releases'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2022-11-13 00:00:00.000000000 Z
 dependencies: []
 description: Access your local SENEC Solar Battery Storage System
 email:
@@ -21,6 +21,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -41,6 +42,7 @@ metadata:
   homepage_uri: https://github.com/solectrus/senec
   source_code_uri: https://github.com/solectrus/senec
   changelog_uri: https://github.com/solectrus/senec/releases
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -49,14 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home