senec 0.17.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaa5f023a77fd7232adff21888f19a4f8e5869e9100142ebadd7eebd49b90e7c
-  data.tar.gz: 8b12f81e7aee5193c66b866eb313e451d199a2e1aff4d5ed135d0e0c435f88f1
+  metadata.gz: a6af14cd79b5176290de5c80e492c31a4e0891770b720fd5017b2b830898838b
+  data.tar.gz: 59477e8b56dea17973fa2e1e7e05e4266d67172f9be54375c120fdd2bbca885a
 SHA512:
-  metadata.gz: 177e65e03d19d3fd4282903155eccd176e8eb3e2224d9fcb89302466f80e55db09a886b12d4086aba11edf9d9d5b07a4d5ba4c379e8813760765e619c8f90d20
-  data.tar.gz: ada3a35782b06a65bf75ecba3990729348c81fd2ad8ed6957e024b39f67cad735e0ff7113279886495366ec06e30c28e0f58346fa9ff02e20e5debec7a5456a1
+  metadata.gz: 19c4f8ae182ef21edaf0e07d62fda3ad45640ac43018c19af26dd125b34987981497f6adade28dcf31e873566fff63f82e5a83639813a1406a8fc0831c81fc8f
+  data.tar.gz: 3bac421adcf8eca7f5f07bdf4ef2a4a5deba0515058cb630f9797cf3c0b64c674123685ba4441c7c0404b097961872a0a730d1d1a5165003c217bbd85ee8912d

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 Georg Ledermann <georg@ledermann.dev>
+Copyright (c) 2020-2025 Georg Ledermann <georg@ledermann.dev>
 
 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

@@ -69,14 +69,43 @@ puts Senec::Cloud::Dashboard[connection].find("123456").data
 #   {"stromerzeugung"=>{"wert"=>0.01, "einheit"=>"W"},
 # ....
 
-# Get the Technical Data of a specific system (by ID):
+# Dashboard data can be requested in different versions, v1 and v2 are available, v1 is the default.
+# To request the data in version 2, pass the version parameter to the `data` method:
+puts Senec::Cloud::Dashboard[connection].first.data(version: 'v2')
+
+# => {
+#   'currently' => {
+#     'powerGenerationInW' => 1.0e-05,
+#     'powerConsumptionInW' => 1350.37,
+#     'gridFeedInInW' => 1.0e-05,
+#     'gridDrawInW' => 1321.26966059603,
+#     'batteryChargeInW' => 1.0e-05,
+#     'batteryDischargeInW' => 11.6411423841,
+#     'batteryLevelInPercent' => 1.0e-05,
+#     'selfSufficiencyInPercent' => 2.16,
+#     'wallboxInW' => 1.0e-05
+#   },
+#   'today' => {
+#     'powerGenerationInWh' => 3.90625,
+#     'powerConsumptionInWh' => 9119.14,
+#     'gridFeedInInWh' => 0.0,
+#     'gridDrawInWh' => 9011.71875,
+#     'batteryChargeInWh' => 0.0,
+#     'batteryDischargeInWh' => 107.421875,
+#     'batteryLevelInPercent' => 1.0e-05,
+#     'selfSufficiencyInPercent' => 1.18,
+#     'wallboxInWh' => 0.0
+#   },
+#   'timestamp' => '2025-01-11T06:45:09Z',
+#   'electricVehicleConnected' => false
+# }
 
+# Get the Technical Data of a specific system (by ID):
 puts Senec::Cloud::TechnicalData[connection].find("123456").data
 
 # => {"systemOverview"=>{"systemId"=>123456, "productName"=>"SENEC.Home V3 hybrid duo", ...
 
 # Get the Technical Data of first systems (without knowing the ID):
-
 puts Senec::Cloud::TechnicalData[connection].first.data
 
 # => {"systemOverview"=>{"systemId"=>123456, "productName"=>"SENEC.Home V3 hybrid duo", ...
@@ -153,7 +182,7 @@ 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-2024 Georg Ledermann
+Copyright (c) 2020-2025 Georg Ledermann
 
 ## Code of Conduct
 

data/lib/senec/cloud/dashboard.rb

@@ -7,14 +7,23 @@ require_relative 'connection'
 # connection = Senec::Cloud::Connection.new(username: '...', password: '...')
 #
 # # Get the data of a specific system:
-# Dashboard[connection].find('123456')
+# Dashboard[connection].find('123456').data
 #
 # # Get the data of the default system:
-# Dashboard[connection].first
+# Dashboard[connection].first.data
+#
+# By default, it returns v1 data. To get v2 data, use:
+#
+# Dashboard[connection].find('123456').data(version: 'v2')
+# or
+# Dashboard[connection].first.data(version: 'v2')
 #
 module Senec
   module Cloud
     class Dashboard
