Sha256: 51f9268c8d165800b208379f268c7e424c3d36e7fc39d695cc45c74e4889ff29

Contents?: true

Size: 1.7 KB

Versions: 3

Compression:

Stored size: 1.7 KB

Contents

# 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:

```ruby
gem 'fritzbox-smarthome'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install fritzbox-smarthome

## Usage

```ruby
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](https://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](https://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
fritzbox-smarthome-0.8.0 README.md
fritzbox-smarthome-0.7.0 README.md
fritzbox-smarthome-0.6.0 README.md