Netatmo
Ruby API Wrapper for the Netatmo API.
Installation
Add this line to your application's Gemfile:
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_USERNAME |
User address email |
NETATMO_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.
# 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'
endEndpoint /getstationdata
get_station_data Returns all weather stations you have read access to.
station_data = client.get_station_data
# => #<Netatmo::Weather::StationData @devices=[...] @user=#<Netatmo::User> ...>Devices
You can access the base stations in the devices array.
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=[...] ...>
# ]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.
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"], ...>
# ]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.
outdoor.temperature?
# => trueoutdoor.noise?
# => falseIf the data type is supported you can access the values.
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.
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.
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.