lightwavez 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da6552ea173370cbbd96bebb304ad2f6431b53e9
+  data.tar.gz: 986c18230dc462567fa5194141240049da7acb43
+SHA512:
+  metadata.gz: aed46c72751f7d8996999677352786e8077397f4ed8c99f9480f77d06d78d6283144d13a412bf6b09f46b1dc94219a86388af87ce740c827a057cf1e89318b94
+  data.tar.gz: d19df62409641986d48907cf1c88fe21c30f203fd8efd1233ecbbd902e26a94e56236b653fbd4811c1c15a2405dfaace1610ccc88840bd424eeeee3e866cb8dc

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1 @@
+source 'https://rubygems.org'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Khash Sajadi
+
+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/lib/client.rb

@@ -0,0 +1,81 @@
+module Lightwavez
+
+  require 'socket'
+
+  class Client
+
+    COMMANDS = { :on => 'F1', :off => 'F0', :all_off => 'Fa', :last_dim => 'Fo', :dim => 'Fd', :mood => 'Fm'}
+
+    def initialize(address = nil, port = 9760)
+      @address = address || discover
+      @port = port
+    end
+
+    # generates a command for a room and a device. Only supports on/off/dimm commands for now
+    # accepted operations are: :on, :off, :all_off, :last_dim, :dim (needs param to be 1-32), :mood (needs mood id)
+    # device is not needed for :all_off and :mood
+    # rooms, devices and moods (params for :mood) and be either a number or name if mapping is loaded
+    def get_command(room, device, operation, params = nil)
+      raise 'invalid command' unless COMMANDS.has_key? operation
+      raise 'missing dim level (1-32)' if params.nil? && operation == :dim
+      raise 'missing mood id' if params.nil? && operation == :mood
+
+      cmd = ""
+      if operation != :all_off && operation != :mood
+        cmd = "R#{room}D#{device}#{COMMANDS[operation]}"
+        if operation == :dim
+          raise 'invalid dim level (1-32)' if params < 1 || params > 32
+          cmd = cmd + "P#{params}"
+        end
+      else
+        cmd = "R#{room}#{COMMANDS[operation]}"
+        if operation == :mood
+          cmd = cmd + "P#{params}"
+        end
+      end
+
+      return cmd
+    end
+
+    # consructs and sends a command over to the link without waiting for the answer
+    def send(command)
+      sequence = Random.rand(100)
+      send_raw("#{sequence},!#{command}\r")
+    end
+
+    # this will register the first time and get the IP address for the link afte that
+    def discover
+      sock = UDPSocket.new
+      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+
+      result = ""
+      server_thread = Thread.start do
+        server = UDPSocket.open
+        server.bind('0.0.0.0', 9761)
+        result = server.recvfrom(64)
+        server.close
+      end
+
+      sock.send("100,!F*p\r", 0, '255.255.255.255', 9760)
+      server_thread.join
+      sock.close
+
+      if !result.is_a? Array || result.length < 1 || result[1].length < 2
+        raise 'invalid response'
+      end
+
+      return result[1][2]
+    end
+
+    private
+
+    # sends a command to the link without waiting for answer
+    def send_raw(command)
+      sock = UDPSocket.new
+      sock.send(command, 0, @address, @port)
+      sock.close
+    end
+
+  end
+
+end

data/lib/controller.rb

@@ -0,0 +1,83 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "version")
+require File.join(File.expand_path(File.dirname(__FILE__)), "client")
+require 'yaml'
+
+module Lightwavez
+
+  # you will need to create one of these:
+  # c = Lightwavez::Controller.new
+  class Controller
+
+    # if addres is missing, it will use discover to find it
+    # if mapping_file is missing, it will load 'mapping.yml' from the running folder
+    def initialize(address = nil, port = 9760, mapping_file = "")
+      @mapping = {}
+
+      mapping_file = File.join(Dir.pwd, 'mapping.yml') if mapping_file == ""
+      if File.exists? mapping_file
+        @mapping = YAML.load_file(mapping_file)
+      end
+
+      @client = Lightwavez::Client.new(address, port)
+    end
+
+    # registers the client with the link. The first time this runs the lights on the link
+    # will flash and the button needs to be pressed to authorise the client
+    # calling this again after initial registration will return the IP address of the link
+    def register
+      @client.discover
+    end
+
+    # sends a command to the link.
+    # room is the name of the room based on mapping
+    # device is the name of the device based on mapping. pass '' if the command doesn't need it (all_off and mood)
+    # operation can be :on, :off, :all_off, :dim, :last_dim, :mood
+    # params is used for dim (1-32) and mood (mood name based on mapping)
+    def send(room, device, operation, params = {})
+      room_id = get_room(room)['id']
+      device_id = get_device(room, device)
+
+      puts "Room: #{room_id}, Device: #{device_id}"
+
+      pa = nil
+      if operation == :mood
+        pa = get_mood(room, params)
+
+        puts "Mood: #{params}"
+      else
+        pa = params
+      end
+
+      cmd = @client.get_command(room_id, device_id, operation, pa)
+
+      puts "Sending command #{cmd}"
+
+      @client.send(cmd)
+    end
+
+    private
+
+    def get_room(room)
+      raise 'invalid mapping file. no "rooms" node found' unless @mapping.has_key? 'rooms'
+      if @mapping['rooms'].has_key? room
+        return @mapping['rooms'][room]
+      else
+        raise "invalid room name #{room}"
+      end
+    end
+
+    def get_device(room, device)
+      m_room = get_room(room)
+      raise "invalid mapping format for room #{room}" unless m_room.has_key? 'devices'
+      return m_room['devices'][device]
+    end
+
+    def get_mood(room, mood)
+      m_room = get_room(room)
+      raise "invalid mapping format for room #{room}" unless m_room.has_key? 'moods'
+      return m_room['moods'][mood]
+    end
+
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Lightwavez
+	VERSION = Gem::Version.new("0.0.1")
+end

data/lightwavez.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lightwavez"
+  spec.version       = Lightwavez::VERSION
+  spec.authors       = ["Khash Sajadi"]
+  spec.email         = ["khash@sajadi.co.uk"]
+  spec.summary       = "A simple Ruby gem to control LightwaveRF link"
+  spec.description   = "This is a quick and simple ruby client gem for LightwaveRF link. No liability is accepted etc etc."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/mapping.yml

@@ -0,0 +1,13 @@
+# Modify as needed. This is a sample
+rooms:
+  main:
+    id: 1
+    devices:
+      living_room: 1
+      counter: 2
+      kitchen: 3
+      hallway: 4
+    moods:
+      kitchen_work: 1
+      tv: 2
+      cooking: 3

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: lightwavez
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Khash Sajadi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies: []
+description: This is a quick and simple ruby client gem for LightwaveRF link. No liability
+  is accepted etc etc.
+email:
+- khash@sajadi.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- lib/client.rb
+- lib/controller.rb
+- lib/version.rb
+- lightwavez.gemspec
+- mapping.yml
+homepage: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple Ruby gem to control LightwaveRF link
+test_files: []