kasa 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8358679b94124f72b7015263cf0d9343b24e03012cfce371c8ee910e4d10c0ca
-  data.tar.gz: 7fdcee5d14a85f0bf16b3fca9ca6f9da17cb033580952257dd9f84a077b748f5
+  metadata.gz: b626279712effe805e53a91246d3ecc486de435a2ae2e1398cc99341b24e1bff
+  data.tar.gz: a6e06dd229b13f8567dbc446709eb437960706111eec76d42a1cb0312421cf50
 SHA512:
-  metadata.gz: b413201f7e11995a88ebb96f724addaf0d1e26d6607295ff8ad0e1bfa43eba8a334ad27efe5d6ce4f82e28d20dcb4df4733a0b473ad1806b529fe5b4c1e11d56
-  data.tar.gz: ccc90f4a8417797d03fce52c60a5c1f48e8a3bfd3f14c4eb08d78e061d1e15ed5c334ca90d0587171a9c5d10ab76fc5b1da5007d5d2777898ef815a6a3e37b13
+  metadata.gz: 9bf6c0701474c148d2b49609c2cdd20b7e9321dad106cf3d7b610d083c3045b0cec8f51a96bdcb8479a8f5afb6f70b3f890f0c7f1c1d1b23b8be51080a90a3a7
+  data.tar.gz: 6f60278666990dafe81745b3c534a771df4fcd3cbf81f22a7610ccf72eb962a9807210b55020b4a2399b4b74641babe8860c88b34b92e7fadd2a32c6bc8854f0

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.2'
+  VERSION = '0.2.2'
 end

data/lib/kasa.rb

@@ -2,7 +2,9 @@
 
 require 'timeout'
 require 'base64'
+require 'ipaddr'
 require 'logger'
+require 'terminal-table'
 require_relative 'kasa/version'
 require_relative 'kasa/factory'
 
@@ -33,6 +35,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kasa
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 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
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !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