atrea_control 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88aee51ff62bb07d3020bb0a65f13361ae6c36055072da6dc09d80bf4c0b2aff
+  data.tar.gz: fd32eb80961e9355fc9bb9f9af1a9ed4b49072272b7e5142dbd5f1b17c2d4844
+SHA512:
+  metadata.gz: 03aeeac63edae08f4e6ed4f7a4316846015540d3c4d5439bbb914270c66e1bf897cc399f53eb2d7f2f884c6c176198b28ce4331b37572b0abeb895fa54de5c51
+  data.tar.gz: b9d55180b76bb447b6030f5b56cb1a617a07363ed9d239dea90264cacd450a18a7382ead94cb43de2c87fa447b02be2a0bceae3960354130ab6287a978142ec6

data/.github/workflows/main.yml

@@ -0,0 +1,17 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+        bundler-cache: true
+    - uses: browser-actions/setup-firefox@latest
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,12 @@
+/.idea
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rspec
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.rubocop_todo.yml

@@ -0,0 +1,69 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude`
+# on 2021-09-13 19:43:25 UTC using RuboCop version 1.20.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.gemspec'
+    - 'spec/atrea_control/duplex_spec.rb'
+
+# Offense count: 4
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 1
+# Configuration parameters: Max.
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/atrea_control/duplex_spec.rb'
+
+# Offense count: 2
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/atrea_control/duplex_spec.rb'
+
+# Offense count: 4
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/atrea_control/duplex_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/atrea_control.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'spec/atrea_control/duplex_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'spec/atrea_control/duplex_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/atrea_control/duplex.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2021-09-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at luk4s.pokorny@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in atrea_control.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.10"
+gem "rubocop", "~> 1.7", require: false
+gem "rubocop-rspec", "~> 2.4", require: false
+gem "simplecov", require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    atrea_control (1.0.0)
+      selenium-webdriver (~> 3.142)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    childprocess (3.0.0)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    selenium-webdriver (3.142.7)
+      childprocess (>= 0.5, < 4.0)
+      rubyzip (>= 1.2.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  atrea_control!
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.7)
+  rubocop-rspec (~> 2.4)
+  simplecov
+
+BUNDLED WITH
+   2.2.17

data/README.md

@@ -0,0 +1,65 @@
+# atrea_control
+Ventilation systems by https://www.atrea.eu are build with web UI portal - but this portal did not provide any API interface...
+
+This gem provide simple DSL by parsing content of https://control.atrea.eu with selenium webdriver.
+
+## Highlights
+
+* connect to portal, wait for login
+* provide basic data
+  * temperature
+  * fan power
+  * power mode
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'atrea_control'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install atrea_control
+
+## Usage
+
+UI map of sensors is required = each box have own ID contains sensor ID. Its required for correct element lookup.
+
+Default sensor map:
+```ruby
+def default_sensors_map
+  {
+    outdoor_temperature: "I10208",
+    current_power: "H10704",
+    current_mode: "H10705",
+  }
+end
+```
+Example usage:
+```ruby
+control = AtreaControl::Duplex.new login: "myhome", password: "sup3r-S3CR3T-kocicka", sensors_map: { current_power: "H10704" }
+control.login # => true (takes max 5.minutes)
+control.current_mode # => "Bathroom"
+control.current_power # => 37.0
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/atrea_control. 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/luk4s/atrea_control/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the AtreaControl project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/luk4s/atrea_control/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/atrea_control.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/atrea_control/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "atrea_control"
+  spec.version       = AtreaControl::VERSION
+  spec.authors       = ["Lukáš Pokorný"]
+  spec.email         = ["pokorny@luk4s.cz"]
+
+  spec.summary       = "Get data control.atrea.eu"
+  spec.description   = "Read data from web controller of RD5 duplex by Atrea."
+  spec.homepage      = "https://github.com/luk4s/atrea_control"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.2")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/luk4s/atrea_control"
+  spec.metadata["changelog_uri"] = "https://github.com/luk4s/atrea_control/CHANGELOG.md"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_dependency "selenium-webdriver", "~> 3.142"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "atrea_control"
+
+# 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

