sunnycarcharger-agent 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1521d41056f5682fc870c43ba5c1568be1085f2ccd90c0df1cf633f534e2821
-  data.tar.gz: 64f40fa8d301bcdf823358acadbd980b147e6ae46feeea6e8f1bad0a28fd659a
+  metadata.gz: e597967d1cfd8c1ee46871b7a305827914023f8beeb15e79b3a6aaf1b0682d1b
+  data.tar.gz: d59ea067d905fc3f28b5c25f330bf91351bd41574fd8eb8b3030799417633fb0
 SHA512:
-  metadata.gz: 4501815a3e3688f24006c82ac7de05875d136be46a26c4dd6717c325dd76fcc5af2cd329f50aa1c095ed457eaf0059b68eef7b9514893bd4066072013f127390
-  data.tar.gz: 421fa9325aebb37f67ebc331db771b7487722099c0b9c1bffd171ef3dd02498fa0281d8fd3c74c6bde6da17eb84163f6c5532ee5ca994d63d2e0910a35dc897a
+  metadata.gz: 71a65178b4a571925bed92ef6b3cc4b59a9804ae3e9dde69def469183a666c23535e417e6f33da634c33f817e1502199bc22089b1c0db3bd2aed0bc045dc56d8
+  data.tar.gz: 1b2a926d280593da53996986ed39d8e32c9b6a99393560321b9a1c3044b1990262afb016e31c5850b0382cbbb4929a70e173ec4d5dc1dbb72fd27a5a8b842a41

data/README.md

@@ -20,9 +20,13 @@ gem install sunnycarcharger-agent
 ## Usage
 
 ```plain
-FRONIUS_IP=192.168.1.2 WEB_TOKEN=<token from sunnycarcharger.com> sunnycarcharger-agent
+FRONIUS_IP=192.168.1.2:5757 WEB_TOKEN=<token from sunnycarcharger.com> sunnycarcharger-agent
+# or
+FRONIUS_IPS=192.168.1.2:5757,192.168.1.3:5757 WEB_TOKEN=<token from sunnycarcharger.com> sunnycarcharger-agent
 ```
 
+Use either `$FRONIUS_IPS` or `$FRONIUS_IP` to provide a comma separated list of IP address that the Fronius inverter might be available on. Include the `:port` if its not the default port of `80`.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/sunnycarcharger-agent

@@ -2,14 +2,16 @@
 
 require "sunnycarcharger/agent"
 
-puts "Fronius IP address: #{Config.fronius_ip}"
+puts "Fronius IP addresses: #{Config.fronius_ips.join(", ")}"
 puts "Web URL: #{Config.web_url}"
 
 startup_errors = false
 
 fronius_client = Sunnycarcharger::Agent::Fronius.new
 unless fronius_client.connected?
-  warn "ERROR: Fronius #{Config.fronius_ip} could not be connected"
+  Config.fronius_ips.each do |ip|
+    warn "ERROR: Fronius #{ip} could not be connected"
+  end
   startup_errors = true
 end
 web_client = Sunnycarcharger::Agent::Web.new
@@ -24,7 +26,9 @@ loop do
   begin
     invertor_data = fronius_client.fetch
   rescue Faraday::ConnectionFailed, Errno::ECONNREFUSED
-    warn "ERROR: Fronius #{Config.fronius_ip} could not be connected"
+    Config.fronius_ips.each do |ip|
+      warn "ERROR: Fronius #{ip} could not be connected"
+    end
   end
 
   begin

data/lib/sunnycarcharger/agent/config.rb

@@ -8,12 +8,23 @@ class AgentConfig < Anyway::Config
   attr_config refresh_interval: 1 # minutes
 
   attr_config :fronius_ip
+  attr_config fronius_ips: []
 
   extend_options do |parser, config|
     parser.on_tail "-h", "--help" do
       puts parser
     end
   end
+
+  on_load do
+    if fronius_ip
+      if fronius_ip.is_a?(Array)
+        self.fronius_ips = fronius_ip
+      elsif fronius_ip.is_a?(String)
+        self.fronius_ips = [fronius_ip]
+      end
+    end
+  end
 end
 
 Config = AgentConfig.new

data/lib/sunnycarcharger/agent/fronius.rb

@@ -1,36 +1,64 @@
 require "faraday"
 
 class Sunnycarcharger::Agent::Fronius
