Merge branch 'release/0.14.0'

Author: ledermann

.dockerignore

@@ -7,3 +7,8 @@ compose.yml
 spec
 Rakefile
 Dockerfile
+.dockerignore
+.rspec
+.rubocop.yml
+.vscode
+Guardfile

.env.example

@@ -25,6 +25,11 @@ SENEC_SYSTEM_ID=1236456
 # Interval in seconds to get data from SENEC cloud (minimum: 30 seconds)
 SENEC_INTERVAL=60
 
+# Optional: Disable specific fields you do not want to send to InfluxDB.
+# This can be useful if you are tracking them from another source.
+# Comma separated list of fields, no whitespace. Example:
+# SENEC_IGNORE=wallbox_charge_power,grid_power_minus
+
 # Credentials of your InfluxDB installation
 INFLUX_HOST=influxdb.example.com
 INFLUX_SCHEMA=https

.github/workflows/automerge.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.6.0
+        uses: dependabot/fetch-metadata@v2.0.0
         with:
           github-token: '${{ secrets.PAT }}'
 

.github/workflows/push.yml

@@ -91,6 +91,7 @@ jobs:
         with:
           context: .
           platforms: linux/amd64,linux/arm64,linux/arm/v7
+          provenance: false
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -29,10 +29,6 @@ ENV REVISION ${REVISION}
 
 WORKDIR /senec-collector
 
-# The heartbeat is written at least every 60 seconds, so the container
-# is considered healthy if the last heartbeat was less than 70 seconds ago.
-HEALTHCHECK CMD test $(expr $(date +%s) - $(cat /tmp/heartbeat.txt)) -lt 70 || exit 1
-
 COPY --from=Builder /usr/local/bundle/ /usr/local/bundle/
 COPY . /senec-collector/
 

Gemfile.lock

@@ -3,16 +3,16 @@ GEM
   specs:
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
-    amazing_print (1.5.0)
+    amazing_print (1.6.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.7)
     coderay (1.1.3)
     connection_pool (2.4.1)
     crack (1.0.0)
       bigdecimal
       rexml
-    csv (3.2.8)
+    csv (3.3.0)
     diff-lcs (1.5.1)
     docile (1.4.0)
     dotenv (3.1.0)
@@ -42,14 +42,14 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (1.1.0)
-    influxdb-client (3.0.0)
-    json (2.7.1)
+    influxdb-client (3.1.0)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.10)
-    method_source (1.0.0)
+    method_source (1.1.0)
     nenv (0.3.0)
     net-http (0.4.1)
       uri
@@ -64,14 +64,13 @@ GEM
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    prism (0.24.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -90,33 +89,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.61.0)
+    rubocop (1.63.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.0)
+    rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
-      prism (>= 0.24.0)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-performance (1.20.2)
+    rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.26.1)
+    rubocop-rspec (2.29.1)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     senec (0.15.0)
       faraday
@@ -161,4 +162,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.5.6
+   2.5.9

README.md

@@ -5,7 +5,7 @@
 
 # SENEC collector
 
-Collect data from SENEC photovoltaics and push it to InfluxDB 2
+Collect data from SENEC Solar Battery Storage System and push it to InfluxDB 2
 
 Allows accessing a local SENEC device (V2 + V3) as well as the SENEC cloud (V4).
 
@@ -15,8 +15,9 @@ Linux machine with Docker installed
 
 Tested on:
 
-- Raspberry Pi 4 Model B on Raspbian GNU/Linux 10 (buster) and 11 (bullseye)
-- Synology NAS DS220+ on DSM 7.1
+- Raspberry Pi 4 Model B on Raspbian GNU/Linux 10 (buster) and 11 (bullseye) and 12 (bookworm)
+- Synology NAS DS220+ on DSM 7.1+
+- ... and lots of other Linux machines - if it runs Docker, it should work
 
 ## Getting started
 

app.rb

@@ -28,6 +28,7 @@
 logger.info "Pushing to InfluxDB at #{config.influx_url}, " \
        "bucket #{config.influx_bucket}, " \
        "measurement #{config.influx_measurement}"
+logger.info "Ignoring: #{config.senec_ignore.join(', ')}" if config.senec_ignore.any?
 logger.info "\n"
 
 Loop.start(config:)

lib/cloud_adapter.rb

@@ -84,7 +84,7 @@ def technical_data
     Senec::Cloud::TechnicalData[connection].find(system_id)
   end
 
-  def record_hash
+  def raw_record_hash
     {
       current_state:,
       current_state_ok:,
@@ -104,6 +104,10 @@ def record_hash
     }.compact
   end
 
+  def record_hash
+    raw_record_hash.except(*config.senec_ignore)
+  end
+
   def dashboard_record
     @dashboard_record ||= dashboard.data
   end
@@ -192,11 +196,14 @@ def current_state_ok
   end
 
   def success_message(record)
