tradfri 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75618514cb5e629e1a16cd4689cc95383019522b
+  data.tar.gz: 45cb06ad1531e7104e198b723b42e562957104b8
+SHA512:
+  metadata.gz: db9caa6476804c7a71b8cb7257e48f79ee31d34adff6fc012cb70de544f33ff27491ea1e3ab4e6d2af70102bbde0e03268136e1fce31b03934d91bf9e4cc3c2e
+  data.tar.gz: 78957f3c6a895ad96d33d1a01438df0daf3d8c167d17bc88096a55a766c7d1440ee1520626107690b0c5d1b7c1484b3ea8b9dd896eb24f27e1e9d30558d65647

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org/'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Tom Stuart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# `tradfri`, a Ruby interface to IKEA’s smart lighting system
+
+`tradfri` is a Ruby library for talking to the [gateway][] which controls
+IKEA’s [TRÅDFRI][] smart lighting system. If you own a TRÅDFRI gateway and some
+bulbs, this library lets you turn them on and off from a Ruby program.
+
+The communication with the gateway uses the HTTP-like [CoAP][] protocol over
+UDP and is secured with [DTLS][]. I don’t know how the hell any of that works
+so this library sends CoAP requests by shelling out to the `coap-client`
+program that comes with [`libcoap`][libcoap]. You’ll have to build this
+yourself and tell `tradfri` where to find it.
+
+Because the gateway advertises itself with [DNS-SD][], `tradfri` can discover
+it automatically without you having to specify an IP address. The CoAP messages
+are encrypted, though, so you’ll need the “serial number” (MAC address) and
+“security code” (pre-shared key) from the sticker on the underside of the
+gateway.
+
+[gateway]: http://www.ikea.com/us/en/catalog/products/00337813/
+[TRÅDFRI]: http://www.ikea.com/us/en/catalog/categories/departments/lighting/36812/
+[CoAP]: http://coap.technology/
+[DTLS]: https://en.wikipedia.org/wiki/Datagram_Transport_Layer_Security
+[libcoap]: https://libcoap.net/
+[DNS-SD]: https://en.wikipedia.org/wiki/Zero-configuration_networking#DNS-SD
+
+## Building `libcoap`
+
+You should build the `dtls` branch of `libcoap` according to [these
+instructions][]. You may need to install other tools like `libtool` and
+`automake` for this to work.
+
+Here’s what worked for me:
+
+```bash
+$ git clone --recursive --branch dtls https://github.com/obgm/libcoap.git
+$ cd libcoap
+$ ./autogen.sh
+$ ./configure --disable-documentation --disable-shared
+$ make
+```
+
+[these instructions]: https://libcoap.net/doc/install.html
+
+## Example
+
+Once you’ve built `libcoap`’s `coap-client` binary, you can use `tradfri` like
+this:
+
+```ruby
+require 'tradfri'
+
+CLIENT_PATH = 'libcoap/examples/coap-client' # wherever you compiled it
+
+SERIAL_NUMBER = 'a0-b1-c2-d3-e4-f5' # from the sticker on your gateway
+SECURITY_CODE = 'aBcDeFgHiJkLmNoP' # from the sticker on your gateway
+SECRETS = { SERIAL_NUMBER => SECURITY_CODE }
+
+client = Tradfri::Client.new(CLIENT_PATH)
+gateways = client.discover_gateways(SECRETS)
+gateway = gateways.first
+bulbs = gateway.bulbs
+
+puts "Found: #{bulbs.map(&:name).join(', ')}"
+
+bulbs.each do |bulb|
+  bulb.on # bulb.off works too
+end
+
+loop do
+  bulbs.each do |bulb|
+    bulb.dim(rand) # 0 is full darkness, 1 is full brightness
+    bulb.send(%i{cold normal warm}.sample)
+  end
+
+  sleep 5
+end
+```
+
+## Limitations
+
+This is incredibly hacky and doesn’t work very well, but it’s a start.

data/lib/tradfri.rb

@@ -0,0 +1,5 @@
+require 'tradfri/client'
+require 'tradfri/device'
+require 'tradfri/gateway'
+require 'tradfri/service'
+require 'tradfri/version'

data/lib/tradfri/client.rb

@@ -0,0 +1,45 @@
+require 'open3'
+require 'tempfile'
+require 'tradfri/gateway'
+require 'tradfri/service'
+
+module Tradfri
+  class Client < Struct.new(:coap_client_path)
+    METHOD_GET = 'get'
+    METHOD_PUT = 'put'
+
+    def discover_gateways(keys)
+      Service.discover.map do |service|
+        connect_to service.host, service.port, keys[service.mac_address]
+      end
+    end
+
+    def connect_to(host, port, key)
+      Gateway.new(self, host, port, key)
+    end
+
+    def get(key, uri)
+      Tempfile.open do |file|
+        args =
+          '-k', key,
+          '-m', METHOD_GET,
+          '-o', file.path,
+          uri.to_s
+
+        Open3.capture3(coap_client_path, *args)
+
+        file.read
+      end
+    end
+
+    def put(key, uri, payload)
+      args =
+        '-k', key,
+        '-m', METHOD_PUT,
+        '-e', payload,
+        uri.to_s
+
+      Open3.capture3(coap_client_path, *args)
+    end
+  end
+end

data/lib/tradfri/device.rb

