lightwaverf 0.2.2 → 0.3.0

data/bin/lightwaverf

@@ -3,12 +3,16 @@ require 'lightwaverf'
 case ARGV[0]
   when 'help'
     puts LightWaveRF.new.help
+  when 'configure'
+    puts LightWaveRF.new.configure
   when 'sequence'
     puts LightWaveRF.new.sequence ARGV[1], ARGV[2]
   when 'energy'
     puts LightWaveRF.new.energy ARGV[1], ARGV[2], ARGV[3]
   when 'timer'
     puts LightWaveRF.new.timer ARGV[1], ARGV[2]
+  when 'update'
+    puts LightWaveRF.new.update_config ARGV[1], ARGV[2]
   else
     LightWaveRF.new.send ARGV[0], ARGV[1], ARGV[2], ARGV[3]
 end

data/lib/lightwaverf.rb

@@ -11,7 +11,7 @@ class LightWaveRF
   # Display usage info
   def usage
     rooms = self.class.get_rooms self.get_config
-    'usage: lightwaverf ' + rooms.keys.first + ' ' + rooms.values.first['device'].keys.first.to_s + ' on # where "' + rooms.keys.first + '" is a room in ' + self.get_config_file
+    'usage: lightwaverf ' + rooms.values.first['name'] + ' ' + rooms.values.first['device'].keys.first.to_s + ' on # where "' + rooms.keys.first + '" is a room in ' + self.get_config_file
   end
 
   # Display help
@@ -19,11 +19,53 @@ class LightWaveRF
     help = self.usage + "\n"
     help += "your rooms, devices, and sequences, as defined in " + self.get_config_file + ":\n\n"
     help += YAML.dump self.get_config['room']
-    room = self.get_config['room'].keys.last
-    device = self.get_config['room'][room].last
+    room = self.get_config['room'].last['name']
+    device = self.get_config['room'].last['device'].last
     help += "\n\nso to turn on " + room + " " + device + " type \"lightwaverf " + room + " " + device + " on\"\n"
   end
 
+  # Configure, build config file
+  def configure
+    config = { 'host' => self.get_config['host'], 'calendar' => self.get_config['calendar'] }
+    puts 'What is the ip address of your wifi link? (' + self.get_config['host'] + ')'
+    host = STDIN.gets.chomp
+    if ! host.to_s.empty?
+      config['host'] = host
+    end
+    puts 'What is the address of your google calendar? (' + self.get_config['calendar'] + ')'
+    calendar = STDIN.gets.chomp
+    if ! calendar.to_s.empty?
+      config['calendar'] = calendar
+    end
+    device = 'x'
+    while ! device.to_s.empty?
+      puts 'Give me the name of a room and its devices, space separated. For example "lounge light socket tv". Just hit enter to finish.'
+      if device = STDIN.gets.chomp
+        parts = device.split ' '
+        if !parts[0].to_s.empty? and !parts[1].to_s.empty?
+          new_room = parts.shift
+          puts 'got ' + device + ' todo: to split this up... new room is ' + new_room
+          if ! config['room']
+            config['room'] = [ ]
+          end
+          found = false
+          config['room'].each do | room |
+            if room['name'] == new_room
+              room['device'] = parts
+              found = true
+            end
+            p 'so now room is ' + room.to_s
+          end
+          if ! found
+            config['room'].push 'name' => new_room, 'device' => parts
+          end
+        end
+      end
+    end
+    puts 'end of configure, config is now ' + config.to_s
+    self.put_config config
+  end
+
   # Config file setter
   def set_config_file file
     @config_file = file
@@ -39,29 +81,130 @@ class LightWaveRF
     @log_file || File.expand_path('~') + '/lightwaverf.log'
   end
 
+  def put_config config = { 'host' => '192.168.1.64', 'room' => [ { 'name' => 'our', 'device' => [ 'light', 'lights' ] } ] }
+    puts 'put_config got ' + config.to_s
+    puts 'so writing ' + YAML.dump( config )
+    File.open( self.get_config_file, 'w' ) do | handle |
+      handle.write YAML.dump( config )
+    end
+  end
+
   # Get the config file, create it if it does not exist
   def get_config
     if ! @config
       if ! File.exists? self.get_config_file
-        File.open( self.get_config_file, 'w' ) do | handle |
-          handle.write YAML.dump( { 'host' => '192.168.0.14', 'room' => { 'our' => [ 'light', 'lights' ] }, 'sequence' => { 'lights' => [ [ 'our', 'light', 'on' ], [ 'our', 'lights', 'on' ] ] }} )
-        end
+        puts self.get_config_file + ' does not exist - copy lightwaverf-configy.yml from https://github.com/pauly/lightwaverf to your home directory or type lightwaverf configure'
+        self.put_config
       end
       @config = YAML.load_file self.get_config_file
     end
     @config
   end
 
+  # Update the LightWaveRF Gem config file from the LightWaveRF Host server
+  #
+  # Example:
+  #   >> LightWaveRF.new.update_config 'name@example.com', '1234'
+  #
+  # Arguments:
+  #   email: (String)
+  #   pin: (String)
+  #   debug: (Boolean)
+  #
+  # Credits:
+  #   wonko - http://lightwaverfcommunity.org.uk/forums/topic/querying-configuration-information-from-the-lightwaverf-website/
+  def update_config email = nil, pin = nil, debug = false
+  
+    # Login to LightWaveRF Host server
+    require 'net/http'
+    require 'uri'
+    uri = URI.parse('https://lightwaverfhost.co.uk/manager/index.php')
+    http = Net::HTTP.new(uri.host, uri.port)
+    if uri.scheme == 'https'
+        require 'net/https'
+        http.use_ssl = true
+    end
+    data = 'pin=' + pin + '&email=' + email
+    headers = {'Content-Type'=> 'application/x-www-form-urlencoded'}
+    resp, data = http.post(uri.request_uri, data, headers)
+    
+    if resp and resp.body
+      # Extract JavaScript variables from the page
+      #   var gDeviceNames = [""]
+      #   var gDeviceStatus = [""]
+      #   var gRoomNames = [""]
+      #   var gRoomStatus = [""]
+      # http://rubular.com/r/UH0H4b4afF
+      variables = Hash.new
+      resp.body.scan(/var (gDeviceNames|gDeviceStatus|gRoomNames|gRoomStatus)\s*=\s*([^;]*)/).each do |variable|
+          variables[variable[0]] = variable[1].scan(/"([^"]*)\"/)
+      end
+      debug and (p '[Info - LightWaveRF Gem] Javascript variables ' + variables.to_s)
+      
+      rooms = Array.new
+      # Rooms - gRoomNames is a collection of 8 values, or room names
+      variables['gRoomNames'].each_with_index do |(roomName), roomIndex|
+        # Room Status - gRoomStatus is a collection of 8 values indicating the status of the corresponding room in gRoomNames
+        #   A: Active
+        #   I: Inactive
+        if variables['gRoomStatus'] and variables['gRoomStatus'][roomIndex] and variables['gRoomStatus'][roomIndex][0] == 'A'
+          # Devices - gDeviceNames is a collection of 80 values, structured in blocks of ten values for each room:
+          #   Devices 1 - 6, Mood 1 - 3, All Off
+          roomDevices = Array.new
+          deviceNamesIndexStart = roomIndex*10
+          variables['gDeviceNames'][(deviceNamesIndexStart)..(deviceNamesIndexStart+5)].each_with_index do |(deviceName), deviceIndex|
+            # Device Status - gDeviceStatus is a collection of 80 values which indicate the status/type of the corresponding device in gDeviceNames
+            #   O: On/Off Switch
+            #   D: Dimmer
+            #   R: Radiator(s)
+            #   P: Open/Close
+            #   I: Inactive (i.e. not configured)
+            #   m: Mood (inactive)
+            #   M: Mood (active)
+            #   o: All Off
+            deviceStatusIndex = roomIndex*10+deviceIndex
+            if variables['gDeviceStatus'] and variables['gDeviceStatus'][deviceStatusIndex] and variables['gDeviceStatus'][deviceStatusIndex][0] != 'I'
+                roomDevices << deviceName
+            end
+          end
+          # Create a hash of the active room and active devices and add to rooms array
+          if roomName and roomDevices and roomDevices.any?
+            rooms << {'name'=>roomName,'device'=>roomDevices}
+          end
+        end
+      end
+      
+      # Update 'room' element in LightWaveRF Gem config file
+      # config['room'] is an array of hashes containing the room name and device names
+      # in the format { 'name' => 'Room Name', 'device' => ['Device 1', Device 2'] }
+      if rooms and rooms.any?
+        config = self.get_config
+        config['room'] = rooms
+        File.open( self.get_config_file, 'w' ) do | handle |
+          handle.write YAML.dump( config )
+        end
+        debug and (p '[Info - LightWaveRF Gem] Updated config with ' + rooms.size.to_s + ' room(s): ' + rooms.to_s)
+      else
+        debug and (p '[Info - LightWaveRF Gem] Unable to update config: No active rooms or devices found')
+      end
+    else
+      debug and (p '[Info - LightWaveRF Gem] Unable to update config: No response from Host server')
+    end
+    self.get_config
+  end
+
   # Get a cleaned up version of the rooms and devices from the config file
