ewelink 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97046b44715a988f6ae92d986c0fad17ab4d5cae6420a125c10f23854cfaadc9
-  data.tar.gz: b95e52d88f8d57d5bf9f54b67d5a8c0779d26b66faadbc252e13eadb80854292
+  metadata.gz: 2c58323e838b9fbbdca7c7ee0fdf22d1e7950c627fb4fcf8851b3263e69ce883
+  data.tar.gz: 475d05f731b079f7734fde4dd93ec8f151077d6e5b716a86e611f11bdbb8d49b
 SHA512:
-  metadata.gz: f153a280ff50b245434b2039cd3bb88341da6bd7688556a8a7c3fe4558a2b13a6be5c1497f5b06dc381495cb63d8c26d4d3f2625ea5bd4148e4c55a2f28b2faf
-  data.tar.gz: e3b69fa1607599325ea0f2867fbd0d32fd3abd56a4e7bd8d07107e083d4ebbfaf919bc4af34b28948163d1fb5340a53489aec1839cc59ba238f2917a8db03cc5
+  metadata.gz: 50ba5474e9012f219e380c47515d599da29a72b50cc26c36a19e253623c997e429a32c1b279619eef0e2d8b7f454fccde519500f998575c38d028ac86e6c1ba4
+  data.tar.gz: 122f2997897893b395cd04204e3e169d90bac15fc1a9eaabbf31def8da1c7f754bd502341411727364a79011379791a89031e9d42090d22bf96be233a24a5958

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/lib/ewelink/api.rb

@@ -11,6 +11,7 @@ module Ewelink
     URL = 'https://#{region}-api.coolkit.cc:8080'
     UUID_NAMESPACE = 'e25750fb-3710-41af-b831-23224f4dd609';
     VERSION = 8
+    WEB_SOCKET_PING_TOLERANCE_FACTOR = 1.5
     WEB_SOCKET_WAIT_INTERVAL = 0.2.seconds
 
     attr_reader :email, :password, :phone_number
@@ -41,6 +42,7 @@ module Ewelink
             'ts' => 0,
             'userAgent' => 'app',
           }
+          Ewelink.logger.debug(self.class.name) { "Pressing RF bridge button #{button[:uuid].inspect}" }
           send_to_web_socket(JSON.generate(params))
           true
         end
@@ -48,10 +50,17 @@ module Ewelink
     end
 
     def reload
-      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices, region,...)' }
+      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices, region, connections,...)' }
       dispose_web_socket
       @switches_statuses.clear
-      [:@api_keys, :@authentication_token, :@devices, :@rf_bridge_buttons, :@region, :@switches, :@web_socket, :@web_socket_url].each do |variable|
+      [
+        :@api_keys,
+        :@authentication_token,
+        :@devices,
+        :@region,
+        :@rf_bridge_buttons,
+        :@switches,
+      ].each do |variable|
         remove_instance_variable(variable) if instance_variable_defined?(variable)
       end
       self
@@ -103,10 +112,12 @@ module Ewelink
           'userAgent' => 'app',
         }
         web_socket_wait_for(-> { web_socket_authenticated? }) do
+          Ewelink.logger.debug(self.class.name) { "Checking switch #{switch[:uuid].inspect} status" }
           send_to_web_socket(JSON.generate(params))
         end
       end
       web_socket_wait_for(-> { !@switches_statuses[switch[:uuid]].nil? }) do
+        Ewelink.logger.debug(self.class.name) { "Switch #{switch[:uuid].inspect} is #{@switches_statuses[switch[:uuid]]}" }
         @switches_statuses[switch[:uuid]] == 'on'
       end
     end
@@ -151,9 +162,11 @@ module Ewelink
           'ts' => 0,
           'userAgent' => 'app',
         }
+        Ewelink.logger.debug(self.class.name) { "Turning switch #{switch[:uuid].inspect} #{on ? 'on' : 'off'}" }
         send_to_web_socket(JSON.generate(params))
-        true
       end
+      switch_on?(switch[:uuid]) # Waiting for switch status update
+      true
     end
 
     private
@@ -210,13 +223,31 @@ module Ewelink
 
     def dispose_web_socket
       @web_socket_authenticated_api_keys = Set.new