-    "\nGot record ##{record.id} at " \
-      "#{Time.at(record.measure_time).localtime} " \
-      "#{record.current_state || 'Unknown state'}, " \
-      "Inverter #{record.inverter_power} W, House #{record.house_power} W, " \
-      "Wallbox #{record.wallbox_charge_power} W"
+    [
+      "\nGot record ##{record.id} at " \
+      "#{Time.at(record.measure_time).localtime}",
+      record.current_state || 'Unknown state',
+      ("Inverter #{record.inverter_power} W" unless config.excludes?(:inverter_power)),
+      ("House #{record.house_power} W" unless config.excludes?(:house_power)),
+      ("Wallbox #{record.wallbox_charge_power} W" unless config.excludes?(:wallbox_charge_power)),
+    ].compact.join(', ')
   end
 
   def failure_message(error)

lib/config.rb

@@ -13,6 +13,7 @@
   senec_password
   senec_token
   senec_system_id
+  senec_ignore
   influx_schema
   influx_host
   influx_port
@@ -26,6 +27,7 @@
   senec_adapter: :local,
   senec_schema: :https,
   senec_language: :de,
+  senec_ignore: [],
   influx_schema: :http,
   influx_port: 8086,
   influx_measurement: 'SENEC',
@@ -36,30 +38,25 @@
     def initialize(*options)
       super
 
-      set_defaults_and_types
-      validate!
-    end
-
-    def set_defaults_and_types
-      convert_types
+      set_types
       set_defaults
-      limit_interval
+      limit_senec_interval
+      validate!
     end
 
-    def convert_types
-      # Strip blanks
+    def set_types
       KEYS.each do |key|
         self[key] = self[key].presence
-      end
-
-      # Symbols
-      %i[senec_adapter senec_schema senec_language influx_schema].each do |key|
-        self[key] = self[key]&.to_sym
-      end
-
-      # Integer
-      %i[senec_interval influx_port].each do |key|
-        self[key] = self[key]&.to_i
+        next unless self[key]
+
+        case key
+        when :senec_adapter, :senec_schema, :senec_language, :influx_schema
+          self[key] = self[key].to_sym
+        when :senec_interval, :influx_port
+          self[key] = self[key].to_i
+        when :senec_ignore
+          self[key] = self[key].split(',').map(&:to_sym)
+        end
       end
     end
 
@@ -71,7 +68,7 @@ def set_defaults
       self[:senec_interval] ||= senec_adapter == :local ? 5 : 60
     end
 
-    def limit_interval
+    def limit_senec_interval
       minimum = case senec_adapter
                 when :local
                   # Be careful with your local SENEC device, do not flood it with queries.
@@ -97,7 +94,8 @@ def validate!
       end
 
       validate_influx_settings!
-      validate_interval!(senec_interval)
+      validate_senec_interval!
+      validate_senec_ignore!
     end
 
     def influx_url
@@ -118,6 +116,10 @@ def adapter
         end
     end
 
+    def excludes?(key)
+      senec_ignore.include?(key)
+    end
+
     attr_writer :logger
 
     def logger
@@ -130,8 +132,8 @@ def validate_senec_adapter!
       %i[local cloud].include?(senec_adapter) || throw("SENEC_ADAPTER is invalid: #{senec_adapter}")
     end
 
-    def validate_interval!(interval)
-      (interval.is_a?(Integer) && interval.positive?) || throw("SENEC_INTERVAL is invalid: #{interval}")
+    def validate_senec_interval!
+      (senec_interval.is_a?(Integer) && senec_interval.positive?) || throw("SENEC_INTERVAL is invalid: #{senec_interval}")
     end
 
     def validate_senec_credentials!
@@ -142,6 +144,12 @@ def validate_senec_credentials!
       senec_username.include?('@') || throw('SENEC_USERNAME is invalid')
     end
 
+    def validate_senec_ignore!
+      senec_ignore.all? do |key|
+        SolectrusRecord::KEYS.include?(key) || throw("SENEC_IGNORE contains unknown field: #{key}")
+      end
+    end
+
     def validate_influx_settings!
       %i[
         influx_schema
@@ -166,24 +174,9 @@ def validate_url!(url)
 
     def self.from_env(options = {})
       new(
-        {
-          senec_adapter: ENV.fetch('SENEC_ADAPTER', nil),
-          senec_host: ENV.fetch('SENEC_HOST', nil),
-          senec_schema: ENV.fetch('SENEC_SCHEMA', nil),
-          senec_interval: ENV.fetch('SENEC_INTERVAL', nil),
-          senec_language: ENV.fetch('SENEC_LANGUAGE', nil),
-          senec_username: ENV.fetch('SENEC_USERNAME', nil),
-          senec_password: ENV.fetch('SENEC_PASSWORD', nil),
-          senec_token: ENV.fetch('SENEC_TOKEN', nil),
-          senec_system_id: ENV.fetch('SENEC_SYSTEM_ID', nil),
-          influx_host: ENV.fetch('INFLUX_HOST'),
-          influx_schema: ENV.fetch('INFLUX_SCHEMA', nil),
-          influx_port: ENV.fetch('INFLUX_PORT', nil),
-          influx_token: ENV.fetch('INFLUX_TOKEN'),
-          influx_org: ENV.fetch('INFLUX_ORG'),
-          influx_bucket: ENV.fetch('INFLUX_BUCKET', nil),
-          influx_measurement: ENV.fetch('INFLUX_MEASUREMENT', nil),
-        }.merge(options),
+        KEYS.to_h do |key|
+          [key, ENV.fetch(key.to_s.upcase, nil)]
+        end.merge(options),
       )
     end
   end