-  def initialize(ip: Config.fronius_ip)
-    raise ArgumentError, "Missing Fronius IP address" unless ip
-    @ip = ip
+  def initialize(ips: Config.fronius_ips)
+    raise ArgumentError, "Missing Fronius IP addresses" unless ips
+    @ips = ips
   end
 
   def client
-    @client ||= Faraday.new(
-      "http://" + @ip,
-      headers: {"User-Agent" => "sunnycarcharger-agent"}
-    ) do |conn|
-      conn.request :json
-      conn.response :json
-      conn.response :raise_error
-      # conn.request :retry, retry_options if retry_options # Must be registered after :raise_error
-      conn.adapter Faraday.default_adapter
-      conn.options.timeout = 1
+    @client ||= begin
+      successful_client = nil
+      @ips.find do |ip|
+        successful_client = Faraday.new(
+          "http://" + ip,
+          headers: {"User-Agent" => "sunnycarcharger-agent"}
+        ) do |conn|
+          conn.request :json
+          conn.response :json
+          conn.response :raise_error
+          # conn.request :retry, retry_options if retry_options # Must be registered after :raise_error
+          conn.adapter Faraday.default_adapter
+          conn.options.timeout = 3
+        end
+        true
+      rescue Faraday::ConnectionFailed, Errno::ECONNREFUSED
+        false
+      end
+      successful_client || raise("Could not connect to any of the provided Fronius IP addresses")
     end
   end
 
   def fetch
-    path = "/solar_api/v1/GetPowerFlowRealtimeData.fcgi"
-    response = client.get(path).body
     data = Sunnycarcharger::Agent::InvertorData.new
-    data.power_from_grid = response.dig("Body", "Data", "Site", "P_Grid").to_i
-    data.power_to_load = -1 * response.dig("Body", "Data", "Site", "P_Load").to_i
-    data.power_from_solar = response.dig("Body", "Data", "Site", "P_PV").to_i
-    data.solar_energy_today = response.dig("Body", "Data", "Site", "E_Day").to_i
+
+    response = client.get("/solar_api/v1/GetPowerFlowRealtimeData.fcgi").body
+    body = response.dig("Body", "Data", "Site")
+    data.power_from_grid = body.dig("P_Grid").to_i
+    data.power_to_load = -1 * body.dig("P_Load").to_i
+    data.power_from_solar = body.dig("P_PV").to_i
+    data.solar_energy_today = body.dig("E_Day").to_i
+
+    begin
+      response = client.get("/solar_api/v1/GetMeterRealtimeData.cgi?Scope=System").body
+      body = response.dig("Body", "Data", "0")
+      data.energy_consumed = body.dig("EnergyReal_WAC_Sum_Consumed").to_i
+      data.energy_produced = body.dig("EnergyReal_WAC_Sum_Produced").to_i
+      data.serial = body.dig("Details", "Serial")
+    rescue => e
+      puts "Error fetching energy_consumed and energy_produced: #{e}"
+    end
+
     data
   end
 
+  # {"Manufacturer"=>"Fronius", "Model"=>"CCS WattNode WND-3D-480-MB", "Serial"=>"123456"}
+  def inverter_details
+    response = client.get("/solar_api/v1/GetMeterRealtimeData.cgi?Scope=System").body
+    body = response.dig("Body", "Data", "0")
+    body.dig("Details")
+  end
+
   def connected?
     fetch
     true

data/lib/sunnycarcharger/agent/invertor_data.rb

@@ -1,5 +1,7 @@
 class Sunnycarcharger::Agent::InvertorData
+  attr_accessor :serial
   attr_accessor :power_from_grid, :power_to_load, :power_from_solar, :solar_energy_today
+  attr_accessor :energy_consumed, :energy_produced
 
   def power_to_grid
     -power_from_grid
@@ -7,10 +9,13 @@ class Sunnycarcharger::Agent::InvertorData
 
   def as_json
     {
+      serial: serial,
       power_from_grid: power_from_grid,
       power_to_load: power_to_load,
       power_from_solar: power_from_solar,
-      solar_energy_today: solar_energy_today
+      solar_energy_today: solar_energy_today,
+      energy_consumed: energy_consumed,
+      energy_produced: energy_produced
     }
   end
 end

data/lib/sunnycarcharger/agent/version.rb

@@ -2,6 +2,6 @@
 
 module Sunnycarcharger
   module Agent
