atrea_control 1.3.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a5ccc9d8596b46a4ec4c2eb98e26b820c62bfdbf91c8c1b732adc9f858f31bf
-  data.tar.gz: bac1c0183608fe7f16c679578203fba54c10d8e2270be7d0bf68fb1f17d7cce4
+  metadata.gz: 7d02f9e12d50a1306027858699f71f71435f5f9bd393eb20e157b649ad7111ee
+  data.tar.gz: ef9a19f18361713356cd28d5a6ecd5ff634fd82e703bf9073fba9d2763703dcc
 SHA512:
-  metadata.gz: 657e441b8aa3ecfaa5eb8905ff6e22064d70d43984156bd15c6b7dfc17f6ed92e1a7c8318cd7febeb2ce68c621ff06f69561cd8861b642f2313f4421df098597
-  data.tar.gz: 97dcc1fa4810f952e4b89d2f610c93a2359debb663b0138f8bf3d5771ca9e4ddfb96be2d9c8e0a0a2a2667f1daa4533606704adfc9a89571a4d0852800cf7bf1
+  metadata.gz: 807dc186b9810f869df2f9c6ad40b9f15fbbb33a85bfcea73a634a396b15a12e9e7060da2d2e76380789158280ee95313303a5f8b6c2e811b58a242fa3d9f950
+  data.tar.gz: 55a2c020ad45023c840a5f1734146dc4159849fdc667f91d9dc6c16d16359554dcd374e76be95bfa8852fcf3e1435ed20ea838a507e15ff5b50fd811b7814fd2

data/.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.2
+        ruby-version: 2.7
         bundler-cache: true
     - uses: browser-actions/setup-firefox@latest
     - name: Run tests

data/CHANGELOG.md

@@ -1,4 +1,28 @@
 ## [Unreleased]
+## [2.0.1] - 2021-12-26
+### Fixed
+- write correct arguments
+
+## [2.0.0] - 2021-12-26
+### Changed
+- refactored codebase to more readable classes
+- selenium used only for login and then close => obtain SID (and user with unit)
+- login waiting mechanism
+### Added
+- found way how to change mode & power (tell unit to change)
+
+## [1.4.1] - 2021-12-18
+### Changed
+- little refactor
+
+## [1.4.0] - 2021-12-12
+### Changed
+- founded way to get config and data from Atrea server
+
+## [1.3.1] - 2021-12-11
+### Changed
+- version of selenium
+
 ## [1.3.0] - 2021-12-11
 ### Changed
 - store auth tokens outside

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    atrea_control (1.3.0)
+    atrea_control (2.0.1)
+      i18n (~> 1.8)
       nokogiri (~> 1.12)
       rest-client (~> 2.1)
-      selenium-webdriver (~> 3.142)
+      selenium-webdriver (~> 4.1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,11 +13,12 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    childprocess (3.0.0)
+    childprocess (4.1.0)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
@@ -24,6 +26,8 @@ GEM
     http-accept (1.7.0)
     http-cookie (1.0.4)
       domain_name (~> 0.5)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
@@ -31,8 +35,10 @@ GEM
     netrc (0.11.0)
     nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -41,7 +47,7 @@ GEM
     racc (1.6.0)
     rainbow (3.0.0)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
@@ -60,24 +66,25 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.22.2)
+    rspec-support (3.10.3)
+    rubocop (1.24.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.12.0, < 2.0)
+      rubocop-ast (>= 1.15.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
+    rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
-    rubocop-rspec (2.5.0)
+    rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     rubyzip (2.3.2)
-    selenium-webdriver (3.142.7)
-      childprocess (>= 0.5, < 4.0)
+    selenium-webdriver (4.1.0)
+      childprocess (>= 0.5, < 5.0)
+      rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2)
     simplecov (0.21.2)
       docile (~> 1.1)

data/README.md

@@ -10,7 +10,9 @@ This gem provide simple DSL by parsing content of https://control.atrea.eu with
   * temperature
   * fan power
   * power mode
-
+* allow change
+  * power
+  * mode
 
 ## Installation
 
@@ -30,27 +32,59 @@ Or install it yourself as:
 
 ## Usage
 
-UI map of sensors is required = each box have own ID contains sensor ID. Its required for correct element lookup.
-
-Default sensor map:
+At the begin you need obtain `user_id`, `unit_id` and `sid` (auth token). For this use "Login"
 ```ruby
-def default_sensors_map
-  {
-    outdoor_temperature: "I10208",
-    current_power: "H10704",
-    current_mode: "H10705",
-  }
-end
+tokens = AtreaControl::Duplex::Login.user_tokens login: "myhome", password: "sup3r-S3CR3T-kocicka"
+tokens # => { user_id: "1234", unit_id: "85425324672", sid: 4012 }
 ```
