tp_link_smartplug 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f6b7cc98865382ad2bfa186843abca5622e0e10e3bbd47b6cbbf3c053fb53fb
-  data.tar.gz: 9581643fd63749b826acc8ada7fc9eaca0392e54d4a42f647d4912023cf89a66
+  metadata.gz: 1739412106dde9bd88df2a292bac503e3c7a00a41d99ea0fa5313af60cbbe873
+  data.tar.gz: a03b730e2e02d3829ae2f37c27dce448d1ac3ed0d2c2122096382733a53ac836
 SHA512:
-  metadata.gz: 96069bf5ff04e8774b15cf9ef12ea8fe7cf0476d44d54c3577f16acf559aa41bbca39825e2a8c1e75c52c2b0a3b54f34ddff6707144ee3653cb7bf146273fcd4
-  data.tar.gz: ffd67c8bf48cae8cc2761390cf04b01829d6f1e03808e38d80c124f61b08204805bf629399f3fa9353e1e5edccf4f3983a5093a7a7721d96594f0a1ca4605a97
+  metadata.gz: 35bd08c5cacc7e8d9a68bd8a48c3d232f8ae77c5875809d5125fa0c218c7dc260b6633c463f325fcf0ea15eda959028699ab06b5674825ef4af96788cf243e5e
+  data.tar.gz: 5e4ea23acfebad26a9410d0b8c1a0cd7ea755bb3847946e412100375b223ffeaec057964acb3a3a9e153d763b32a1941486babcad6d71a760cb0ad615f1986b9

data/lib/tp_link_smartplug/_base.rb

@@ -6,8 +6,6 @@ module TpLinkSmartplug
   # @author Ben Hughes
   class Base
     include TpLinkSmartplug::Helpers
-
-    def initialize; end
   end
 
   # Base plug error class.

data/lib/tp_link_smartplug/command.rb

@@ -13,6 +13,8 @@ module TpLinkSmartplug
     WLANSCAN = '{"netif":{"get_scaninfo":{"refresh":0}}}'.freeze
     # Plug time command
     TIME = '{"time":{"get_time":{}}}'.freeze
+    # Plug timezone command
+    TIMEZONE = '{"time":{"get_timezone":{}}}'.freeze
     # Plug schedule command
     SCHEDULE = '{"schedule":{"get_rules":{}}}'.freeze
     # Plug countdown command
@@ -25,5 +27,11 @@ module TpLinkSmartplug
     RESET = '{"system":{"reset":{"delay":1}}}'.freeze
     # Plug energy command
     ENERGY = '{"emeter":{"get_realtime":{}}}'.freeze
+    # Plug energy VGain/IGain settings
+    ENERGYGAINS = '{"emeter":{"get_vgain_igain":{}}}'.freeze
+    # Plug LED On
+    LEDON = '{"system":{"set_led_off":{"off":0}}}'.freeze
+    # Plug LED Off
+    LEDOFF = '{"system":{"set_led_off":{"off":1}}}'.freeze
   end
 end

data/lib/tp_link_smartplug/device.rb

@@ -1,8 +1,9 @@
 require 'socket'
 require 'ipaddr'
 require 'json'
-require_relative './message'
+require_relative 'message'
 
+# Top level module
 module TpLinkSmartplug
   # Provides an object to represent to a plug
   #
@@ -15,9 +16,9 @@ module TpLinkSmartplug
     include TpLinkSmartplug::Helpers
     include TpLinkSmartplug::Message
 
-    attr_accessor :address, :port, :timeout, :poll_auto_close, :debug
+    attr_accessor :address, :port, :timeout, :poll_auto_close, :auto_connect, :debug
 
-    def initialize(address:, port: 9999)
+    def initialize(address:, port: 9999, auto_connect: true, auto_disconnect: true)
       super()
 
       @address = IPAddr.new(address, Socket::AF_INET)
@@ -26,7 +27,10 @@ module TpLinkSmartplug
       @debug = false
       @sockaddr = Addrinfo.getaddrinfo(@address.to_s, @port, Socket::PF_INET, :STREAM, 6).first.to_sockaddr
       @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM)
-      @poll_auto_close = true
+      @poll_auto_close = auto_disconnect
+      @auto_connect = auto_connect
+
+      connect if auto_connect
     end
 
     # Open connection to plug
@@ -41,7 +45,7 @@ module TpLinkSmartplug
         @socket.connect_nonblock(@sockaddr)
         debug_message('Connected') if @debug
       rescue IO::WaitWritable
-        if @socket.wait_writable(timeout)
+        if @socket.wait_writable(@timeout)
           begin
             @socket.connect_nonblock(@sockaddr)
           rescue Errno::EISCONN
@@ -55,7 +59,7 @@ module TpLinkSmartplug
             raise
           end
         else
-          @socket.close
+          disconnect
           raise TpLinkSmartplug::DeviceError, "Connection timeout connecting to address #{@address}, port #{@port}."
         end
       rescue Errno::EISCONN
@@ -71,7 +75,7 @@ module TpLinkSmartplug
     # Close connection to plug
     #
     def disconnect
-      @socket.close unless @socket.closed?
+      @socket.close unless closed?
     end
 
     alias_method :close, :disconnect
@@ -87,7 +91,11 @@ module TpLinkSmartplug
     #
     # @return [True, False]
     def closed?
-      @socket.closed?
+      @socket.recvfrom_nonblock(0)
+    rescue IO::WaitReadable
+      false
+    rescue Errno::ENOTCONN, IOError
+      true
     end
 
     # Polls plug with a command
@@ -95,29 +103,29 @@ module TpLinkSmartplug
     # @param command [String] the command to send to the plug
     # @return [Hash] the output from the plug command
     def poll(command:)
-      connect
+      connect if closed?
 
       begin
         debug_message("Sending: #{decrypt(encrypt(command)[4..(command.length + 4)])}") if @debug
         @socket.write_nonblock(encrypt(command))
       rescue IO::WaitWritable
-        IO.select(nil, [@socket])
+        @socket.wait_writable(@timeout)
         retry
       end
 
       begin
         data = @socket.recv_nonblock(2048)
       rescue IO::WaitReadable
-        IO.select([@socket])
+        @socket.wait_readable(@timeout)
         retry
       end
 
       if @poll_auto_close && !closed?
         disconnect
-        raise 'Error occured during disconnect' unless closed?
+        raise DeviceError, 'Error occured during disconnect' unless closed?
       end
 
-      raise 'No data received' if nil_or_empty?(data)
+      raise DeviceError, 'No data received' if nil_or_empty?(data)
 
       debug_message("Received Raw: #{data.split('\\')}") if @debug
       data = decrypt(data[4..data.length])
@@ -144,6 +152,9 @@ module TpLinkSmartplug
     # @!method time
     #   Return system time from the plug
     #   @return [Hash]
+    # @!method timezone
+    #   Return system timezone from the plug
+    #   @return [Hash]
     # @!method schedule
     #   Return schedule configured on the plug
     #   @return [Hash]
@@ -156,12 +167,18 @@ module TpLinkSmartplug
     # @!method reboot
     #   Reboot plug
     #   @return [Hash]
-    # @!method resry
+    # @!method reset
     #   Reset plug
     #   @return [Hash]
     # @!method energy
     #   Return plug energy data
     #   @return [Hash]
+    # @!method ledon
+    #   Disable plug night mode (LED on)
+    #   @return [Hash]
+    # @!method ledoff
+    #   Enable plug night mode (LED off)
+    #   @return [Hash]
     [
       :info,
       :on,
@@ -169,12 +186,16 @@ module TpLinkSmartplug
       :cloudinfo,
       :wlanscan,
       :time,
+      :timezone,
       :schedule,
       :countdown,
       :antitheft,
       :reboot,
       :reset,
       :energy,
+      :energygains,
+      :ledon,
+      :ledoff,
     ].each do |method|
       define_method method do
         JSON.parse(poll(command: TpLinkSmartplug::Command.const_get(method.upcase)))
@@ -182,5 +203,22 @@ module TpLinkSmartplug
     end
   end
 
+  # Set plug alias
+  #
+  # @param name [String] the name to assign to the plug alias
+  # @return [Hash] the output from the plug command
+  def alias=(name)
+    JSON.parse(poll(command: "{\"system\":{\"set_dev_alias\":{\"alias\":\"#{name}\"}}}"))
+  end
+
+  # Set plug location
+  #
+  # @param longitude [String] the longitude to assign to the plug location
+  # @param lattitude [String] the lattitude to assign to the plug location
+  # @return [Hash] the output from the plug command
+  def location!(longitude, lattitude)
+    JSON.parse(poll(command: "{\"system\":{\"set_dev_location\":{\"longitude\":\"#{lattitude}\", \"latitude\":\"#{longitude}\"}}}"))
+  end
+
   class DeviceError < TpLinkSmartplug::BaseError; end
 end

data/lib/tp_link_smartplug/version.rb

@@ -1,5 +1,5 @@
 # @author Ben Hughes
 module TpLinkSmartplug
   # Gem version
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tp_link_smartplug
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies: []
 description: Control and retrieve data from a TP-Link HS100/110 (Metered) Smartplug
 email: bmhughes@bmhughes.co.uk
@@ -28,6 +28,7 @@ licenses:
 - Apache-2.0
 metadata:
   github_repo: ssh://github.com/bmhughes/tp_link_smartplug
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -43,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: TP-Link HS100/110 Smart Plug interaction library