wizrb 1.1.1 → 1.2.0

data/lib/wizrb/shared/discover.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "ipaddr"
+require "socket"
+require "json"
+require_relative "group"
+require_relative "products/device"
+
+module Wizrb
+  module Shared
+    class Discover
+      MULTICAST_ADDR = "224.0.0.1"
+      BIND_ADDR = "0.0.0.0"
+      PORT = 38_899
+      REGISTRATION_MESSAGE = {
+        method: "registration",
+        params: {
+          phoneMac: "ABCDEFGHIJKL",
+          register: false,
+          phoneIp: "1.2.3.4",
+          id: "1"
+        }
+      }.to_json
+
+      def initialize(wait: 2)
+        @wait = wait
+        @listening = false
+        @thread = nil
+        @devices = []
+      end
+
+      def all(filters: {})
+        open_socket
+        listen_registration(filters)
+        dispatch_registration
+        sleep(@wait)
+        close_registration
+        close_socket
+        group_devices
+      end
+
+      def home(id)
+        all(filters: {"homeId" => id})
+      end
+
+      def room(id)
+        all(filters: {"roomId" => id})
+      end
+
+      def self.all(wait: 2, filters: {})
+        new(wait: wait).all(filters: filters)
+      end
+
+      def self.home(id, wait: 2)
+        new(wait: wait).home(id)
+      end
+
+      def self.room(id, wait: 2)
+        new(wait: wait).room(id)
+      end
+
+      private
+
+      def open_socket
+        bind_address = IPAddr.new(MULTICAST_ADDR).hton + IPAddr.new(BIND_ADDR).hton
+
+        @socket = UDPSocket.open.tap do |socket|
+          socket.setsockopt(:IPPROTO_IP, :IP_ADD_MEMBERSHIP, bind_address)
+          socket.setsockopt(:IPPROTO_IP, :IP_MULTICAST_TTL, 1)
+          socket.setsockopt(:SOL_SOCKET, :SO_REUSEPORT, 1)
+        end
+      end
+
+      def listen_registration(filters = {})
+        @listening = true
+
+        @socket.bind(BIND_ADDR, PORT)
+
+        @thread = Thread.new do
+          while @listening
+            data, addr = @socket.recvfrom(65_536)
+            device = parse_response(data, addr)
+            @devices << device if device && (filters.to_a - device.system_config.to_a).empty?
+          end
+        end
+      end
+
+      def dispatch_registration
+        @socket.send(REGISTRATION_MESSAGE, 0, MULTICAST_ADDR, PORT)
+      end
+
+      def close_registration
+        @listening = false
+        @thread.terminate
+      end
+
+      def close_socket
+        @socket.close
+        @socket = nil
+      end
+
+      def parse_response(data, addr)
+        response = JSON.parse(data)
+        return unless response.dig("result", "success") && addr[1] && addr[2]
+
+        Wizrb::Shared::Products::Device.new(ip: addr[2], port: addr[1])
+      rescue
+        nil
+      end
+
+      def group_devices
+        Wizrb::Shared::Group.new(devices: @devices)
+      end
+    end
+  end
+end

data/lib/wizrb/shared/events/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Wizrb
+  module Shared
+    module Events
+      class Base
+        attr_reader :params
+
+        def initialize(method:, params: {})
+          @method = method
+          @params = params
+        end
+
+        def to_json(*_args)
+          @to_json ||= {method: @method, params: @params}.to_json
+        end
+      end
+    end
+  end
+end

data/lib/wizrb/shared/events/power_event.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Wizrb
+  module Shared
+    module Events
+      class PowerEvent < Wizrb::Shared::Events::Base
+        def initialize(value)
+          validate!(value)
+          super(method: "setPilot", params: {state: value})
+        end
+
+        private
+
+        def validate!(value)
+          raise ArgumentError, "Power state must be a boolean" unless [true, false].include?(value)
+        end
+      end
+    end
+  end
+end

data/lib/wizrb/shared/events/reboot_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Wizrb
+  module Shared
+    module Events
+      class RebootEvent < Wizrb::Shared::Events::Base
+        def initialize
+          super(method: "reboot")
+        end
+      end
+    end
+  end
+end

data/lib/wizrb/shared/events/refresh_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Wizrb
+  module Shared
+    module Events
+      class RefreshEvent < Wizrb::Shared::Events::Base
+        def initialize
+          super(method: "getPilot")
+        end
+      end
+    end
+  end
+end

