netatmo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5afa0ba31f1da59d10c3b91a68679e21abef496ee5cd34ca0e235f5db43f948d
+  data.tar.gz: 572df5b1e1fced24e36023d4cf9a210ce057df459942917193dad8331c32bc0c
+SHA512:
+  metadata.gz: f762ee09437e403a2ec4737a31f933c8c8980b3db8d167383b552f26b6ad26db083565ac1f697b60b7db65a8a7740445f7d12875123df0df7943c9d0f670b4b3
+  data.tar.gz: 3a1cb2e6420c2b2ba96428d1064f8f3354d77405a88b6452dfcf45a5358bdebf778048a1acf9fbf39c96677b959622b8ce43321b461e46152cb1b2899afb309c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Marco Roth
+
+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,169 @@
+# Netatmo
+
+Ruby API Wrapper for the [Netatmo API](https://dev.netatmo.com/apidocumentation/).
+
+![Build Status](https://github.com/marcoroth/netatmo-ruby/workflows/Build/badge.svg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'netatmo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install netatmo
+
+## Usage
+
+### Environment variables
+
+| Name                      | Description            |
+|---------------------------|------------------------|
+| `NETATMO_CLIENT_ID`       | Your app client_id     |
+| `NETATMO_CLIENT_SECRET`   | Your app client_secret |
+| `NETATMO_CLIENT_USERNAME` | User address email     |
+| `NETATMO_CLIENT_PASSWORD` | User password          |
+
+### Creating a client
+
+To create a Netatmo client you can either set the required environment variables or pass the credentials via a config block to the initialize method.
+
+```ruby
+# if you configured the required ENV variables
+client = Netatmo::Client.new
+
+# or if you want to provide the required credentials
+client = Netatmo::Client.new do |config|
+  config.client_id = '10acb39bc818e5789'
+  config.client_secret = '10dsfxyzbkzva'
+  config.username = 'user@email.address'
+  config.password = 'UserPassword'
+end
+
+```
+
+### Endpoint `/getstationdata`
+
+`get_station_data` Returns all weather stations you have read access to.
+
+```ruby
+station_data = client.get_station_data
+# => #<Netatmo::Weather::StationData @devices=[...] @user=#<Netatmo::User> ...>
+
+```
+
+#### Devices
+
+You can access the base stations in the `devices` array.
+
+```ruby
+station_data.devices
+
+# => [
+#      #<Netatmo::Weather::BaseStation @id="00:11:22:00:11:22", @modules=[...] ...>,
+#      #<Netatmo::Weather::BaseStation @id="12:23:34:45:56:67", @modules=[...] ...>
+#    ]
+
+```
+
+
+
+```ruby
+base_station = station_data.devices.first
+# => #<Netatmo::Weather::BaseStation @id="00:11:22:00:11:22", @code="NAMain", @data_types=["Temperature", "CO2", "Humidity", "Noise", "Pressure"], @modules=[...]>
+
+```
+
+#### Modules
+
+All to this base station connected modules are accessible in the `modules` array.
+
+```ruby
+base_station.modules
+# => [
+#      #<Netatmo::Weather::OutdoorModule @code="NAModule1", @data_types=["Temperature", "Humidity"], ...>,
+#      #<Netatmo::Weather::WindGauge @code="NAModule2", @data_types=["Wind"], ...>,
+#      #<Netatmo::Weather::IndoorModule @code="NAModule4", @data_types=["Temperature", "CO2", "Humidity"], ...>,
+#      #<Netatmo::Weather::RainGauge @code="NAModule3", @data_types=["Rain"], ...>
+#    ]
+```
+
+```ruby
+outdoor = base_station.modules.first
+
+# =>  #<Netatmo::Weather::OutdoorModule
+#       @id="11:22:33:44:55:66",
+#       @code="NAModule1",
+#       @data_types=["Temperature", "Humidity"],
+#       @module_name="Module",
+#       @reachable=true,
+#       @firmware=44,
+#       @last_setup=2014-12-24 21:57:28 +0100,
+#       @last_message=2020-02-11 10:49:33 +0100,
+#       @last_seen=2020-02-11 10:49:27 +0100,
+#       @rf_status=66,
+#       @battery_vp=5440,
+#       @battery_percent=77,
+#       @battery_status=#<Netatmo::BatteryStatus::OutdoorBatteryStatus @value=5440>,
+#       @humidity=#<Netatmo::DashboardData::Humidity @time=2020-02-11 10:48:36 +0100, @value=62.0, @unit="%">,
+#       @temperature=#<Netatmo::DashboardData::Temperature @time=2020-02-11 10:48:36 +0100, @value=13.6, @min=7.6,
+#       @max=13.6, @min_date=2020-02-11 07:12:25 +0100, @max_date=2020-02-11 10:48:36 +0100,
+#       @trend=#<Netatmo::Util::TempTrend @value=1>,
+#       @unit="°C">
+#     >
+```
+
+#### Data Types
+
+You can ask the module if it provides certain data types. 
+
+```ruby
+outdoor.temperature?
+# => true
+```
+
+```ruby
+outdoor.noise?
+# => false
+```
+
+If the data type is supported you can access the values.
+
+```ruby
+outdoor.temperature
+# => #<Netatmo::DashboardData::Temperature @value=13.6, @min=7.6, @max=13.6, @unit="°C", @time=2020-02-11 10:48:36 +0100, @trend=#<Netatmo::Util::TempTrend @value=1>, ...>
+```
+
+#### Values
+
+If you want to get a hash of all the available data types on the module you use the `values` method. 
+
+```ruby
+outdoor.values
+# => {
+#      :humidity=>#<Netatmo::DashboardData::Humidity ...>,
+#      :temperature=>#<Netatmo::DashboardData::Temperature ...
+#    }
+
+```
+
+## 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 tags, 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/marcoroth/netatmo-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/netatmo.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'netatmo/version'
+require 'netatmo_inflector'
+
+require 'zeitwerk'
+require 'byebug'
+require 'dotenv'
+require 'easy_enum'
+
+Dotenv.load
+
+@loader = Zeitwerk::Loader.for_gem
+@loader.inflector = NetatmoInflector.new
+@loader.enable_reloading
+@loader.setup
+
+module Netatmo
+  class Error < StandardError; end
+end

data/lib/netatmo/administrative.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Netatmo
+  class Administrative
+    attr_accessor :unit
+    attr_accessor :windunit
+    attr_accessor :pressureunit
+    attr_accessor :lang
+    attr_accessor :reg_locale
+    attr_accessor :country
+    attr_accessor :feel_like
+
+    def initialize(data)
+      self.unit = Netatmo::Util::Unit.value(data['unit'])
+      self.windunit = Netatmo::Util::Windunit.value(data['windunit'])
+      self.pressureunit = Netatmo::Util::Pressureunit.value(data['pressureunit'])
+      self.feel_like = Netatmo::Util::FeelLike.value(data['feel_like_algo'])
+      self.lang = data['lang']
+      self.reg_locale = data['reg_locale']
+      self.country = data['country']
+    end
+  end
+end

data/lib/netatmo/air_care/home_coach.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Netatmo
+  module AirCare
+    class HomeCoach < Netatmo::Weather::BaseStation
+      attr_accessor :health_index
+
+      # DeviceType: NHC
+      def initialize(data)
+        super(data)
+
+        self.health_index = Netatmo::DashboardData::HealthIndex.new(data['dashboard_data'])
+      end
+
+      def name
+        module_name
+      end
+
+      def data
+        d = super
+        d << health_index if health_index?
+      end
+    end
+  end
+end

data/lib/netatmo/battery_status/battery_status.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Netatmo
+  module BatteryStatus
+    class BatteryStatus
+      extend Forwardable
+
+      attr_accessor :type
+      attr_accessor :value
+
+      class << self
+        attr_accessor :status_values
+      end
+
+      self.status_values = {}
+
+      def initialize(value)
+        self.value = value
+      end
+
+      def status
+        self.class.status_values.each do |key, range|
+          return Netatmo::Util::BatteryStatus.key(key) if range.cover? value
+        end
+
+        nil
+      end
+
+      def_delegators :status, :max?, :full?, :high?, :medium?, :low?, :very_low?
+    end
+  end
+end

data/lib/netatmo/battery_status/indoor_battery_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Netatmo
+  module BatteryStatus
+    class IndoorBatteryStatus < BatteryStatus
+      self.status_values = {
+        very_low: 0..4559,
+        low: 4560..4919,
+        medium: 4920..5279,
+        high: 5280..5639,
+        full: 5640..5999,
+        max: 6000..6000
+      }.freeze
+    end
+  end
+end

data/lib/netatmo/battery_status/outdoor_battery_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Netatmo
+  module BatteryStatus
+    class OutdoorBatteryStatus < BatteryStatus
+      self.status_values = {
+        very_low: 0..3999,
+        low: 4000..4499,
+        medium: 4500..4999,
+        high: 5000..5499,
+        full: 5500..5999,
+        max: 6000..6000
+      }.freeze
+    end
+  end
+end

data/lib/netatmo/battery_status/wind_gauge_battery_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Netatmo
+  module BatteryStatus
+    class WindGaugeBatteryStatus < BatteryStatus
+      self.status_values = {
+        very_low: 0..4359,
+        low: 4360..4769,
+        medium: 4770..5179,
+        high: 5180..5589,
+        full: 5590..5999,
+        max: 6000..6000
+      }.freeze
+    end
+  end
+end

data/lib/netatmo/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+
+module Netatmo
+  class Client
+    BASE_URL = 'https://api.netatmo.net'
+    attr_accessor :access_token, :refresh_token, :expires_at
+    Config = Struct.new(:client_id, :client_secret, :username, :password, :base_url)
+
+    def initialize(&config_block)
+      if block_given?
+        config_block.call config
+      else
+        config
+      end
+
+      authenticate
+    end
+
+    def configure(&config_block)
+      config_block.call config if block_given?
+      config
+    end
+
+    def config
+      @config ||= Config.new(
+        ENV['NETATMO_CLIENT_ID'],
+        ENV['NETATMO_CLIENT_SECRET'],
+        ENV['NETATMO_USERNAME'],
+        ENV['NETATMO_PASSWORD'],
+        BASE_URL
+      )
+    end
+
+    def authenticate
+      if @access_token && @expires_at > Time.now
+        true
+      else
+        fetch_token
+      end
+    end
+
+    def fetch_token
+      response = if @refresh_token
+                   connection.post '/oauth2/token' do |request|
+                     request.body = {
+                       grant_type: :refresh_token,
+                       refresh_token: @refresh_token,
+                       client_id: config.client_id,
+                       client_secret: config.client_secret
+                     }
+                   end
+                 else
+                   connection.post '/oauth2/token' do |request|
+                     request.body = {
+                       grant_type: :password,
+                       client_id: config.client_id,
+                       client_secret: config.client_secret,
+                       username: config.username,
+                       password: config.password,
+                       scope: 'read_station'
+                     }
+                   end
+                 end
+      store_token(response)
+    end
+
+    # rubocop:disable Naming/AccessorMethodName
+    def get_station_data
+      response = connection.get('/api/getstationsdata', access_token: @access_token)
+
+      raise 'Unauthenticated' unless response.status == 200
+
+      Netatmo::Weather::StationData.new(JSON.parse(response.body)['body'])
+    end
+    # rubocop:enable Naming/AccessorMethodName
+
+    private
+
+    def connection
+      @connection ||= Faraday::Connection.new(url: config.base_url) do |builder|
+        builder.request :url_encoded
+        builder.adapter :net_http
+      end
+    end
+
+    def store_token(response)
+      return unless response.status == 200
+
+      data = JSON.parse(response.body)
+      @access_token = data['access_token']
+      @refresh_token = data['refresh_token']
+      @expires_at = Time.now + data['expires_in']
+    end
+  end
+end