-    VERSION = "1.0.2"
+    VERSION = "1.1.1"
   end
 end

data/test/fixtures/vcr_cassettes/fronius-midday.yml

@@ -77,4 +77,103 @@ http_interactions:
            }
         }
   recorded_at: Sun, 09 Jul 2023 04:03:53 GMT
+- request:
+    method: get
+    uri: http://192.168.86.26/solar_api/v1/GetMeterRealtimeData.cgi?Scope=System
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - sunnycarcharger-agent
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - application/json
+      cache-control:
+      - no-cache, no-store, must-revalidate
+      pragma:
+      - no-cache
+      expires:
+      - '0'
+      content-length:
+      - '2705'
+      date:
+      - Sun, 30 Jul 2023 12:16:43 GMT
+      server:
+      - webserver
+    body:
+      encoding: UTF-8
+      string: |
+        {
+           "Body" : {
+              "Data" : {
+                 "0" : {
+                    "Current_AC_Phase_1" : 0.18578459322452545,
+                    "Current_AC_Phase_2" : 2.0522370338439941,
+                    "Current_AC_Phase_3" : 0,
+                    "Current_AC_Sum" : 2.2380216270685196,
+                    "Details" : {
+                       "Manufacturer" : "Fronius",
+                       "Model" : "CCS WattNode WND-3D-480-MB",
+                       "Serial" : "745995"
+                    },
+                    "Enable" : 1,
+                    "EnergyReal_WAC_Minus_Absolute" : 49028617,
+                    "EnergyReal_WAC_Phase_1_Consumed" : 5359053,
+                    "EnergyReal_WAC_Phase_1_Produced" : 30984743,
+                    "EnergyReal_WAC_Phase_2_Consumed" : 18531328,
+                    "EnergyReal_WAC_Phase_2_Produced" : 21950501,
+                    "EnergyReal_WAC_Phase_3_Consumed" : 0,
+                    "EnergyReal_WAC_Phase_3_Produced" : 0,
+                    "EnergyReal_WAC_Plus_Absolute" : 19983755,
+                    "EnergyReal_WAC_Sum_Consumed" : 19983755,
+                    "EnergyReal_WAC_Sum_Produced" : 49028617,
+                    "Frequency_Phase_Average" : 50.03289794921875,
+                    "Meter_Location_Current" : 0,
+                    "PowerApparent_S_Phase_1" : 43.604618072509766,
+                    "PowerApparent_S_Phase_2" : 497.7763671875,
+                    "PowerApparent_S_Phase_3" : 0,
+                    "PowerApparent_S_Sum" : 541.3809814453125,
+                    "PowerFactor_Phase_1" : 0.76950681209564209,
+                    "PowerFactor_Phase_2" : 0.61130160093307495,
+                    "PowerFactor_Phase_3" : 1,
+                    "PowerFactor_Sum" : 0.62404400110244751,
+                    "PowerReactive_Q_Phase_1" : -14.466190338134766,
+                    "PowerReactive_Q_Phase_2" : -348.84356689453125,
+                    "PowerReactive_Q_Phase_3" : 0,
+                    "PowerReactive_Q_Sum" : -363.30975341796875,
+                    "PowerReal_P_Phase_1" : 33.554050445556641,
+                    "PowerReal_P_Phase_2" : 304.29147338867188,
+                    "PowerReal_P_Phase_3" : 0,
+                    "PowerReal_P_Sum" : 337.84555053710938,
+                    "TimeStamp" : 1690719403,
+                    "Visible" : 1,
+                    "Voltage_AC_PhaseToPhase_12" : 414.82183837890625,
+                    "Voltage_AC_PhaseToPhase_23" : 241.61917114257812,
+                    "Voltage_AC_PhaseToPhase_31" : 233.82379150390625,
+                    "Voltage_AC_Phase_1" : 234.70613098144531,
+                    "Voltage_AC_Phase_2" : 242.55319213867188,
+                    "Voltage_AC_Phase_3" : 0,
+                    "Voltage_AC_Phase_Average" : 238.62966918945312
+                 }
+              }
+           },
+           "Head" : {
+              "RequestArguments" : {
+                 "DeviceClass" : "Meter",
+                 "Scope" : "System"
+              },
+              "Status" : {
+                 "Code" : 0,
+                 "Reason" : "",
+                 "UserMessage" : ""
+              },
+              "Timestamp" : "2023-07-30T22:16:43+10:00"
+           }
+        }
+  recorded_at: Sun, 30 Jul 2023 12:16:44 GMT
 recorded_with: VCR 6.2.0

