A long-lived project that still receives updates
Client library to interface with Smarthome features of your FritzBox
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 13.0
~> 11.1
~> 3.11
~> 3.14

Runtime

~> 2.6
~> 3.2
>= 7.0, <= 8
>= 7.0, <= 8
~> 0.20
~> 1.13
 Project Readme

Fritzbox::Smarthome

Ruby client library to interface with Smarthome features of your FritzBox.

Currently implemented actor types:

  • Heater
  • Lightbulb
  • SmokeDetector
  • Switch

Installation

Add this line to your application's Gemfile:

gem 'fritzbox-smarthome'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fritzbox-smarthome

Usage

Fritzbox::Smarthome.configure do |config|
  config.endpoint   = 'https://fritz.box'
  config.username   = 'smarthome'
  config.password   = 'verysmart'
  config.verify_ssl = false
end

# Get all actors of any type
actors = Fritzbox::Smarthome::Actor.all

# Get all actors of type Heater
heaters = Fritzbox::Smarthome::Heater.all
heaters.last.update_hkr_temp_set(BigDecimal('21.5'))

# Get a specific actor via it's AIN
actor = Fritzbox::Smarthome::Actor.find_by!(ain: '0815 4711')

# Reload the data of an already fetched actor
actor.reload

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/klausmeyer/fritzbox-smarthome.

License

The gem is available as open source under the terms of the MIT License.