tp_link 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ecbd0295f05df003c78bbcc8cf1299dc1a7af18
+  data.tar.gz: f34c62675f5fdd65b9607f06408d0c5a66f1c90a
+SHA512:
+  metadata.gz: 9aa8132ae642b60c8bd28623acb3dbd3c5ab1e76d0c712fba47e5026b34cb838eaae53b49cbd58b916c18a9014cb113c2a53cccd8ded999630db4d17e8b08afd
+  data.tar.gz: 6b13493b9a882282f9fe0c9ec7015bd5204007813b1c3397289b0aa46f4a5805ab3d11d93fb710919ebe57ef3cb878bb9e097c9e8d06a098f6b9b066849e9643

data/lib/tp_link.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'faraday'
+require 'net/https'
+require 'json'
+require 'faraday_middleware'
+require 'yaml'
+require 'json'
+require 'securerandom'
+
+require 'tp_link/errors.rb'
+require 'tp_link/config.rb'
+require 'tp_link/device.rb'
+require 'tp_link/light.rb'
+require 'tp_link/rgb_light.rb'
+require 'tp_link/plug.rb'
+require 'tp_link/api.rb'
+require 'tp_link/smart_home.rb'

data/lib/tp_link/api.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# TPLink Module
+module TPLink
+  # Talk to TPLink's API.  This class is use internally.  You should not need to call it.
+  # @!visibility private
+  class API
+    # @!visibility private
+    DEFAULT_PARAMS = {
+      'appName' =>  'Kasa_Android',
+      'termID' =>  proc { @config.terminal_uuid },
+      'appVer' =>  '1.4.4.607',
+      'ospf' =>  'Android+6.0.1',
+      'netType' =>  'wifi',
+      'locale' =>  'es_ES'
+    }.freeze
+
+    # @!visibility private
+    DEFAULT_HEADERS = {
+      'Connection' => 'Keep-Alive',
+      'User-Agent' => 'Dalvik/2.1.0 (Linux; U; Android 6.0.1; ' \
+                                'A0001 Build/M4B30X)',
+      'Content-Type' => 'applicatoin/json;charset=utf-8',
+      'Accept' => 'application/json, text/plain, */*'
+    }.freeze
+
+    # # @!visibility private
+    # TOKEN_API = Faraday.new('https://wap.tplinkcloud.com') do |c|
+    #   c.request :json
+    #   c.response :json, content_type: /\bjson$/i
+    #   c.adapter Faraday.default_adapter
+    #   c.params.merge!(DEFAULT_PARAMS)
+    #   c.headers.merge!(DEFAULT_HEADERS)
+    # end
+
+    # @!visibility private
+    TPLINK_API = Faraday.new('https://wap.tplinkcloud.com') do |c|
+      c.request :json
+      c.response :json, content_type: /\bjson$/i
+      c.adapter Faraday.default_adapter
+      c.params.merge!(DEFAULT_PARAMS)
+      c.headers.merge!(DEFAULT_HEADERS)
+    end
+
+    # @!visibility private
+    def initialize(opts = nil)
+      options = opts || "#{ENV['HOME']}/.tp_link"
+      @config = Config.new(options)
+      @token = nil
+      @device_list = []
+    end
+
+    def token(regen = false)
+      return @token if @token && regen == false
+      response = TPLINK_API.post do |req|
+        req.body = { method: 'login', url: 'https://wap.tplinkcloud.com',
+                     params: @config.to_hash }.to_json
+      end
+      @token = parse_response(response)['token']
+    end
+
+    def device_list
+      @device_list if @device_list
+      response = TPLINK_API.post do |req|
+        req.params['token'] = token
+        req.body = { method: 'getDeviceList' }.to_json
+      end
+      @device_list = parse_response(response)['deviceList']
+    end
+
+    def send_data(device, data)
+      conn = data_connection(device)
+      res = conn.post do |req|
+        req.body = { method: 'passthrough',
+                     params: { deviceId: device.id,
+                               requestData: data.to_json } }.to_json
+      end
+      parse_response(res)
+    end
+
+    private
+
+    def data_connection(device)
+      Faraday.new(device.url) do |c|
+        c.request :json
+        c.response :json, content_type: /\bjson$/i
+        c.adapter Faraday.default_adapter
+        c.params['token'] = token
+        c.headers.merge!(DEFAULT_HEADERS)
+      end
+    end
+
+    def parse_response(res)
+      raise TPLink::TPLinkCloudError, 'Generic TPLinkCloud Error' unless res.success?
+      response = JSON.parse(res.body)
+      raise TPLink::DeviceOffline if response['error_code'].to_i == -20_571
+      raise TPLink::TPLinkCloudError, 'TPLinkCloud API Error' \
+        unless response['error_code'].to_i.zero?
+      raise TPLink::TPLinkCloudError, 'No respone data' \
+        unless res.body['result']
+      if response['result'].key?('responseData') && \
+         response['result']['responseData'].class == String
+        response['result']['responseData'] = \
+          JSON.parse(response['result']['responseData'])
+      end
+      response['result']
+    end
+  end
+end

