ledenet_api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574337eac1f731474460ee834ae7075f68884211
-  data.tar.gz: 234f86496a5df7b8fb8e1ea483a033ea1891c4cb
+  metadata.gz: 8d957c5cc344a32f9a136953d6c250850eee2a49
+  data.tar.gz: e7d1aa4844be0c35a54cdcb50f38e9bb4ffec8f9
 SHA512:
-  metadata.gz: 75cd7c937858687ec6b93bd0899092cc1367659a3febbe04b9eb9451523bc16ce4dbd19b3876c52a50e9080c24784a8dbc56cf2df6623749f63c7f6735f29b6f
-  data.tar.gz: c9b7e98fd06694085000bcb0190aa30a93c13b4fc352e983eb15129fa3dbc4e4e731f9635504ffe1a49faa428ac3545ba01a7304fdeebfaa4224835a649fe10c
+  metadata.gz: 13ec8ea531321fbcf2ef004852680801522cf72c4b606ecb94d9003b2d1a3ead020811ae90cf73987d8514fd377c73097d3dca396399155342264211655783e2
+  data.tar.gz: 71f2af760c9487ec5d6e94917b35a60a24dbb219ee52dcc1b27b9bfa008741b88cb01fa75d2a6ef2d5b3e7d24b3c2ace5832203e98fa99d334869b8e0b4fa754

data/README.md

@@ -1,2 +1,93 @@
 # ledenet_api
-An API for the LEDENET Magic UFO LED WiFi Controller
+An API for the [LEDENET Magic UFO LED WiFi Controller](http://amzn.com/B00MDKOSN0)
+
+## What's this?
+This RGB LED controller is a relatively cheap (~$30) alternative to something like the Phillips Hue RGB Strip + Hub, which can run you between $100 and $200. 
+
+However, it doesn't come with an open API, and doesn't integrate with smarthome hubs (SmartThings, etc.). I used a [packet capture app](https://play.google.com/store/apps/details?id=app.greyshirts.sslcapture&hl=en) on my phone to reverse engineer how the official app communicated with the controller.
+
+## Installing
+
+ledenet_api is available on [Rubygems](https://rubygems.org). You can install it with:
+
+```
+$ gem install ledenet_api
+```
+
+You can also add it to your Gemfile:
+
+```
+gem 'ledenet_api'
+```
+
+## Using it
+
+### 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:
+
+```ruby
+require 'ledenet_api'
+devices = LEDENET.discover_devices
+=> [#<LEDENET::Device:0x007feccc0241d8 @ip="10.133.8.113", @hw_addr="XXXXXXXXXXXX", @model="HF-LPB100-ZJ200">]
+devices.first.ip
+=> "10.133.8.113"
+```
+
+### API
+
+To construct an API class, use the following:
+
+```ruby
+api = LEDENET::Api.new('10.133.8.113')
+```
+
+By default, each API call will open a new connection, and close it when it's finished. This is convenient if the API is being used inside of a long-running process (like a web server). If what you're doing is more short-lived, you can reuse the same connection:
+
+```ruby
+api = LEDENET::Api.new('10.133.8.113', reuse_connection: true)
+```
+
+By default, the API will re-try transient-looking failures three times. You can change this behavior with:
+
+```ruby
+api = LEDENET::Api.new('10.133.8.113', reuse_connection: true, max_retries: 0)
+```
+
+### Status
+
+To check if the controller is current on:
+
+```ruby
+api.on?
+=> false
+```
+
+To turn the controller on and off:
+
+```ruby
+api.on
+=> true
+api.off
+=> true
+```
+
+### Color
+
+To get the current color setting (as an array of RGB values):
+
+```ruby
+api.current_color
+=> [10, 10, 10]
+```
+
+To set the color:
+
+```ruby
+irb(main):016:0> api.update_color(255, 0, 255)
+=> true
+```
+
+### Warm White
+
+This controller is also capable of controling Warm White (WW) LEDs. I didn't have a strip to test, but I'm pretty sure I found out how to control it. If this would be useful to you, please open an issue/pull request.

data/lib/ledenet/device_discovery.rb

@@ -14,6 +14,11 @@ module LEDENET
     end
   end
 
+  DEFAULT_OPTIONS = {
+      expected_devices: 1,
+      timeout: 5
+  }
+
   # The WiFi controllers these things appear to use support a discovery protocol
   # roughly outlined here: http://www.usriot.com/Faq/49.html
   #
@@ -21,7 +26,9 @@ module LEDENET
   # containing IP address, hardware address, and model number. The model number
   # appears to correspond to the WiFi controller, and not the LED controller
   # itself.
-  def self.discover_devices(expected_devices = 1, timeout = 5)
+  def self.discover_devices(options = {})
+    options = DEFAULT_OPTIONS.merge(options)
+
     send_addr = ['<broadcast>', 48899]
     send_socket = UDPSocket.new
     send_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
@@ -30,12 +37,12 @@ module LEDENET
     discovered_devices = []
 
     begin
-      Timeout::timeout(timeout) do
+      Timeout::timeout(options[:timeout]) do
         while true
           data = send_socket.recv(1024)
           discovered_devices.push(LEDENET::Device.new(data))
 
-          raise Timeout::Error if discovered_devices.count >= expected_devices
+          raise Timeout::Error if discovered_devices.count >= options[:expected_devices]
         end
       end
     rescue Timeout::Error

data/lib/ledenet/version.rb

@@ -1,3 +1,3 @@
 module LEDENET
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

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