Housing::API

Daiwa house housing api controller for Ruby.

Installation

Add this line to your application's Gemfile:

gem 'housing-api', github: 'mituoh/housing-api'

You should require this gem like;

require 'housing'

Usage

# You must create API Client at first.
housing = Housing::API.new(
  api_ip: '<your simulator ip address and port>'
)

# AirConditioner
ac = housing.air_conditioner

ac.off!
puts ac.status  #=> OFF
ac.on!
puts ac.status  #=> ON

ac.set_temperature 24
puts ac.get_temperature #=> 24

puts ac.indoor_temperature #=> 18

# LED Light
light = housing.light
light.on!
puts light.status #=> ON
light.off!
puts light.status #=> OFF

# Door Lock
door_lock = housing.door_lock
door_lock.open!
puts door_lock.status #=> OPEN
door_lock.close!
puts door_lock.status #=> CLOSE

# Shutter
shutter = housing.shutter
shutter.close!
puts shutter.status #=> CLOSE
shutter.open!
puts shutter.status #=> OPEN

# Window
window = housing.window
window.open!
puts window.status #=> OPEN
window.close!
puts window.status #=> CLOSE

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/mituoh/housing-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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