tp_link_smartplug 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f53d7ea800a82c44bc660a56066f5e7ee81d2ff2f786ddcb668c8d3267b8960c
-  data.tar.gz: af92b7cd428a8a3e1ceafb1868b3651153b5b192d051f0266174b14d4bbfba67
+  metadata.gz: 41a05841cdc6ffdd697f903abc1d620debf999f2a9a6c5f248edc9ec93635e30
+  data.tar.gz: c3f77299aaeb6b90506f04730467c70889745d85e47148ba738ccc82de484cbd
 SHA512:
-  metadata.gz: f406f2bc6b7a7ebb0d0e8434146593a6080f4a2840d4420f96b3fd9454f31645adbfb8e248c5dab75e35c54ed9e72129b0e2355b508949271f1aa75371eb7269
-  data.tar.gz: 1b21d836bac38def6558452bd6fa6bbb9a4c0fe5023f70abb07c91bdd6921d5f4bb6db7db44d52ecf47d07d7fd417c0a5d8b71e10ccf5832becf864abb90844d
+  metadata.gz: eac7e52a043aebdeeb595aba15df19be7923d2da40a6d214bb41955f4baf4da1e2853e935cd7ade3b410981bd8698024f9598a923b20a5c0311ed2398dbced01
+  data.tar.gz: 74f0ba6ff80393ee43560a76ec6cab25d94fb1b8b5b3b078884be64b9db274e657053f2c90007df89aa2bde7e849b63a049e4628c91ff4bb90cf1e29b59c7d23

data/lib/tp_link_smartplug.rb

@@ -1,8 +1,11 @@
-# frozen_string_literal: true
+require_relative 'tp_link_smartplug/_base'
+require_relative 'tp_link_smartplug/command'
+require_relative 'tp_link_smartplug/device'
+require_relative 'tp_link_smartplug/helpers'
+require_relative 'tp_link_smartplug/message'
+require_relative 'tp_link_smartplug/version'
 
-require 'tp_link_smartplug/command'
-require 'tp_link_smartplug/device'
-require 'tp_link_smartplug/helpers'
-require 'tp_link_smartplug/message_helpers'
-require 'tp_link_smartplug/message'
-require 'tp_link_smartplug/version'
+# Top level module
+#
+# @author Ben Hughes
+module TpLinkSmartplug; end

data/lib/tp_link_smartplug/_base.rb

@@ -0,0 +1,15 @@
+require_relative 'helpers'
+
+module TpLinkSmartplug
+  # Base plug class.
+  #
+  # @author Ben Hughes
+  class Base
+    include TpLinkSmartplug::Helpers
+  end
+
+  # Base plug error class.
+  #
+  # @author Ben Hughes
+  class BaseError < StandardError; end
+end

data/lib/tp_link_smartplug/command.rb

@@ -1,18 +1,29 @@
-# frozen_string_literal: true
-
 module TpLinkSmartplug
+  # Module containing the static commands for the plug
   module Command
-    INFO = '{"system":{"get_sysinfo":{}}}'
-    ON = '{"system":{"set_relay_state":{"state":1}}}'
-    OFF = '{"system":{"set_relay_state":{"state":0}}}'
-    CLOUDINFO = '{"cnCloud":{"get_info":{}}}'
-    WLANSCAN = '{"netif":{"get_scaninfo":{"refresh":0}}}'
-    TIME = '{"time":{"get_time":{}}}'
-    SCHEDULE = '{"schedule":{"get_rules":{}}}'
-    COUNTDOWN = '{"count_down":{"get_rules":{}}}'
-    ANTITHEFT = '{"anti_theft":{"get_rules":{}}}'
-    REBOOT = '{"system":{"reboot":{"delay":1}}}'
-    RESET = '{"system":{"reset":{"delay":1}}}'
-    ENERGY = '{"emeter":{"get_realtime":{}}}'
+    # Plug information command
+    INFO = '{"system":{"get_sysinfo":{}}}'.freeze
+    # Plug output on command
+    ON = '{"system":{"set_relay_state":{"state":1}}}'.freeze
+    # Plug output off command
+    OFF = '{"system":{"set_relay_state":{"state":0}}}'.freeze
+    # Plug cloud info command
+    CLOUDINFO = '{"cnCloud":{"get_info":{}}}'.freeze
+    # Plug WLAN SSID scan command
+    WLANSCAN = '{"netif":{"get_scaninfo":{"refresh":0}}}'.freeze
+    # Plug time command
+    TIME = '{"time":{"get_time":{}}}'.freeze
+    # Plug schedule command
+    SCHEDULE = '{"schedule":{"get_rules":{}}}'.freeze
+    # Plug countdown command
+    COUNTDOWN = '{"count_down":{"get_rules":{}}}'.freeze
+    # Plug antitheft command
+    ANTITHEFT = '{"anti_theft":{"get_rules":{}}}'.freeze
+    # Plug reboot command
+    REBOOT = '{"system":{"reboot":{"delay":1}}}'.freeze
+    # Plug reset command
+    RESET = '{"system":{"reset":{"delay":1}}}'.freeze
+    # Plug energy command
+    ENERGY = '{"emeter":{"get_realtime":{}}}'.freeze
   end
 end

data/lib/tp_link_smartplug/device.rb

@@ -1,27 +1,167 @@
-# frozen_string_literal: true
-
 require 'socket'
 require 'ipaddr'
 require 'json'
-require 'tp_link_smartplug/message'
+require_relative './message'
 
 module TpLinkSmartplug
-  # Provides an interface to a plug
-  class Device
+  # Provides an object to represent to a plug
+  #
+  # @author Ben Hughes
+  # @attr [IPAddr] address IP address of the plug
+  # @attr [Integer] port Port to connect to on the plug
+  # @attr [Integer] timeout Timeout value for connecting and sending commands to the plug
+  # @attr [true, false] debug Control debug logging
+  class Device < TpLinkSmartplug::Base
+    include TpLinkSmartplug::Helpers
     include TpLinkSmartplug::Message
 
-    attr_accessor :address
-    attr_accessor :timeout
-    attr_accessor :port
-    attr_accessor :debug
+    attr_accessor :address, :port, :timeout, :poll_auto_close, :debug
 
     def initialize(address:, port: 9999)
+      super
+
       @address = IPAddr.new(address, Socket::AF_INET)
       @port = port
       @timeout = 3
       @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
+    end
+
+    # Open connection to plug
+    #
+    def connect
+      debug_message("Connecting to #{@address} port #{@port}") if @debug
+      debug_message("Connecting, socket state: #{@socket.closed? ? 'closed' : 'open'}") if @debug
+
+      @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM) if closed?
+
+      begin
+        @socket.connect_nonblock(@sockaddr)
+        debug_message('Connected') if @debug
+      rescue IO::WaitWritable
+        if IO.select(nil, [@socket], nil, timeout)
+          begin
+            @socket.connect_nonblock(@sockaddr)
+          rescue Errno::EISCONN
+            debug_message('Connected') if @debug
+          rescue Errno::ECONNREFUSED
+            @socket.close
+            raise TpLinkSmartplug::DeviceError, "Connection refused connecting to address #{@address}, port #{@port}!"
+          rescue StandardError => e
+            disconnect
+            debug_message("Unexpected exception encountered. Error: #{e}") if @debug
+            raise
+          end
+        else
+          @socket.close
+          raise TpLinkSmartplug::DeviceError, "Connection timeout connecting to address #{@address}, port #{@port}."
+        end
+      rescue Errno::EISCONN
+        debug_message('Connected') if @debug
+      rescue Errno::EINPROGRESS
+        debug_message('Connection in progress') if @debug
+        retry
+      rescue Errno::ECONNREFUSED
+        raise TpLinkSmartplug::DeviceError, "Connection refused connecting to address #{@address}, port #{@port}."
+      end
+    end
+
+    # Close connection to plug
+    #
+    def disconnect
+      @socket.close unless @socket.closed?
+    end
+
+    alias_method :close, :disconnect
+
+    # Return connection state open
+    #
+    # @return [True, False]
+    def open?
+      !@socket.closed?
+    end
+
+    # Return connection state closed
+    #
+    # @return [True, False]
+    def closed?
+      @socket.closed?
     end
 
+    # Polls plug with a command
+    #
+    # @param command [String] the command to send to the plug
+    # @return [Hash] the output from the plug command
+    def poll(command:)
+      connect
+
+      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])
+        retry
+      end
+
+      begin
+        data = @socket.recv_nonblock(2048)
+      rescue IO::WaitReadable
+        IO.select([@socket])
+        retry
+      end
+
+      if @poll_auto_close && !closed?
+        disconnect
+        raise 'Error occured during disconnect' unless closed?
+      end
+
+      raise 'No data received' if nil_or_empty?(data)
+
+      debug_message("Received Raw: #{data}") if @debug
+      data = decrypt(data[4..data.length])
+      debug_message("Received Decrypted: #{data}") if @debug
+
+      data
+    end
+
+    # @!method info
+    #   Return plug information
+    #   @return [Hash]
+    # @!method on
+    #   Turn plug output on
+    #   @return [Hash]
+    # @!method off
+    #   Turn plug output off
+    #   @return [Hash]
+    # @!method cloudinfo
+    #   Return plug cloud account configuration
+    #   @return [Hash]
+    # @!method wlanscan
+    #   Perform a scan for wireless SSIDs
+    #   @return [Hash]
+    # @!method time
+    #   Return system time from the plug
+    #   @return [Hash]
+    # @!method schedule
+    #   Return schedule configured on the plug
+    #   @return [Hash]
+    # @!method countdown
+    #   Return countdown configured on the plug
+    #   @return [Hash]
+    # @!method antitheft
+    #   Unsure
+    #   @return [Hash]
+    # @!method reboot
+    #   Reboot plug
+    #   @return [Hash]
+    # @!method resry
+    #   Reset plug
+    #   @return [Hash]
+    # @!method energy
+    #   Return plug energy data
+    #   @return [Hash]
     [
       :info,
       :on,
@@ -34,11 +174,13 @@ module TpLinkSmartplug
       :antitheft,
       :reboot,
       :reset,
-      :energy
+      :energy,
     ].each do |method|
       define_method method do
-        JSON.parse(poll(address: @address, port: @port, command: TpLinkSmartplug::Command.const_get(method.upcase), timeout: @timeout, debug: @debug))
+        JSON.parse(poll(command: TpLinkSmartplug::Command.const_get(method.upcase)))
       end
     end
   end
+
+  class DeviceError < TpLinkSmartplug::BaseError; end
 end

data/lib/tp_link_smartplug/helpers.rb

@@ -1,13 +1,23 @@
-# frozen_string_literal: true
-
 require 'time'
 
 module TpLinkSmartplug
   # Generic helper methods
   module Helpers
+    # Formats a message for output as a debug log
+    #
+    # @param string [String] the message to be formatted for debug output
     def debug_message(string)
-      caller_method = caller_locations(1..1).label
-      Time.now.strftime('%Y-%m-%d %H:%M:%S: ').concat("#{caller_method}: ").concat(string)
+      caller_method = caller_locations(1..1).first.label
+      $stdout.puts(Time.now.strftime('%Y-%m-%d %H:%M:%S: ').concat("#{caller_method}: ").concat(string))
+    end
+
+    # Tests a variable for nil or empty status
+    #
+    # @param v  the variable to be tested
+    def nil_or_empty?(value)
+      return true if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+
+      false
     end
   end
 end

data/lib/tp_link_smartplug/message.rb

@@ -1,68 +1,31 @@
-# frozen_string_literal: true
-
-require 'socket'
-require 'tp_link_smartplug/helpers'
-require 'tp_link_smartplug/message_helpers'
-
 module TpLinkSmartplug
-  # Provides methods to send and receive messages from plugs
+  # Helper methods for plug communication messages
   module Message
-    include TpLinkSmartplug::Helpers
-    include TpLinkSmartplug::MessageHelpers
-
-    def poll(address:, port:, command:, timeout: 3, debug: false)
-      socket = connect(address: address, port: port, timeout: timeout, debug: debug)
-      STDOUT.puts(debug_message("Sending: #{decrypt(encrypt(command)[4..command.length])}")) if debug
-
-      begin
-        socket.write_nonblock(encrypt(command))
-        data = socket.recv_nonblock(2048)
-      rescue IO::WaitReadable, IO::WaitWritable
-        IO.select([socket], [socket])
-        retry
-      ensure
-        disconnect(socket: socket)
+    # Encrypts a message to send to the smart plug
+    #
+    # @param string [String] the message to be encrypted
+    def encrypt(string)
+      key = 171
+      result = [string.length].pack('N')
+      string.each_char do |char|
+        key = a = key ^ char.ord
+        result.concat(a.chr)
       end