data/test/fixtures/vcr_cassettes/fronius-night.yml

@@ -0,0 +1,179 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://192.168.86.26/solar_api/v1/GetPowerFlowRealtimeData.fcgi
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - sunnycarcharger-agent
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - application/json
+      cache-control:
+      - no-cache, no-store, must-revalidate
+      pragma:
+      - no-cache
+      expires:
+      - '0'
+      content-length:
+      - '1105'
+      date:
+      - Sun, 30 Jul 2023 12:16:42 GMT
+      server:
+      - webserver
+    body:
+      encoding: UTF-8
+      string: |
+        {
+           "Body" : {
+              "Data" : {
+                 "Inverters" : {
+                    "1" : {
+                       "DT" : 102,
+                       "E_Day" : 34470,
+                       "E_Total" : 40344200,
+                       "E_Year" : 7083963.5,
+                       "P" : 0
+                    },
+                    "2" : {
+                       "DT" : 102,
+                       "E_Day" : 27664,
+                       "E_Total" : 41063300,
+                       "E_Year" : 6892509.5,
+                       "P" : 0
+                    }
+                 },
+                 "Site" : {
+                    "E_Day" : 62134,
+                    "E_Total" : 81407500,
+                    "E_Year" : 13976473,
+                    "Meter_Location" : "grid",
+                    "Mode" : "meter",
+                    "P_Akku" : null,
+                    "P_Grid" : 335.26931762695312,
+                    "P_Load" : -335.26931762695312,
+                    "P_PV" : null,
+                    "rel_Autonomy" : 0,
+                    "rel_SelfConsumption" : null
+                 },
+                 "Version" : "12"
+              }
+           },
+           "Head" : {
+              "RequestArguments" : {},
+              "Status" : {
+                 "Code" : 0,
+                 "Reason" : "",
+                 "UserMessage" : ""
+              },
+              "Timestamp" : "2023-07-30T22:16:42+10:00"
+           }
+        }
+  recorded_at: Sun, 30 Jul 2023 12:16:42 GMT
+- request:
+    method: get
+    uri: http://192.168.86.26/solar_api/v1/GetMeterRealtimeData.cgi?Scope=System
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - sunnycarcharger-agent
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - application/json
+      cache-control:
+      - no-cache, no-store, must-revalidate
+      pragma:
+      - no-cache
+      expires:
+      - '0'
+      content-length:
+      - '2705'
+      date:
+      - Sun, 30 Jul 2023 12:16:43 GMT
+      server:
+      - webserver
+    body:
+      encoding: UTF-8
+      string: |
+        {
+           "Body" : {
+              "Data" : {
+                 "0" : {
+                    "Current_AC_Phase_1" : 0.18578459322452545,
+                    "Current_AC_Phase_2" : 2.0522370338439941,
+                    "Current_AC_Phase_3" : 0,
+                    "Current_AC_Sum" : 2.2380216270685196,
+                    "Details" : {
+                       "Manufacturer" : "Fronius",
+                       "Model" : "CCS WattNode WND-3D-480-MB",
+                       "Serial" : "745995"
+                    },
+                    "Enable" : 1,
+                    "EnergyReal_WAC_Minus_Absolute" : 49028617,
+                    "EnergyReal_WAC_Phase_1_Consumed" : 5359053,
+                    "EnergyReal_WAC_Phase_1_Produced" : 30984743,
+                    "EnergyReal_WAC_Phase_2_Consumed" : 18531328,
+                    "EnergyReal_WAC_Phase_2_Produced" : 21950501,
+                    "EnergyReal_WAC_Phase_3_Consumed" : 0,
+                    "EnergyReal_WAC_Phase_3_Produced" : 0,
+                    "EnergyReal_WAC_Plus_Absolute" : 19983755,
+                    "EnergyReal_WAC_Sum_Consumed" : 19983755,
+                    "EnergyReal_WAC_Sum_Produced" : 49028617,
+                    "Frequency_Phase_Average" : 50.03289794921875,
+                    "Meter_Location_Current" : 0,
+                    "PowerApparent_S_Phase_1" : 43.604618072509766,
+                    "PowerApparent_S_Phase_2" : 497.7763671875,
+                    "PowerApparent_S_Phase_3" : 0,
+                    "PowerApparent_S_Sum" : 541.3809814453125,
+                    "PowerFactor_Phase_1" : 0.76950681209564209,
+                    "PowerFactor_Phase_2" : 0.61130160093307495,
+                    "PowerFactor_Phase_3" : 1,
+                    "PowerFactor_Sum" : 0.62404400110244751,
+                    "PowerReactive_Q_Phase_1" : -14.466190338134766,
+                    "PowerReactive_Q_Phase_2" : -348.84356689453125,
+                    "PowerReactive_Q_Phase_3" : 0,
+                    "PowerReactive_Q_Sum" : -363.30975341796875,
+                    "PowerReal_P_Phase_1" : 33.554050445556641,
+                    "PowerReal_P_Phase_2" : 304.29147338867188,
+                    "PowerReal_P_Phase_3" : 0,
+                    "PowerReal_P_Sum" : 337.84555053710938,
+                    "TimeStamp" : 1690719403,
+                    "Visible" : 1,
+                    "Voltage_AC_PhaseToPhase_12" : 414.82183837890625,
+                    "Voltage_AC_PhaseToPhase_23" : 241.61917114257812,
+                    "Voltage_AC_PhaseToPhase_31" : 233.82379150390625,
+                    "Voltage_AC_Phase_1" : 234.70613098144531,
+                    "Voltage_AC_Phase_2" : 242.55319213867188,
+                    "Voltage_AC_Phase_3" : 0,
+                    "Voltage_AC_Phase_Average" : 238.62966918945312
+                 }
+              }
+           },
+           "Head" : {
+              "RequestArguments" : {
+                 "DeviceClass" : "Meter",
+                 "Scope" : "System"
+              },
+              "Status" : {
+                 "Code" : 0,
+                 "Reason" : "",
+                 "UserMessage" : ""
+              },
+              "Timestamp" : "2023-07-30T22:16:43+10:00"
+           }
+        }
+  recorded_at: Sun, 30 Jul 2023 12:16:44 GMT
+recorded_with: VCR 6.2.0