data/lib/tp_link/config.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module TPLink
+  # This class handles the configuration.
+  # It is used internally and should not need to be called.
+  # @!visibility private
+  class Config
+    def initialize(config = "#{ENV['HOME']}/.tp_link")
+      @config_file = nil
+      @config = get_config(config)
+      raise 'User name not spcified in configuration.' \
+        unless @config.key?('user')
+      raise 'Password not specified in configuration.' \
+        unless @config.key?('password')
+      generate_uuid unless @config.key? 'uuid'
+    end
+
+    def generate_uuid
+      if @config_file && @config['uuid'].nil?
+        @config['uuid'] ||= SecureRandom.uuid
+        File.open(@config_file, 'w') do |f|
+          f.write @config.to_yaml
+        end
+      end
+      @config['uuid']
+    end
+
+    def app_type
+      'Kasa_Android'
+    end
+
+    def terminal_uuid
+      @config['uuid']
+    end
+
+    def cloud_user_name
+      @config['user']
+    end
+
+    def cloud_password
+      @config['password']
+    end
+
+    def to_hash
+      {
+        appType: app_type,
+        cloudUserName: cloud_user_name,
+        cloudPassword: cloud_password,
+        terminalUUID: terminal_uuid
+      }
+    end
+
+    def to_json(_o)
+      to_hash.to_json
+    end
+
+    private
+
+    def get_config(config)
+      if config.is_a? String
+        raise "Config file missing: #{config}" \
+          unless File.exist?(config)
+        @config_file = config
+        return YAML.load_file(config) || {}
+      elsif !config.is_a?(Hash)
+        raise "Invalid config type #{config.class}"
+      end
+      config
+    end
+  end
+end

