xilight 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c3dc25e017b83233fc1bd1a00381a9caa30017d82ef30fb8faa1b939c180e08
-  data.tar.gz: 312521fb62a439c0c7450dfafb85d8b2b8bdef79800d9a09a49122c768d8fb0b
+  metadata.gz: 44464a51e814edd4efc2df5a1fbf336f8081faa936cc1a3a1e228bcdc6777ae7
+  data.tar.gz: fd04dddea590e4f0fb860b57e5334bacf017f151245eb839e425fd1727d6ebe0
 SHA512:
-  metadata.gz: 74b7b836df129bf26a10d7693537bed7c79ce7c1295739063965db489d51700412a19760d8ed30fea94c3e50c0b2961cbd837629da87e58380c76ea0251f94c0
-  data.tar.gz: 6aca5cae5c1c4380fe4fc4a42e55e0891a7e920cf02d03b533e131a76935c4b02975a6868aad7fe98aff751898c43defc6f30c4d3b8151721e6f34f0031a2983
+  metadata.gz: d065ccb4e6aa4ff99984778525dd69f1b6fda9cf2d7f25e1de176d241b53fbcd846e8735588cb11634f8a9efb320d5374f280803a9c72ebdab27ca0928dfa07b
+  data.tar.gz: 538d5da718744d16bd2690728a496cfd799fbee712ed97ec1166be6bde5deabf4a7b00e40b91cfeff47d3141e96f90038894d4450ee936e490903c8c0fba94b3

data/README.md

