kasa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43b88d71bcfcf597efbc974a100df7386365bb90b5bb113ea1a07801a8bcf565
+  data.tar.gz: 72be110483b25f002b025743c3f5896ccc690a69d9e0b1a2bfef5b92e79fd1db
+SHA512:
+  metadata.gz: 7116bd99634440e8416ae926cde96814f9b56c209bcca52d22ab2d5f5b6393f5b2b4ad3c09a35d66cad6ab65c5d2aec59ad6f92701010a939438bcf2d8d990bd
+  data.tar.gz: b996de906614906a8de6b19e5b46e4b6d0ab7aeb05f1f221e5af541d36bc2fe8208f3e626a6931d164a8078c251df20e9eddf8bc69f462de526a363cc8112a4d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+---
+require:
+  - rubocop-rspec
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'vendor/**/*'
+    - '.bundle/**/*'
+    - '*.gemspec'
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*_spec.rb'
+Style/DocumentationMethod:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kasa.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+
+gem 'json', '~> 2.6'

data/README.md

@@ -0,0 +1,50 @@
+# Kasa
+
+Connect directly to TP Link Kasa devices on your local network
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kasa'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install kasa
+
+## Usage
+To scan local network and turn on first device:
+```
+require 'kasa'
+
+kasa = Kasa.new
+kasa.devices.first.on
+```
+
+Local network device is detected but can be optionally overridden:
+```
+Kasa.new(discover_interface_override: 'eth1')
+```
+
+To connect to known host and adjust brightness:
+```
+require 'kasa'
+
+device = Kasa::Factory.new('192.168.1.55')
+device.brightness=50
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sevendials/ruby-kasa.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "kasa"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/kasa/devices.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+class Kasa
+  # Common methods across kasa devices
+  class Device
+    ON = 1
+    OFF = 0
+
+    attr_reader :ip
+
+    # initialize
+    def initialize(ip)
+      @ip = ip
+      @sysinfo = sysinfo
+    end
+
+    # Get system information
+    def sysinfo
+      Kasa::Protocol.get(@ip, location: '/system/get_sysinfo')
+    end
+
+    # Turn on light
+    def on
+      relay ON
+    end
+
+    # Turn off light
+    def off
+      relay OFF
+    end
+
+    # Is relay off?
+    def off?
+      relay_state.zero?
+    end
+
+    # Is relay on?
+    def on?
+      relay_state.eql? 1
+    end
+
+    private
+
+    # Check light state
+    def relay_state
+      Kasa::Protocol.get(@ip, location: '/system/get_sysinfo/relay_state')
+    end
+
+    def relay(state)
+      Kasa::Protocol.get(
+        @ip,
+        location: '/system/set_relay_state/state',
+        value: state
+      )
+    end
+  end
+
+  # Most devices are not dimmable
+  class NonDimmable < Device
+  end
+
+  # add dimmable device
+  class Dimmable < NonDimmable
+    # Get brightness
+    def brightness
+      sysinfo['brightness']
+    end
+
+    # Set brightness
+    def brightness=(level)
+      Kasa::Protocol.get(
+        @ip,
+        location: '/smartlife.iot.dimmer/set_brightness/brightness',
+        value: level
+      )
+    end
+  end
+
+  # add dimmable device
+  class SmartStrip < NonDimmable
+    attr_accessor :children
+
+    def initialize(ip)
+      super
+      @children = @sysinfo['children'].map { |c| c['id'] }
+    end
+
+    # Turn on light
+    def on(index)
+      relay ON, index
+    end
+
+    # Turn off light
+    def off(index)
+      relay OFF, index
+    end
+
+    def off?(index)
+      relay_state(index).zero?
+    end
+
+    def on?(index)
+      relay_state(index).eql? 1
+    end
+
+    private
+
+    def relay_state(index)
+      Kasa::Protocol.get(
+        @ip,
+        location: '/system/get_sysinfo/children'
+      )[index]['state']
+    end
+
+    def relay(state, index)
+      Kasa::Protocol.get(
+        @ip,
+        location: '/system/set_relay_state/state',
+        value: state,
+        extra: { context: { child_ids: [@children[index]] } }
+      )
+    end
+  end
+end

data/lib/kasa/factory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'devices'
+require_relative 'protocol'
+
+class Kasa
+  DEVICE_TYPES = {
+    Dimmable => [
+      'HS220(US)'
+    ],
+    NonDimmable => [
+      'HS200(US)',
+      'HS105(US)',
+      'HS210(US)'
+    ],
+    SmartStrip => [
+      'HS300(US)',
+      'KP303(US)',
+      'KP400(US)'
+    ]
+  }.freeze
+
+  # Common methods across kasa devices
+  class Factory
+    # Factory
+    def self.new(ip)
+      model = Kasa::Protocol.get(ip, location: '/system/get_sysinfo')['model']
+      begin
+        object = DEVICE_TYPES.detect { |_k, v| v.include? model }.first.allocate
+      rescue StandardError => _e
+        raise "#{model} not supported"
+      end
+      object.send :initialize, ip
+      object
+    end
+  end
+end

data/lib/kasa/protocol.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'socket'
+
+class Kasa
+  # TP link protocol
+  class Protocol
+    START_KEY = 171
+    TIMEOUT = 2
+    KASA_PORT = 9999
+
+    # get result from request
+    def self.get(ip, location:, value: nil, extra: {})
+      request = request_to_hash location, value
+      request.merge! extra
+
+      encoded_response = Timeout.timeout(TIMEOUT) do
+        transport(ip, encode(request.to_json))
+      end
+
+      strip_location(location, decode(encoded_response))
+    end
+
+    # strip away the request location from the response
+    def self.strip_location(location, response)
+      location = location.split('/').reject(&:empty?)
+      response = JSON.parse response
+      location.each do |j|
+        response = (response[j] or response)
+      end
+
+      response
+    end
+
+    # convert location and value to a hash
+    def self.request_to_hash(location, value)
+      request = value
+      location = location.split('/').reject(&:empty?).reverse
+      location.each do |e|
+        request = { e => request }
+      end
+
+      request
+    end
+
+    # Open socket and send request and response
+    def self.transport(ip, request)
+      Socket.tcp(ip, KASA_PORT) do |s|
+        s.write request
+
+        result_length = s.recv(4).unpack1('I>')
+        result = ''
+        while result_length.positive?
+          result += s.recv(1024)
+          result_length -= 1024
+        end
+        result
+      end
+    end
+
+    # Encrypt and encode
+    def self.encode(plain)
+      key = START_KEY
+
+      enc_bytes = plain.unpack('C*').map do |byte|
+        key = key ^ byte
+        key
+      end
+      ([enc_bytes.length] + enc_bytes).pack('I>C*')
+    end
+
+    # Decrypt and decode
+    def self.decode(line)
+      key = START_KEY
+
+      line.unpack('C*').map do |enc_byte|
+        byte = key ^ enc_byte
+        key = enc_byte
+        byte
+      end.pack('C*')
+    end
+  end
+end

data/lib/kasa/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Kasa
+  VERSION = '0.1.0'
+end

data/lib/kasa.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'timeout'
+require 'base64'
+require 'logger'
+require_relative 'kasa/version'
+require_relative 'kasa/factory'
+
+# Control local Kasa devices
+class Kasa
+  attr_reader :devices
+
+  # initialize
+  def initialize(discover: true, discover_interface_override: false, debug: false)
+    @logger = Logger.new($stdout)
+    @logger.level = debug ? Logger::DEBUG : Logger::INFO
+    @devices = []
+    @discover_interface_override = discover_interface_override
+    refresh if discover
+  end
+
+  # Populate devices hash with Kasa devices
+  def refresh
+    threads = []
+    ip_range.each do |ip|
+      threads << Thread.new do
+        @devices << Kasa::Factory.new(ip)
+      rescue StandardError => e
+        @logger.debug e
+      end
+    end
+    threads.each(&:join)
+    @devices
+  end
+
+  private
+
+  # Return CIDR of first IPv4 interface or user-specified interface
+  def cidr
+    interface = Socket.getifaddrs.detect do |intf|
+      intf.addr.ipv4_private? && (@discover_interface_override ? intf.name.eql?(@discover_interface_override) : true)
+    end
+
+    raise 'Interface does not exist' if interface.nil?
+
+    "#{interface.addr.ip_address}/#{interface.netmask.ip_address}"
+  end
+
+  # Generate array of IP addresses from local subnet
+  def ip_range
+    IPAddr.new(cidr).to_range.to_a.map(&:to_s)
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: kasa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Jenkins
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+description: Directly control Kasa devices
+email:
+- christj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/kasa.rb
+- lib/kasa/devices.rb
+- lib/kasa/factory.rb
+- lib/kasa/protocol.rb
+- lib/kasa/version.rb
+homepage: https://github.com/sevendials/ruby-kasa
+licenses:
+- GPL-3.0
+metadata:
+  homepage_uri: https://github.com/sevendials/ruby-kasa
+  source_code_uri: https://github.com/sevendials/ruby-kasa
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: TP-Link Kasa
+test_files: []