kasa 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3b9cb41f21b4a0d40d68a55925bf620fff272fc86c08f490294ff3289be3a7a
-  data.tar.gz: 9047ea8932a63637e4626a06a1b5249f4f85892c5ac1edd09b1b9c592eef43b2
+  metadata.gz: 8e186cc4152335207cb22e4a1ca609b90b4d975af35e4c7928b47b2ef28015af
+  data.tar.gz: 0a7a3cb147c216fc56dbb6f33ade5b5a017399a2e6b75410055d32951a2b1a28
 SHA512:
-  metadata.gz: 83e87a4949e2acb817af2efa53c66635ef570f2dff2c51bb3b9f9e3cbf957441e75380df78570586afc50f29e3955e47447878c2610ac53454610a3801b9ca60
-  data.tar.gz: b1c9317735c13e22f027e92f489f377e4e9a659204a867e7cb68d5c025dc12b529327277c308b272039edc99fe8f756d5b14043828603de3172d7df11bf97b9a
+  metadata.gz: 5652eb61fefad48dc3781fd35d4109d7c697cf31415958333889cf50d467e537458dbfd0c0473c7dbfe9d55c73d6224635385d2c8b5be8e87321e158d298360c
+  data.tar.gz: 01ba283907de37a317b7802d70a416bdcd2cae3d7fb1866e7f2f4269f6fed05beee4bb68c82bc6a4dd66786fec75aedc9d630ca1ebfe24bf56a84f980d9106d2

data/Gemfile

@@ -4,11 +4,3 @@ 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

@@ -28,7 +28,9 @@ kasa.devices.first.on
 
 Local network device is detected but can be optionally overridden:
 ```
-Kasa.new(discover_interface_override: 'eth1')
+require 'kasa'
+
+kasa = Kasa.new(discover_interface_override: 'eth1')
 ```
 
 To connect to known host and adjust brightness:
@@ -39,6 +41,14 @@ device = Kasa::Factory.new('192.168.1.55')
 device.brightness=50
 ```
 
+To get device summary:
+```
+require 'kasa'
+
+kasa = Kasa.new
+kasa.summary
+```
+
 ## 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.

data/lib/kasa/devices.rb

@@ -6,12 +6,15 @@ class Kasa
     ON = 1
     OFF = 0
 
-    attr_reader :ip
+    attr_reader :ip, :alias, :model, :dev_name, :mac
 
     # initialize
-    def initialize(ip)
+    def initialize(ip, args)
       @ip = ip
-      @sysinfo = sysinfo
+      @alias = args['alias']
+      @model = args['model']
+      @dev_name = args['dev_name']
+      @mac = args['mac']
     end
 
     # Get system information
@@ -70,8 +73,8 @@ class Kasa
     def brightness=(level)
       Kasa::Protocol.get(
         @ip,
-        location: '/smartlife.iot.dimmer/set_brightness/brightness',
-        value: level
+        location: '/smartlife.iot.dimmer/set_brightness',
+        value: { brightness: level }
       )
     end
   end
@@ -80,9 +83,9 @@ class Kasa
   class SmartStrip < NonDimmable
     attr_accessor :children
 
-    def initialize(ip)
+    def initialize(ip, args)
       super
-      @children = @sysinfo['children'].map { |c| c['id'] }
+      @children = args['children'].map { |c| c['id'] }
     end
 
     # Turn on light

data/lib/kasa/factory.rb

@@ -11,6 +11,7 @@ class Kasa
     NonDimmable => [
       'HS200(US)',
       'HS105(US)',
+      'HS103(US)',
       'HS210(US)'
     ],
     SmartStrip => [
@@ -24,13 +25,14 @@ class Kasa
   class Factory
     # Factory
     def self.new(ip)
-      model = Kasa::Protocol.get(ip, location: '/system/get_sysinfo')['model']
+      sysinfo = Kasa::Protocol.get(ip, location: '/system/get_sysinfo')
+      model = 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.send :initialize, ip, sysinfo
       object
     end
   end

data/lib/kasa/protocol.rb

@@ -19,13 +19,21 @@ class Kasa
         transport(ip, encode(request.to_json))
       end
 
-      strip_location(location, decode(encoded_response))
+      response = JSON.parse decode(encoded_response)
+      response = strip_location(location, response)
+      validate response
+
+      response
+    end
+
+    # examine error code
+    def self.validate(response)
+      raise response.to_json if response.is_a?(Hash) && response['err_code']&.negative?
     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

data/lib/kasa/version.rb

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

data/lib/kasa.rb

@@ -3,6 +3,7 @@
 require 'timeout'
 require 'base64'
 require 'logger'
+require 'terminal-table'
 require_relative 'kasa/version'
 require_relative 'kasa/factory'
 
@@ -33,6 +34,20 @@ class Kasa
     @devices
   end
 
+  # human readable devices summary
+  def summary
+    all_headings = @devices.first.instance_variables
+    common_headings = @devices.each_with_object(all_headings) do |d, memo|
+      memo & d.instance_variables
+    end
+    rows = devices.map do |d|
+      common_headings.map do |a|
+        d.instance_variable_get a
+      end
+    end
+    puts Terminal::Table.new headings: common_headings, rows: rows
+  end
+
   private
 
   # Return CIDR of first IPv4 interface or user-specified interface

metadata

@@ -1,15 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: kasa
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Christopher Jenkins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-19 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: timeout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement