yeelight-client 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb98a134503f504391f1761d58cb09eb9679daf9ac1f7a9b70289ee00f05ab76
+  data.tar.gz: 0a0fee6c5ea0404fef06d81e1df180e42debdc1c5eab37b1abb30588655ae27f
+SHA512:
+  metadata.gz: aa273c4520f489e82948d812e1cd3de64f9240463a818baa079ec1e982ff2f041fda57261911a7b234bba33c7402464f653948848aa0de4fb8495f65fa37213b
+  data.tar.gz: 3b631a17ca51965a6efc6386763e46c16d5d8e0cb36e5bc73fe3bc6e8a3efe1f6c56f1b5e68c6313ef32553789f1cdbba951f131050134ad966556cf9e779805

data/.gitignore

@@ -0,0 +1,12 @@
+/.idea/
+/.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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yeelight-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    yeelight-client (1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bump (0.8.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump (~> 0.8.0)
+  bundler (~> 1.17)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  yeelight-client!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,80 @@
+# YeelightClient
+
+Official implementation of Yeelight Operation Spec
+
+https://www.yeelight.com/en_US/developer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yeelight-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yeelight-client
+
+## Usage
+
+This gem split into two parts. The first is to how to discover all Yeelight lights in your local network.
+```ruby
+results = YeelightClient::Broadcast.new(logger: Logger.new(STDOUT)).discover
+results.first.addr
+```
+
+You will see something like this if your have many lights:
+
+```
+I, [2019-11-02T23:42:56.142927 #3071]  INFO -- : Receive #<UDPSocket:fd 9, AF_INET, 0.0.0.0, 56343>
+I, [2019-11-02T23:42:56.143275 #3071]  INFO -- : Receive #<UDPSocket:fd 9, AF_INET, 0.0.0.0, 56343>
+I, [2019-11-02T23:42:56.143811 #3071]  INFO -- : Receive #<UDPSocket:fd 9, AF_INET, 0.0.0.0, 56343>
+I, [2019-11-02T23:42:56.144785 #3071]  INFO -- : Receive #<UDPSocket:fd 9, AF_INET, 0.0.0.0, 56343>
+I, [2019-11-02T23:42:56.144911 #3071]  INFO -- : Receive #<UDPSocket:fd 9, AF_INET, 0.0.0.0, 56343>
+I, [2019-11-02T23:42:56.145422 #3071]  INFO -- : Receive #<UDPSocket:fd 9, AF_INET, 0.0.0.0, 56343>
+```
+
+Get an addr from results:
+```
+irb(main):002:0> results.first.addr
+=> #<Addrinfo: 192.168.31.64:55443 TCP>
+irb(main):003:0> addr.ip_address
+=> "192.168.31.16"
+irb(main):004:0> addr.ip_port
+=> 55443
+```
+
+
+For now you have every Yeelight host and port. We have to go next part of this gem Yeelight Client.
+
+Initialize client with received addr or with host and port
+
+```ruby
+client = YeelightClient.new(addrs: addr, logger: Logger.new(STDOUT))
+```
+
+```ruby
+client = YeelightClient.new(capabilities: { host: "192.168.31.16", port: 55443 }, logger: Logger.new(STDOUT))
+```
+
+Client supports only two methods: set_bright and set_rgb
+
+```ruby
+client.set_bright(100)
+client.set_rgb(0xff0000)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yeelight-client.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/bump

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bump' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bump", "bump")

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logger"
+require "yeelight_client"
+
+# 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/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/yeelight-client.rb

@@ -0,0 +1 @@
+require "yeelight_client"

data/lib/yeelight_client/broadcast/broadcaster.rb

@@ -0,0 +1,89 @@
+class YeelightClient
+  class Broadcast
+    class Broadcaster
+      DEFAULT_TIMEOUT = 3
+      DEFAULT_MAX_PACK = 65_535
+      HEADER_MATCH = /^([^:]+):\s*(.+)$/
+
+      SSDP_HOST = "239.255.255.250".freeze
+      SSDP_PORT = 1982
+      SSDP_MX = 100
+      SSDP_ST = "wifi_bulb".freeze
+
+      def initialize(logger: nil)
+        @socket = create_socket
+        @logger = logger
+      end
+
+      def broadcast
+        query = build_query
+        @socket.send(query, 0, SSDP_HOST, SSDP_PORT)
+        packages = receive
+        packages.map { |message, producer| process_packet(message, producer) }
+      end
+
+      private
+
+      def receive
+        remaining = DEFAULT_TIMEOUT
+        responses = []
+
+        while remaining > 0
+          start_time = Time.now
+          ready = IO.select([@socket], nil, nil, remaining)
+
+          @logger&.info { "Receive #{ready.dig(0, 0).inspect}" } if ready
+
+          if ready
+            message, producer = @socket.recvfrom DEFAULT_MAX_PACK
+            responses << [message, producer]
+          end
+
+          remaining -= (Time.now - start_time).to_i
+        end
+
+        responses
+      end
+
+      def process_packet(message, producer)
+        message = parse_message(message)
+        { address: producer[3], port: producer[1], message: message }
+      end
+
+      def parse_message(message)
+        message.gsub! "\r\n", "\n"
+        header, body = message.split "\n\n"
+
+        header = header.split "\n"
+        status = header.shift
+        params = {}
+        header.each do |line|
+          match = HEADER_MATCH.match line
+          next if match.nil?
+          value = match[2]
+          value = (value[1, value.length - 2] || '') if value.start_with?('"') && value.end_with?('"')
+          params[match[1]] = value
+        end
+
+        { status: status, headers: params, body: body }
+      end
+
+      def build_query
+        query = "M-SEARCH * HTTP/1.1\r\n" \
+              "HOST: #{SSDP_HOST}:#{SSDP_PORT}\r\n" \
+              "MAN: \"ssdp:discover\"\r\n" \
+              "MX: #{SSDP_MX}\r\n" \
+              "ST: #{SSDP_ST}\r\n" \
+              "\r\n"
+        query
+      end
+
+      def create_socket
+        broadcaster = UDPSocket.new
+        broadcaster.setsockopt Socket::SOL_SOCKET, Socket::SO_BROADCAST, true
+        broadcaster.setsockopt Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, 1
+        broadcaster
+      end
+    end
+  end
+end

data/lib/yeelight_client/broadcast/response.rb

@@ -0,0 +1,18 @@
+class YeelightClient
+  class Broadcast
+    class Response
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def addr
+        location = @data.dig(:message, :headers, "Location")
+        return unless location
+        uri = URI.parse(location)
+        Addrinfo.tcp(uri.host, uri.port)
+      end
+    end
+  end
+end

data/lib/yeelight_client/broadcast.rb

@@ -0,0 +1,20 @@
+require "socket"
+require "yeelight_client/broadcast/broadcaster"
+require "yeelight_client/broadcast/response"
+
+class YeelightClient
+  class Broadcast
+    def initialize(logger: nil)
+      @broadcaster = Broadcaster.new(logger: logger)
+      @logger = logger
+    end
+
+    def discover
+      responses = @broadcaster.broadcast
+      responses.map do |response|
+        Broadcast::Response.new(response)
+      end
+    end
+  end
+end
+

data/lib/yeelight_client/connection.rb

@@ -0,0 +1,68 @@
+require "socket"
+require "json"
+require "timeout"
+
+class YeelightClient
+  class Connection
+    class Group
+      def initialize(connections:)
+        @connections = Array(connections)
+      end
+
+      def request(query)
+        @connections.map { |connection| connection.request(query) }
+      end
+    end
+
+    DEFAULT_TIMEOUT = 60
+    DEFAULT_REQUEST_ID = 0
+    DEFAULT_PORT = 5544
+
+    def initialize(host:, port: nil, logger: nil)
+      @host = host
+      @port = port || DEFAULT_PORT
+      @logger = logger
+      # TODO: shared counter
+      @request_id = rand(10) * 1000 + DEFAULT_REQUEST_ID
+    end
+
+    def request(query)
+      request_id = build_request_id
+      query = { id: request_id }.merge(query)
+
+      @logger&.info { "Query #{query.to_json} to yeelight #{@host}:#{@port}" }
+      text = dump_query(query)
+
+      socket = TCPSocket.new(@host, @port)
+      socket.write(text)
+
+      result = Timeout.timeout(DEFAULT_TIMEOUT) do
+        loop do
+          data = socket.readline
+          result = parse_data(data)
+          break result if result["id"].eql?(@request_id)
+        end
+      end
+
+      @logger&.info { "Result #{result.to_json}" }
+      result
+
+    ensure
+      socket&.close
+    end
+
+    private
+
+    def dump_query(query)
+      "#{query.to_json}\r\n"
+    end
+
+    def parse_data(data)
+      JSON.parse(data)
+    end
+
+    def build_request_id
+      @request_id += 1
+    end
+  end
+end

data/lib/yeelight_client/handler.rb

@@ -0,0 +1,17 @@
+class YeelightClient
+  module Handler
+    def wrap(method)
+      prev = "_#{method}".to_sym
+      alias_method prev, method
+      define_method(method) do |*args|
+        begin
+          responses = send(prev, *args)
+          return responses if responses.size > 1
+          responses.first
+        rescue => exception
+          Response::Exception.new(exception)
+        end
+      end
+    end
+  end
+end

data/lib/yeelight_client/requests.rb

@@ -0,0 +1,33 @@
+class YeelightClient
+  module Requests
+    extend Handler
+
+    def set_bright(value, params: {})
+      params = prep_params(params)
+        .slice(:effect, :duration)
+
+      query = {
+        method: "set_bright",
+        params: [value, *params.values]
+      }
+
+      responses = @connection.request(query)
+      responses.map { |response| Response::Result.new(response) }
+    end
+
+    def set_rgb(value, params: {})
+      params = prep_params(params)
+        .slice(:effect, :duration)
+
+      query = {
+        method: "set_rgb",
+        params: [value, *params.values]
+      }
+
+      responses = @connection.request(query)
+      responses.map { |response| Response::Result.new(response) }
+    end
+
+    instance_methods.each { |method| wrap(method) }
+  end
+end

data/lib/yeelight_client/response/exception.rb

@@ -0,0 +1,40 @@
+class YeelightClient
+  class Response
+    class Exception < YeelightClient::Response
+      attr_reader :exception
+
+      def initialize(exception)
+        @exception = exception
+        detect_errors
+      end
+
+      def success?
+        false
+      end
+
+      def data
+        {}
+      end
+
+      def details
+        @exception.message
+      end
+
+      private
+
+      def detect_errors
+        # EOFError - when lamp is busy
+        case @exception
+        when EOFError
+          assign_errors(:device_busy, :device_error)
+        when Timeout::Error, Errno::ETIMEDOUT
+          assign_errors(:http_timeout, :network_error)
+        when Errno::ECONNRESET, Errno::ECONNREFUSED, Errno::EINVAL
+          assign_errors(:socket_error, :network_error)
+        else
+          assign_errors(:unknown, :exception)
+        end
+      end
+    end
+  end
+end

data/lib/yeelight_client/response/result.rb

@@ -0,0 +1,17 @@
+class YeelightClient
+  class Response
+    class Result < YeelightClient::Response
+      def data
+        return unless success?
+        super["result"]
+      end
+
+      # {"id"=>4, "error"=>{"code"=>-5000, "message"=>"general error"}}
+      # Result {"id":8232,"error":{"code":-1,"message":"client quota exceeded"}}
+      def detect_errors
+        return unless success?
+
+      end
+    end
+  end
+end

data/lib/yeelight_client/response.rb

@@ -0,0 +1,38 @@
+class YeelightClient
+  class Response
+    attr_reader :error, :error_type
+
+    def initialize(data)
+      @data = data
+      detect_errors
+    end
+
+    def success?
+      @data&.has_key?("result")
+    end
+
+    def fail?
+      !success?
+    end
+
+    def data
+      @data || {}
+    end
+
+    def details
+
+    end
+
+    private
+
+    def detect_errors
+      return if success?
+      assign_errors(:unknown, :unknown)
+    end
+
+    def assign_errors(error, type)
+      @error = error
+      @error_type = type
+    end
+  end
+end

data/lib/yeelight_client/version.rb

@@ -0,0 +1,3 @@
+class YeelightClient
+  VERSION = "1.0.2"
+end

data/lib/yeelight_client.rb

@@ -0,0 +1,42 @@
+require "yeelight_client/handler"
+require "yeelight_client/connection"
+require "yeelight_client/requests"
+require "yeelight_client/response"
+require "yeelight_client/response/result"
+require "yeelight_client/response/exception"
+require "yeelight_client/broadcast"
+
+class YeelightClient
+  include Requests
+
+  DEFAULT_PARAMS = {
+    effect: "sudden".freeze,
+    duration: 0
+  }
+
+  def initialize(addrs: nil, capabilities: {}, logger: nil)
+    @logger = logger
+    @connection = build_connection(addrs, capabilities)
+  end
+
+  private
+
+  def build_connection(addrs, capabilities)
+    connections = if addrs
+      addrs = Array(addrs).uniq { |addr| "#{addr.ip_address}:#{addr.ip_port}".hash }
+
+      addrs.map do |addr|
+        Connection.new(host: addr.ip_address, port: addr.ip_port, logger: @logger)
+      end
+    else
+      raise "Please specify capabilities host and port" unless capabilities[:host] && capabilities[:port]
+      Connection.new(host: capabilities[:host], port: capabilities[:port], logger: @logger)
+    end
+
+    Connection::Group.new(connections: connections)
+  end
+
+  def prep_params(params)
+    DEFAULT_PARAMS.merge(params)
+  end
+end

data/yeelight-client.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yeelight_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yeelight-client"
+  spec.version       = YeelightClient::VERSION
+  spec.authors       = ["Andrew Ostroumov"]
+  spec.email         = ["andrew.ostroumov@gmail.com"]
+
+  spec.summary       = %q{Yeelight Client}
+  spec.description   = %q{Official implementation of Yeelight Operation Spec}
+  spec.homepage      = "https://github.com/andrewostroumov/yeelight-client"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "bump", "~> 0.8.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: yeelight-client
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Andrew Ostroumov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Official implementation of Yeelight Operation Spec
+email:
+- andrew.ostroumov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/bump
+- bin/console
+- bin/setup
+- lib/yeelight-client.rb
+- lib/yeelight_client.rb
+- lib/yeelight_client/broadcast.rb
+- lib/yeelight_client/broadcast/broadcaster.rb
+- lib/yeelight_client/broadcast/response.rb
+- lib/yeelight_client/connection.rb
+- lib/yeelight_client/handler.rb
+- lib/yeelight_client/requests.rb
+- lib/yeelight_client/response.rb
+- lib/yeelight_client/response/exception.rb
+- lib/yeelight_client/response/result.rb
+- lib/yeelight_client/version.rb
+- yeelight-client.gemspec
+homepage: https://github.com/andrewostroumov/yeelight-client
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Yeelight Client
+test_files: []