milight 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3e8344aaa8ad7deb994a84f912d00f7ff12cf25
+  data.tar.gz: 50464a893318e56f13339df22857df680e7834f3
+SHA512:
+  metadata.gz: ec1ff3073876baa5deabd457ab963901b09452067e64263d48df8ec378258d5ad684dce52d7c0e69f991f6e61a7f20852f84d337cb045388888b97f1148b689f
+  data.tar.gz: 569487c0539325798cf7124038d88ef9df7a157b736ff2baf1930a10bc6bb14e78cc8b0ab4b0488e5e373d33cef76ad9231ad8801020d4d3383c529fa1797201

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.*
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-milight.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ippei Kato
+
+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,61 @@
+# Milight
+
+[![Build Status](https://travis-ci.org/beco-ippei/ruby-milight.svg?branch=master)](https://travis-ci.org/beco-ippei/ruby-milight)
+[![Coverage Status](https://coveralls.io/repos/github/beco-ippei/ruby-milight/badge.svg)](https://coveralls.io/github/beco-ippei/ruby-milight)
+
+A ruby wrapper project for milight api.
+
+controller ruby-api for milight or limitless-led
+(milight and limitless-led and easy-bulb is
+ same bridge-box controllable products)
+
+## API Document
+http://www.limitlessled.com/dev/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'milight'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install milight
+
+
+# components
+* local controller (working on LAN)
+* [may be not] gateway server (working on Internet)
+
+components messaging each other.
+use web-socket ??
+
+---
+
+# TODO
+setup
+---
+* ?) connect bridge-box and setup wifi config
+  or configure by Appli
+* ~~get bridge-box IP-Address (from LAN)~~
+* configure this app (make or overwrite config file ?)
+
+boot local-controller / env
+---
+* load config
+  * get bridge-box network segment (24bit)
+  * server url
+* bulb controller
+  * lib/bulb.rb
+  * and tests
+  * sample app
+  * controll by groups
+
+... writing.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/milight

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+SETUP = %w[setup]
+CONSOLE = %w[console c]
+all_cmd = SETUP + CONSOLE
+
+cmd = ARGV[0]
+unless cmd
+  puts <<-DESC
+    sub-command must set
+    valid commands are #{all_cmd.join ','}
+  DESC
+  exit
+end
+
+require 'milight'
+
+#TODO add group to bulb
+case cmd.downcase.to_sym
+when :setup
+  require 'milight/bridge_box'
+  Milight::BridgeBox.setup
+
+when :console, :c
+  require "irb"
+  IRB.start
+
+else
+  puts <<-DESC
+    sub-command '#{cmd}' is invalid.
+    valid commands are #{all_cmd.join ','}
+  DESC
+end
+

data/lib/milight.rb

@@ -0,0 +1,7 @@
+require "milight/version"
+
+require "milight/command"
+require "milight/color"
+require "milight/bulb"
+require "milight/util"
+

data/lib/milight/bridge_box.rb

@@ -0,0 +1,168 @@
+require 'milight'
+require 'readline'
+require "socket"
+
+module Milight::BridgeBox
+  MILIGHT_WIFI = /^10\.10\.100\.[0-9]+$/
+  SERVER_IP = '10.10.100.254'
+  RECEIVE_IP = "0.0.0.0"
+  PORT = '48899'
+
+  def self.setup
+    puts "-- Please connect wifi 'milight_XXXXXXX'."
+
+    if self.wait_connection true
+      puts '... milight connected.'
+    else
+      puts <<DESC
+  milight wifi connection timeout (1min)
+  if milight wifi not found, initialize your controller box.
+DESC
+      exit 1
+    end
+
+    sock = self.socket
+
+    t1 = Thread.new do
+      self.wait_wscan_results
+    end
+
+    sleep 1
+    puts '-- send command: WSCAN ....'
+    sock.command "Link_Wi-Fi"
+    sock.command "+ok"
+    sock.command "AT+WSCAN\r"
+
+    t1.join
+
+    wlans = t1.value.split "\n"
+
+    wlans.shift   # ignore header
+    ssids = wlans.map do |line|
+      ch, ssid, _, sec, _ = line.split ','
+      if ssid.is_a?(String) && ssid.length > 1
+        {ch: ch, ssid: ssid, sec: sec}
+      end
+    end.compact
+
+    ssid = self.choice_ssid ssids
+    puts "-- set wifi SSID : '#{ssid[:ssid]}'"
+    sock.command "AT+WSSSID=#{ssid[:ssid]}\r"
+
+    key = self.security_key
+    puts "-- set wifi security key : '#{key}'"
+    sock.command "AT+WSKEY=WPA2PSK,AES,#{key}\r"
+
+    sock.command "AT+WMODE=STA\r"
+    sock.command "AT+Z\r"
+    sock.command "AT+Q\r"
+
+    sock.close
+
+
+    if self.wait_connection false
+      puts <<DESC
+  ... miligt wifi disconnected.
+  check your controller box led!
+
+DESC
+    else
+      puts ' milight wifi connection still connected'
+      exit 1
+    end
+  end
+
+  def self.wait_connection(milight = true)
+    20.times do
+      sleep 3
+      if ipaddr = Milight::Util.current_ipaddr
+        print '.'
+      else
+        print '-'
+      end
+
+      if self.milight_wifi?(ipaddr) == milight
+        return true
+      end
+    end
+    false
+  end
+
+  def self.milight_wifi? ipaddr
+    !(ipaddr && MILIGHT_WIFI =~ ipaddr).nil?
+  end
+
+  def self.socket
+    sock = UDPSocket.open
+    sock.setsockopt(
+      Socket::SOL_SOCKET,
+      Socket::SO_BROADCAST,
+      1
+    )
+    def sock.command msg
+      self.send msg, 0, SERVER_IP, PORT
+    end
+    sock
+  end
+
+  def self.wait_wscan_results
+    puts '-- waiting receive response: WSCAN ....'
+    rsock = UDPSocket.new
+    rsock.bind(RECEIVE_IP, PORT)
+    string = nil
+
+    sel = IO::select([rsock])
+    if sel != nil
+      sel[0].each do |s|
+        data = s.recvfrom_nonblock(65535)
+        string = data[0].chomp!
+      end
+    else
+      puts '-- not received ....'
+      exit 1
+    end
+    rsock.close
+    string.gsub(/\+ok=\n/, '')
+  end
+
+  def self.choice_ssid ssids
+    puts '', '-'*20
+    puts " no: 'ssid' (security types)"
+    ssids.each.with_index do |s, idx|
+      num = '%#2d' % (idx+1)
+      puts " #{num}: '#{s[:ssid]}' (#{s[:sec]})"
+    end
+    puts '-'*20, ''
+    puts <<-DESC
+      Choise your SSID(no).
+      but if your Access point not found, restart app
+    DESC
+
+    while true
+      msg = ">> input your SSID no(1-#{ssids.size-1}) > "
+      num = Readline.readline(msg).chomp.to_i
+      if num == 0
+        next      # 0 or nil (not a number)
+      elsif !(1..ssids.size).cover? num
+        puts <<-MSG
+          invalid number : '#{num}'
+          exit.
+        MSG
+        exit 0
+      end
+      return ssids[num-1]
+    end
+  end
+
+  def self.security_key
+    while true
+      msg = '>> Input security key > '
+      key = Readline.readline(msg).chomp
+      if key != ""
+        return key
+      end
+    end
+  end
+
+end
+

data/lib/milight/bulb.rb

@@ -0,0 +1,179 @@
+require 'socket'
+require 'ipaddr'
+
+module Milight
+  class Bulb
+    def initialize(group: :all, ip: nil, port: 8899)
+      self.group = group
+      self.ip = ip
+      @port = port
+
+      @debugger = lambda {|_| }
+    end
+
+    #TODO: move to anywhere...
+    def debugger=(type)
+      @debugger = case type
+                  when :puts
+                    lambda {|msg|
+                      puts " - debug :: #{msg}"
+                    }
+                  else
+                    lambda {|_| }
+                  end
+      debug "set debug - #{type}"
+    end
+
+    def debug(msg)
+      @debugger.call msg
+    end
+
+    def on
+      command Command::LED_ON[@group]
+    end
+
+    def disco(attr = nil)
+      case attr && attr.to_sym
+      when nil
+        command Command::DISCO_MODE
+      when :faster, :fast
+        command Command::DISCO_SPEED_FASTER
+      when :slower, :slow
+        command Command::DISCO_SPEED_SLOWER
+      else
+        debug "invalid disco attribute: '#{attr}'"
+      end
+    end
+
+    def off
+      command Command::LED_OFF[@group]
+    end
+
+    # white-command 100ms followed by 'on-command'
+    def white
+      self.on
+      command Command::WHITE[@group]
+    end
+
+    # night-command 100ms followed by 'off-command'
+    def night
+      self.off
+      command Command::NIGHT[@group]
+    end
+
+    # for colors
+    Color.constants.each do |color|
+      color_name = color.downcase
+      define_method color_name.to_sym do
+        color_code = defined_color color
+        self.on
+        command Command::SET_COLOR, color_code
+      end
+    end
+
+    def color_value=(val)
+      if code = color_code(val)
+        self.on
+        command Command::SET_COLOR, code
+      else
+        debug "invalid color value '#{val}'"
+      end
+    end
+
+    def bright(persent)
+      if val = brightness(persent.to_i)
+        self.on
+        command Command::BRIGHTENESS, val
+      else
+        debug "invalid persent value '#{persent}'"
+      end
+    end
+
+    def full_bright
+      self.bright 50
+    end
+
+    def dark
+      self.bright 0
+    end
+
+    private
+
+    def ip=(ipaddr)
+      unless ipaddr
+        raise "ip is not allowed nil"
+      end
+      IPAddr.new ipaddr   # just validate
+      @ipaddr = ipaddr
+    end
+
+    def group=(group)
+      if group == :all
+        @group = :all
+      elsif (1..5).cover? group
+        @group = "group#{group}".to_sym
+      else
+        raise 'invalid group. use :all or 1..5'
+      end
+    end
+
+    def brightness(persent)
+      if (0..100).cover? persent
+        sprintf(
+          '%02d',
+          2 + 25 * persent.to_i / 100
+        )
+      end
+    end
+
+    def defined_color(method)
+      name = method.upcase.to_sym
+      if Color.constants.include? name
+        Color.const_get(name)
+      else
+        nil
+      end
+    end
+
+    # parse color code ("00" .. "ff")
+    # valid color-value is 0..255
+    def color_code(val)
+      if val.is_a? String
+        code = val
+        val = code.hex
+        val = -1 if val == 0 && code != '00'
+      elsif val.is_a? Fixnum
+        code = val
+        val = val.to_i
+        code = '%02x' % val
+      else
+        return nil
+      end
+
+      if (0..255).cover? val
+        code
+      else
+        nil
+      end
+    end
+
+    def command(cmd, value = '00')
+      debug "cmd : #{cmd} / #{value}"
+      msg = message cmd, value
+
+      #TODO: initialize first ?
+      sock = UDPSocket.open
+      sock.setsockopt(
+        Socket::SOL_SOCKET,
+        Socket::SO_BROADCAST,
+        1
+      )
+      sock.send(msg, 0, @ipaddr, @port)
+    end
+
+    def message(cmd, value)
+      [cmd, value, "55"].map(&:to_s)
+        .map(&:hex).pack "C*"
+    end
+  end
+end

data/lib/milight/color.rb

@@ -0,0 +1,21 @@
+module Milight
+  module Color
+    VIOLET = '00'
+    ROYAL_BLUE = '10'
+    BLUE = ROYAL_BLUE     # alias
+    BABY_BLUE = '20'
+    AQUA = '30'
+    MINT = '40'
+    SEAFOAM_GREEN = '50'
+    GREEN = '60'
+    LIME_GREEN = '70'
+    YELLOW = '80'
+    YELLOW_ORANGE = '90'
+    ORANGE = 'a0'
+    RED = 'b0'
+    PINK = 'c0'
+    FUSIA = 'd0'
+    LILAC = 'e0'
+    LAVENDAR = 'f0'
+  end
+end

data/lib/milight/command.rb

@@ -0,0 +1,49 @@
+module Milight
+  module Command
+    SET_COLOR = '40'
+
+    LED_ON = {
+      all: '42',
+      group1: '45',
+      group2: '47',
+      group3: '49',
+      group4: '4B',
+    }
+
+    LED_OFF = {
+      all: '41',
+      group1: '46',
+      group2: '48',
+      group3: '4A',
+      group4: '4C',
+    }
+
+    DISCO_SPEED_SLOWER = '43'
+    DISCO_SPEED_FASTER = '44'
+    DISCO_MODE = '4D'
+    DISCO_MODE_NEXT = '27'
+    DISCO_MODE_PREVIOUS = '28'
+
+    #TODO: not RGB?
+    WARM_WHITE_INCREASE = '3E'
+    COOL_WHITE_INCREASE = '3F'
+
+    BRIGHTENESS = '4E'
+
+    NIGHT = {
+      all: 'C1',
+      group1: 'C6',
+      group2: 'C8',
+      group3: 'CA',
+      group4: 'CC',
+    }
+
+    WHITE = {
+      all: 'C2',
+      group1: 'C5',
+      group2: 'C7',
+      group3: 'C9',
+      group4: 'CB',
+    }
+  end
+end

data/lib/milight/util.rb

@@ -0,0 +1,21 @@
+module Milight
+  module Util
+    def self.current_ipaddr
+      matched = /inet\ addr:([0-9\.]*)/.match wlan_config
+      matched[1] if matched
+    end
+
+    def self.broadcast_addr
+      matched = /Bcast:([0-9\.]*)/.match wlan_config
+      matched[1] if matched
+    end
+
+    private
+
+    #TODO: modularize for env/os.
+    def self.wlan_config
+      %x[LANG=C ifconfig wlan]
+    end
+  end
+end
+

data/lib/milight/version.rb

@@ -0,0 +1,3 @@
+module Milight
+  VERSION = "0.2.0"
+end

data/milight.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'milight/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "milight"
+  spec.version       = Milight::VERSION
+  spec.authors       = ["beco-ippei"]
+  spec.email         = ["beco.ippei@gmail.com"]
+
+  spec.summary       = %q{A ruby controller for Mi-Light LED bulb.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/beco-ippei/ruby-milight"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/sample/light.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'milight'
+
+ipaddr = ENV['IPADDR']
+
+group = (g = ARGV.shift) == 'all' ? :all : g.to_i
+bulb = Milight::Bulb.new ip: ipaddr, group: group
+
+cmd = ARGV.shift
+val = ARGV.shift
+
+case cmd.downcase
+when 'on'
+  bulb.on
+when 'off'
+  bulb.off
+when 'color'
+  bulb.send val.to_sym
+when 'color-list'
+  puts Milight::Color.constants
+    .map(&:downcase).join ', '
+when 'dark'
+  bulb.dark
+when 'bright'
+  bulb.bright val.to_i
+when 'night'
+  bulb.night
+when 'disco'
+  bulb.disco val
+end
+

data/sample/wakeup_light.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'milight'
+
+ipaddr = ENV['IPADDR']
+interval = 3 * 60     # 3min
+
+bulb = Milight::Bulb.new ip: ipaddr
+
+if ARGV[0] == 'prepare'
+  puts 'prepare for wakeup-light'
+  [:on, :dark, :lime_green, :off].each do |cmd|
+    bulb.send(cmd)
+    sleep 2
+  end
+  exit
+end
+
+# light on (night-mode)
+[
+  [:night],
+  [:on, :dark, :lime_green],
+  [[:bright, 10]],
+  [[:bright, 20]],
+  [:white],
+  [[:bright, 30]],
+  [:full_bright],
+  [:disco],
+].each do |commands|
+  commands.each do |cmd|
+    bulb.send(*cmd)
+    sleep 1.5
+  end
+  sleep interval
+end
+
+sleep 10 * 60   # 10min
+bulb.dark
+sleep 2
+bulb.off
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: milight
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- beco-ippei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: ''
+email:
+- beco.ippei@gmail.com
+executables:
+- milight
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/milight
+- lib/milight.rb
+- lib/milight/bridge_box.rb
+- lib/milight/bulb.rb
+- lib/milight/color.rb
+- lib/milight/command.rb
+- lib/milight/util.rb
+- lib/milight/version.rb
+- milight.gemspec
+- sample/light.rb
+- sample/wakeup_light.rb
+homepage: https://github.com/beco-ippei/ruby-milight
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby controller for Mi-Light LED bulb.
+test_files: []