+I recommend to store then somewhere... 
+Then you can call Unit for data...
+
 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
+control = AtreaControl::Duplex::Unit.new user_id: "1234", unit_id: "85425324672", sid: 4012
+control.values # => { current_power: 88.0, current_mode: "CO2" }
+control.power # => 88.0 
+```
+### Dig deeper
+`AtreaControl::Duplex::Unit` expect optional argument `user_ctrl` which should be object respond to 
+
+`name` (String) = Name of unit
+`sensors` (Hash) = Map of sensors, for example: `{ outdoor_temperature: "HI10208", current_power: "H10704" }`
+`modes` (Hash) = Is a map of "changable" modes - in unit its something like "builtin?" modes. They are translated by unit lang - `{ "0" => "Vypnuto", "1" => "Automat" }` 
+`user_modes` (Hash) = Is a map user specific modes, based on home switches / devices (D1, D2, D3, IN1, IN2 ...). They are translated by user texts - `{ "D1" => "Koupelna", "D2" => "CO2", "IN1" => "ovladač" }`
+
+__Please check [lib/atrea_control/duplex/user_ctrl.rb](./lib/atrea_control/duplex/user_ctrl.rb) for more details !__
+
+## Development / TODO
+Login is currently done by selenium - fill login form. 
+I found that Atre submit form to BE, generate some "empty" HTML and JS which onLoad start doing request to queue for "login".
+
+Re-login user, add login procedure into queue:
+```bash
+curl -X POST -d "comm=config%2Flogin.cgi" "https://control.atrea.eu/apps/rd5Control/handle.php?action=unitLogin&user=XXXX&unit=NNNNNNN&table=userUnits&idPwd=YYYYYYY&NFP"
+```
+Response is time in seconds when login will ready:
+```xml
+<root><sended time="264"/></root>
+```
+Based it su shown countdown ...
+
+
+Request for current queue status
+```bash
+curl 'https://control.atrea.eu/apps/rd5Control/handle.php?Sync=1&action=unitQuery&query=loged&user=XXXX&unit=NNNNNNN'
+```
+if queue is processed:
+```xml
+<root><login uconn="16395889" sid="010101" ver="3001009"/></root>
+```
+else
+```xml
+<root><login uconn="16390480" sid="0"/></root>
 ```
 
-## Development
+Goal is to obtain "SID".
 
 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.
 

data/atrea_control.gemspec

@@ -3,14 +3,14 @@
 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.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"
@@ -18,14 +18,16 @@ Gem::Specification.new do |spec|
   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"
-
+  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{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  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
@@ -34,7 +36,9 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 
+  spec.add_dependency "i18n", "~> 1.8"
   spec.add_dependency "nokogiri", "~> 1.12"
   spec.add_dependency "rest-client", "~> 2.1"
-  spec.add_dependency "selenium-webdriver", "~> 3.142"
+  spec.add_dependency "selenium-webdriver", "~> 4.1"
+
 end

data/config/locales/cs.yml

@@ -0,0 +1,269 @@
+---
+cs:
+  mainTitle: Váš specialista na rekuperaci tepla a ekonomii vzduchotechnických systémů
+  save: Uložit
+  cancel: Storno
+  copy: Kopírovat
+  refresh: Obnovit
+  change: Změnit
+  pleaseWait: Prosím, čekejte ...
+  backToHome: Návrat na hlavní stranu
+  mainPage: Hlavní strana
+  serviceMenu: Servisní menu
+  activeFrom: Aktivní od
+  hours: Hodiny
+  minutes: Minuty
+  record: Záznam
+  allowed: Povoleno
+  netSetup: Nastavení sítě
+  getFromDHCP: Načíst hodnoty ze serveru DHCP
+  useNextValues: Použít následující hodnoty
+  addressIP: IP adresa
+  subnetMask: Maska podsítě
+  defaultGW: Výchozí brána
+  serverDNS: DNS server
+  FTPsetup: Nastavení hesla FTP serveru
+  passwordOld: Původní heslo
+  passwordNew: Nové heslo
+  passwordConfirm: Potvrzení nového hesla
+  airCond: Vzduchotechnika
+  airCondSetup: Nastavení vzduchotechniky
+  temperature: Teplota
+  tempSetup: Nastavení teploty
+  notInDemo: V demo verzi není podporováno
+  thisTimeExist: Zadaný čas již existuje
+  serviceSetup: Servisní nastavení
+  activeAlarms: Aktivní alarmy
+  alarmHistory: Historie alarmů
+  unitStarted: Start jednotky
+  active: Aktivní
+  noAlarmDefined: Není definován žádný alarm
+  noAlarmDetected: Není detekován žádný alarm
+  values: Hodnoty
+  parameters: Parametry
+  badInput: Chybné zadání
+  allowedRange: Povolený rozsah
+  start: Start
+  stop: Stop
+  text: Text
+  digiVer: Verze DIGI modulu
+  rdVer: Verze RD modulu
+  unitAddress: Adresa jednotky
+  currentMode: Aktuální mód provozu
+  damageWarning: Pozor nastavením těchto parametrů lze způsobit neadekvátní reakci
+    větrací jednotky, což může zapříčinit její poruchu či poškození. Za neuvážené
+    změny v nastavení výstupů nenese výrobce zařízení žádnou zodpovědnost!
+  parameter: Parametr
+  value: Hodnota
+  minimum: Minimum
+  maximum: Maximum
+  defValue: Výchozí hodnota
+  warning: Varování
+  error: Nastav
+  accessPrompt: Kontrola přístupu, zadejte přístupový kód
+  accessDenied: Přístup odepřen, chybný kód nebo příliš mnoho přihlášených!
+  swVer: Verze software
+  orderNum: Číslo zakázky
+  userSetup: Uživatelské nastavení
+  switchman: Manuál
+  valueOutOfRange: Hodnota leží mimo rozsah
+  fwStep1: Krok 1. - Uložení nastavení
+  fwStep2: Krok 2. - Update firmware
+  fwSTep3: Krok 3. - Obnova nastavení
+  saveSettings: Uložit nastavení
+  updateIt: Provést update
+  restoreSettings: Obnovit nastavení
+  parsNotSaved: Parametry nebyly dosud uloženy
+  errLengthCoo: Chyba dat, použijte jiný prohlížeč
+  parsSaved: Parametry uloženy
+  updateInProcess: Probíhá update, prosím čekejte
+  updateNoFile: Nebyl nalezen žádný soubor pro update
+  updateSucess: UPDATE dokončen
+  updateError: Chyba při updatu
+  manControlOn: Ruční řízení povoleno
+  manControlOff: Ruční řízení neaktivní
+  notConnected: Nepřipojeno
+  PgFW_FS1: Obnova/Záloha nastavení
+  PgFW_S1: Provedení zálohy servisního nastavení
+  PgFW_SB1: Zálohovat
+  PgFW_S2: Obnova servisního nastavení ze zálohy
+  PgFW_SB2: Obnovit
+  PgFW_S3: Obnova nastavení do výrobních hodnot
+  PgFW_SB3: Obnovit
+  PgFW_FS2: Update
+  PgFW_U2: Stažení aplikace pro update
+  PgFW_UB1: Otevřít
+  PgFW_SB1c: 'Přejete si vytvořit zálohu servisního nastavení? '
+  PgFW_SB2c: Opravdu si přejete obnovit servisní nastavení ze zálohy?
+  PgFW_SB3c: Opravdu si přejete obnovit výrobní nastavení?
+  fwUnit: FW Jednotky
+  fwAvail: Dostupný FW
+  restInProgress: Probíhá obnova nastavení
+  restart: Restart
+  activate: Aktivovat
+  deactivate: Deaktivovat
+  badTimeZone: Nesprávné časové pásmo
+  badTime: Nesprávné nastavení času
+  setByPC: Nastavit podle PC
+  msgFindAddr: Zadejte novou adresu jednotky.
+  dtFilterChange: Datum výměny filtru
+  confirmFilter: Potvrdit výměnu
+  confFilterQuest: Opravdu byl filtr vyměněn?
+  'off': Vypnuto
+  'on': Zapnuto
+  dayOfWeek: Den v týdnu
+  monday: Pondělí
+  tuesday: Úterý
+  wednesday: Středa
+  thursday: Čtvrtek
+  friday: Pátek
+  saturday: Sobota
+  sunday: Neděle
+  medium: Střední
+  night: Noc
+  day: Den
+  power: Výkon
+  automatic: Týdenní program
+  manual: Ruční
+  temporary: Dočasné
+  non: Není
+  mode: Režim
+  perVentilation: Periodické větrání
+  ventilation: Větrání
+  circulation: Cirkulace
+  startUp: Náběh
+  runDown: Doběh
+  defrosting: Odtávání rekuperátoru
+  external: Externě
+  inactive: Vypnuto
+  zone: Zóna
+  heating: Topná
+  nonHeating: Netopná
+  dateTime: Datum a čas
+  filterChange: Výměna filtru
+  notWhenAuto: Řízení teploty je nastaveno na automatiku, změna je platná pouze do
+    příští změny režimu.
+  heatingSched: Rozvrh topná sezóna
+  nonHeatingSched: Rozvrh netopná sezóna
+  userSetting: Uživatelské nastavení
+  season: Sezóna
+  modeAC: Režim VZT
+  modeTemp: Režim teploty
+  controlSetting: Nastavení regulace
+  tempSenzorDev: Korekce čidla teploty ovladače
+  inputBlock: Blokování vstupu
+  personsCount: Počet osob
+  thermostatFcn: Funkce termostatu
+  holidayParty: Dovolená / párty
+  texts: Texty
+  txtZone1: Text pro zónu 1
+  txtZone2: Text pro zónu 2
+  txtZone12: Text pro zónu 1 2
+  swInfo: Informace o SW
+  alarms: Alarmy
+  controlAC: Řízení VZT
+  controlTemp: Řízení teploty
+  currentPower: Aktuální výkon
+  requiredPower: Požadovaný výkon
+  requiredTemp: Požadovaná teplota
+  requiredMode: Požadovaný režim
+  indoorTemp: Vnitřní teplota
+  inletTemp: Teplota přívodu
+  czech: Česky
+  german: Německy
+  english: Anglicky
+  eqVent: Rovnotlaké větrání
+  ventCirc: Větrání s cirkulací
+  circDepend: Cirkulace závislá
+  overPrVent: Přetlakové větrání
+  devHeating: Odchylka pro topení
+  devCooling: Odchylka pro chlazení
+  devCoolMax: Odchylka pro chlazení na max.
+  productNumber: Výrobní číslo
+  unitType: Typ jednotky
+  polish: Polsky
+  bySens: Auto - větrání
+  hpDefrosting: Odmražení TČ
+  userLogin: Přihlášení uživatele
+  passwordInput: Zadejte heslo
+  loginCmd: Přihlásit
+  weeklyProgram: Týdenní program
+  italiano: Italsky
+  nightBefCool: Noční předchlazení
+  passwordMenu: Změna hesla
+  enterAllFields: Zadejte všechny údaje!
+  passwordNoChk: Nové heslo a jeho potvrzeni se neshoduje!
+  passwordBad: Heslo může obsahovat pouze znaky a-z, A-Z a číslice!
+  passwordSaved: Heslo bylo uloženo.
+  passwordSaveErr: Chyba při ukládání hesla.
+  unavail: Nedostupná
+  disabledRange: Nepovolený rozsah
+  emergMode: Nouzový režim
+  outdoorTemp: Venkovní teplota
+  currentZone: Aktuální zóna
+  components: Komponenty
+  all: Vše
+  modeAuto: Automat
+  disbalance: Rozvážení
+  saveActive: Uložit / Aktivovat
+  holidays: Svátky
+  vacations: Prázdniny
+  unitDesign: Provedení
+  unitSpec: Specifikace
+  partyStart: Spustit v
+  partyEnd: Ukončit v
+  tsNtsSwitch: Přepnutí TS/NTS
+  tsNtsTemp: Teplota TS/NTS
+  in1Block: Blokace cidla IN1
+  in2Block: Blokace cidla IN2
+  hystHeat: Hystereze topení
+  hystCool: Hystereze chlazení
+  set: Nastavit
+  timeZone: Časové pásmo
+  settingTZ: Nastavení časového pásma
+  producer: Výrobce
+  unitLine: Řada
+  unitSize: Velikost jednotky
+  unitIntDesign: Vnitřní uspořádání
+  currentConfig: Aktuální nastavení
+  monthName1: Leden
+  monthName2: Únor
+  monthName3: Březen
+  monthName4: Duben
+  monthName5: Květen
+  monthName6: Červen
+  monthName7: Červenec
+  monthName8: Srpen
+  monthName9: Září
+  monthName10: Říjen
+  monthName11: Listopad
+  monthName12: Prosinec
+  holidayTip: Svátek / Prázdniny
+  prodCodeInput: Zadejte kód výrobce
+  logType: Typ logu
+  current: Aktuální
+  week: Týden
+  month: Měsíc
+  selectDay: Vyberte den
+  show: Zobrazit
+  dataNotFound: Data nenalezena
+  logLive: On-line
+  holidayVacation: Svátky a prázdniny
+  timeAutoSwitch: Automatické přepnutí na letní čas
+  timeSyncInet: Synchronizace času s Internetem
+  unitTime: Čas jednotky
+  inputs: Vstupy
+  outputs: Výstupy
+  others: Ostatní
+  heatIconTip: Aktivní topení
+  coolIconTip: Aktivní chlazení
+  partyIconTip: Aktivní režim Párty/Dovolená
+  alarmIconTip: Aktivní alarm
+  PgFW_S2A: Záloha z
+  reset: Reset
+  commun: Komunikace
+  serverPing: Služba "Connect server"
+  acsService: Přístup servisu
+  acsDistr: Přístup distributora
+  lastCommun: Poslední komunikace
+  unitName: Jméno jednotky