data/test/sunnycarcharger/agent/fronius_test.rb

@@ -4,8 +4,8 @@ require "test_helper"
 
 describe Sunnycarcharger::Agent::Fronius do
   it "fetches from fronius" do
-    fronius_ip = "192.168.86.26"
-    agent = Sunnycarcharger::Agent::Fronius.new(ip: fronius_ip)
+    fronius_ips = ["192.168.86.26"]
+    agent = Sunnycarcharger::Agent::Fronius.new(ips: fronius_ips)
     VCR.use_cassette("fronius-midday") do
       data = agent.fetch
 
@@ -14,6 +14,25 @@ describe Sunnycarcharger::Agent::Fronius do
       assert_equal(6444, data.power_from_solar.to_i)
       assert_equal(2844, data.power_to_load.to_i)
       assert_equal(38601, data.solar_energy_today.to_i)
+      assert_equal("745995", data.serial)
+      assert data.energy_consumed
+      assert data.energy_produced
+    end
+  end
+
+  it "fetches from fronius at night" do
+    fronius_ips = ["192.168.86.26"]
+    agent = Sunnycarcharger::Agent::Fronius.new(ips: fronius_ips)
+    VCR.use_cassette("fronius-night") do
+      data = agent.fetch
+
+      assert_equal(335, data.power_from_grid.to_i)
+      assert_equal(0, data.power_from_solar.to_i)
+      assert_equal(335, data.power_to_load.to_i)
+      assert_equal(62134, data.solar_energy_today.to_i)
+      assert_equal("745995", data.serial)
+      assert data.energy_consumed
+      assert data.energy_produced
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sunnycarcharger-agent
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Dr Nic Williams
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-29 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -103,6 +103,7 @@ files:
 - lib/sunnycarcharger/agent/version.rb
 - lib/sunnycarcharger/agent/web.rb
 - test/fixtures/vcr_cassettes/fronius-midday.yml
+- test/fixtures/vcr_cassettes/fronius-night.yml
 - test/sunnycarcharger/agent/fronius_test.rb
 - test/test_helper.rb
 homepage: https://sunnycarcharger.com
@@ -128,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Run agent within home network to get solar invertor data and upload to Sunny