data/lib/wizrb/shared/events/reset_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Wizrb
+  module Shared
+    module Events
+      class ResetEvent < Wizrb::Shared::Events::Base
+        def initialize
+          super(method: "reset")
+        end
+      end
+    end
+  end
+end

data/lib/wizrb/shared/group.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "events/base"
+require_relative "events/power_event"
+require_relative "events/reboot_event"
+require_relative "events/refresh_event"
+require_relative "events/reset_event"
+
+module Wizrb
+  module Shared
+    class Group
+      include Enumerable
+
+      attr_reader :devices
+
+      def initialize(devices:)
+        @devices = devices
+      end
+
+      def each(&)
+        @devices.each(&)
+      end
+
+      def power_on
+        dispatch_event(Wizrb::Shared::Events::PowerEvent.new(true))
+      end
+
+      def power_off
+        dispatch_event(Wizrb::Shared::Events::PowerEvent.new(false))
+      end
+
+      def reboot
+        dispatch_event(Wizrb::Shared::Events::RebootEvent.new)
+      end
+
+      def reset
+        dispatch_event(Wizrb::Shared::Events::ResetEvent.new)
+      end
+
+      def dispatch_event(event)
+        unless event.is_a?(Wizrb::Shared::Events::Base)
+          raise ArgumentError, "Not an instance of Wizrb::Shared::Events::Base"
+        end
+
+        dispatch(event)
+      end
+
+      def dispatch_events(*events)
+        events.each do |event|
+          unless event.is_a?(Wizrb::Shared::Events::Base)
+            raise ArgumentError, "Not an instance of Wizrb::Shared::Events::Base"
+          end
+        end
+
+        params = events.reduce({}) { |h, e| h.merge(e.params) }
+        dispatch_event(Wizrb::Shared::Events::Base.new(method: "setState", params: params))
+      end
+
+      private
+
+      def dispatch(event)
+        @devices.each do |light|
+          light.dispatch_event(event)
+        end
+      end
+    end
+  end
+end

data/lib/wizrb/shared/products/device.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "json"
+require "socket"
+require_relative "../connection"
+require_relative "../state"
+require_relative "../events/base"
+require_relative "../events/power_event"
+require_relative "../events/reboot_event"
+require_relative "../events/refresh_event"
+require_relative "../events/reset_event"
+
+module Wizrb
+  module Shared
+    module Products
+      class Device
+        attr_reader :ip, :port, :state
+
+        def initialize(ip:, port: 38_899, state: Wizrb::Shared::State.new)
+          @ip = ip
+          @port = port
+          @state = state
+          connect
+        end
+
+        def system_config
+          @system_config ||= dispatch({method: "getSystemConfig", params: {}})&.dig("result")
+        end
+
+        def model_config
+          @model_config ||= dispatch({method: "getModelConfig", params: {}})&.dig("result")
+        end
+
+        def user_config
+          @user_config ||= dispatch({method: "getUserConfig", params: {}})&.dig("result")
+        end
+
+        def module_name
+          @module_name ||= system_config&.dig("moduleName")
+        end
+
+        def power_on
+          dispatch_event(Wizrb::Shared::Events::PowerEvent.new(true))
+        end
+
+        def power_off
+          dispatch_event(Wizrb::Shared::Events::PowerEvent.new(false))
+        end
+
+        def power_switch
+          if refresh.state.power
+            power_off
+          else
+            power_on
+          end
+        end
+
+        def reboot
+          dispatch_event(Wizrb::Shared::Events::RebootEvent.new)
+        end
+
+        def reset
+          dispatch_event(Wizrb::Shared::Events::ResetEvent.new)
+        end
+
+        def refresh
+          response = dispatch_event(Wizrb::Shared::Events::RefreshEvent.new)
+          state.parse!(response)
+          self
+        end
+
+        def dispatch_event(event)
+          unless event.is_a?(Wizrb::Shared::Events::Base)
+            raise ArgumentError, "Not an instance of Wizrb::Shared::Events::Base"
+          end
+
+          dispatch(event)
+        end
+
+        def dispatch_events(*events)
+          events.each do |event|
+            unless event.is_a?(Wizrb::Shared::Events::Base)
+              raise ArgumentError, "Not an instance of Wizrb::Shared::Events::Base"
+            end
+          end
+
+          params = events.reduce({}) { |h, e| h.merge(e.params) }
+          dispatch_event(Wizrb::Shared::Events::Base.new(method: "setState", params: params))
+        end
+
+        private
+
+        def connect
+          @connection = Wizrb::Shared::Connection.new(ip, port)
+          refresh
+        end
+
+        def dispatch(data)
+          @connection.send(data)
+          @connection.receive(timeout: 5, max: 65_536)
+        end
+      end
+    end
+  end
+end

