hued 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5cf08955db23b65793e437c07db14d6b866017b
+  data.tar.gz: 086a26303c15748e74ed137ab8d44e23f25b9590
+SHA512:
+  metadata.gz: d5a4c0d3238d1278a878fc5053f1aa5f6601a00a9f15bfde35c53597d97124a1bc8ea7b2c13a11ad4cfaea34cced002d4e2509acce8494d01eb588b501bfb215
+  data.tar.gz: 1785b51a324ec14fe8e1237177013a217440a583d102f7de2c4797e9eb6fc335a2396c758feb53a0e4222faa2c51b9ec7b8c215830ac35edbef6fd43c2654886

data/Gemfile

@@ -0,0 +1,9 @@
+ruby '2.0.0'
+
+source 'https://rubygems.org'
+
+gem 'json', '~> 1.8.3', '>= 1.8'
+
+group :development do
+  gem 'jeweler', '~> 2.0.1', '>= 2.0.1'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashie (3.4.4)
+    highline (1.7.8)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile2 (2.0.0)
+    multi_json (1.11.3)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (1.6.4)
+    rake (10.5.0)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    thread_safe (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 2.0.1, >= 2.0.1)
+  json (~> 1.8.3, >= 1.8)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,149 @@
+hued - (?:ab)using the Hue HTTP API
+====
+
+- [writeup](#writeup)
+- [API methods](#api-methods)
+- [notes](#notes)
+
+# writeup
+
+want to talk to your [Philips Hue](http://www2.meethue.com/en-us/) lights directly through an HTTP API without registering an application?
+
+to turn off the currently-in-use lighting scheme:
+
+```
+~/hue $ curl -X PUT http://<hue hub>/api/<token>/groups/0/action -d '{"on":true}'
+[{"success":{"/groups/0/action/on":true}}]
+```
+
+all you need are:
+  - the IP for the Hue Hub plugged in to your network
+  - a 'whitelisted' token to talk to the API
+
+finding the IP should be pretty straight forward, but the nmap output is not very specific:
+```
+~/hue $ nmap 192.168.42.0/24
+...
+Nmap scan report for 192.168.42.66
+Host is up (0.0063s latency).
+Not shown: 65534 closed ports
+PORT   STATE SERVICE    VERSION
+80/tcp open  tcpwrapped
+...
+```
+
+the Hue hub uses DHCP by default, so it likely won't be at that address for you, but you get the idea.
+
+now, you need to get a token. to do that, trick the Hue app on your phone/tablet/Echo to send it to us.
+
+  - stand up a webserver listening for GET of `http://0.0.0.0:80/api/config` on the same network (0/24) your phone/tablet/Echo is on
+  - `api/config` needs to be JSON that a Hue hub would return (sample included in repo)
+  - from your phone/tablet/Echo, select `Settings->Find Bridge->Search`
+    * this works intermittently, as some times the app found the real hub and the imposter, other times it would only find the real hub, but would mostly end up with a 'Specify IP' button
+  - wait for the app to query your imposter, and you'll have a token
+
+by the numbers:
+
+```
+~/hue $ cat api/config
+HTTP/1.1 200 OK
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+Expires: Mon, 1 Aug 2011 09:00:00 GMT
+Connection: close
+Access-Control-Max-Age: 3600
+Access-Control-Allow-Origin: *
+Access-Control-Allow-Credentials: true
+Access-Control-Allow-Methods: POST, GET, OPTIONS, PUT, DELETE, HEAD
+Access-Control-Allow-Headers: Content-Type
+Content-type: application/json
+
+{"name": "Philips hue","swversion": "01032318","apiversion": "1.13.0","mac": "DE:AD:BE:EF:CA:FE","bridgeid": "001788FFFECAFE","factorynew": false,"replacesbridgeid": null,"modelid": "BSB001"}
+~/hue $ while true; do sudo nc -l 80 < api/config; done
+...
+GET /api/config HTTP/1.1
+Host: 192.168.42.83
+Accept: */*
+Accept-Language: en-us
+Connection: keep-alive
+Accept-Encoding: gzip, deflate
+User-Agent: Hue/1 CFNetwork/758.4.3 Darwin/15.5.0
+
+GET /api/eKpsfhR9K1u32/config HTTP/1.1
+Host: 192.168.42.83
+Accept: */*
+Accept-Language: en-us
+Connection: keep-alive
+Accept-Encoding: gzip, deflate
+User-Agent: Hue/1 CFNetwork/758.4.3 Darwin/15.5.0
+
+GET /api/eKpsfhR9K1u32 HTTP/1.1
+Host: 192.168.42.83
+Accept: */*
+Accept-Language: en-us
+Connection: keep-alive
+Accept-Encoding: gzip, deflate
+User-Agent: Hue/1 CFNetwork/758.4.3 Darwin/15.5.0
+```
+
+and now we have our token, `eKpsfhR9K1u32`. with that, we can call (all?) API methods
+
+# API methods
+
+api|description|GET|PUT
+----|-----------|---------------|----------------
+`/config/`|set and query existing settings|without token for unauthenticated, basic registration information, with token for light/device/schedule/sensor configuration|JSON matching schema validation|
+`/lights/`|scan and query existing lights|JSON scan status|empty body to start a scan
+`/sensors/`|scan and query existing sensors|JSON scan status|empty body to start a scan
+`/scenes/`|set and query existing scenes|JSON scene list| /`<uuid>/lights/<id>/state => {"on":true,"xy":[0.5804,0.3995],"bri":253}`
+`/schedules/`|set and query existing schedules/timers|JSON schedules/timers|`/<uuid> => {"name":"Alarm","autodelete":false,"localtime":"2016-06-20T16:20:00","description":"giants","status":"enabled","command":{"address":"/api/eKpsfhR9K1u32/groups/0/action","body":{"scene":"f55e38250-on-0"},"method":"PUT"}}`
+`/groups/`|set and query scene (?) groupings|empty JSON|`/<id>/action => {"scene":"2fc89fcdb-on-0"}`
+
+a few example request/responses:
+
+```json
+# http://192.168.42.66/api/eKpsfhR9K1u32/scenes
+{
+  "f4750b0cf-off-5": {
+    "name": "HIDDEN foff 1452936620159",
+    "lights": [
+      "1",
+      "2",
+      "3",
+      "4",
+      "5",
+      "6",
+      "7",
+      "8",
+      "9",
+      "10"
+    ],
+    "owner": "eKpsfhR9K1u32",
+    "recycle": true,
+    "locked": true,
+    "appdata": {
+
+    },
+    "picture": "",
+    "lastupdated": "2016-01-16T09:30:21",
+    "version": 1
+  },
+  ...
+}  
+```
+
+# notes
+
+all versions tested are the latest available as of 2016/06/19
+
+component|version|notes
+---------|-------|-----
+Philips Hue Hub|5.23.1.13452|
+Hue mobile App|1.12.1.0|same version reported on both Android and Apple devices
+
+TODO
+* dig further in api/\<token\>/config
+  * determine how the hashes are generated. not concatenation of create time / name in any obvious way. different devices seem to come up with hashes in different ways. older iPhone/iPad apps were [A-Z0-9]{16}, while Android ones seem to always have been [A-Z]{32}
+* write a client library/binding? or at least some abstraction
+* determine the truly necessary pieces of the imposter response, think it really only needs content-type and minimal JSON
+* work on SSDP discovery, see [description.xml](resources/api/description.xml)

data/Rakefile

@@ -0,0 +1,19 @@
+require 'jeweler'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include('pkg/*')
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = 'hued'
+  gem.summary     = 'Philips Hue HTTP API bindings'
+  gem.description = 'interact with Philips Hue Hub to control your devices'
+  gem.email       = ['conor.code@gmail.com']
+  gem.homepage    = 'http://github.com/chorankates/hued'
+  gem.authors     = ['Conor Horan-Kates', 'Maureen Long']
+  gem.licenses    =  'MIT'
+
+  gem.executables = ['hued']
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/hued

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# hued - CLI for Hued module
+
+require 'hued'
+
+def parse_input
+  options = Hash.new
+
+  parser = OptionParser.new do |o|
+    o.on('--ip <ip>', 'IP address of Phillips Hue Hub') do |p|
+      options[:ip] = p
+    end
+    o.on('--token <token>', 'whitelisted token') do |p|
+      options[:token] = p
+    end
+  end
+
+  parser.parse!
+  options
+end
+
+options = parse_input
+
+hub = Hued::Hub.new(options[:ip], options[:token])
+
+# TODO this should really be a REPL
+off = hub.all_lights_off
+puts "off: #{off}"
+
+sleep 5
+
+on = hub.all_lights_on
+puts "on: #{on}"
+
+off = hub.all_lights_off
+puts "off(2): #{off}"

data/lib/hued.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+## hued.rb Philips Hue HTTP binding
+
+require 'json'
+require 'net/http'
+require 'optparse'
+require 'yaml'
+require 'uri'
+
+module Hued
+
+  class Hub
+
+    attr_accessor :lights, :scenes, :schedules
+
+    def initialize(ip, token)
+      @ip    = ip
+      @token = token
+
+      raise "no IP specified" if @ip.nil?
+      raise "no token specified" if @token.nil?
+
+      @config = get_config()
+
+      @lights    = get_lights()
+      @scenes    = get_scenes()
+      @schedules = get_schedules()
+    end
+
+    def inspect
+      {
+        :ip        => @ip,
+        :token     => @token,
+        :lights    => @lights.size,
+        :scenes    => @scenes.size,
+        :schedules => @schedules.size,
+      }
+    end
+
+    def to_s
+      inspect.to_s
+    end
+
+    def get_config
+      JSON.parse(get_http(get_url('config')).body)
+    end
+
+    def get_lights(input = nil)
+      lights   = Array.new
+      response = JSON.parse(get_http(get_url('lights')).body)
+      response.each do |_i, hash|
+        lights << OpenStruct.new(hash)
+      end
+
+      lights
+    end
+
+    def get_scenes(input = nil)
+      scenes = Array.new
+      response = JSON.parse(get_http(get_url('scenes')).body)
+      response.each do |_i, hash|
+        scenes << OpenStruct.new(hash)
+      end
+
+      scenes
+    end
+
+    def get_schedules(input = nil)
+      schedules = Array.new
+      response  = JSON.parse(get_http(get_url('schedules')).body)
+      response.each do |_i, hash|
+        schedules << OpenStruct.new(hash)
+      end
+
+      schedules
+    end
+
+    def all_lights_on
+      url     = get_url('groups/0/action')
+      payload = { :on => true }
+      put_http(url, payload)
+    end
+
+    def all_lights_off
+      url     = get_url('groups/0/action')
+      payload = { :on => false }
+      put_http(url, payload)
+    end
+
+    ## helper functions
+    def get_url(method)
+      sprintf('http://%s/api/%s/%s', @ip, @token, method)
+    end
+
+    def get_http(url)
+      uri      = URI.parse(url)
+      http     = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = false
+      request  = Net::HTTP::Get.new(uri.request_uri)
+      http.request(request)
+    end
+
+    def put_http(url, body)
+      uri     = URI.parse(url)
+      http    = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Put.new(uri.request_uri)
+
+      request.add_field('Content-Type', 'application.json')
+      request.body = body.to_json
+      http.request(request)
+    end
+
+  end
+
+end

data/resources/api/config

@@ -0,0 +1,13 @@
+HTTP/1.1 200 OK
+Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+Pragma: no-cache
+Expires: Mon, 1 Aug 2011 09:00:00 GMT
+Connection: close
+Access-Control-Max-Age: 3600
+Access-Control-Allow-Origin: *
+Access-Control-Allow-Credentials: true
+Access-Control-Allow-Methods: POST, GET, OPTIONS, PUT, DELETE, HEAD
+Access-Control-Allow-Headers: Content-Type
+Content-type: application/json
+
+{"name": "Philips hue","swversion": "01032318","apiversion": "1.13.0","mac": "DE:AD:BE:EF:CA:FE","bridgeid": "001788FFFECAFE","factorynew": false,"replacesbridgeid": null,"modelid": "BSB001"}

data/resources/api/description.xml

@@ -0,0 +1,39 @@
+
+
+<?xml version="1.0" encoding="UTF-8"?>
+<root xmlns="urn:schemas-upnp-org:device-1-0">
+    <specVersion>
+        <major>1</major>
+        <minor>0</minor>
+    </specVersion>
+    <URLBase>http://192.168.42.66:80/</URLBase>
+    <device>
+        <deviceType>urn:schemas-upnp-org:device:Basic:1</deviceType>
+        <friendlyName>Philips hue (192.168.42.66)</friendlyName>
+        <manufacturer>Royal Philips Electronics</manufacturer>
+        <manufacturerURL>http://www.philips.com</manufacturerURL>
+        <modelDescription>Philips hue Personal Wireless Lighting</modelDescription>
+        <modelName>Philips hue bridge 2012</modelName>
+        <modelNumber>000</modelNumber>
+        <modelURL>http://www.meethue.com</modelURL>
+        <serialNumber>000</serialNumber>
+        <UDN>000</UDN>
+        <presentationURL>index.html</presentationURL>
+        <iconList>
+            <icon>
+                <mimetype>image/png</mimetype>
+                <height>48</height>
+                <width>48</width>
+                <depth>24</depth>
+                <url>hue_logo_0.png</url>
+            </icon>
+            <icon>
+                <mimetype>image/png</mimetype>
+                <height>120</height>
+                <width>120</width>
+                <depth>24</depth>
+                <url>hue_logo_3.png</url>
+            </icon>
+        </iconList>
+    </device>
+</root>

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: hued
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Conor Horan-Kates
+- Maureen Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: interact with Philips Hue Hub to control your devices
+email:
+- conor.code@gmail.com
+executables:
+- hued
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- bin/hued
+- lib/hued.rb
+- resources/api/config
+- resources/api/description.xml
+homepage: http://github.com/chorankates/hued
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Philips Hue HTTP API bindings
+test_files: []