ledenet_api 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 438dd0a9cc94eb0cf9336316839e5292fc97c715
-  data.tar.gz: e0f0597eb72ea4f113c27ddba486784ceb04c7d5
+  metadata.gz: 9b2322ff3b2b79724713e5b7b620a1f3d160fc61
+  data.tar.gz: 0313e482fccc8cd041f2440f802220e50d1151f1
 SHA512:
-  metadata.gz: 9e25bd22bd9554db774affa2355823b7c286af3528c6f50c5ef7dc75a5b2a7eb381bd9761f0917672537b9feff43b11f0c70a90baa5cf1a0d1413b7c126d49cb
-  data.tar.gz: 456eab17a6d58c786feaf7aa3c1902b252d8ec05d14a3ce34a7bea9b3b74cad280351404c238f981d569f029701f8f4d7fee8c0cc324614b43a2889acee95afa
+  metadata.gz: c5088d200d263359d2846de07822c1d3dbbc4f98fac1482677264d5c86dd28629127ccfebba560fc530fe1898d2a8f1ccf33db2dccaccdff365b484995d31c54
+  data.tar.gz: f942c29bb3e5a98f945f1b9c258b46547300834687f2c0bacff6c497f1492a9ea35c5d0a41ae462c5a3374c1ec9be3c65230c8ddd58047f37dee4a20c121941b

data/README.md

@@ -22,7 +22,63 @@ gem 'ledenet_api'
 
 ## Using it
 
-### Device discovery
+In addition to the Ruby API, this gem also comes bundled with an executable named `ledenet-ufo`.
+
+### Commandline
+
+Here's the `--help` message:
+
+```
+$ ledenet-ufo
+  Usage: ledenet-ufo --list
+     OR: ledenet-ufo [IP|HW ADDR] [OPTIONS]
+
+    -r, --red [VALUE]                Set red to VALUE
+    -g, --green [VALUE]              Set green to VALUE
+    -b, --blue [VALUE]               Set blue to VALUE
+    -w, --warm-white [VALUE]         Set warm white to VALUE
+        --on                         Turn on the controller
+        --off                        Turn off the controller
+    -l, --list                       Prints a list of available devices and exists
+    -s, --status                     Prints status as JSON
+    -h, --help                       Prints this help message
+```
+
+When using it, you can specify the IP address, hardware (mac) address, or let `ledenet_api` choose an arbitrary device on the local network (this would work well if you only have one).
+
+Examples:
+
+#### List available devices
+
+```
+$ ledenet-ufo --list
+      IP ADDRESS         HW ADDRESS              Model #
+    10.133.8.113       XXXXXXXXXXXX      HF-LPB100-ZJ200
+```
+
+#### Get current status
+
+```
+$ ledenet-ufo -s
+{"red":"255","green":"255","blue":"255","warm_white":"255","is_on":true}
+```
+
+#### Turn on, adjust colors
+
+```
+$ ledenet-ufo --on -r 200 -g 0 -b 255 --warm-white 0 --status
+{"red":"200","green":"0","blue":"255","warm_white":"255","is_on":true}
+```
+
+#### Turn off
+
+```
+$ ledenet-ufo --off
+```
+
+### Ruby API
+
+#### Device discovery
 
 These devices implement a service discovery protocol, which allows you to find them on your network without digging for their IP address. To use it:
 
@@ -41,7 +97,7 @@ irb(main):005:0> LEDENET.discover_devices(expected_devices: 2, timeout: 1)
 => [#<LEDENET::Device:0x007fff328f4330 @ip="10.133.8.113", @hw_addr="XXXXXXXXXXXX", @model="HF-LPB100-ZJ200">]
 ```
 
-### API
+#### API
 
 To construct an API class, use the following:
 
@@ -61,7 +117,7 @@ By default, the API will re-try transient-looking failures three times. You can
 api = LEDENET::Api.new('10.133.8.113', reuse_connection: true, max_retries: 0)
 ```
 
-### Status
+#### Status
 
 To check if the controller is currently on:
 
@@ -77,7 +133,7 @@ api.on
 api.off
 ```
 
-### Color / Warm White
+#### Color / Warm White
 
 To get the current color settings:
 

data/bin/ledenet-ufo

@@ -20,7 +20,7 @@ if ARGV.count > 0 && !ARGV.first.start_with?('-')
   if IPAddress.valid?(arg)
     options[:ip] = arg
   elsif /^([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2}$/i.match(arg)
-    options[:hw_addr] = arg
+    options[:hw_addr] = arg.gsub(':', '').upcase
   else
     raise "Invalid device speicifier \"#{arg}\". Must be ip or mac address."
   end
@@ -53,7 +53,7 @@ opts = OptionParser.new do |opts|
     options[:on?] = false
   end
 
-  opts.on("-l", "--list", Integer, "Prints a list of available devices and exists") do |v|
+  opts.on("-l", "--list", Integer, "Prints a list of available devices and exits") do |v|
     options[:list] = true
   end
 
@@ -87,7 +87,12 @@ begin
     printf row_format, "IP ADDRESS", "HW ADDRESS", "Model #"
 
     LEDENET.discover_devices.each do |device|
-      printf row_format, device.ip, device.hw_addr, device.model
+      formatted_hwaddr = (0...12).step(2)
+        .map { |x| device.hw_addr[x, 2] }
+        .join(':')
+        .downcase
+
+      printf row_format, device.ip, formatted_hwaddr, device.model
     end
   else
     ip = nil

data/lib/ledenet/version.rb

@@ -1,3 +1,3 @@
 module LEDENET
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledenet_api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Christopher Mullins