data/lib/wizrb/shared/state.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Wizrb
+  module Shared
+    class State
+      STATE_KEYS = %i[state].freeze
+
+      def initialize
+        @state = {state: false}
+      end
+
+      def parse!(response)
+        result = response&.dig("result")
+        return unless result
+
+        @state = result.transform_keys(&:to_sym).slice(*STATE_KEYS)
+      end
+
+      def power
+        @state[:state]
+      end
+
+      def to_s
+        @state.to_s
+      end
+
+      def to_json(*_args)
+        @state.to_json
+      end
+    end
+  end
+end

data/lib/wizrb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Wizrb
+  VERSION = "1.2.0"
+end

data/lib/wizrb.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "wizrb/version"
+require_relative "wizrb/shared/connection"
+require_relative "wizrb/shared/discover"
+require_relative "wizrb/shared/group"
+require_relative "wizrb/shared/state"
+require_relative "wizrb/lighting"
+require_relative "wizrb/lighting/discover"
+require_relative "wizrb/lighting/group"
+require_relative "wizrb/lighting/state"
+require_relative "wizrb/power/discover"
+require_relative "wizrb/power/group"
+
+Dir["#{File.dirname(__FILE__)}/wizrb/shared/products/*.rb"].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/wizrb/shared/events/*.rb"].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/wizrb/lighting/products/*.rb"].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/wizrb/lighting/events/*.rb"].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/wizrb/lighting/scenes/*.rb"].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/wizrb/power/products/*.rb"].sort.each { |file| require file }
+
+module Wizrb
+  class Error < StandardError; end
+
+  class ConnectionError < Wizrb::Error; end
+
+  class ConnectionTimeoutError < Wizrb::ConnectionError
+    def initialize(msg = "Connection timeout waiting for response.")
+      super
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wizrb
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Bert McCutchen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,21 +16,68 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 description: Manage the state of your Philips WiZ devices.
 email:
 - mail@bertm.dev
-executables: []
+executables:
+- wizrb
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- doc/devices.md
+- doc/lighting.md
+- doc/power.md
+- exe/wizrb
+- lib/wizrb.rb
+- lib/wizrb/cli.rb
+- lib/wizrb/lighting.rb
+- lib/wizrb/lighting/discover.rb
+- lib/wizrb/lighting/events/set_brightness_event.rb
+- lib/wizrb/lighting/events/set_cold_white_event.rb
+- lib/wizrb/lighting/events/set_color_temp_event.rb
+- lib/wizrb/lighting/events/set_rgb_event.rb
+- lib/wizrb/lighting/events/set_scene_event.rb
+- lib/wizrb/lighting/events/set_speed_event.rb
+- lib/wizrb/lighting/events/set_warm_white_event.rb
+- lib/wizrb/lighting/group.rb
+- lib/wizrb/lighting/products/dimable_light.rb
+- lib/wizrb/lighting/products/light.rb
+- lib/wizrb/lighting/products/rgb_light.rb
+- lib/wizrb/lighting/products/tunable_light.rb
+- lib/wizrb/lighting/scenes/scene.rb
+- lib/wizrb/lighting/scenes/spooky_scene.rb
+- lib/wizrb/lighting/state.rb
+- lib/wizrb/power/discover.rb
+- lib/wizrb/power/group.rb
+- lib/wizrb/power/products/smart_plug.rb
+- lib/wizrb/shared/connection.rb
+- lib/wizrb/shared/discover.rb
+- lib/wizrb/shared/events/base.rb
+- lib/wizrb/shared/events/power_event.rb
+- lib/wizrb/shared/events/reboot_event.rb
+- lib/wizrb/shared/events/refresh_event.rb
+- lib/wizrb/shared/events/reset_event.rb
+- lib/wizrb/shared/group.rb
+- lib/wizrb/shared/products/device.rb
+- lib/wizrb/shared/state.rb
+- lib/wizrb/version.rb
 homepage: https://github.com/bert-mccutchen/wizrb
 licenses:
 - MIT
@@ -38,6 +85,7 @@ metadata:
   homepage_uri: https://github.com/bert-mccutchen/wizrb
   source_code_uri: https://github.com/bert-mccutchen/wizrb
   changelog_uri: https://github.com/bert-mccutchen/wizrb/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -46,14 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: State management for Philips WiZ devices.