data/lib/tp_link/device.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module TPLink
+  # Generic class for all TPLink devices0
+  class Device
+    # Returns satus of device.
+    # @return [Boolean<1>] if device is on.
+    # @return [Boolean<0>] if device is off.
+    attr_reader :status
+
+    # Returns alais of device.
+    # @return [String] Device alias (name in kasa app).
+    attr_reader :alias
+
+    # Returns name of device.
+    # @return [String] Name of device (e.g. TP Link Smart Plug).
+    attr_reader :name
+
+    # @!visibility private
+    attr_reader :type, :url, :model, :mac, :role
+    # @!visibility private
+    attr_reader :same_region, :hw_id, :fw_id, :id, :hw_version, :fw_version
+
+    # @!visibility private
+    # This should only be called internally
+    def initialize(parent, dev)
+      @parent = parent
+      @alias = dev['alias']
+      @name = dev['deviceName']
+      @status = dev['status']
+      @type = dev['deviceType']
+      @url = dev['appServerUrl']
+      @model = dev['deviceModel']
+      @mac = dev['deviceMac']
+      @role = dev['role']
+      @same_region = dev['isSameRegion']
+      @hw_id = dev['hwId']
+      @fw_id = dev['fwId']
+      @id = dev['deviceId']
+      @hw_version = dev['deviceHwVersion']
+      @fw_version = dev['fwVer']
+    end
+
+    # Get Wifi signal strength in dB
+    # @returns [Integer]
+    def rssi
+      reload
+      @rssi
+    end
+
+    # Reload data / device state
+    def reload
+      res = @parent.send_data(self,
+                              "system":
+                               { "get_sysinfo": nil },
+                              "emeter": { "get_realtime": nil })
+      @rssi = res['responseData']['system']['get_sysinfo']['rssi']
+      case self.class.to_s
+      when 'TPLink::Light'
+        reload_light(res)
+      when 'TPLink::Plug'
+        reload_plug(res)
+      end
+      true
+    end
+
+    # Turn device on
+    def on; end
+
+    # Turn device off
+    def off; end
+
+    # @return [True] if device is on.
+    # @return [False] if device is off.
+    def on?
+      reload
+      @status == 1
+    end
+
+    # @return [True] if device is off.
+    # @return [False] if device is on.
+    def off?
+      !on?
+    end
+
+    private
+
+    def reload_plug(res)
+      @status = res['responseData']['system']['get_sysinfo']['relay_state']
+    end
+
+    def reload_light(res)
+      @status = res['responseData']['system']['get_sysinfo']['light_state']['on_off']
+    end
+
+    def reload_rgb(res)
+      # TODO: Add variables for Hue, and Saturation
+      @status = res['responseData']['system']['get_sysinfo']['light_state']['on_off']
+    end
+  end
+end

data/lib/tp_link/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Provides errors raised by the gem.
+
+module TPLink
+  # Handle Errrors related to TPLink's Cloud
+  class DeviceOffline < StandardError
+    def initialize
+      super('Device Offline')
+    end
+  end
+  class TPLinkCloudError < StandardError
+    attr_reader :action
+    def initialize(message, action = nil)
+      super(message)
+      @action = action
+    end
+  end
+end

data/lib/tp_link/light.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module TPLink
+  # Control TPLink Dimmable lights
+  # @example
+  #  light.on # turn on light
+  #  light.off # turn off light
+  #
+  #  # turn on light and set brightness to 50%
+  #  light.on
+  #  light.on(50)
+  class Light < TPLink::Device
+    # Turn light on
+    # @param b [Integer<1-100>] Set light intensity between 1 and 100
+    def on(b = 100)
+      transition_light_state(1, b)
+    end
+
+    # Turn light off
+    def off
+      transition_light_state(0, 100)
+    end
+
+    # Toggle device (turn off if on, on if off)
+    def toggle
+      if on?
+        off
+      else
+        on
+      end
+    end
+
+    private
+
+    def transition_light_state(o, b)
+      @parent.send_data(self,
+                        "smartlife.iot.smartbulb.lightingservice": {
+                          "transition_light_state": {
+                            "on_off": o,
+                            "brightness": b
+                          }
+                        })
+    end
+  end
+end

data/lib/tp_link/plug.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TPLink
+  # Control TPLink Smart Plugs
+  class Plug < TPLink::Device
+    # Turn device on
+    def on
+      relay_state(1)
+    end
+
+    # Turn device off
+    def off
+      relay_state(0)
+    end
+
+    # Toggle device (turn off if on, on if off)
+    def toggle
+      if on?
+        off
+      else
+        on
+      end
+    end
+
+    private
+
+    def relay_state(s)
+      @parent.send_data(self, "system": { "set_relay_state": { "state": s } })
+    end
+  end
+end

data/lib/tp_link/rgb_light.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module TPLink
+  # Control TP-Link LS130 / RGB lights
+  class RGBLight < TPLink::Device
+    # Turn Light on
+    def on(b = 100, h = 100, s = 100)
+      transition_light_state(1, b, h, s)
+    end
+
+    # Turn light off
+    def off
+      transition_light_state(0, 100, 100, 100)
+    end
+
+    # Toggle device (turn off if on, on if off)
+    def toggle
+      if on?
+        off
+      else
+        on
+      end
+    end
+
+    private
+
+    def transition_light_state(o, b, h, s)
+      @parent.send_data(self,
+                        "smartlife.iot.smartbulb.lightingservice": {
+                          "transition_light_state": {
+                            "on_off": o,
+                            "brightness": b,
+                            "hue": h,
+                            "saturation": s
+                          }
+                        })
+    end
+  end
+end