@@ -1,8 +1,8 @@
-# Yeelight
+# Xilight
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xilight`. To experiment with that code, run `bin/console` for an interactive prompt.
+Xilight provides a Ruby library and a CLI interface to control your Xiaomi Yeelight programmatically.
 
-TODO: Delete this and the text above, and describe your gem
+**Note**: It requires your yeelight to be configured to [development mode](https://www.yeelight.com/en_US/developer).
 
 ## Installation
 
@@ -22,7 +22,226 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Library
+
+Read the API docs [here](https://rubydoc.info/github/wouterken/xilight/master/Xilight/Yeelight).
+
+###  CLI
+
+#### Help
+
+    yee -h
+
+#### Discovery
+    Command:
+      yee discover
+
+    Usage:
+      yee discover
+
+    Description:
+      Discover Yeelights and save to ~/.config/.yeelights
+
+    Options:
+      --help, -h                        # Print this help
+
+    Examples:
+      yee discover
+
+#### List Lights
+
+    Command:
+      yee list
+
+    Usage:
+      yee list
+
+    Description:
+      List known Yeelights
+
+    Options:
+      --help, -h                        # Print this help
+
+    Examples:
+      yee list
+
+#### Set Light Name
+
+    Command:
+      yee name
+
+    Usage:
+      yee name NAME
+
+    Description:
+      Set name for Yeelight
+
+    Arguments:
+      NAME                  # REQUIRED Name to set for light
+
+    Options:
+      --light=VALUE, -l VALUE           # ID/index of Yeelight to target, default: "0"
+      --help, -h                        # Print this help
+
+    Examples:
+      yee name name -l 1 foo # Set the name for light#1 to "foo"
+
+
+#### Set RGB
+
+    Command:
+      yee rgb
+
+    Usage:
+      yee rgb R G B
+
+    Description:
+      Set RGB for Yeelight
+
+    Arguments:
+      R                     # REQUIRED Red (0-255)
+      G                     # REQUIRED Green (0-255)
+      B                     # REQUIRED Blue (0-255)
+
+    Options:
+      --light=VALUE, -l VALUE           # ID/index of Yeelight to target, default: "0"
+      --name=VALUE, -n VALUE            # Name of Yeelight to target
+      --help, -h                        # Print this help
+
+    Examples:
+      yee rgb 255 0 0 # set light to red (red 255, green 0, blue 0)
+      yee rgb 0 0 180 -n foo# set light with name foo to blue (red 0, green 0, blue 180)
+      yee rgb 255 255 255 -l 3# set light #3 to white (red 255, green 255, blue 255)
+
+
+#### Brightness
+
+    Command:
+      yee bright
+
+    Usage:
+      yee bright BRIGHTNESS
+
+    Description:
+      Set Brightness for Yeelight
+
+    Arguments:
+      BRIGHTNESS            # REQUIRED Brightness (0-100)
+
+    Options:
+      --light=VALUE, -l VALUE           # ID/index of Yeelight to target, default: "0"
+      --name=VALUE, -n VALUE            # Name of Yeelight to target
+      --help, -h                        # Print this help
+
+    Examples:
+      yee bright 100 # full brightness
+      yee bright 50 -n foo  # 50% brightness for light with name foo
+      yee bright 25 -l 3  # 25% brightness for light#3
+
+#### Set HSV
+
+    Command:
+      yee hsv
+
+    Usage:
+      yee hsv H S
+
+    Description:
+      Set HSV for Yeelight
+
+    Arguments:
+      H                     # REQUIRED Hue (0-359)
+      S                     # REQUIRED Saturation (0-100)
+
+    Options:
+      --light=VALUE, -l VALUE           # ID/index of Yeelight to target, default: "0"
+      --name=VALUE, -n VALUE            # Name of Yeelight to target
+      --help, -h                        # Print this help
+
+    Examples:
+      yee hsv 180 40 # set hue to 180 and saturation to 40
+      yee hsv 200 20 -n foo# set light with name foo to hue: 200, saturation: 20
+      yee hsv 359 90 -l 3# set light #3  to hue: 359, saturation: 90
+
+#### Turn Off
+
+    Command:
+      yee off
+
+    Usage:
+      yee off
+
+
+    Description:
+      Turn Off Yeelight
+
+    Options:
+      --light=VALUE, -l VALUE           # ID/index of Yeelight to target, default: "0"
+      --name=VALUE, -n VALUE            # Name of Yeelight to target
+      --help, -h                        # Print this help
+
+    Examples:
+      yee off # turn default/first light off
+      yee off -n kitchen # turn light with name 'kitchen' off
+      yee off -l 3 # turn light #3 off
+
+#### Turn On
+    Command:
+      yee on
+
+    Usage:
+      yee on
+
+    Description:
+      Turn on Yeelight
+
+    Options:
+      --light=VALUE, -l VALUE           # ID/index of Yeelight to target, default: "0"
+      --name=VALUE, -n VALUE            # Name of Yeelight to target
+      --help, -h                        # Print this help
+
+    Examples:
+      yee on # turn default/first light on
+      yee on -n kitchen # turn light with name 'kitchen' on
+      yee on -l 3 # turn light #3 on
+
+#### Toggle
+
+    Command:
+      yee toggle
+
+    Usage:
+      yee toggle
+
+    Description:
+      Toggle Yeelight
+
+    Options:
+      --light=VALUE, -l VALUE           # ID/index of Yeelight to target, default: "0"
+      --name=VALUE, -n VALUE            # Name of Yeelight to target
+      --help, -h                        # Print this help
+
+    Examples:
+      yee toggle # toggle default/first light
+      yee toggle -n kitchen # toggle light with name 'kitchen'
+      yee toggle -l 3 # toggle light #3
+
+#### Version
+
+    Command:
+      yee version
+
+    Usage:
+      yee version
+
+    Description:
+      Print version
+
+    Options:
+      --help, -h                        # Print this help
+
+    Examples:
+      yee version
 
 ## Development
 
@@ -32,5 +251,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xilight. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/wouterken/xilight. 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.
 

data/exe/yee

@@ -58,17 +58,11 @@ module Xilight
         ]
 
         def call(**)
-          current_config = ::Xilight::CLI.config
-          current_lights = current_config.fetch('yeelights', [])
-          ::Xilight::Yeelight.discover.each do |light|
-            current_lights.reject!{|l| l['id'] == light.id}
-            current_lights << light.instance_variables.map{|v| [v.to_s[1..-1], light.instance_variable_get(v)] }.to_h
-          end
-          current_config['yeelights'] = current_lights
-          current_lights.each_with_index do |light, index|
-            puts "Light ##{index} => #{(light['name'] || light['id'])}@#{light['host']}"
-          end
-          ::Xilight::CLI.config = current_config
+          ::Xilight::CLI.config = {
+            'yeelights' => ::Xilight::Yeelight.discover.each do |light|
+              light.instance_variables.map{|v| [v.to_s[1..-1], light.instance_variable_get(v)] }.to_h
+            end
+          }
         end
       end
 
@@ -236,7 +230,7 @@ module Xilight
         Object.const_set(class_name, Class.new(Dry::CLI::Command) do
           desc "Set yeelight to color #{color}"
           example [
-            "#{color}"
+            ""
           ]
 
           option :light, desc: "ID/index of Yeelight to target", default: "0", aliases: ["-l"]

data/lib/xilight.rb

@@ -25,11 +25,17 @@ module Xilight
     end
 
     def request(cmd)
-      s = TCPSocket.open(@host, @port)
-      s.puts "#{JSON.generate(cmd)}\r\n"
-      data = s.gets.chomp
-      s.close
-      JSON.parse(data)
+      begin
+        Timeout.timeout(0.5) do
+          s = TCPSocket.open(@host, @port)
+          s.puts "#{JSON.generate(cmd)}\r\n"
+          data = s.gets.chomp
+          s.close
+          JSON.parse(data)
+        end
+      rescue Timeout::Error
+        puts "Yeelight connection timed out. Yeelight not accessible"
+      end
     end
 
     # This method is used to retrieve current property of smart LED.
@@ -37,38 +43,44 @@ module Xilight
       request({id: 1,method: 'get_prop', params: values})
     end
 
-    # This method is used to change the color temperature of a smart LED.
+    # This method is used to change the color temperature of the smart LED.
     def set_ct_abx(ct_value, effect='smooth', duration=200)
       request({id: 2,method: 'set_ct_abx', params: [ct_value,effect,duration]})
     end
 
+    # This method is used to change the color temperature of the smart LED.
     def ct_abx=ct_value
       set_ct_abx(ct_value)
     end
 
-    # This method is used to change the color RGB of a smart LED.
+    # This method is used to change the color RGB of the smart LED.
+    # Expects an integer representing a hex triplet (e.g. 0xFFFFFF )
     def set_rgb(rgb_value, effect='smooth', duration=200)
       request({id: 3,method: 'set_rgb', params: [rgb_value,effect,duration]})
     end
 
+    # This method is used to change the color RGB of the smart LED.
+    # Expects an integer representing a hex triplet (e.g. 0xFFFFFF )
     def rgb=rgb_value
       set_rgb(rgb_value)
     end
 
-    # This method is used to change the color HSV of a smart LED.
+    # This method is used to change the color HSV of the smart LED.
     def set_hsv(hue, sat, effect='smooth', duration=200)
       request({id: 4,method: 'set_hsv', params: [hue,sat,effect,duration]})
     end
 
+    # This method is used to change the color HSV of the smart LED.
     def hsv=hue
       set_hsv(hue)
     end
 
-    # This method is used to change the brightness of a smart LED.
+    # This method is used to change the brightness of the smart LED.
     def set_bright(brightness, effect='smooth', duration=200)
       request({id: 5,method: 'set_bright', params: [brightness,effect,duration]})
     end
 
+    # This method is used to change the brightness of the smart LED.
     def bright=brightness
       set_bright(brightness)
     end
@@ -78,6 +90,7 @@ module Xilight
       request({id: 6,method: 'set_power', params: [power,effect,duration]})
     end
 
+    # This method is used to switch on or off the smart LED (software managed on/off).
     def power=power
       set_power(power)
     end
@@ -87,16 +100,15 @@ module Xilight
       request({id: 7,method: 'toggle', params: []})
     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
+    # This method is used to save the current state of smart LED in persistent memory.
+    # If user powers off and then powers on the smart LED again (hard power reset),
+    # the smart LED will show last the saved state.
     def set_default
       request({id: 8,method: 'set_default', params: []})
     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
+    # LED visible state changes. It can be either brightness changing, color changing
     # or color temperature changing
     def start_cf(count, action, flow_expression)
       request({id: 9,method: 'set_power', params: [count,action,flow_expression]})
@@ -108,8 +120,8 @@ module Xilight
     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.
+    # the smart LED is off, then it will first turn on the smartLED  and then
+    # apply the specified command.
     def set_scene(classe, val1, val2)
       request({id: 11,method: 'set_scene', params: [classe,val1,val2]})
     end
@@ -131,14 +143,14 @@ module Xilight
     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.
+    # without knowing the current value, it's mainly used by controllers.
     def set_adjust(action, prop)
       request({id: 15,method: 'set_adjust', params: [action,prop]})
     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.
+    # device and reported in the discovery response. Users can also read the device name
+    # through the “get_prop” method.
     def set_name(name)
       request({id: 16,method: 'set_name', params: [name]})
     end
@@ -158,7 +170,7 @@ module Xilight
     end
 
 
-    # This method is used to discover a smart LED in the network
+    # This method is used to discover a smart LED on the local network
     def self.discover
       host = "239.255.255.250"
       port = 1982

data/lib/xilight/version.rb

@@ -1,3 +1,3 @@
 module Xilight
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/xilight.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Ruby Xiaomi Yeelight gem"
   spec.description   = "Ruby Xiaomi Yeelight gem"
+  spec.homepage      = "https://github.com/wouterken/xilight"
 
   # 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.
@@ -29,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "dry-cli"
   spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xilight
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Wouter Coppieters
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ files:
 - lib/xilight.rb
 - lib/xilight/version.rb
 - xilight.gemspec
-homepage: 
+homepage: https://github.com/wouterken/xilight
 licenses: []
 metadata: {}
 post_install_message: