wemote 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fab169b7fb29b3ed90820cfa268951f6a88f28d
-  data.tar.gz: cd0c3fd1971486865e170eae94cca933e1558070
+  metadata.gz: 50907f96c202b14aff7fbac722c9133a3c4860f5
+  data.tar.gz: 2fa839d4ce9819d5223f078b08464906556bcfb1
 SHA512:
-  metadata.gz: f365c6b952fd03d3b38d53081ede3d21ac1d28a1c4568e0d0275d9f3ddc0732a0b8651fbf33a20c0aa43d9335b0d41449906df90f4902e74a064f2f08e304de1
-  data.tar.gz: aafdae13551a09dfc8b4ce12336e6a3e3971add9667f7a61c5dd4b57353e5d49e4f69112d0a6945304852e00320d33ef89a2d3029006ae3decd2e42c053274e6
+  metadata.gz: 352264a9e37d2d4e3e54e1925b751e2d37adb277cfd7e6b818864afd3315fa0f332bd836242f5d2f7e8c1fecc6571761c214eac4126c9c6f1143e37236a8047f
+  data.tar.gz: c7a62b670905ff95356342c2886d76f61cc21e2384c0da60abff32fea4fb267b503faa7ac8482d208fb66151cf5e91ebf9523a6f2aac787addde5a39c3769c1e

data/lib/wemote.rb

@@ -2,7 +2,9 @@ require_relative './wemote/version'
 
 module Wemote
   require_relative './wemote/collection/switch'
+  require_relative './wemote/collection/insight'
   require_relative './wemote/switch'
+  require_relative './wemote/insight'
   require_relative './wemote/client'
   require_relative './wemote/xml'
 

data/lib/wemote/collection/insight.rb

@@ -0,0 +1,12 @@
+module Wemote
+  module Collection
+
+    # This class provides an extension on the basic Array object, in order to
+    # facilitate group operations on a collection of Wemote::Switch instances.
+    class Insight < Switch
+
+      make :standby?
+
+    end
+  end
+end

data/lib/wemote/insight.rb

@@ -0,0 +1,90 @@
+require 'socket'
+require 'ipaddr'
+require 'timeout'
+require 'ssdp'
+
+module Wemote
+
+  # This class encapsulates an individual Wemo Insight. It provides methods for
+  # getting and setting the insight's state, as well as a {#toggle!} method for
+  # convenience. Finally, it provides the {#poll} method, which accepts a block
+  # to be executed any time the insight changes state.
+  class Insight < Switch
+
+    GET_HEADERS_POWER = {
+      "SOAPACTION"   => '"urn:Belkin:service:insight:1#GetInsightParams"',
+      "Content-type" => 'text/xml; charset="utf-8"'
+    }
+
+    class << self
+
+      def device_type
+        'urn:Belkin:device:insight:1'
+      end
+
+      # Returns all Insight detected on the local network
+      #
+      # @param [Boolean] refresh Refresh and redetect Insight
+      # @return [Array] all Insight on the network
+      def all(refresh=false)
+        @insights = nil if refresh
+        @insights ||= Wemote::Collection::Insight.new(discover)
+      end
+
+    end
+
+    # Turn the Insight on or off, based on its current state
+    def toggle!  
+      on? or standby? ? off! : on!;   
+    end
+
+    # Return whether the Insight is standby
+    #
+    # @return [Boolean]
+    def standby?
+      get_state == :standby;   
+    end
+
+    def power
+      get_insight_params()[:power]
+    end
+
+    def energy
+      get_insight_params()[:energy]
+    end
+
+    def on_today
+      get_insight_params()[:on_today]
+    end
+
+    private
+
+    def get_state
+      case get_binary_state()
+        when '0'
+          :off
+        when '1'
+          :on
+        when '8'
+          :standby
+      end
+    end
+
+    def get_insight_params
+      response = begin
+        client.post("http://#{@host}:#{@port}/upnp/control/insight1",Wemote::XML.get_insight_params,GET_HEADERS_POWER)
+      rescue Exception
+        client.post("http://#{@host}:#{@port}/upnp/control/insight1",Wemote::XML.get_insight_params,GET_HEADERS_POWER)
+      end
+      params = response.body.match(/<InsightParams>(.*)<\/InsightParams>/)[1].split('|')
+      {
+        value: (params[0].to_i == 0 ? :off : :on),
+        energy: (params[8].to_i / 60000000.0).ceil,
+        power: (params[7].to_i / 1000.0).round,
+        on_today: (params[3].to_i / 60.0).floor
+      }      
+    end
+
+
+  end
+end

data/lib/wemote/switch.rb

@@ -1,6 +1,7 @@
 require 'socket'
 require 'ipaddr'
 require 'timeout'
+require 'ssdp'
 
 module Wemote
 
@@ -10,8 +11,6 @@ module Wemote
   # to be executed any time the switch changes state.
   class Switch
 
-    GOOGLE_IP = "64.233.187.99"
-
     GET_HEADERS = {
       "SOAPACTION"   => '"urn:Belkin:service:basicevent:1#GetBinaryState"',
       "Content-type" => 'text/xml; charset="utf-8"'
@@ -23,6 +22,11 @@ module Wemote
     }
 
     class << self
+
+      def device_type
+        'urn:Belkin:device:controllee:1'
+      end
+
       # Returns all Switches detected on the local network
       #
       # @param [Boolean] refresh Refresh and redetect Switches
@@ -40,14 +44,15 @@ module Wemote
         all.detect{|s|s.name == name}
       end
 
-      private
+      protected
 
       def discover
-        ip = UDPSocket.open {|s| s.connect(GOOGLE_IP, 1); s.addr.last}
-        `nmap -sP #{ip.split('.')[0..-2].join('.')}.* > /dev/null && arp -na | grep b4:75`.split("\n").map do |device|
-          self.new(/\((\d+\.\d+\.\d+\.\d+)\)/.match(device)[1])
-        end.reject{|device| device.instance_variable_get(:@port).nil? }
+        finder = SSDP::Consumer.new timeout: 3, first_only: false
+        finder.search(service: self.device_type).map do |device|
+          self.new(device[:address], device[:params]['LOCATION'].match(/:([0-9]{1,5})\//)[1])
+        end
       end
+
     end
 
     attr_accessor :name
@@ -57,24 +62,38 @@ module Wemote
       set_meta
     end
 
+    def device_type 
+      'urn:Belkin:device:controllee:1'
+    end
+
     # Turn the Switch on or off, based on its current state
-    def toggle!;  on? ? off! : on!;   end
+    def toggle!
+        on? ? off! : on!
+    end
 
     # Turn the Switch off
-    def off!;     set_state(0);       end
+    def off!     
+      set_state(0)       
+    end
 
     # Turn the Switch on
-    def on!;      set_state(1);       end
+    def on!      
+      set_state(1)   
+    end
 
     # Return whether the Switch is off
     #
     # @return [Boolean]
-    def off?;     get_state == :off;  end
+    def off?     
+      get_state == :off
+    end
 
     # Return whether the Switch is on
     #
     # @return [Boolean]
-    def on?;      get_state == :on;   end
+    def on?      
+      get_state == :on
+    end
 
     # Monitors the state of the Switch via polling, and yields to the block
     # given with the updated state.
@@ -111,15 +130,19 @@ module Wemote
       async ? poller : poller.join
     end
 
-    private
+    protected
 
     def get_state
+      self.get_binary_state() == '1' ? :on : :off
+    end
+
+    def get_binary_state
       response = begin
         client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",Wemote::XML.get_binary_state,GET_HEADERS)
       rescue Exception
         client.post("http://#{@host}:#{@port}/upnp/control/basicevent1",Wemote::XML.get_binary_state,GET_HEADERS)
       end
-      response.body.match(/<BinaryState>(\d)<\/BinaryState>/)[1] == '1' ? :on : :off
+      response.body.match(/<BinaryState>(\d)<\/BinaryState>/)[1]
     end
 
     def set_state(state)
@@ -135,22 +158,8 @@ module Wemote
     end
 
     def set_meta
-      if @port
-        response = client.get("http://#{@host}:#{@port}/setup.xml")
-        @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
-      else
-        for port in 49152..49156
-          begin
-            response = nil
-            Timeout::timeout(1){ response = client.get("http://#{@host}:#{port}/setup.xml") }
-            @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
-            @port = port
-            break
-          rescue Exception
-          end
-        end
-      end
+      response = client.get("http://#{@host}:#{@port}/setup.xml")
+      @name = response.body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
     end
-
   end
 end

data/lib/wemote/version.rb

@@ -1,3 +1,3 @@
 module Wemote
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/wemote/xml.rb

@@ -4,7 +4,8 @@ module Wemote
       xml_path = File.join(File.dirname(__FILE__),'/../../xml')
       TEMPLATES = {
         get_binary_state: File.read(File.join(xml_path,'get_binary_state.xml')),
-        set_binary_state: File.read(File.join(xml_path,'set_binary_state.xml'))
+        set_binary_state: File.read(File.join(xml_path,'set_binary_state.xml')),
+        get_insight_params: File.read(File.join(xml_path,'get_insight_params.xml'))
       }
 
       # @return [String] The required XML body for a Wemo binary state request
@@ -18,6 +19,11 @@ module Wemote
         TEMPLATES[:set_binary_state].gsub("{{1}}",state.to_s)
       end
 
+      def get_insight_params
+        TEMPLATES[:get_insight_params]
+      end
+
+
     end
   end
 end

data/wemote.gemspec

@@ -18,4 +18,7 @@ Gem::Specification.new do |spec|
   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"]
+
+  spec.add_dependency 'ssdp', '~> 1.1', '>= 1.1.6'
+
 end

data/xml/get_binary_state.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
- s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
   <s:Body>
     <u:GetBinaryState xmlns:u="urn:Belkin:service:basicevent:1"/>
   </s:Body>

data/xml/get_insight_params.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+  <s:Body>
+    <u:GetInsightParams xmlns:u="urn:Belkin:service:insight:1"></u:GetInsightParams>
+  </s:Body>
+</s:Envelope>

data/xml/set_binary_state.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
- s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
   <s:Body>
     <u:SetBinaryState xmlns:u="urn:Belkin:service:basicevent:1">
       <BinaryState>{{1}}</BinaryState>

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: wemote
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Kevin Gisi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
-dependencies: []
+date: 2018-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ssdp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
 description: Wemote is a Ruby-agnostic gem for Wemo light switches
 email:
 - kevin@kevingisi.com
@@ -25,7 +45,9 @@ files:
 - Rakefile
 - lib/wemote.rb
 - lib/wemote/client.rb
+- lib/wemote/collection/insight.rb
 - lib/wemote/collection/switch.rb
+- lib/wemote/insight.rb
 - lib/wemote/switch.rb
 - lib/wemote/version.rb
 - lib/wemote/xml.rb
@@ -33,6 +55,7 @@ files:
 - spec/wemote/switch_spec.rb
 - wemote.gemspec
 - xml/get_binary_state.xml
+- xml/get_insight_params.xml
 - xml/set_binary_state.xml
 homepage: https://github.com/gisikw/wemote
 licenses:
@@ -54,11 +77,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Wemote is a Ruby-agnostic gem for Wemo light switches
 test_files:
 - spec/spec_helper.rb
 - spec/wemote/switch_spec.rb
-has_rdoc: