tp_link_smartplug 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f53d7ea800a82c44bc660a56066f5e7ee81d2ff2f786ddcb668c8d3267b8960c
+  data.tar.gz: af92b7cd428a8a3e1ceafb1868b3651153b5b192d051f0266174b14d4bbfba67
+SHA512:
+  metadata.gz: f406f2bc6b7a7ebb0d0e8434146593a6080f4a2840d4420f96b3fd9454f31645adbfb8e248c5dab75e35c54ed9e72129b0e2355b508949271f1aa75371eb7269
+  data.tar.gz: 1b21d836bac38def6558452bd6fa6bbb9a4c0fe5023f70abb07c91bdd6921d5f4bb6db7db44d52ecf47d07d7fd417c0a5d8b71e10ccf5832becf864abb90844d

data/lib/tp_link_smartplug/command.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TpLinkSmartplug
+  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":{}}}'
+  end
+end

data/lib/tp_link_smartplug/device.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'ipaddr'
+require 'json'
+require 'tp_link_smartplug/message'
+
+module TpLinkSmartplug
+  # Provides an interface to a plug
+  class Device
+    include TpLinkSmartplug::Message
+
+    attr_accessor :address
+    attr_accessor :timeout
+    attr_accessor :port
+    attr_accessor :debug
+
+    def initialize(address:, port: 9999)
+      @address = IPAddr.new(address, Socket::AF_INET)
+      @port = port
+      @timeout = 3
+      @debug = false
+    end
+
+    [
+      :info,
+      :on,
+      :off,
+      :cloudinfo,
+      :wlanscan,
+      :time,
+      :schedule,
+      :countdown,
+      :antitheft,
+      :reboot,
+      :reset,
+      :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))
+      end
+    end
+  end
+end

data/lib/tp_link_smartplug/helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module TpLinkSmartplug
+  # Generic helper methods
+  module Helpers
+    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)
+    end
+  end
+end

data/lib/tp_link_smartplug/message.rb

@@ -0,0 +1,68 @@
+# 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
+  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)
+      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
+    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
+      end
+    end
+
+    def disconnect(socket:)
+      socket.close unless socket.closed? || socket.nil?
+    end
+  end
+end

data/lib/tp_link_smartplug/message_helpers.rb

@@ -0,0 +1,31 @@
+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

data/lib/tp_link_smartplug/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TpLinkSmartplug
+  VERSION = '0.0.1'
+end

data/lib/tp_link_smartplug.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+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'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: tp_link_smartplug
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-07 00:00:00.000000000 Z
+dependencies: []
+description: Control and retrieve data from a TP-Link HS100/110 (Metered) Smartplug
+email: bmhughes@bmhughes.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/tp_link_smartplug.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:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: TP-Link HS100/110 Smart Plug interaction library
+test_files: []