data/lib/tp_link/smart_home.rb

@@ -0,0 +1,85 @@
+#  frozen_string_literal: true
+
+module TPLink
+  # Main class for TPLink.  This is likely the only class you will initialize.
+  # @example
+  #   sh = TPLink::SmartHome.new
+  #
+  #   # Get array of TPLink Devices (currently only dimmable lights work).
+  #   sh.devices
+  #
+  #   # Find a device by name:
+  #   light = sh.find("kitchen")
+  #
+  #   # Turn light on
+  #   light.on
+  #
+  #   # Turn light off
+  #   light.off
+  #
+  #   # Dim light to 50%
+  #   light.on(50)
+  class SmartHome
+    # @!visibility private
+    attr_reader :api
+    # @param [Hash,String] config options for TPLink
+    # @option config [String] :user Your Kasa user name
+    # @option config [String] :password Your Kasa password
+    # @option config [String] :uuid Your "device" (program) uuid.
+    # @example
+    #  smarthome = TPLink::SmartHome.new(user: kasa@example.com, password: password: 1234)
+    #  kitchen_light = smarthome.find("kitchen")
+    #  kitchen_light.on
+    #  kitchen_light.off
+    def initialize(config = {})
+      @api = TPLink::API.new(config)
+      reload
+    end
+
+    # Find a device by it's alias.  Search is case insensitive.
+    # @param [String] a device alias.
+    # @return [TPLink::Light] If device is a dimmable light.
+    # @return [TPLink::RGBLight] if device is an RGB light.
+    # @return [TPLink::Plug] if device is a smart plug.
+    # @return [nil] if no device is found.
+    # @example Find your kitchen light
+    #   smarthome.find("kitchen")
+    def find(a)
+      devices.find { |d| d.alias.match(/^#{a}$/i) }
+    end
+
+    # Find a device by it's alias.
+    # @return [Array<TPLink::Light,TPLink::RGBLight,TPLlink::Plug>] an array of devices.
+    # @example Turn everything off
+    #   smarthome.devices.each { |device| device.off }
+    def devices
+      @devices ||= @raw_devices.map { |d| dev_to_class(d) }.compact
+    end
+
+    def send_data(device, data)
+      @api.send_data(device, data)
+    end
+
+    # Reload devices from TPLink api.
+    def reload
+      @raw_devices = @api.device_list
+      @devices = nil
+    end
+
+    private
+
+    # TODO: Test LB130, LB120, LB110, and BR30 devices.
+    def dev_to_class(device)
+      case device['deviceType']
+      when 'IOT.SMARTBULB'
+        return TPLink::Light.new(self, device) \
+          if device['deviceModel'].match(/^(LB100|LB110|BR30)/)
+        return TPLink::RGBLight.new(self, device) \
+          if device['deviceModel'].match(/^(LB130|LB120)/)
+      when 'IOT.SMARTPLUGSWITCH'
+        return TPLink::Plug.new(self, device)
+      end
+      nil
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: tp_link
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Paterni
+- Ian MOrgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: Control various TPLink smart home devices.
+email: tp_link@ruby-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/tp_link.rb"
+- "./lib/tp_link/api.rb"
+- "./lib/tp_link/config.rb"
+- "./lib/tp_link/device.rb"
+- "./lib/tp_link/errors.rb"
+- "./lib/tp_link/light.rb"
+- "./lib/tp_link/plug.rb"
+- "./lib/tp_link/rgb_light.rb"
+- "./lib/tp_link/smart_home.rb"
+homepage: https://ruby-code.com/james/tp_link
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: TPLink smarthome library
+test_files: []