senec 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01c953be78bd25556bdc237430130f7dec23a0d48d6bf0ba345c4148f132e1e
-  data.tar.gz: 29d87125f60177f5110a7efe7d4016c1390fcb03362f37e914630359ad327989
+  metadata.gz: 16c3c9c4abc76f4aefff00ebf5d5bec743f32f6a974c82ad28687067177f38b9
+  data.tar.gz: e1688029cc73db36e58212956fb483697036159e45fd5e76082efe85d42c444f
 SHA512:
-  metadata.gz: 2a0e8e2fdedc6c7189f53df01abc35bffc427ce561ac5f66f4e129bcd53242f58b4ccf499ec4560d465b939ec7f07482c755affc287a636dba7824ebd668288c
-  data.tar.gz: 35a99bb5c476a589186084a5a9055fa56f7d0d6731dcc8e2c576567387b40158423a30d10164ca84ddadd5df89f82cb4bed72d16d80bf9a17f9a52f989881525
+  metadata.gz: c25862ac9c3ff78553ac5b651335c2ad653bbbc1746aa0164cdac8e67e65984104e0b453069cd4222f1a1bb188ffc1115cf41d7e1e21628dbd70aee7735cfb72
+  data.tar.gz: 9b0a3e4a5586ccdec41978614364951a3f616287dd8ed029ca66b707987656a45930d7688029cd1e705e9fd51833a4ec62bd9dea432c77bf26118e0676eecaec

data/.github/workflows/push.yml

@@ -0,0 +1,23 @@
+name: Continuous integration
+
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: '3.1'
+
+      - name: Lint with RuboCop
+        run: bundle exec rubocop
+
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -1,115 +1,17 @@
 require:
   - rubocop-performance
   - rubocop-rspec
+  - rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.5
-  EnabledByDefault: true
-
-### Metrics
-
-Metrics/MethodLength:
-  Max: 20
-
-### Bundler
-
-Bundler/OrderedGems:
-  Enabled: false
-
-### Style
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/MixinUsage:
-  Enabled: false
+  TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/Documentation:
   Enabled: false
 
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Lambda:
-  EnforcedStyle: literal
-
-Style/LambdaCall:
-  Enabled: false
-
-Style/MethodCallWithArgsParentheses:
-  Enabled: false
-
-Style/MissingElse:
-  Enabled: false
-
-Style/Copyright:
-  Enabled: false
-
-Style/InlineComment:
-  Enabled: false
-
-Style/StringHashKeys:
-  Enabled: false
-
-Style/MethodCalledOnDoEndBlock:
-  Enabled: false
-
-Style/DocumentationMethod:
-  Enabled: false
-
-Style/DisableCopsWithinSourceCodeDirective:
-  Enabled: false
-
-Style/ConstantVisibility:
-  Enabled: false
-
-### Layout
-
-Layout/DotPosition:
-  EnforcedStyle: trailing
-
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: variable
-
-Layout/SpaceInsideArrayLiteralBrackets:
-  Enabled: false
-
-Layout/HashAlignment:
-  Enabled: false
-
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: false
-
-Layout/MultilineArrayLineBreaks:
-  Enabled: false
-
-Layout/MultilineAssignmentLayout:
-  Enabled: false
-
-# RSpec
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/AlignRightLetBrace:
-  Enabled: false
-
-RSpec/MultipleDescribes:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Enabled: false
-
-RSpec/ImplicitSubject:
-  Enabled: false
-
-# Lint
-
-Lint/ConstantResolution:
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-Lint/NumberConversion:
-  Enabled: false
+Metrics/MethodLength:
+  Max: 15

data/Gemfile

@@ -9,11 +9,14 @@ gem 'rake'
 # rspec-3.10.0 (http://github.com/rspec)
 gem 'rspec'
 
-# Automatic Ruby code style checking tool. (https://github.com/rubocop-hq/rubocop)
+# Automatic Ruby code style checking tool. (https://github.com/rubocop/rubocop)
 gem 'rubocop'
 
-# Automatic performance checking tool for Ruby code. (https://github.com/rubocop-hq/rubocop-performance)
+# Automatic performance checking tool for Ruby code. (https://github.com/rubocop/rubocop-performance)
 gem 'rubocop-performance'
 
