sunnycarcharger-agent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 300f7e97fe554caf8db90f6c9cb4f428ffbff5648b5cd5b0dfee1da5fcd1bff6
+  data.tar.gz: 6ccfa0cbf5bd490af1905231fe0ccbdd3fa127a0a8053d6a6b93752478edf36c
+SHA512:
+  metadata.gz: 1a308ac0eb698c3f9bf2453ca259045816a9583303e2693a68f1972a615174ef1a1b46d3717442b1f17a631724e6441166870dc2882e632f29367de89ae691e0
+  data.tar.gz: ace0fe2c2323c3fa8b5030924b09041ce2d32e8ef2e12041e0649fff781aaf66513af66c27e515e1ed8a3f2457f37e502660b613b34352a72313b790798cc522

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Dr Nic Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Sunnycarcharger::Agent
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sunnycarcharger/agent`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sunnycarcharger-agent. 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/[USERNAME]/sunnycarcharger-agent/blob/develop/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sunnycarcharger::Agent project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sunnycarcharger-agent/blob/develop/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sunnycarcharger/agent"
+
+# 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.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/docker-buildx

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+cd $ROOT
+
+# On MacOS Docker Desktop turn on "Use containerd for pulling and storing images" experimental feature
+docker buildx build --platform linux/arm/v7,linux/arm64/v8,linux/amd64 -t drnic/sunnycarcharger-agent .

data/bin/docker-push

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+cd $ROOT
+
+docker push drnic/sunnycarcharger-agent

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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/exe/sunnycarcharger-agent

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require "sunnycarcharger/agent"
+
+puts "Fronius IP address: #{Config.fronius_ip}"
+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"
+  startup_errors = true
+end
+web_client = Sunnycarcharger::Agent::Web.new
+unless web_client.connected?
+  warn "ERROR: Web #{Config.web_url} could not be connected"
+  startup_errors = true
+end
+exit 1 if startup_errors
+
+# Loop and sleep for Config.refresh_interval minutes
+loop do
+  begin
+    invertor_data = fronius_client.fetch
+  rescue Faraday::ConnectionFailed, Errno::ECONNREFUSED
+    warn "ERROR: Fronius #{Config.fronius_ip} could not be connected"
+  end
+
+  begin
+    web_client.publish(invertor_data) if invertor_data
+  rescue Faraday::ConnectionFailed, Errno::ECONNREFUSED
+    warn "ERROR: Web #{Config.web_url} could not be connected"
+  end
+
+  sleep Config.refresh_interval.to_i * 60
+end

data/lib/sunnycarcharger/agent/config.rb

@@ -0,0 +1,19 @@
+require "anyway_config"
+
+class AgentConfig < Anyway::Config
+  config_name ""
+  attr_config web_url: "https://sunnycarcharger.com/"
+  attr_config :web_token
+
+  attr_config refresh_interval: 1 # minutes
+
+  attr_config :fronius_ip
+
+  extend_options do |parser, config|
+    parser.on_tail "-h", "--help" do
+      puts parser
+    end
+  end
+end
+
+Config = AgentConfig.new

data/lib/sunnycarcharger/agent/fronius.rb

@@ -0,0 +1,39 @@
+require "faraday"
+
+class Sunnycarcharger::Agent::Fronius
+  def initialize(ip: Config.fronius_ip)
+    raise ArgumentError, "Missing Fronius IP address" unless ip
+    @ip = ip
+  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
+    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
+  end
+
+  def connected?
+    fetch
+    true
+  rescue Faraday::ConnectionFailed, Errno::ECONNREFUSED
+    false
+  end
+end

data/lib/sunnycarcharger/agent/invertor_data.rb

@@ -0,0 +1,15 @@
+class Sunnycarcharger::Agent::InvertorData
+  attr_accessor :power_from_grid, :power_to_load, :power_from_solar
+
+  def power_to_grid
+    -power_from_grid
+  end
+
+  def as_json
+    {
+      power_from_grid: power_from_grid,
+      power_to_load: power_to_load,
+      power_from_solar: power_from_solar
+    }
+  end
+end

data/lib/sunnycarcharger/agent/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sunnycarcharger
+  module Agent
+    VERSION = "1.0.0"
+  end
+end

data/lib/sunnycarcharger/agent/web.rb

@@ -0,0 +1,41 @@
+require "faraday"
+
+class Sunnycarcharger::Agent::Web
+  def initialize(url: Config.web_url, token: Config.web_token)
+    raise ArgumentError, "Missing web token" unless token
+    @url = url
+    @token = token
+  end
+
+  def client
+    @client ||= Faraday.new(
+      @url,
+      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 = 2
+    end
+  end
+
+  def publish(invertor_data)
+    url = File.join(@url, "/api/v1/solar_charge_events")
+    data = {solar_charge_event: invertor_data}
+    client.post do |req|
+      req.url url
+      req.headers["Authorization"] = "token #{@token}"
+      req.body = data.to_json
+    end
+  end
+
+  def connected?
+    url = File.join(@url, "/api/v1/ping")
+    response = client.get(url)
+    response.status == 200
+  rescue Faraday::ConnectionFailed, Errno::ECONNREFUSED
+    false
+  end
+end

data/lib/sunnycarcharger/agent.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sunnycarcharger
+  module Agent
+  end
+end
+
+require_relative "agent/version"
+require_relative "agent/config"
+require_relative "agent/fronius"
+require_relative "agent/web"
+require_relative "agent/invertor_data"

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

@@ -0,0 +1,80 @@
+---
+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:
+      - '1124'
+      date:
+      - Sun, 09 Jul 2023 04:03:52 GMT
+      server:
+      - webserver
+    body:
+      encoding: UTF-8
+      string: |
+        {
+           "Body" : {
+              "Data" : {
+                 "Inverters" : {
+                    "1" : {
+                       "DT" : 102,
+                       "E_Day" : 20905,
+                       "E_Total" : 39760000,
+                       "E_Year" : 6499775.5,
+                       "P" : 2798
+                    },
+                    "2" : {
+                       "DT" : 102,
+                       "E_Day" : 17696,
+                       "E_Total" : 40577100,
+                       "E_Year" : 6406383.5,
+                       "P" : 3646
+                    }
+                 },
+                 "Site" : {
+                    "E_Day" : 38601,
+                    "E_Total" : 80337100,
+                    "E_Year" : 12906159,
+                    "Meter_Location" : "grid",
+                    "Mode" : "meter",
+                    "P_Akku" : null,
+                    "P_Grid" : -3599.85595703125,
+                    "P_Load" : -2844.14404296875,
+                    "P_PV" : 6444,
+                    "rel_Autonomy" : 100,
+                    "rel_SelfConsumption" : 44.136313515964467
+                 },
+                 "Version" : "12"
+              }
+           },
+           "Head" : {
+              "RequestArguments" : {},
+              "Status" : {
+                 "Code" : 0,
+                 "Reason" : "",
+                 "UserMessage" : ""
+              },
+              "Timestamp" : "2023-07-09T14:03:52+10:00"
+           }
+        }
+  recorded_at: Sun, 09 Jul 2023 04:03:53 GMT
+recorded_with: VCR 6.2.0

data/test/sunnycarcharger/agent/fronius_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+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)
+    VCR.use_cassette("fronius-midday") do
+      data = agent.fetch
+
+      assert_equal(-3599, data.power_from_grid.to_i)
+      assert_equal(3599, data.power_to_grid.to_i)
+      assert_equal(6444, data.power_from_solar.to_i)
+      assert_equal(2844, data.power_to_load.to_i)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "sunnycarcharger/agent"
+
+require "minitest/autorun"
+require "minitest/spec"
+require "vcr"
+
+VCR.configure do |config|
+  config.cassette_library_dir = "test/fixtures/vcr_cassettes"
+  config.hook_into :faraday
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sunnycarcharger-agent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dr Nic Williams
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run agent within home network to get solar invertor data and upload to
+  Sunny Car Charger.
+email:
+- drnicwilliams@gmail.com
+executables:
+- sunnycarcharger-agent
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/docker-buildx
+- bin/docker-push
+- bin/setup
+- exe/sunnycarcharger-agent
+- lib/sunnycarcharger/agent.rb
+- lib/sunnycarcharger/agent/config.rb
+- lib/sunnycarcharger/agent/fronius.rb
+- lib/sunnycarcharger/agent/invertor_data.rb
+- lib/sunnycarcharger/agent/version.rb
+- lib/sunnycarcharger/agent/web.rb
+- test/fixtures/vcr_cassettes/fronius-midday.yml
+- test/sunnycarcharger/agent/fronius_test.rb
+- test/test_helper.rb
+homepage: https://sunnycarcharger.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://sunnycarcharger.com
+  source_code_uri: https://sunnycarcharger.com
+  changelog_uri: https://sunnycarcharger.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
+summary: Run agent within home network to get solar invertor data and upload to Sunny
+  Car Charger.
+test_files: []