hue_switch 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de98ca6559d56e0a56b9b9388f5b81b50ba92595
+  data.tar.gz: 670efbf7d7ebe27988d7a7773d870d1ba41ef2cd
+SHA512:
+  metadata.gz: 7bb3d29d1fa11c37da5570de9fec03fff39260d95bf95b818a3cd75ab3b023a9dbf5566102a3e5a56045f5df352d6c2f6d18b490433650e114bd50ba68e88837
+  data.tar.gz: 9dbd6c526a1c8dc25c3898f07b83deeef021c04dffd4cba7798ddece13137324dae04d2409523021980787dd38c54d97550c74113a0edc90ad0d2c7c84150004

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hue_switch.gemspec
+gemspec

data/README.md

@@ -0,0 +1,159 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hue_switch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hue_switch
+
+## Usage
+A Hue Switch is designed control Hue lights, groups, and scenes. You can schedule a Switch. You can save a Switch as a Hue Scene on the bridge.
+
+NOTE: The first time you run this gem, you'll need to press the link button on the bridge immediately beforehand. If you don't, you'll get an error telling you to do so and try again.
+
+Why is this different from other wrappers?  Hue-Switch is not designed to give full access to Hue API, but to make access to basic operations super easy. A Hue Switch can be assigned an existing group, scene, or one or more individual lights. Switches can be scheduled easily. Color effects can be added (color loop, random colors, etc.) For example, a switch could be three random lights, rotating through random colors (or colors in a range.) If you turn the switch off, the lights go off. Turn it on, and they continue to cycle through colors.
+
+You'll need to replace USER constant with a string representing an authorized user on your Hue bridge.
+
+Colors can be specified by 
+
+    1. Color name (pink, red, blue, etc) including Hue color names (reading, energize, etc.)
+
+    2. Numeric value of hue [0-65535], or mired color value [0-500]
+
+
+###Create a Switch
+
+Basic case, an on-off switch for all lights
+```ruby
+switch = Switch.new {}
+```
+
+Then
+```ruby
+switch.on
+switch.off
+```
+
+###Switch to control a group.
+
+```ruby
+switch = Switch.new do
+  group :kitchen
+  color :blue
+  saturation 255
+  brightness 120
+  fade 10  #specified in seconds
+end
+```
+Use `group :all` to specify all lights.
+
+###Switch to control a scene
+
+```ruby
+switch = Switch.new do
+  scene :dinner
+end
+```
+
+###Switch to control one or more individually specified lights.
+
+```ruby
+switch = Switch.new do
+  lights :bedside, :floor, :table
+  hue 27000
+  brightness 120
+end
+```
+###Modify Switch
+
+After the switch is created, you can modify it:
+```ruby
+switch.group :fireplace
+switch.color :red
+```
+You can assign a new group, scene, or set of individual lights to a switch
+
+####Or reset it
+
+```ruby
+switch.reset
+```
+
+###Schedule the lights
+
+Switches can be scheduled:
+
+```ruby
+switch.schedule :on, "8:30 tonight"
+switch.schedule :off, "in three minutes"  # "tomorrow", "next week"
+```
+
+If you don't specify :on, :off, or a time, schedule will default to turning on the current switch state in 24 hours.
+
+####Delete the schedule[s] created by the switch:
+
+```ruby
+switch.delete_schedules!
+```
+
+###Save Switch as a Hue Scene
+
+Just specify a name (words must be join with a hyphen.)
+
+The scene will be assigned to the group the switch is currently controlling (or all the lights if a group hasn't been assigned to the switch.)
+
+All features of the Switch (fade, group, color, etc) will be saved in the scene attributes.
+    
+```ruby
+switch.save_scene "my-switch"
+```
+
+
+###Switches can be dynamic:
+```ruby
+switch.colorloop  # to cycle through colors
+switch.alert  # to flash lights once
+switch.long_alert  # to flash lights for 30 seconds
+```
+then `switch.on`
+
+In addition
+
+```ruby
+switch.random_colors # to loop through random colors
+```
+Hue, saturation, and brightness can be changed while the switch is cycling. If turned off, the switch will still be dynamic when turned back on.
+
+Speed and color range can optionally be assigned
+```ruby
+switch.random_colors range: 20000..28000 #cycles through greens, roughly
+```
+Stops dynamic effects.
+```ruby
+switch.colorloop :stop
+switch.alert :stop
+switch.random_colors :stop
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hue_switch/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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hue_switch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hue_switch.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hue_switch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hue_switch"
+  spec.version       = HueSwitch::VERSION
+  spec.authors       = ["sarkonovich"]
+  spec.email         = ["sarkonovich@ at gmail dot com"]
+
+  spec.summary       = "A gem to easily control Hue lights"
+  spec.homepage      = "http://www.github.com/sarkonovich"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_dependency 'chronic', '~> 0.10.0'
+  spec.add_dependency 'chronic_duration', '~> 0'
+  spec.add_dependency 'httparty', '~> 0.13.0'
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hue_switch.rb

@@ -0,0 +1,252 @@
+require 'chronic'
+require 'chronic_duration'
+require 'httparty'
+
+class Switch
+
+	attr_accessor :description, :lights_array, :_group, :body, :schedule_params, :schedule_ids, :effect, :effect_state, :effect_thread, :switch_state
+
+	def initialize(description = "", _group = 0, &block)
+
+		@user = "1234567890"
+		@ip = HTTParty.get("https://www.meethue.com/api/nupnp").first["internalipaddress"]
+		unless HTTParty.get("http://#{@ip}/api/#{@user}/config").include?("whitelist")
+			if HTTParty.post("http://#{@ip}/api", :body => ({:devicetype => "Hue_Switch", :username=>"1234567890"}).to_json).first.include?("error")
+				raise "You need to press the link button on the bridge and run again"
+			end
+		end
+			
+		@colors = {red: 65280, pink: 56100, purple: 52180, violet: 47188, blue: 46920, turquoise: 31146, green: 25500, yellow: 12750, orange: 8618}
+		@mired_colors = {candle: 500, relax: 467, reading: 346, neutral: 300, concentrate: 231, energize: 136} ; puts @mired_colors
+		@scenes = [] ; HTTParty.get("http://#{@ip}/api/#{@user}/scenes").keys.each { |k| @scenes.push(k) if k =~ /^\D*$/ }
+		@groups = {} ; HTTParty.get("http://#{@ip}/api/#{@user}/groups").each { |k,v| @groups["#{v['name']}".downcase.gsub(' ','_')] = k } ; @groups["all"] = "0"
+		@lights = {} ; HTTParty.get("http://#{@ip}/api/#{@user}/lights").each { |k,v| @lights["#{v['name']}".downcase] = k }
+		
+		switch_state = switch_state
+		self.lights_array = []
+		self.effect_thread = []
+		self.effect = ""
+		self.effect_state = :off
+		self.schedule_ids = []
+		self.schedule_params = nil
+		self.description = description
+		self._group = :all
+		self.body = {}
+		instance_eval(&block) if block_given?
+	end
+
+	def hue (numeric_value)
+		self.body.delete(:scene)
+		self.body.delete(:ct)
+		self.body[:hue] = numeric_value
+		self.on
+	end
+
+	def mired (numeric_value)
+		self.body.delete(:scene)
+		self.body.delete(:hue)
+		self.body[:ct] = numeric_value
+		self.on
+	end
+
+	def color(color_name)
+		self.body.delete(:scene)
+		self.body.delete(:ct)
+		self.body.delete(:hue)
+		@colors.keys.include?(color_name.to_sym) ?
+		self.body[:hue] = @colors[color_name.to_sym] : self.body[:ct] = @mired_colors[color_name.to_sym]
+		self.on
+	end
+
+	def saturation(depth)
+		self.body.delete(:scene)
+		self.body[:sat] = depth
+		self.on
+	end
+
+	def brightness(depth)
+		self.body.delete(:scene)
+		self.body[:bri] = depth
+		self.on
+	end
+
+	def fade(in_seconds)
+		self.body[:transitiontime] = in_seconds * 10
+	end	
+
+	def lights(*args)
+		self.lights_array = []
+		self._group = nil
+		self.body.delete(:groups)
+		self.body.delete(:scene)
+		args.each { |l| self.lights_array.push @lights[l.to_s] if @lights.keys.include?(l.to_s) }
+		self.switch_state = "off"
+		self.on
+	end
+
+	def group(group_name)
+		self.lights_array = []
+		self.body.delete(:scene)
+		self._group = @groups[group_name.to_s]
+		self.switch_state = "off"
+		self.on
+	end
+
+	def scene(scene_name)
+		self.lights_array = []
+		self._group = 0
+		self.body.delete(:groups)
+		self.body[:scene] = scene_name.to_s
+		self.switch_state = "off"
+		self.on
+	end
+
+	def save_scene (scene_name)
+		self.fade 2 if self.body[:transitiontime] == nil
+		if self._group.empty?
+			light_group = HTTParty.get("http://10.100.100.3/api/#{@user}/groups/0")["lights"]
+		else
+		 light_group = HTTParty.get("http://10.100.100.3/api/#{@user}/groups/#{self._group}")["lights"]
+		end
+		params = {name: scene_name, lights: light_group, transitiontime: self.body[:transitiontime]}
+		response = HTTParty.put("http://#{@ip}/api/#{@user}/scenes/#{scene_name}", :body => params.to_json)
+		if response.first.keys[0] == "success"
+			puts "Scene created!"
+		else
+			puts "Error: scene was NOT created!"
+		end
+	end
+
+	def on
+		if self.switch_state != "on"
+			self.switch_state = "on"
+			self.body[:on] = true
+		end
+
+		if self.lights_array.any?
+			self.lights_array.each { |l| HTTParty.put("http://#{@ip}/api/#{@user}/lights/#{l}/state", :body => (self.body).to_json) }
+		elsif self.body.include?(:scene)
+			HTTParty.put("http://#{@ip}/api/#{@user}/groups/#{self._group}/action", :body => (self.body.select { |s| s == :scene }).to_json)
+		else 
+			HTTParty.put("http://#{@ip}/api/#{@user}/groups/#{self._group}/action", :body => (self.body).to_json)
+		end
+
+		#restart switch custom dynamic effects after switch is turned back on
+		if !self.effect.empty? && !self.effect_thread.last.alive?
+			self.effect_thread.each { |t| self.effect_thread.delete t if !t.alive?}
+			self.send(self.effect, :start) if !self.effect.nil?
+		end
+		# Don't keep sending "on" signal to lights as suggested by Hue API
+		self.body.delete(:on)
+	end
+
+	def off
+		# Stop Switch custom dynamic effects
+		if self.effect_state == :start
+			self.effect_thread.last.kill
+			self.effect_state = :stop
+		end
+		if self.switch_state != "off"
+			self.switch_state = "off"
+			self.body[:on] = false
+		end
+		if self.lights_array.any?
+			self.lights_array.each { |l| HTTParty.put("http://#{@ip}/api/#{@user}/lights/#{l}/state", :body => (self.body).to_json) }
+		elsif !self.body[:scene].nil? 
+			(HTTParty.get("http://#{@ip}/api/#{@user}/scenes"))[self.body[:scene]]["lights"].each do |l|
+				HTTParty.put("http://#{@ip}/api/#{@user}/lights/#{l}/state", :body => ({:on=>false}).to_json)
+			end
+		else
+			HTTParty.put("http://#{@ip}/api/#{@user}/groups/#{self._group}/action", :body => (self.body).to_json)
+		end
+	end
+
+	def schedule(on_or_off = :default, set_time = "tomorrow")
+		if set_time.scan(/ seconds?| minutes?| hours?| days?| weeks?/).any? 
+			set_time = Time.now + ChronicDuration.parse(set_time)
+			set_time = set_time.to_s.split(' ')[0..1].join(' ').sub(' ',"T")
+		else
+			set_time = Chronic.parse(set_time).to_s.split(' ')[0..1].join(' ').sub(' ',"T")
+		end
+
+		if on_or_off != :default
+			on_or_off = on_or_off == :on ? true : false
+			self.body[:on]=on_or_off
+		end 
+
+		if Chronic.parse(set_time) < Time.now
+			p "You've scheduled this in the past"
+		else
+			self.schedule_params = {:name=>"Hue_Switch Alarm",
+						 :description=>"",
+						 :localtime=>"#{set_time}",
+						 :status=>"enabled",
+						 :autodelete=>true
+						}
+			if self.lights_array.any?
+				self.schedule_params[:name]= "Hue_Switch Alarm Light Set"
+				lights_array.each do |l|
+					self.schedule_params[:command] = {:address=>"/api/#{@user}/lights/#{l}/state", :method=>"PUT", :body=>self.body}
+					self.schedule_ids.push(HTTParty.post("http://#{@ip}/api/#{@user}/schedules", :body => (self.schedule_params).to_json))
+				end
+			elsif !self.body[:scene].nil?
+				self.schedule_params[:command] = {:address=>"/api/#{@user}/groups/#{self._group}/action", :method=>"PUT", :body=>self.body.reject { |s| s == :scene }}
+				self.schedule_ids.push(HTTParty.post("http://#{@ip}/api/#{@user}/schedules", :body => (self.schedule_params).to_json))
+			else
+				self.schedule_params[:command] = {:address=>"/api/#{@user}/groups/#{self._group}/action", :method=>"PUT", :body=>self.body}
+				self.schedule_ids.push(HTTParty.post("http://#{@ip}/api/#{@user}/schedules", :body => (self.schedule_params).to_json))
+			end
+		end
+	end
+
+	def delete_schedules!
+		self.schedule_ids.flatten!
+		self.schedule_ids.each { |k| 
+	 		id = k["success"]["id"] if k.include?("success")
+	 		HTTParty.delete("http://#{@ip}/api/#{@user}/schedules/#{id}")
+	 	}
+	 	self.schedule_ids = []
+	end
+
+	def reset
+		self._group = 0
+		self.body = {}
+		self.schedule_params = nil
+	end
+
+# Switches can be dynamic
+	def colorloop(state = :on)
+		state == :on ? self.body[:effect] = "colorloop"  : self.body[:effect] = "none"
+		self.on
+	end
+
+	def alert(state = :on)
+		state == :on ? self.body[:alert] = "select"  : self.body[:alert] = "none"
+		self.on
+	end
+
+	def long_alert(state = :on)
+		state == :on ? self.body[:alert] = "lselect"  : self.body[:alert] = "none"
+		self.on
+	end
+
+	def random_colors(state = :start, range: 0..65500)
+		if state == :stop
+			self.effect = ""
+			self.effect_thread = []
+			self.effect_state = :stop
+		else
+			self.effect_state = state
+			self.effect = __method__.to_s
+			self.fade 2
+			Thread.new do
+				self.effect_thread.push Thread.list.last
+				while self.effect_state == :start do
+					self.body[:hue] = rand(range)
+					sleep (self.body[:transitiontime] / 10) + 0.5 
+					self.on
+				end
+			end
+		end
+	end
+end

data/lib/hue_switch/version.rb

@@ -0,0 +1,3 @@
+module HueSwitch
+  VERSION = "0.9.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: hue_switch
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- sarkonovich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- sarkonovich@ at gmail dot com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hue_switch.gemspec
+- lib/hue_switch.rb
+- lib/hue_switch/version.rb
+homepage: http://www.github.com/sarkonovich
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A gem to easily control Hue lights
+test_files: []