-      if instance_variable_defined?(:@web_socket)
+
+      if @web_socket_ping_thread
+        if Thread.current == @web_socket_ping_thread
+          Thread.current[:stop] = true
+        else
+          @web_socket_ping_thread.kill
+        end
+      end
+
+      if @web_socket.present?
         begin
           @web_socket.close if @web_socket.open?
         rescue
           # Ignoring close errors
         end
-        remove_instance_variable(:@web_socket) if instance_variable_defined?(:@web_socket)
+      end
+
+      [
+        :@last_web_socket_pong_at,
+        :@web_socket_ping_interval,
+        :@web_socket_ping_thread,
+        :@web_socket_url,
+        :@web_socket,
+      ].each do |variable|
+        remove_instance_variable(variable) if instance_variable_defined?(variable)
       end
     end
 
@@ -256,6 +287,10 @@ module Ewelink
     end
 
     def send_to_web_socket(data)
+      if web_socket_outdated_ping?
+        Ewelink.logger.warn(self.class.name) { 'WebSocket ping is outdated' }
+        dispose_web_socket
+      end
       web_socket.send(data)
     rescue
       dispose_web_socket
@@ -290,16 +325,42 @@ module Ewelink
 
             web_socket.on(:message) do |message|
               api.instance_eval do
-                response = JSON.parse(message.data)
+                if message.data == 'pong'
+                  Ewelink.logger.debug(self.class.name) { "Received WebSocket #{message.data.inspect} message" }
+                  @last_web_socket_pong_at = Time.now
+                  next
+                end
+
+                begin
+                  response = JSON.parse(message.data)
+                rescue => e
+                  Ewelink.logger.error(self.class.name) { "WebSocket JSON parse error" }
+                  next
+                end
 
                 if response.key?('error') && response['error'] != 0
                   Ewelink.logger.error(self.class.name) { "WebSocket message error: #{message.data}" }
                   next
                 end
 
+                if !@web_socket_ping_thread && response.key?('config') && response['config'].key?('hbInterval')
+                  @last_web_socket_pong_at = Time.now
+                  # @web_socket_ping_interval = response['config']['hbInterval']
+                  @web_socket_ping_interval = 30.seconds
+                  Ewelink.logger.debug(self.class.name) { "Creating thread for WebSocket ping every #{@web_socket_ping_interval} seconds" }
+                  @web_socket_ping_thread = Thread.new do
+                    loop do
+                      break if Thread.current[:stop]
+                      sleep(@web_socket_ping_interval)
+                      Ewelink.logger.debug(self.class.name) { 'Sending WebSocket ping' }
+                      send_to_web_socket('ping')
+                    end
+                  end
+                end
+
                 if response['apikey'].present? && !@web_socket_authenticated_api_keys.include?(response['apikey'])
                   @web_socket_authenticated_api_keys << response['apikey']
-                  Ewelink.logger.debug(self.class.name) { "WebSocket successfully authenticated API key: #{response['apikey'].inspect}" }
+                  Ewelink.logger.debug(self.class.name) { "WebSocket successfully authenticated API key: #{response['apikey'].truncate(16).inspect}" }
                 end
 
                 if response['deviceid'].present? && response['params'].is_a?(Hash) && response['params']['switch'].present?
@@ -324,7 +385,7 @@ module Ewelink
                     'userAgent' => 'app',
                     'version' => VERSION,
                   }
-                  Ewelink.logger.debug(self.class.name) { "Authenticating WebSocket API key: #{api_key.inspect}" }
+                  Ewelink.logger.debug(self.class.name) { "Authenticating WebSocket API key: #{api_key.truncate(16).inspect}" }
                   send_to_web_socket(JSON.generate(params))
                 end
               end
@@ -338,6 +399,10 @@ module Ewelink
       api_keys == @web_socket_authenticated_api_keys
     end
 
+    def web_socket_outdated_ping?
+      @last_web_socket_pong_at.present? && @web_socket_ping_interval.present? && @last_web_socket_pong_at < (@web_socket_ping_interval * WEB_SOCKET_PING_TOLERANCE_FACTOR).seconds.ago
+    end
+
     def web_socket_sequence
       (Time.now.to_f * 1000).round.to_s
     end
@@ -365,7 +430,10 @@ module Ewelink
       web_socket # Initializes WebSocket
       Timeout.timeout(TIMEOUT) do
         loop do
-          return yield if condition.call
+          if condition.call
+            return yield if block_given?
+            return true
+          end
           sleep(WEB_SOCKET_WAIT_INTERVAL)
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Alexis Toulotte