-
-      raise 'Error occured during disconnect' unless socket.closed?
-      raise 'No data received' if data.nil? || data.empty?
-
-      STDOUT.puts(debug_message("Received Raw: #{data}")) if debug
-      data = decrypt(data[4..data.length])
-      STDOUT.puts(debug_message("Received: #{data}")) if debug
-
-      data
+      result
     end
 
-    private
-
-    def connect(address:, port:, timeout: 3, debug: false)
-      STDOUT.puts(debug_message("Connecting to #{address} port #{port}")) if debug
-
-      Socket.new(Socket::AF_INET, Socket::SOCK_STREAM).tap do |socket|
-        sockaddr = Addrinfo.getaddrinfo(address.to_s, port, Socket::PF_INET, :STREAM, 6).first.to_sockaddr
-        STDOUT.puts(debug_message("Connecting, socket closed: #{socket.closed?}")) if debug
-        socket.connect_nonblock(sockaddr)
-      rescue IO::WaitWritable
-        if IO.select(nil, [socket], nil, timeout)
-          begin
-            socket.connect_nonblock(sockaddr)
-          rescue Errno::EISCONN
-            STDOUT.puts(debug_message('Connected')) if debug
-          rescue StandardError => e
-            socket.close
-            STDOUT.puts(debug_message('Unexpected exception encountered.')) if debug
-            raise e
-          end
-        else
-          socket.close
-          raise "Connection timeout connecting to address #{address}, port #{port}."
-        end
+    # Decrypts a message received from the smart plug
+    #
+    # @param string [String] the message to be decrypted
+    def decrypt(string)
+      key = 171
+      result = ''
+      string.each_char do |char|
+        a = key ^ char.ord
+        key = char.ord
+        result.concat(a.chr)
       end
-    end
-
-    def disconnect(socket:)
-      socket.close unless socket.closed? || socket.nil?
+      result
     end
   end
 end

data/lib/tp_link_smartplug/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
+# @author Ben Hughes
 module TpLinkSmartplug
-  VERSION = '0.0.1'
+  # Gem version
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tp_link_smartplug
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies: []
 description: Control and retrieve data from a TP-Link HS100/110 (Metered) Smartplug
 email: bmhughes@bmhughes.co.uk
@@ -17,11 +17,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - "./lib/tp_link_smartplug.rb"
+- "./lib/tp_link_smartplug/_base.rb"
 - "./lib/tp_link_smartplug/command.rb"
 - "./lib/tp_link_smartplug/device.rb"
 - "./lib/tp_link_smartplug/helpers.rb"
 - "./lib/tp_link_smartplug/message.rb"
-- "./lib/tp_link_smartplug/message_helpers.rb"
 - "./lib/tp_link_smartplug/version.rb"
 homepage: https://github.com/bmhughes/tp_link_smartplug
 licenses:
@@ -42,8 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: TP-Link HS100/110 Smart Plug interaction library

data/lib/tp_link_smartplug/message_helpers.rb

@@ -1,31 +0,0 @@
-module TpLinkSmartplug
-  # Helper methods for plug communication messages
-  module MessageHelpers
-    # Encrypts a message to send to the smart plug
-    #
-    # @string format [String] the message to be encrypted
-    def encrypt(string)
-      key = 171
-      result = [string.length].pack('N')
-      string.each_char do |char|
-        key = a = key ^ char.ord
-        result.concat(a.chr)
-      end
-      result
-    end
-
-    # Decrypts a message received from the smart plug
-    #
-    # @string format [String] the message to be decrypted
-    def decrypt(string)
-      key = 171
-      result = ''
-      string.each_char do |char|
-        a = key ^ char.ord
-        key = char.ord
-        result.concat(a.chr)
-      end
-      result
-    end
-  end
-end