dsshap / wink

A Ruby wrapper for the Wink Hub API.

Wink

A Ruby wrapper for the Wink Hub API

Installation

Add this line to your application's Gemfile:

gem 'wink'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wink

Usage

Wink.configure do |wink|
  wink.client_id     = ENV['WINK_CLIENT_ID']
  wink.client_secret = ENV['WINK_CLIENT_SECRET']
  wink.access_token  = ENV['WINK_ACCESS_TOKEN']
  wink.refresh_token = ENV['WINK_REFRESH_TOKEN']
end

Finding your connected devices:

client = Wink::Client.new
client.devices

Finding a subset of your devices:

client.light_bulbs
client.binary_switches
client.garage_doors

Controlling binary switch:

light_bulb = client.light_bulbs.find(400)
light_bulb.powered?
light_bulb.off
light_bulb.off? # => true
light_bulb.on
light_bulb.on? # => true
light_bulb.toggle
light_bulb.off? # => true

Controlling garage doors:

door = client.garage_doors.find(1)
door.position # => 0
door.open
door.open?
door.closed?
door.close
door.opening?

List groups of devices:

client = Wink::Client.new
client.groups

Find a group:

client = Wink::Client.new

# find by name
group = client.group('Living Room')
group.name
group.id

# find by id
group = client.group(2322322)
group.name
group.id

Adjust a group:

client = Wink::Client.new

group = client.group('Living Room')
group.on
group.off
group.dim(0.05)

List scenes (Shortcuts in the Wink App):

client = Wink::Client.new
client.scenes

Find a scene:

client = Wink::Client.new

# find by name
scene = client.scene('Good Night')
scene.name
scene.id

# find by id
scene = client.scene(34322)
scene.name
scene.id

Activate a scene:

client = Wink::Client.new

scene = client.scene('Good Night')
scene.activate

List subscriptions for each device:

light_bulb.subscriptions

Create subscription for device:

light_bulb.subscriptions.create(:secret => "1", :callback => "http://requestb.in/")

Parse incoming subscription payload from Wink API:

Wink::Subscription.parse(params[:payload])

Contributing

1. Fork it ( https://github.com/dewski/wink/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request