Module: LEDENET

Defined in:
lib/ledenet/api.rb,
lib/ledenet/version.rb,
lib/ledenet/functions.rb,
lib/ledenet/function_speed.rb,
lib/ledenet/device_discovery.rb,
lib/ledenet/packets/fields/checksum.rb

Defined Under Namespace

Modules: Functions, Packets Classes: Api, Checksum, Device, FunctionSpeed

Constant Summary collapse

VERSION = 
'1.4.2'
DEFAULT_OPTIONS = 
{
    expected_devices: 1,
    timeout: 5,
    expected_models: [],
    expected_hw_addrs: [],
    udp_port: 48899
}

Class Method Summary collapse

Class Method Details

.discover_devices(options = {}) ⇒ Object

The WiFi controllers these things appear to use support a discovery protocol roughly outlined here: www.usriot.com/Faq/49.html

A “password” is sent over broadcast port 48899. We can respect replies containing IP address, hardware address, and model number. The model number appears to correspond to the WiFi controller, and not the LED controller itself.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ledenet/device_discovery.rb', line 33

def self.discover_devices(options = {})
  options = DEFAULT_OPTIONS.merge(options)

  send_addr = ['<broadcast>', options[:udp_port]]
  send_socket = UDPSocket.new
  send_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
  send_socket.send('HF-A11ASSISTHREAD', 0, send_addr[0], send_addr[1])

  discovered_devices = []
  discovered_models = Set.new
  discovered_hw_addrs = Set.new
  expected_models = Set.new(options[:expected_models])
  expected_hw_addrs = Set.new(
    options[:expected_hw_addrs].map { |x| x.gsub(':', '').upcase }
  )

  begin
    Timeout::timeout(options[:timeout]) do
      while discovered_devices.count < options[:expected_devices] ||
            !expected_models.subset?(discovered_models) ||
            !expected_hw_addrs.subset?(discovered_hw_addrs)
        data = send_socket.recv(1024)

        device = LEDENET::Device.new(data)

        if device.ip and device.hw_addr and device.model
          discovered_devices.push(device)
          discovered_models.add(device.model)
          discovered_hw_addrs.add(device.hw_addr)
        end
      end
    end
  rescue Timeout::Error
    # Expected
  ensure
    send_socket.close
  end

  discovered_devices
end