milight-v6 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3af0d2759af9191fdeec66af91c2d183637470f5
+  data.tar.gz: 7a959f4f8018887a71a187c47321146f61909531
+SHA512:
+  metadata.gz: ab7573061d49cde08b90954fb8329c44358b3bbb58b8f8a2d9a3718d7236aac8ffcf9371abcd14f9790cc20998646af7e0a70de0dc7a8b2ea2f818ec1888e300
+  data.tar.gz: 45a69a1f9f34846cba4d0f96d71eaa716ee8db322c62e71504ee9bd13def67fcb601df81d5b7bf037b3931e606d2cde2428fca1af0686e3dabdc4d7c507cedb2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'lib/milight/v6/api/version.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/For:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+milight

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in milight-v6.gemspec
+gemspec
+
+gem 'rubocop', '~> 0.52.1', group: :test

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    milight-v6 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  milight-v6!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.52.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Peter Postma
+
+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,57 @@
+# Milight Wifi Bridge v6 Ruby API
+
+This gem provides a Ruby API for the Milight Wifi Bridge (or Wifi iBOX controller) version 6.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'milight-v6'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install milight-v6
+
+## Usage
+
+```ruby
+require "milight/v6"
+
+controller = Milight::V6::Controller.new("192.168.178.33")
+controller.zone(1).on
+
+controller.zone(2).on.brightness(70).warm_light
+
+controller.zone(3).on.saturation(80).hue(Milight::V6::Color::BLUE)
+
+controller.all.off
+```
+
+See `Milight::V6::All` and `Milight::V6::Zone` for all supported commands.
+
+## Command line
+
+A command line tool is included which can be used to control the lights.
+
+Usage: milight <host> <command> [zone]
+
+Supported commands: on, off, link, unlink
+
+```bash
+$ milight 192.168.178.33 on 1  # turn on lights for zone 1
+$ milight 192.168.178.33 off   # turn off lights for all zones
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ppostma/milight-v6-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "milight/v6"
+
+# 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(__FILE__)

data/bin/milight

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "milight/v6"
+
+if ARGV.length < 2
+  puts "Usage: #{$PROGRAM_NAME} <host> <command> [zone]"
+  exit 1
+end
+
+host = ARGV.shift
+command = ARGV.shift
+zone = ARGV.shift
+
+controller = Milight::V6::Controller.new(host)
+
+if zone.nil?
+  lights = controller.all
+else
+  lights = controller.zone(zone.to_i)
+end
+
+case command
+when "link"
+  lights.link
+when "unlink"
+  lights.unlink
+when "off"
+  lights.off
+when "on"
+  lights.on
+end

data/bin/setup

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

data/lib/milight/v6.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "milight/v6/color"
+require "milight/v6/controller"
+
+require "milight/v6/version"

data/lib/milight/v6/all.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Milight
+  module V6
+    class All
+      def initialize(command)
+        @command = command
+      end
+
+      # Switch the lights on.
+      def on
+        @command.on(0)
+
+        self
+      end
+
+      # Switch the lights off.
+      def off
+        @command.off(0)
+
+        self
+      end
+
+      # Enable night light mode.
+      def night_light
+        @command.night_light(0)
+
+        self
+      end
+
+      # Set brightness, value: 0% to 100%
+      def brightness(value)
+        @command.brightness(0, value)
+
+        self
+      end
+
+      # Set color temperature, value: 0 = 2700K, 100 = 6500K.
+      def temperature(value)
+        @command.temperature(0, value)
+
+        self
+      end
+
+      # Set color temperature to warm light (2700K).
+      def warm_light
+        @command.temperature(0, 0)
+
+        self
+      end
+
+      # Set color temperature to white (cool) light (6500K).
+      def white_light
+        @command.temperature(0, 100)
+
+        self
+      end
+
+      # Set the hue, value: 0 to 255 (red).
+      # See Milight::V6::Color for predefined colors.
+      def hue(value)
+        @command.hue(0, value)
+
+        self
+      end
+
+      # Set the saturation, value: 0% to 100%.
+      def saturation(value)
+        @command.saturation(0, value)
+
+        self
+      end
+
+      # Wait before continuing to next command.
+      def wait(seconds)
+        sleep(seconds)
+
+        self
+      end
+    end
+  end
+end

data/lib/milight/v6/color.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Milight
+  module V6
+    module Color
+      RED      = 0xFF
+      LAVENDER = 0xD9
+      BLUE     = 0xBA
+      AQUA     = 0x85
+      GREEN    = 0x7A
+      LIME     = 0x54
+      YELLOW   = 0x3B
+      ORANGE   = 0x1E
+    end
+  end
+end

data/lib/milight/v6/command.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "milight/v6/socket"
+
+module Milight
+  module V6
+    # see http://www.limitlessled.com/dev/
+    class Command
+      def initialize(host, port = 5987)
+        @socket = Milight::V6::Socket.new(host, port)
+
+        bridge_session
+      end
+
+      def link(zone_id)
+        execute(zone_id, [0x3D, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00])
+      end
+
+      def unlink(zone_id)
+        execute(zone_id, [0x3E, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00])
+      end
+
+      def on(zone_id)
+        execute(zone_id, [0x31, 0x00, 0x00, 0x08, 0x04, 0x01, 0x00, 0x00, 0x00])
+      end
+
+      def off(zone_id)
+        execute(zone_id, [0x31, 0x00, 0x00, 0x08, 0x04, 0x02, 0x00, 0x00, 0x00])
+      end
+
+      def night_light(zone_id)
+        execute(zone_id, [0x31, 0x00, 0x00, 0x08, 0x04, 0x05, 0x00, 0x00, 0x00])
+      end
+
+      def brightness(zone_id, value)
+        raise ArgumentError, "Please supply a brightness value between 0-100." if value.negative? || value > 100
+
+        execute(zone_id, [0x31, 0x00, 0x00, 0x08, 0x03, value, 0x00, 0x00, 0x00])
+      end
+
+      def temperature(zone_id, value)
+        raise ArgumentError, "Please supply a temperature value between 0-100 (2700K to 6500K)." if value.negative? || value > 100
+
+        execute(zone_id, [0x31, 0x00, 0x00, 0x08, 0x05, value, 0x00, 0x00, 0x00])
+      end
+
+      def hue(zone_id, value)
+        raise ArgumentError, "Please supply a hue value between 0-255." if value.negative? || value > 255
+
+        execute(zone_id, [0x31, 0x00, 0x00, 0x08, 0x01, value, value, value, value])
+      end
+
+      def saturation(zone_id, value)
+        raise ArgumentError, "Please supply a saturation value between 0-100." if value.negative? || value > 100
+
+        execute(zone_id, [0x31, 0x00, 0x00, 0x08, 0x02, value, 0x00, 0x00, 0x00])
+      end
+
+      def execute(zone_id, command)
+        raise ArgumentError, "Please supply a zone ID between 1-4." if zone_id.negative? || zone_id > 4
+
+        # UDP Hex Send Format: 80 00 00 00 11 {WifiBridgeSessionID1} {WifiBridgeSessionID2} 00 {SequenceNumber} 00 {COMMAND} {ZONE NUMBER} 00 {Checksum}
+        request = [0x80, 0x00, 0x00, 0x00, 0x11, @session_id1, @session_id2, 0x00, next_sequence_number, 0x00]
+
+        request += command
+
+        request << zone_id
+        request << 0x00
+        request << calculate_checksum(request)
+
+        @socket.send_bytes(request)
+        @socket.receive_bytes
+      end
+
+      private
+
+      def bridge_session
+        # UDP.SEND hex bytes: 20 00 00 00 16 02 62 3A D5 ED A3 01 AE 08 2D 46 61 41 A7 F6 DC AF (D3 E6) 00 00 1E <-- Send this to the ip address of the wifi bridge v6
+        request = [0x20, 0x00, 0x00, 0x00, 0x16, 0x02, 0x62, 0x3A, 0xD5,
+                   0xED, 0xA3, 0x01, 0xAE, 0x08, 0x2D, 0x46, 0x61, 0x41,
+                   0xA7, 0xF6, 0xDC, 0xAF, 0xD3, 0xE6, 0x00, 0x00, 0x1E]
+
+        @socket.send_bytes(request)
+        response = @socket.receive_bytes
+
+        @session_id1 = response[19]
+        @session_id2 = response[20]
+      end
+
+      def next_sequence_number
+        @sequence_number = 0 if @sequence_number.nil? || @sequence_number >= 255
+        @sequence_number += 1
+
+        @sequence_number
+      end
+
+      def calculate_checksum(bytes)
+        checksum = 0
+
+        for i in 10..19 do
+          checksum += bytes[i]
+        end
+
+        checksum & 0xFF
+      end
+    end
+  end
+end

data/lib/milight/v6/controller.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "milight/v6/command"
+require "milight/v6/all"
+require "milight/v6/zone"
+
+module Milight
+  module V6
+    class Controller
+      def initialize(host, port = 5987)
+        @command = Milight::V6::Command.new(host, port)
+      end
+
+      # Select all zones.
+      def all
+        Milight::V6::All.new(@command)
+      end
+
+      # Select a specific zone.
+      def zone(zone_id)
+        Milight::V6::Zone.new(@command, zone_id)
+      end
+    end
+  end
+end

data/lib/milight/v6/socket.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "logger"
+require "socket"
+
+module Milight
+  module V6
+    class Socket
+      def initialize(host, port)
+        @host = host
+        @port = port
+        @socket = UDPSocket.new
+
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO if ENV["MILIGHT_DEBUG"] != "1"
+      end
+
+      def send_bytes(bytes)
+        @logger.debug("Sending: #{format_bytes_as_hex(bytes)}")
+
+        @socket.send bytes.pack('C*'), 0, @host, @port
+      end
+
+      def receive_bytes
+        response = @socket.recvfrom(128).first
+        bytes = response.unpack('C*')
+
+        @logger.debug("Received: #{format_bytes_as_hex(bytes)}")
+
+        bytes
+      end
+
+      private
+
+      def format_bytes_as_hex(bytes)
+        bytes.map { |s| format("0x%02X", s) }
+      end
+    end
+  end
+end

data/lib/milight/v6/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Milight
+  module V6
+    VERSION = "0.1.0"
+  end
+end

data/lib/milight/v6/zone.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Milight
+  module V6
+    class Zone
+      attr_reader :zone_id
+
+      def initialize(command, zone_id)
+        @command = command
+        @zone_id = zone_id
+      end
+
+      # Link/sync light bulbs.
+      def link
+        @command.link(zone_id)
+
+        self
+      end
+
+      # Unlink/clear light bulbs.
+      def unlink
+        @command.unlink(zone_id)
+
+        self
+      end
+
+      # Switch the lights on.
+      def on
+        @command.on(zone_id)
+
+        self
+      end
+
+      # Switch the lights off.
+      def off
+        @command.off(zone_id)
+
+        self
+      end
+
+      # Enable night light mode.
+      def night_light
+        @command.night_light(zone_id)
+
+        self
+      end
+
+      # Set brightness, value: 0% to 100%
+      def brightness(value)
+        @command.brightness(zone_id, value)
+
+        self
+      end
+
+      # Set color temperature, value: 0 = 2700K, 100 = 6500K.
+      def temperature(value)
+        @command.temperature(zone_id, value)
+
+        self
+      end
+
+      # Set color temperature to warm light (2700K).
+      def warm_light
+        @command.temperature(zone_id, 0)
+
+        self
+      end
+
+      # Set color temperature to white (cool) light (6500K).
+      def white_light
+        @command.temperature(zone_id, 100)
+
+        self
+      end
+
+      # Set the hue, value: 0 to 255 (red).
+      # See Milight::V6::Color for predefined colors.
+      def hue(value)
+        @command.hue(zone_id, value)
+
+        self
+      end
+
+      # Set the saturation, value: 0% to 100%.
+      def saturation(value)
+        @command.saturation(zone_id, value)
+
+        self
+      end
+
+      # Wait before continuing to next command.
+      def wait(seconds)
+        sleep(seconds)
+
+        self
+      end
+    end
+  end
+end

data/milight-v6.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "milight/v6/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "milight-v6"
+  spec.version       = Milight::V6::VERSION
+  spec.authors       = ["Peter Postma"]
+  spec.email         = ["peter.postma@gmail.com"]
+
+  spec.summary       = "Ruby API for the Milight Wifi Bridge v6"
+  spec.description   = "Ruby API for the Milight Wifi Bridge (or Wifi iBOX controller) version 6."
+  spec.homepage      = "https://github.com/ppostma/milight-v6-api"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = ["milight"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: milight-v6
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Postma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby API for the Milight Wifi Bridge (or Wifi iBOX controller) version
+  6.
+email:
+- peter.postma@gmail.com
+executables:
+- milight
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/milight
+- bin/setup
+- lib/milight/v6.rb
+- lib/milight/v6/all.rb
+- lib/milight/v6/color.rb
+- lib/milight/v6/command.rb
+- lib/milight/v6/controller.rb
+- lib/milight/v6/socket.rb
+- lib/milight/v6/version.rb
+- lib/milight/v6/zone.rb
+- milight-v6.gemspec
+homepage: https://github.com/ppostma/milight-v6-api
+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.14
+signing_key: 
+specification_version: 4
+summary: Ruby API for the Milight Wifi Bridge v6
+test_files: []