-# Code style checking for RSpec files (https://github.com/rubocop-hq/rubocop-rspec)
+# Code style checking for RSpec files (https://github.com/rubocop/rubocop-rspec)
 gem 'rubocop-rspec'
+
+# A RuboCop plugin for Rake (https://github.com/rubocop/rubocop-rake)
+gem 'rubocop-rake'

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

@@ -31,8 +31,13 @@ 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"
 puts "Current state of the system: #{request.current_state}"
+puts "Measure time: #{Time.at request.measure_time}"
 
 # Example result:
 #
@@ -44,8 +49,13 @@ puts "Current state of the system: #{request.current_state}"
 # 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
 # Current state of the system: CHARGE
+# Measure time: 2021-10-06 17:50:22 +0200
 ```
 
 ## Development
@@ -56,7 +66,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ledermann/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/ledermann/senec/blob/master/CODE_OF_CONDUCT.md).
+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
@@ -65,4 +75,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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/ledermann/senec/blob/master/CODE_OF_CONDUCT.md).
+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,16 +1,16 @@
 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',
+    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',
@@ -95,36 +95,28 @@ 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)
+    STATISTIC: {
+      CURRENT_STATE: '',                # Current state of the system (int, see SYSTEM_STATE_NAME)
+      MEASURE_TIME: ''                  # Unix timestamp for above values (ms)
     },
-    'ENERGY': {
-      '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
+    ENERGY: {
+      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
     },
-    'BMS': {
-      'CHARGED_ENERGY': '',               # List: Charged energy per battery
-      'DISCHARGED_ENERGY': '',            # List: Discharged energy per battery
-      'CYCLES': ''                        # List: Cycles per battery
+    TEMPMEASURE: {
+      CASE_TEMP: ''
     },
-    'PV1': {
-      'POWER_RATIO': '',                  # Grid export limit (percent)
-      'P_TOTAL': ''                       # ?
+    WALLBOX: {
+      APPARENT_CHARGING_POWER: ''
     }
   }.freeze
 end

data/lib/senec/request.rb

@@ -44,6 +44,17 @@ module Senec
       Senec::Value.new(value).to_i
     end
 
+    def wallbox_charge_power
+      response.dig('WALLBOX', 'APPARENT_CHARGING_POWER').map do |value|
+        Senec::Value.new(value).to_i
+      end
+    end
+
+    def case_temp
+      value = response.dig('TEMPMEASURE', 'CASE_TEMP')
+      Senec::Value.new(value).to_f
+    end
+
     def current_state
       value = response.dig('STATISTIC', 'CURRENT_STATE')
       state = Senec::Value.new(value).to_i
@@ -51,6 +62,11 @@ module Senec
       STATE_NAMES[state]
     end
 
+    def measure_time
+      value = response.dig('STATISTIC', 'MEASURE_TIME')
+      Senec::Value.new(value).to_i
+    end
+
     private
 
     def response

data/lib/senec/value.rb

@@ -31,10 +31,7 @@ module Senec
     end
 
     def hex2float(hex)
-      [ "0x#{hex}".to_i(16) ].
-        pack('L').
-        unpack1('F').
-        round(1)
+      ["0x#{hex}".to_i(16)].pack('L').unpack1('F').round(1)
     end
 
     def hex2int(hex)

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/senec.rb

@@ -3,5 +3,4 @@ require 'senec/request'
 
 module Senec
   class Error < StandardError; end
-  # Your code goes here...
 end

data/senec.gemspec

@@ -8,13 +8,14 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Unofficial Ruby Client for SENEC Home'
   spec.description   = 'Access your local SENEC Solar Battery Storage System'
-  spec.homepage      = 'https://github.com/ledermann/senec'
+  spec.homepage      = 'https://github.com/solectrus/senec'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/ledermann/senec'
-  spec.metadata['changelog_uri'] = 'https://github.com/ledermann/releases'
+  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.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies: []
 description: Access your local SENEC Solar Battery Storage System
 email:
@@ -17,10 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/push.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -34,13 +34,14 @@ files:
 - lib/senec/value.rb
 - lib/senec/version.rb
 - senec.gemspec
-homepage: https://github.com/ledermann/senec
+homepage: https://github.com/solectrus/senec
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ledermann/senec
-  source_code_uri: https://github.com/ledermann/senec
-  changelog_uri: https://github.com/ledermann/releases
+  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 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4