@@ -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/lib/atrea_control/duplex.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "logger"
+require "selenium-webdriver"
+
+module AtreaControl
+  # Controller for +control.atrea.eu+
+  class Duplex
+    CONTROL_URI = "https://control.atrea.eu/"
+
+    attr_reader :driver
+
+    # @param [String] login
+    # @param [String] password
+    # @param [Hash] sensors_map which box is related to sensor ID
+    # @option sensors_map [String] :outdoor_temperature
+    # @option sensors_map [String] :current_power
+    # @option sensors_map [String] :current_mode
+    def initialize(login:, password:, sensors_map: Config.default_sensors_map)
+      @logged = false
+      @login = login
+      @password = password
+      @sensors = sensors_map
+
+      options = Selenium::WebDriver::Firefox::Options.new
+      options.headless! unless ENV["NO_HEADLESS"]
+      @driver = Selenium::WebDriver.for :firefox, options: options
+    end
+
+    def logged?
+      @logged
+    end
+
+    # Login into control
+    def login
+      driver.get CONTROL_URI
+      form = driver.find_element(id: "loginFrm")
+      username = form.find_element(name: "username")
+      username.send_keys @login
+      password = form.find_element(name: "password")
+      password.send_keys @password
+
+      submit = form.find_element(css: "input[type=submit]")
+      submit.click
+      finish_login
+      inspect
+    end
+
+    # Retrieve dashboard URI from object tag and open it again
+    def open_dashboard
+      uri = driver.find_element(tag_name: "object").attribute "data"
+      driver.get uri
+      logger.debug "#{name} login success"
+      @logged = true
+    end
+
+    # @return [String]
+    def name
+      return unless logged?
+
+      container = driver.find_element css: "div#pageTitle > h2"
+      container.text
+    end
+
+    def unit_id
+      return unless logged?
+
+      element = driver.find_element css: "div#pageTitle > a"
+      element.attribute(:href) =~ /unit=(\d+)/
+      Regexp.last_match(1)
+    end
+
+    # @return [Float]
+    def outdoor_temperature
+      return unless logged?
+
+      element = sensor_element(@sensors[__method__])
+      element.find_element(css: "div").text.to_f
+    end
+
+    # @return [Float] in %
+    def current_power
+      return unless logged?
+
+      # element = driver.find_element id: "contentBox#{@sensors[__method__]}"
+      element = sensor_element(@sensors[__method__])
+      element.find_element(css: "div:first-child").text.to_f
+    end
+
+    # @return [String]
+    def current_mode
+      return unless logged?
+
+      element = sensor_element(@sensors[__method__])
+      element.find_element(css: "div:first-child").text
+    end
+
+    def inspect
+      "<AtreaControl name: '#{name}' outdoor_temperature: #{outdoor_temperature}°C current_power: #{current_power}% current_mode: '#{current_mode}>'"
+    end
+
+    def close
+      @logged = false
+      driver.quit
+    end
+
+    private
+
+    def logger
+      @logger ||= ::Logger.new($stdout)
+    end
+
+    def sensor_element(sensor_id)
+      driver.find_element id: "contentBox#{sensor_id}"
+    end
+
+    def finish_login
+      8.times do |i|
+        return true if open_dashboard
+      rescue Selenium::WebDriver::Error::NoSuchElementError => _e
+        t = 5 * (1 + i)
+        logger.debug "waiting #{t}s for login..."
+        sleep t
+      end
+      raise Error, "unable to login"
+    end
+  end
+end

data/lib/atrea_control/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AtreaControl
+  VERSION = "1.0.0"
+end

data/lib/atrea_control.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "atrea_control/version"
+
+module AtreaControl
+  class Error < StandardError; end
+
+  autoload :Duplex, "atrea_control/duplex"
+
+  # Provide map sensor to element ID
+  module Config
+    module_function
+
+    def default_sensors_map
+      {
+        outdoor_temperature: "I10208",
+        current_power: "H10704",
+        current_mode: "H10705",
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: atrea_control
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lukáš Pokorný
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.142'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.142'
+description: Read data from web controller of RD5 duplex by Atrea.
+email:
+- pokorny@luk4s.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- atrea_control.gemspec
+- bin/console
+- bin/setup
+- lib/atrea_control.rb
+- lib/atrea_control/duplex.rb
+- lib/atrea_control/version.rb
+homepage: https://github.com/luk4s/atrea_control
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/luk4s/atrea_control
+  source_code_uri: https://github.com/luk4s/atrea_control
+  changelog_uri: https://github.com/luk4s/atrea_control/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Get data control.atrea.eu
+test_files: []