Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 3.47 KB

README.md

File metadata and controls

89 lines (63 loc) · 3.47 KB

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 way how to connect to portal and obtain data from unit as API.

Highlights

  • connect to portal, wait for login
  • provide basic data
    • temperature
    • fan power
    • power mode
  • allow change
    • power
    • mode

Installation

Add this line to your application's Gemfile:

gem "atrea_control"

And then execute:

bundle install

Or

bundle add atrea_control

Or install it yourself as:

gem install atrea_control

Usage

At the begin you need obtain user_id, unit_id and sid (auth token). For this use "Login"

  • user_id is atrea internal ID of user account
  • unit_id is atrea ident - identification number of airflow unit (ventilation system) - 10 digits
  • sid is session ID - auth token, valid for logged session. Its validity is unknown
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:

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 for more details !

This object is used to translate internal unit modes to user-friendly texts & translations.

I strong recommend to use AtreaControl::Duplex::UserCtrl object from "cache", for optimize network traffic - because they are static data.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/luk4s/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.

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.