yeelight-lamp-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4daf27a8b30269c578aee1962bdd700e94abe886
+  data.tar.gz: 921511f4f0a975f2d530ab05ddaed32731fd7c07
+SHA512:
+  metadata.gz: 2a973ab724c5a149d027f9c268ff1575ca9e033b509257c4effc4bd17038685416f25267f8954bc0eacd34bec1444bc7d7e762fafcaa7e48a78f5c475a41f69e
+  data.tar.gz: '08c983beb6227e9585a7ff4a4b886ab667f3a778ff3be1fa7a19705c0b32f9cfa143b2890297120edf4585c1e25a114fc7bab0812dff3f56bb9ab64fe360f87a'

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at antondavydov.o@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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-lamp-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    yeelight-lamp-client (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  yeelight-lamp-client!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Anton Davydov
+
+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,51 @@
+# Yeelight::Lamp::Client
+
+Simple client for Yeelight lamps
+
+Inspired by:
+https://github.com/nunows/Yeelight-Wifi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yeelight-lamp-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yeelight-lamp-client
+
+## Usage
+
+```ruby
+require_relative './lib/yeelight'
+
+GREEN = '5701376'
+RED = '16713472'
+
+client = Yeelight::Client.new(LAMP_IP_ADDRESS, 55443)
+client.get_prop('"ct"') # => JSON with props
+
+lamp = Yeelight::Lamp.new(client)
+lamp.toggle_color(GREEN, 2)
+sleep 1
+lamp.toggle_color(RED, 2)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davydovanton/yeelight-lamp-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Yeelight::Lamp::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yeelight-lamp-client/blob/master/CODE_OF_CONDUCT.md).

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 => :test

data/bin/console

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

@@ -0,0 +1,7 @@
+require "yeelight/client"
+require "yeelight/lamp"
+require "yeelight/version"
+
+module Yeelight
+  # Your code goes here...
+end

data/lib/yeelight/client.rb

@@ -0,0 +1,182 @@
+require 'socket'
+require 'json'
+require 'timeout'
+
+module Yeelight
+  class Client
+    def initialize(host, port)
+      @host = host
+      @port = port
+    end
+
+    def request(cmd)
+      begin
+        s = TCPSocket.open(@host, @port)
+        s.puts cmd
+        data = s.gets.chomp
+        s.close
+        response(data)
+      rescue Exception => msg
+        response(JSON.generate({:exception => msg}))
+      end
+    end
+
+    def response(data)
+      json = JSON.parse(data)
+      # create a standard response message
+      result = {
+        :status => json['result'] ? true : false,
+        :data => json
+      }
+      JSON.generate(result)
+    end
+
+    private :request, :response
+
+    # This method is used to retrieve current property of smart LED.
+    def get_prop(values)
+      cmd = "{\"id\":1,\"method\":\"get_prop\",\"params\":[#{values}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to change the color temperature of a smart LED.
+    def set_ct_abx(ct_value, effect, duration)
+      cmd = "{\"id\":2,\"method\":\"set_ct_abx\",\"params\":[#{ct_value},\"#{effect}\",#{duration}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to change the color RGB of a smart LED.
+    def set_rgb(rgb_value, effect, duration)
+      cmd = "{\"id\":3,\"method\":\"set_rgb\",\"params\":[#{rgb_value},\"#{effect}\",#{duration}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to change the color HSV of a smart LED.
+    def set_hsv(hue, sat, effect, duration)
+      cmd = "{\"id\":4,\"method\":\"set_hsv\",\"params\":[#{hue},#{sat},\"#{effect}\",#{duration}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to change the brightness of a smart LED.
+    def set_bright(brightness, effect, duration)
+      cmd = "{\"id\":5,\"method\":\"set_bright\",\"params\":[#{brightness},\"#{effect}\",#{duration}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to switch on or off the smart LED (software managed on/off).
+    def set_power(power, effect, duration)
+      cmd = "{\"id\":6,\"method\":\"set_power\",\"params\":[\"#{power}\",\"#{effect}\",#{duration}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to toggle the smart LED.
+    def toggle
+      cmd = "{\"id\":7,\"method\":\"toggle\",\"params\":[]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to save current state of smart LED in persistent memory.
+    # So if user powers off and then powers on the smart LED again (hard power reset),
+    # the smart LED will show last saved state.
+    # Note: The "automatic state saving" must be turn off
+    def set_default
+      cmd = "{\"id\":8,\"method\":\"set_default\",\"params\":[]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to start a color flow. Color flow is a series of smart
+    # LED visible state changing. It can be brightness changing, color changing
+    # or color temperature changing
+    def start_cf(count, action, flow_expression)
+      cmd = "{\"id\":9,\"method\":\"set_power\",\"params\":[#{count},#{action},\"#{flow_expression}\"]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to stop a running color flow.
+    def stop_cf
+      cmd = "{\"id\":10,\"method\":\"stop_cf\",\"params\":[]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to set the smart LED directly to specified state. If
+    # the smart LED is off, then it will turn on the smart LED firstly and then
+    # apply the specified scommand.
+    def set_scene(classe, val1, val2)
+      cmd = "{\"id\":11,\"method\":\"set_scene\",\"params\":[\"#{classe}\",#{val1},#{val2}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to start a timer job on the smart LED
+    def cron_add(type, value)
+      cmd = "{\"id\":12,\"method\":\"cron_add\",\"params\":[#{type},#{value}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to retrieve the setting of the current cron job
+    # of the specified type
+    def cron_get(type)
+      cmd = "{\"id\":13,\"method\":\"cron_get\",\"params\":[#{type}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to stop the specified cron job.
+    def cron_del(type)
+      cmd = "{\"id\":14,\"method\":\"cron_del\",\"params\":[#{type}]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to change brightness, CT or color of a smart LED
+    # without knowing the current value, it's main used by controllers.
+    def set_adjust(action, prop)
+      cmd = "{\"id\":15,\"method\":\"set_adjust\",\"params\":[\"#{action}\",\"#{prop}\"]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to name the device. The name will be stored on the
+    # device and reported in discovering response. User can also read the name
+    # through “get_prop” method.
+    def set_name(name)
+      cmd = "{\"id\":16,\"method\":\"set_name\",\"params\":[\"#{name}\"]}\r\n"
+      request(cmd)
+    end
+
+    # This method is used to switch on the smart LED
+    def on
+      set_power("on", "smooth",1000)
+    end
+
+    # This method is used to switch off the smart LED
+    def off
+      set_power("off", "smooth",1000)
+    end
+
+
+    # This method is used to discover a smart LED in the network
+    def self.discover
+      host = "239.255.255.250"
+      port = 1982
+      socket  = UDPSocket.new(Socket::AF_INET)
+
+      payload = []
+      payload << "M-SEARCH * HTTP/1.1\r\n"
+      payload << "HOST: #{host}:#{port}\r\n"
+      payload << "MAN: \"ssdp:discover\"\r\n"
+      payload << "ST: wifi_bulb"
+
+      socket.send(payload.join(), 0, host, port)
+
+      devices = []
+      begin
+        Timeout.timeout(2) do
+          loop do
+            devices << socket.recvfrom(2048)
+          end
+        end
+      rescue Timeout::Error => ex
+        ex
+      end
+
+      devices
+    end
+  end
+end

data/lib/yeelight/lamp.rb

@@ -0,0 +1,30 @@
+module Yeelight
+  class Lamp
+    VALUES = '"rgb", "ct", "color_mode", "hue", "sat"'
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def toggle_color(color_hex, duration = 1)
+      color = "0x#{color_hex}".to_i(16)
+
+      rgb, ct, color_mode, hue, sat = JSON.parse(client.get_prop(VALUES))['data']['result']
+
+      client.set_rgb(color, 'smooth', 500)
+      sleep duration
+
+      case color_mode.to_i
+      when 1
+        client.set_rgb(rgb, 'smooth', 500)
+      when 2
+        client.set_ct_abx(ct, 'smooth', 500)
+      when 3
+        client.set_hsv(hue, sat, 'smooth', 500)
+      end
+    end
+  end
+end
+

data/lib/yeelight/version.rb

@@ -0,0 +1,3 @@
+module Yeelight
+  VERSION = "0.1.0"
+end

data/yeelight-lamp-client.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yeelight/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yeelight-lamp-client"
+  spec.version       = Yeelight::VERSION
+  spec.authors       = ["Anton Davydov"]
+  spec.email         = ["antondavydov.o@gmail.com"]
+
+  spec.summary       = %q{Ruby client for yeelight lamps}
+  spec.homepage      = "https://github.com/davydovanton/yeelight-lamp-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: yeelight-lamp-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Davydov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-03 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: 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:
+- antondavydov.o@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yeelight.rb
+- lib/yeelight/client.rb
+- lib/yeelight/lamp.rb
+- lib/yeelight/version.rb
+- yeelight-lamp-client.gemspec
+homepage: https://github.com/davydovanton/yeelight-lamp-client
+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.13
+signing_key: 
+specification_version: 4
+summary: Ruby client for yeelight lamps
+test_files: []