+      AVAILABLE_VERSIONS = %w[v1 v2].freeze
+      DEFAULT_VERSION = 'v1'.freeze
+
       class Finder
         def initialize(connection)
           @connection = connection
@@ -22,7 +31,7 @@ module Senec
         attr_reader :connection
 
         def find(system_id)
-          Dashboard.new(connection:, system_id:).tap(&:load_data)
+          Dashboard.new(connection:, system_id:)
         end
 
         def first
@@ -41,17 +50,18 @@ module Senec
         @system_id = system_id
 
         # Useful for testing only
-        @data = data
+        @data = {
+          'v1' => data,
+          'v2' => data
+        }
       end
 
-      def load_data
-        raise 'Data already present!' if @data
-
-        @system_id ||= connection.default_system_id
-        @data = fetch_data
+      def data(version: DEFAULT_VERSION)
+        @data ||= {}
+        @data[version] ||= fetch_data(version:)
       end
 
-      attr_reader :system_id, :data
+      attr_reader :system_id
 
       private
 
@@ -59,10 +69,11 @@ module Senec
         @connection.get(path, params:)
       end
 
-      def fetch_data
+      def fetch_data(version:)
+        raise ArgumentError unless AVAILABLE_VERSIONS.include?(version)
         return unless system_id
 
-        get("/v1/senec/systems/#{system_id}/dashboard")
+        get("/#{version}/senec/systems/#{system_id}/dashboard")
       end
     end
   end

data/lib/senec/version.rb

@@ -1,3 +1,3 @@
 module Senec
-  VERSION = '0.17.2'.freeze
+  VERSION = '0.18.0'.freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: senec
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.0
 platform: ruby
 authors:
 - Georg Ledermann
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2025-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -60,18 +59,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.test"
-- ".github/workflows/push.yml"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/senec.rb
 - lib/senec/cloud/connection.rb
 - lib/senec/cloud/dashboard.rb
@@ -84,7 +78,6 @@ files:
 - lib/senec/local/state.rb
 - lib/senec/local/value.rb
 - lib/senec/version.rb
-- senec.gemspec
 homepage: https://github.com/solectrus/senec
 licenses:
 - MIT
@@ -93,7 +86,6 @@ metadata:
   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:
 - lib
@@ -108,8 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Unofficial Ruby Client for SENEC Home
 test_files: []

data/.github/workflows/push.yml

@@ -1,37 +0,0 @@
-name: Continuous integration
-
-on: push
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ['3.2', '3.3']
-
-    env:
-      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-
-    steps:
-      - name: Checkout the code
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: ${{ matrix.ruby }}
-
-      - name: Lint with RuboCop
-        run: bundle exec rubocop
-
-      - name: Run tests
-        run: bundle exec dotenv -f ".env.test" rspec
-
-      - name: Send test coverage to CodeClimate
-        uses: paambaati/codeclimate-action@v8
-        if: ${{ env.CC_TEST_REPORTER_ID }}
-        with:
-          coverageCommand: true

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.env
-
-# rspec failure tracking
-.rspec_status
-Gemfile.lock

data/Gemfile

@@ -1,43 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in senec.gemspec
-gemspec
-
-# Support for encoding and decoding binary data using a Base64 representation. (https://github.com/ruby/base64)
-gem 'base64'
-
-# Arbitrary-precision decimal floating-point number library. (https://github.com/ruby/bigdecimal)
-gem 'bigdecimal'
-
-# Rake is a Make-like program implemented in Ruby (https://github.com/ruby/rake)
-gem 'rake'
-
-# rspec-3.13.0 (http://github.com/rspec)
-gem 'rspec'
-
-# Automatic Ruby code style checking tool. (https://github.com/rubocop/rubocop)
-gem 'rubocop', require: false
-
-# Automatic performance checking tool for Ruby code. (https://github.com/rubocop/rubocop-performance)
-gem 'rubocop-performance', require: false
-
-# Code style checking for RSpec files (https://github.com/rubocop/rubocop-rspec)
-gem 'rubocop-rspec', require: false
-
-# A RuboCop plugin for Rake (https://github.com/rubocop/rubocop-rake)
-gem 'rubocop-rake', require: false
-
-# 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/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'senec'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/senec.gemspec

@@ -1,32 +0,0 @@
-require_relative 'lib/senec/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'senec'
-  spec.version       = Senec::VERSION
-  spec.authors       = ['Georg Ledermann']
-  spec.email         = ['georg@ledermann.dev']
-
-  spec.summary       = 'Unofficial Ruby Client for SENEC Home'
-  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('>= 3.2.0')
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday-net_http_persistent'
-  spec.add_dependency 'faraday-request-timer'
-
-  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.
-  spec.files =
-    Dir.chdir(File.expand_path(__dir__)) do
-      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-    end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-end