@@ -0,0 +1,77 @@
+require 'json'
+
+module Tradfri
+  class Device < Struct.new(:gateway, :uri)
+    # https://github.com/IPSO-Alliance/pub/blob/master/reg/xml/3311.xml
+    LIGHT_CONTROL = 3311
+    ON_OFF = 5850
+    OFF = 0
+    ON = 1
+    DIMMER = 5851
+    DIMMER_MIN = 0
+    DIMMER_MAX = 255
+    COLOUR = 5706
+    COLOUR_COLD = 'f5faf6'
+    COLOUR_NORMAL = 'f1e0b5'
+    COLOUR_WARM = 'efd275'
+
+    # I don’t know if/where these are officially documented
+    NAME = 9001
+
+    BULBS = 15001 # TODO discover this
+
+    def bulb?
+      info.has_key? LIGHT_CONTROL.to_s
+    end
+
+    def name
+      info[NAME.to_s]
+    end
+
+    def info
+      data = gateway.get(uri)
+
+      result =
+        begin
+          JSON.parse(data)
+        rescue JSON::ParserError
+          {}
+        end
+
+      case result
+      when Hash
+        result
+      else
+        {}
+      end
+    end
+
+    def on
+      change ON_OFF => ON
+    end
+
+    def off
+      change ON_OFF => OFF
+    end
+
+    def dim(brightness)
+      change DIMMER => DIMMER_MIN + (brightness * (DIMMER_MAX - DIMMER_MIN)).round
+    end
+
+    def cold
+      change COLOUR => COLOUR_COLD
+    end
+
+    def normal
+      change COLOUR => COLOUR_NORMAL
+    end
+
+    def warm
+      change COLOUR => COLOUR_WARM
+    end
+
+    private def change(state)
+      gateway.put uri, JSON.generate(LIGHT_CONTROL => [state])
+    end
+  end
+end

data/lib/tradfri/gateway.rb

@@ -0,0 +1,37 @@
+require 'tradfri/device'
+require 'uri'
+
+module Tradfri
+  class Gateway < Struct.new(:client, :host, :port, :key)
+    SCHEME = 'coaps'
+    DISCOVERY_PATH = '/.well-known/core'
+
+    def devices
+      client.get(key, discovery_uri).split(',').
+        map { |link| %r{\A</(?<uri>[^>]+)>}.match(link) }.
+        compact.
+        map { |match| discovery_uri.merge(match[:uri]) }.
+        map { |uri| Device.new(self, uri) }
+    end
+
+    def bulbs
+      devices.select(&:bulb?)
+    end
+
+    def get(uri)
+      client.get key, uri
+    end
+
+    def put(uri, payload)
+      client.put key, uri, payload
+    end
+
+    private def discovery_uri
+      URI::Generic.build \
+        scheme: SCHEME,
+        host: host,
+        port: port,
+        path: DISCOVERY_PATH
+    end
+  end
+end

data/lib/tradfri/service.rb

@@ -0,0 +1,43 @@
+require 'dnssd'
+
+module Tradfri
+  class Service < Struct.new(:name, :host, :port)
+    SERVICE_TYPE = '_coap'
+    TRANSPORT_PROTOCOL = '_udp'
+    INTERNET_PROTOCOL = DNSSD::Service::IPv4
+    REGISTRATION_TYPE = [SERVICE_TYPE, TRANSPORT_PROTOCOL].join('.')
+
+    def mac_address
+      name.slice %r{(?:\h{2}-){5}\h{2}} ||
+        raise("couldn’t find MAC address in “#{name}”")
+    end
+
+    def self.discover
+      browse(REGISTRATION_TYPE).map do |reply|
+        host, port = resolve(reply, INTERNET_PROTOCOL)
+        Service.new(reply.name, host, port)
+      end
+    end
+
+    private_class_method def self.browse(registration_type)
+      [].tap do |replies|
+        DNSSD.browse! registration_type do |reply|
+          replies << reply if reply.flags.add?
+          break unless reply.flags.more_coming?
+        end
+      end
+    end
+
+    private_class_method def self.resolve(browse_reply, protocol)
+      DNSSD.resolve! browse_reply do |resolve_reply|
+        DNSSD::Service.getaddrinfo(resolve_reply.target, protocol).each do |address_reply|
+          return [address_reply.address, resolve_reply.port]
+        end
+
+        break unless resolve_reply.flags.more_coming?
+      end
+
+      raise "couldn’t resolve #{browse_reply.name}"
+    end
+  end
+end

data/lib/tradfri/version.rb

@@ -0,0 +1,3 @@
+module Tradfri
+  VERSION = '0.0.1'
+end

data/tradfri.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tradfri/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tradfri'
+  spec.version       = Tradfri::VERSION
+  spec.author        = 'Tom Stuart'
+  spec.email         = 'tom@codon.com'
+  spec.summary       = 'A Ruby interface to IKEA’s smart lighting system'
+  spec.homepage      = 'https://github.com/tomstuart/tradfri'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dnssd', '~> 3.0', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: tradfri
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dnssd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email: tom@codon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/tradfri.rb
+- lib/tradfri/client.rb
+- lib/tradfri/device.rb
+- lib/tradfri/gateway.rb
+- lib/tradfri/service.rb
+- lib/tradfri/version.rb
+- tradfri.gemspec
+homepage: https://github.com/tomstuart/tradfri
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to IKEA’s smart lighting system
+test_files: []