-  def self.get_rooms config = { 'room' => { }}
+  def self.get_rooms config = { 'room' => [ ]}, debug = false
     rooms = { }
     r = 1
-    config['room'].each do | name, devices |
-      rooms[name] = { 'id' => 'R' + r.to_s, 'name' => name, 'device' => { }}
+    config['room'].each do | room |
+      debug and ( puts room['name'] + ' = R' + r.to_s )
+      rooms[room['name']] = { 'id' => 'R' + r.to_s, 'name' => room['name'], 'device' => { }}
       d = 1
-      devices.each do | device |
+      room['device'].each do | device |
         # @todo possibly need to complicate this to get a device name back in here
-        rooms[name]['device'][device] = 'D' + d.to_s
+        debug and ( puts ' - ' + device + ' = D' + d.to_s )
+        rooms[room['name']]['device'][device] = 'D' + d.to_s
         d += 1
       end
       r += 1
@@ -78,8 +221,8 @@ class LightWaveRF
   # Arguments:
   #   state: (String)
   def self.get_state state = 'on'
-    if /^\d+$/.match state.to_s
-    	state = state.to_i
+    if /^\d+%?$/.match state.to_s
+      state = state.to_i
     end
     case state
       when 'off'
@@ -107,7 +250,7 @@ class LightWaveRF
   #   state: (String)
   def command room, device, state
     # @todo get the device name in here...
-   '666,!' + room['id'] + room['device'][device] + state + '|' + room['name'] + ' ' + room['id'] + '|via @pauly'
+   '666,!' + room['id'] + room['device'][device] + state + '|' + room['name'] + ' ' + device + ' ' + state + '|via @pauly'
   end
 
   # Turn one of your devices on or off
@@ -121,12 +264,13 @@ class LightWaveRF
   #   state: (String)
   def send room = nil, device = nil, state = 'on', debug = false
     debug and ( puts 'config is ' + self.get_config.to_s )
-    rooms = self.class.get_rooms self.get_config
+    rooms = self.class.get_rooms self.get_config, debug
     state = self.class.get_state state
     if rooms[room] and device and state and rooms[room]['device'][device]
       command = self.command rooms[room], device, state
       debug and ( p 'command is ' + command )
-      self.raw command
+      data = self.raw command
+      debug and ( p 'response is ' + data )
     else
       STDERR.puts self.usage
     end
@@ -213,7 +357,11 @@ class LightWaveRF
     debug and ( p url )
     parsed_url = URI.parse url
     http = Net::HTTP.new parsed_url.host, parsed_url.port
-    http.use_ssl = true
+    begin
+      http.use_ssl = true
+    rescue
+      debug && ( p 'cannot use ssl' )
+    end
     request = Net::HTTP::Get.new parsed_url.request_uri
     response = http.request request
     doc = REXML::Document.new response.body

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lightwaverf
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
 - Paul Clarke
+- Ian Perrin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies: []
 description: Interact with lightwaverf wifi link from code or the command line. Control
   your lights, heating, sockets etc. Also set up timers using a google calendar and